com.amazonaws.services.apigateway.model

Class CreateAuthorizerResult

java.lang.Object

com.amazonaws.AmazonWebServiceResult<ResponseMetadata>

com.amazonaws.services.apigateway.model.CreateAuthorizerResult

All Implemented Interfaces:

Serializable, Cloneable

public class CreateAuthorizerResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

Represents an authorization layer for methods. If enabled on a method, API Gateway will activate the authorizer when a client calls the method.

Enable custom authorization

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CreateAuthorizerResult()

Method Summary

Modifier and Type	Method and Description
CreateAuthorizerResult	clone()
boolean	equals(Object obj)
String	getAuthorizerCredentials() Specifies the credentials required for the authorizer, if any.
Integer	getAuthorizerResultTtlInSeconds() The TTL in seconds of cached authorizer results.
String	getAuthorizerUri() [Required] Specifies the authorizer's Uniform Resource Identifier (URI).
String	getAuthType() Optional customer-defined field, used in Swagger imports/exports.
String	getId() The identifier for the authorizer resource.
String	getIdentitySource() [Required] The source of the identity in an incoming request.
String	getIdentityValidationExpression() A validation expression for the incoming identity.
String	getName() [Required] The name of the authorizer.
List<String>	getProviderARNs() A list of the provider ARNs of the authorizer.
String	getType() [Required] The type of the authorizer.
int	hashCode()
void	setAuthorizerCredentials(String authorizerCredentials) Specifies the credentials required for the authorizer, if any.
void	setAuthorizerResultTtlInSeconds(Integer authorizerResultTtlInSeconds) The TTL in seconds of cached authorizer results.
void	setAuthorizerUri(String authorizerUri) [Required] Specifies the authorizer's Uniform Resource Identifier (URI).
void	setAuthType(String authType) Optional customer-defined field, used in Swagger imports/exports.
void	setId(String id) The identifier for the authorizer resource.
void	setIdentitySource(String identitySource) [Required] The source of the identity in an incoming request.
void	setIdentityValidationExpression(String identityValidationExpression) A validation expression for the incoming identity.
void	setName(String name) [Required] The name of the authorizer.
void	setProviderARNs(Collection<String> providerARNs) A list of the provider ARNs of the authorizer.
void	setType(AuthorizerType type) [Required] The type of the authorizer.
void	setType(String type) [Required] The type of the authorizer.
String	toString() Returns a string representation of this object; useful for testing and debugging.
CreateAuthorizerResult	withAuthorizerCredentials(String authorizerCredentials) Specifies the credentials required for the authorizer, if any.
CreateAuthorizerResult	withAuthorizerResultTtlInSeconds(Integer authorizerResultTtlInSeconds) The TTL in seconds of cached authorizer results.
CreateAuthorizerResult	withAuthorizerUri(String authorizerUri) [Required] Specifies the authorizer's Uniform Resource Identifier (URI).
CreateAuthorizerResult	withAuthType(String authType) Optional customer-defined field, used in Swagger imports/exports.
CreateAuthorizerResult	withId(String id) The identifier for the authorizer resource.
CreateAuthorizerResult	withIdentitySource(String identitySource) [Required] The source of the identity in an incoming request.
CreateAuthorizerResult	withIdentityValidationExpression(String identityValidationExpression) A validation expression for the incoming identity.
CreateAuthorizerResult	withName(String name) [Required] The name of the authorizer.
CreateAuthorizerResult	withProviderARNs(Collection<String> providerARNs) A list of the provider ARNs of the authorizer.
CreateAuthorizerResult	withProviderARNs(String... providerARNs) A list of the provider ARNs of the authorizer.
CreateAuthorizerResult	withType(AuthorizerType type) [Required] The type of the authorizer.
CreateAuthorizerResult	withType(String type) [Required] The type of the authorizer.

Methods inherited from class com.amazonaws.AmazonWebServiceResult

getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateAuthorizerResult

public CreateAuthorizerResult()

Method Detail

setId

public void setId(String id)

The identifier for the authorizer resource.

Parameters:

id - The identifier for the authorizer resource.

getId

public String getId()

The identifier for the authorizer resource.

Returns:

The identifier for the authorizer resource.

withId

public CreateAuthorizerResult withId(String id)

The identifier for the authorizer resource.

Parameters:

id - The identifier for the authorizer resource.

Returns:

Returns a reference to this object so that method calls can be chained together.

setName

public void setName(String name)

[Required] The name of the authorizer.

Parameters:

name - [Required] The name of the authorizer.

getName

public String getName()

[Required] The name of the authorizer.

Returns:

[Required] The name of the authorizer.

withName

public CreateAuthorizerResult withName(String name)

[Required] The name of the authorizer.

Parameters:

name - [Required] The name of the authorizer.

Returns:

Returns a reference to this object so that method calls can be chained together.

setType

public void setType(String type)

[Required] The type of the authorizer. Currently, the valid type is TOKEN for a Lambda function or COGNITO_USER_POOLS for an Amazon Cognito user pool.

Parameters:

type - [Required] The type of the authorizer. Currently, the valid type is TOKEN for a Lambda function or COGNITO_USER_POOLS for an Amazon Cognito user pool.

See Also:

AuthorizerType

getType

public String getType()

[Required] The type of the authorizer. Currently, the valid type is TOKEN for a Lambda function or COGNITO_USER_POOLS for an Amazon Cognito user pool.

Returns:

[Required] The type of the authorizer. Currently, the valid type is TOKEN for a Lambda function or COGNITO_USER_POOLS for an Amazon Cognito user pool.

See Also:

AuthorizerType

withType

public CreateAuthorizerResult withType(String type)

[Required] The type of the authorizer. Currently, the valid type is TOKEN for a Lambda function or COGNITO_USER_POOLS for an Amazon Cognito user pool.

Parameters:

type - [Required] The type of the authorizer. Currently, the valid type is TOKEN for a Lambda function or COGNITO_USER_POOLS for an Amazon Cognito user pool.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AuthorizerType

setType

public void setType(AuthorizerType type)

[Required] The type of the authorizer. Currently, the valid type is TOKEN for a Lambda function or COGNITO_USER_POOLS for an Amazon Cognito user pool.

Parameters:

type - [Required] The type of the authorizer. Currently, the valid type is TOKEN for a Lambda function or COGNITO_USER_POOLS for an Amazon Cognito user pool.

See Also:

AuthorizerType

withType

public CreateAuthorizerResult withType(AuthorizerType type)

[Required] The type of the authorizer. Currently, the valid type is TOKEN for a Lambda function or COGNITO_USER_POOLS for an Amazon Cognito user pool.

Parameters:

type - [Required] The type of the authorizer. Currently, the valid type is TOKEN for a Lambda function or COGNITO_USER_POOLS for an Amazon Cognito user pool.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AuthorizerType

getProviderARNs

public List<String> getProviderARNs()

A list of the provider ARNs of the authorizer. For an TOKEN authorizer, this is not defined. For authorizers of the COGNITO_USER_POOLS type, each element corresponds to a user pool ARN of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}.

Returns:

A list of the provider ARNs of the authorizer. For an TOKEN authorizer, this is not defined. For authorizers of the COGNITO_USER_POOLS type, each element corresponds to a user pool ARN of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}.

setProviderARNs

public void setProviderARNs(Collection<String> providerARNs)

A list of the provider ARNs of the authorizer. For an TOKEN authorizer, this is not defined. For authorizers of the COGNITO_USER_POOLS type, each element corresponds to a user pool ARN of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}.

Parameters:

providerARNs - A list of the provider ARNs of the authorizer. For an TOKEN authorizer, this is not defined. For authorizers of the COGNITO_USER_POOLS type, each element corresponds to a user pool ARN of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}.

withProviderARNs

public CreateAuthorizerResult withProviderARNs(String... providerARNs)

A list of the provider ARNs of the authorizer. For an TOKEN authorizer, this is not defined. For authorizers of the COGNITO_USER_POOLS type, each element corresponds to a user pool ARN of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}.

NOTE: This method appends the values to the existing list (if any). Use setProviderARNs(java.util.Collection) or withProviderARNs(java.util.Collection) if you want to override the existing values.

Parameters:

providerARNs - A list of the provider ARNs of the authorizer. For an TOKEN authorizer, this is not defined. For authorizers of the COGNITO_USER_POOLS type, each element corresponds to a user pool ARN of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}.

Returns:

Returns a reference to this object so that method calls can be chained together.

withProviderARNs

public CreateAuthorizerResult withProviderARNs(Collection<String> providerARNs)

A list of the provider ARNs of the authorizer. For an TOKEN authorizer, this is not defined. For authorizers of the COGNITO_USER_POOLS type, each element corresponds to a user pool ARN of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}.

Parameters:

providerARNs - A list of the provider ARNs of the authorizer. For an TOKEN authorizer, this is not defined. For authorizers of the COGNITO_USER_POOLS type, each element corresponds to a user pool ARN of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}.

Returns:

Returns a reference to this object so that method calls can be chained together.

setAuthType

public void setAuthType(String authType)

Optional customer-defined field, used in Swagger imports/exports. Has no functional impact.

Parameters:

authType - Optional customer-defined field, used in Swagger imports/exports. Has no functional impact.

getAuthType

public String getAuthType()

Optional customer-defined field, used in Swagger imports/exports. Has no functional impact.

Returns:

Optional customer-defined field, used in Swagger imports/exports. Has no functional impact.

withAuthType

public CreateAuthorizerResult withAuthType(String authType)

Optional customer-defined field, used in Swagger imports/exports. Has no functional impact.

Parameters:

authType - Optional customer-defined field, used in Swagger imports/exports. Has no functional impact.

Returns:

Returns a reference to this object so that method calls can be chained together.

setAuthorizerUri

public void setAuthorizerUri(String authorizerUri)

[Required] Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations . In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.

Parameters:

authorizerUri - [Required] Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations . In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.

getAuthorizerUri

public String getAuthorizerUri()

[Required] Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations . In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.

Returns:

[Required] Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations . In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.

withAuthorizerUri

public CreateAuthorizerResult withAuthorizerUri(String authorizerUri)

[Required] Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations . In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.

Parameters:

authorizerUri - [Required] Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations . In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.

Returns:

Returns a reference to this object so that method calls can be chained together.

setAuthorizerCredentials

public void setAuthorizerCredentials(String authorizerCredentials)

Specifies the credentials required for the authorizer, if any. Two options are available. To specify an IAM role for Amazon API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.

Parameters:

authorizerCredentials - Specifies the credentials required for the authorizer, if any. Two options are available. To specify an IAM role for Amazon API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.

getAuthorizerCredentials

public String getAuthorizerCredentials()

Specifies the credentials required for the authorizer, if any. Two options are available. To specify an IAM role for Amazon API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.

Returns:

Specifies the credentials required for the authorizer, if any. Two options are available. To specify an IAM role for Amazon API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.

withAuthorizerCredentials

public CreateAuthorizerResult withAuthorizerCredentials(String authorizerCredentials)

Specifies the credentials required for the authorizer, if any. Two options are available. To specify an IAM role for Amazon API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.

Parameters:

authorizerCredentials - Specifies the credentials required for the authorizer, if any. Two options are available. To specify an IAM role for Amazon API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.

Returns:

Returns a reference to this object so that method calls can be chained together.

setIdentitySource

public void setIdentitySource(String identitySource)

[Required] The source of the identity in an incoming request. For a TOKEN authorizer, this value is a mapping expression with the same syntax as integration parameter mappings. The only valid source for tokens is 'header', so the expression should match 'method.request.header.[headerName]'. The value of the header '[headerName]' will be interpreted as the incoming token. For COGNITO_USER_POOLS authorizers, this property is used.

Parameters:

identitySource - [Required] The source of the identity in an incoming request. For a TOKEN authorizer, this value is a mapping expression with the same syntax as integration parameter mappings. The only valid source for tokens is 'header', so the expression should match 'method.request.header.[headerName]'. The value of the header '[headerName]' will be interpreted as the incoming token. For COGNITO_USER_POOLS authorizers, this property is used.

getIdentitySource

public String getIdentitySource()

[Required] The source of the identity in an incoming request. For a TOKEN authorizer, this value is a mapping expression with the same syntax as integration parameter mappings. The only valid source for tokens is 'header', so the expression should match 'method.request.header.[headerName]'. The value of the header '[headerName]' will be interpreted as the incoming token. For COGNITO_USER_POOLS authorizers, this property is used.

Returns:

[Required] The source of the identity in an incoming request. For a TOKEN authorizer, this value is a mapping expression with the same syntax as integration parameter mappings. The only valid source for tokens is 'header', so the expression should match 'method.request.header.[headerName]'. The value of the header '[headerName]' will be interpreted as the incoming token. For COGNITO_USER_POOLS authorizers, this property is used.

withIdentitySource

public CreateAuthorizerResult withIdentitySource(String identitySource)

[Required] The source of the identity in an incoming request. For a TOKEN authorizer, this value is a mapping expression with the same syntax as integration parameter mappings. The only valid source for tokens is 'header', so the expression should match 'method.request.header.[headerName]'. The value of the header '[headerName]' will be interpreted as the incoming token. For COGNITO_USER_POOLS authorizers, this property is used.

Parameters:

identitySource - [Required] The source of the identity in an incoming request. For a TOKEN authorizer, this value is a mapping expression with the same syntax as integration parameter mappings. The only valid source for tokens is 'header', so the expression should match 'method.request.header.[headerName]'. The value of the header '[headerName]' will be interpreted as the incoming token. For COGNITO_USER_POOLS authorizers, this property is used.

Returns:

Returns a reference to this object so that method calls can be chained together.

setIdentityValidationExpression

public void setIdentityValidationExpression(String identityValidationExpression)

A validation expression for the incoming identity. For TOKEN authorizers, this value should be a regular expression. The incoming token from the client is matched against this expression, and will proceed if the token matches. If the token doesn't match, the client receives a 401 Unauthorized response.

Parameters:

identityValidationExpression - A validation expression for the incoming identity. For TOKEN authorizers, this value should be a regular expression. The incoming token from the client is matched against this expression, and will proceed if the token matches. If the token doesn't match, the client receives a 401 Unauthorized response.

getIdentityValidationExpression

public String getIdentityValidationExpression()

A validation expression for the incoming identity. For TOKEN authorizers, this value should be a regular expression. The incoming token from the client is matched against this expression, and will proceed if the token matches. If the token doesn't match, the client receives a 401 Unauthorized response.

Returns:

A validation expression for the incoming identity. For TOKEN authorizers, this value should be a regular expression. The incoming token from the client is matched against this expression, and will proceed if the token matches. If the token doesn't match, the client receives a 401 Unauthorized response.

withIdentityValidationExpression

public CreateAuthorizerResult withIdentityValidationExpression(String identityValidationExpression)

A validation expression for the incoming identity. For TOKEN authorizers, this value should be a regular expression. The incoming token from the client is matched against this expression, and will proceed if the token matches. If the token doesn't match, the client receives a 401 Unauthorized response.

Parameters:

identityValidationExpression - A validation expression for the incoming identity. For TOKEN authorizers, this value should be a regular expression. The incoming token from the client is matched against this expression, and will proceed if the token matches. If the token doesn't match, the client receives a 401 Unauthorized response.

Returns:

Returns a reference to this object so that method calls can be chained together.

setAuthorizerResultTtlInSeconds

public void setAuthorizerResultTtlInSeconds(Integer authorizerResultTtlInSeconds)

The TTL in seconds of cached authorizer results. If greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.

Parameters:

authorizerResultTtlInSeconds - The TTL in seconds of cached authorizer results. If greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.

getAuthorizerResultTtlInSeconds

public Integer getAuthorizerResultTtlInSeconds()

The TTL in seconds of cached authorizer results. If greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.

Returns:

The TTL in seconds of cached authorizer results. If greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.

withAuthorizerResultTtlInSeconds

public CreateAuthorizerResult withAuthorizerResultTtlInSeconds(Integer authorizerResultTtlInSeconds)

The TTL in seconds of cached authorizer results. If greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.

Parameters:

authorizerResultTtlInSeconds - The TTL in seconds of cached authorizer results. If greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateAuthorizerResult clone()

Overrides:

clone in class Object