Package software.amazon.awssdk.services.apigateway.model

Interface Authorizer.Builder

All Superinterfaces:

CopyableBuilder<Authorizer.Builder,Authorizer>, SdkBuilder<Authorizer.Builder,Authorizer>

Enclosing class:

Authorizer

public static interface Authorizer.Builder
extends CopyableBuilder<Authorizer.Builder,Authorizer>

Method Summary

Modifier and Type	Method	Description
Authorizer.Builder	authorizerCredentials(String authorizerCredentials)	Specifies the credentials required for the authorizer, if any.
Authorizer.Builder	authorizerResultTtlInSeconds(Integer authorizerResultTtlInSeconds)	The TTL in seconds of cached authorizer results.
Authorizer.Builder	authorizerUri(String authorizerUri)	[Required] Specifies the authorizer's Uniform Resource Identifier (URI).
Authorizer.Builder	authType(String authType)	Optional customer-defined field, used in Swagger imports/exports.
Authorizer.Builder	id(String id)	The identifier for the authorizer resource.
Authorizer.Builder	identitySource(String identitySource)	[Required] The source of the identity in an incoming request.
Authorizer.Builder	identityValidationExpression(String identityValidationExpression)	A validation expression for the incoming identity.
Authorizer.Builder	name(String name)	[Required] The name of the authorizer.
Authorizer.Builder	providerARNs(String... providerARNs)	A list of the provider ARNs of the authorizer.
Authorizer.Builder	providerARNs(Collection<String> providerARNs)	A list of the provider ARNs of the authorizer.
Authorizer.Builder	type(String type)	[Required] The type of the authorizer.
Authorizer.Builder	type(AuthorizerType type)	[Required] The type of the authorizer.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

apply, build

Method Detail

id

Authorizer.Builder id(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.

name

Authorizer.Builder name(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.

type

Authorizer.Builder type(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

type

Authorizer.Builder type(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

providerARNs

Authorizer.Builder providerARNs(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.

providerARNs

Authorizer.Builder providerARNs(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.

authType

Authorizer.Builder authType(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.

authorizerUri

Authorizer.Builder authorizerUri(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.

authorizerCredentials

Authorizer.Builder authorizerCredentials(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.

identitySource

Authorizer.Builder identitySource(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.

identityValidationExpression

Authorizer.Builder identityValidationExpression(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.

authorizerResultTtlInSeconds

Authorizer.Builder authorizerResultTtlInSeconds(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.