setType

[Required] The authorizer type. Valid values are TOKEN for a Lambda function using a single
authorization token submitted in a custom header, REQUEST for a Lambda function using incoming
request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.

Parameters:

type - [Required] The authorizer type. Valid values are TOKEN for a Lambda function using a single
authorization token submitted in a custom header, REQUEST for a Lambda function using
incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.

getType

[Required] The authorizer type. Valid values are TOKEN for a Lambda function using a single
authorization token submitted in a custom header, REQUEST for a Lambda function using incoming
request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.

Returns:

[Required] The authorizer type. Valid values are TOKEN for a Lambda function using a single
authorization token submitted in a custom header, REQUEST for a Lambda function using
incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.

withType

[Required] The authorizer type. Valid values are TOKEN for a Lambda function using a single
authorization token submitted in a custom header, REQUEST for a Lambda function using incoming
request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.

Parameters:

type - [Required] The authorizer type. Valid values are TOKEN for a Lambda function using a single
authorization token submitted in a custom header, REQUEST for a Lambda function using
incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.

Returns:

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

setType

[Required] The authorizer type. Valid values are TOKEN for a Lambda function using a single
authorization token submitted in a custom header, REQUEST for a Lambda function using incoming
request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.

Parameters:

type - [Required] The authorizer type. Valid values are TOKEN for a Lambda function using a single
authorization token submitted in a custom header, REQUEST for a Lambda function using
incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.

withType

[Required] The authorizer type. Valid values are TOKEN for a Lambda function using a single
authorization token submitted in a custom header, REQUEST for a Lambda function using incoming
request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.

Parameters:

type - [Required] The authorizer type. Valid values are TOKEN for a Lambda function using a single
authorization token submitted in a custom header, REQUEST for a Lambda function using
incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.

Returns:

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

getProviderARNs

A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is
of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a
TOKEN or REQUEST authorizer, this is not defined.

Returns:

A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each
element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}
. For a TOKEN or REQUEST authorizer, this is not defined.

setProviderARNs

A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is
of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a
TOKEN or REQUEST authorizer, this is not defined.

Parameters:

providerARNs - A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each
element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}.
For a TOKEN or REQUEST authorizer, this is not defined.

withProviderARNs

A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is
of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a
TOKEN or REQUEST authorizer, this is not defined.

providerARNs - A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each
element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}.
For a TOKEN or REQUEST authorizer, this is not defined.

Returns:

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

withProviderARNs

A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is
of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a
TOKEN or REQUEST authorizer, this is not defined.

Parameters:

providerARNs - A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each
element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}.
For a TOKEN or REQUEST authorizer, this is not defined.

Returns:

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

setAuthorizerUri

Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST
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 - Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or
REQUEST 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

Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST
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:

Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or
REQUEST 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

Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST
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 - Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or
REQUEST 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

Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM
role for 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 required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an
IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based
permissions on the Lambda function, specify null.

getAuthorizerCredentials

Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM
role for 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 required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an
IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based
permissions on the Lambda function, specify null.

withAuthorizerCredentials

Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM
role for 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 required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an
IAM role for 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

For a TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the
request header mapping expression for the custom header holding the authorization token submitted by the client.
For example, if the token header name is Auth, the header mapping expression is
method.request.header.Auth.

For the REQUEST authorizer, this is required when authorization caching is enabled. The value is
a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if
an Auth header, a Name query string parameter are defined as identity sources, this
value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used
to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer
by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this
is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized
response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions
of the specified request parameters. When the authorization caching is not enabled, this property is optional.

Parameters:

identitySource - The identity source for which authorization is requested.

For a TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies
the request header mapping expression for the custom header holding the authorization token submitted by
the client. For example, if the token header name is Auth, the header mapping expression is
method.request.header.Auth.

For the REQUEST authorizer, this is required when authorization caching is enabled. The
value is a comma-separated string of one or more mapping expressions of the specified request parameters.
For example, if an Auth header, a Name query string parameter are defined as
identity sources, this value is method.request.header.Auth, method.request.querystring.Name.
These parameters will be used to derive the authorization caching key and to perform runtime validation of
the REQUEST authorizer by verifying all of the identity-related request parameters are
present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda
function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid
value is a string of comma-separated mapping expressions of the specified request parameters. When the
authorization caching is not enabled, this property is optional.

getIdentitySource

For a TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the
request header mapping expression for the custom header holding the authorization token submitted by the client.
For example, if the token header name is Auth, the header mapping expression is
method.request.header.Auth.

For the REQUEST authorizer, this is required when authorization caching is enabled. The value is
a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if
an Auth header, a Name query string parameter are defined as identity sources, this
value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used
to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer
by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this
is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized
response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions
of the specified request parameters. When the authorization caching is not enabled, this property is optional.

Returns:

The identity source for which authorization is requested.

For a TOKEN or COGNITO_USER_POOLS authorizer, this is required and
specifies the request header mapping expression for the custom header holding the authorization token
submitted by the client. For example, if the token header name is Auth, the header mapping
expression is method.request.header.Auth.

For the REQUEST authorizer, this is required when authorization caching is enabled. The
value is a comma-separated string of one or more mapping expressions of the specified request parameters.
For example, if an Auth header, a Name query string parameter are defined as
identity sources, this value is method.request.header.Auth, method.request.querystring.Name.
These parameters will be used to derive the authorization caching key and to perform runtime validation
of the REQUEST authorizer by verifying all of the identity-related request parameters are
present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda
function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The
valid value is a string of comma-separated mapping expressions of the specified request parameters. When
the authorization caching is not enabled, this property is optional.

withIdentitySource

For a TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the
request header mapping expression for the custom header holding the authorization token submitted by the client.
For example, if the token header name is Auth, the header mapping expression is
method.request.header.Auth.

For the REQUEST authorizer, this is required when authorization caching is enabled. The value is
a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if
an Auth header, a Name query string parameter are defined as identity sources, this
value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used
to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer
by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this
is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized
response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions
of the specified request parameters. When the authorization caching is not enabled, this property is optional.

Parameters:

identitySource - The identity source for which authorization is requested.

For a TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies
the request header mapping expression for the custom header holding the authorization token submitted by
the client. For example, if the token header name is Auth, the header mapping expression is
method.request.header.Auth.

For the REQUEST authorizer, this is required when authorization caching is enabled. The
value is a comma-separated string of one or more mapping expressions of the specified request parameters.
For example, if an Auth header, a Name query string parameter are defined as
identity sources, this value is method.request.header.Auth, method.request.querystring.Name.
These parameters will be used to derive the authorization caching key and to perform runtime validation of
the REQUEST authorizer by verifying all of the identity-related request parameters are
present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda
function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid
value is a string of comma-separated mapping expressions of the specified request parameters. When the
authorization caching is not enabled, this property is optional.

Returns:

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

setIdentityValidationExpression

A validation expression for the incoming identity token. For TOKEN authorizers, this value is a
regular expression. API Gateway will match the aud field of the incoming token from the client
against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match.
Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation
expression does not apply to the REQUEST authorizer.

Parameters:

identityValidationExpression - A validation expression for the incoming identity token. For TOKEN authorizers, this value is
a regular expression. API Gateway will match the aud field of the incoming token from the
client against the specified regular expression. It will invoke the authorizer's Lambda function when
there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda
function. The validation expression does not apply to the REQUEST authorizer.

getIdentityValidationExpression

A validation expression for the incoming identity token. For TOKEN authorizers, this value is a
regular expression. API Gateway will match the aud field of the incoming token from the client
against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match.
Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation
expression does not apply to the REQUEST authorizer.

Returns:

A validation expression for the incoming identity token. For TOKEN authorizers, this value
is a regular expression. API Gateway will match the aud field of the incoming token from the
client against the specified regular expression. It will invoke the authorizer's Lambda function when
there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda
function. The validation expression does not apply to the REQUEST authorizer.

withIdentityValidationExpression

A validation expression for the incoming identity token. For TOKEN authorizers, this value is a
regular expression. API Gateway will match the aud field of the incoming token from the client
against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match.
Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation
expression does not apply to the REQUEST authorizer.

Parameters:

identityValidationExpression - A validation expression for the incoming identity token. For TOKEN authorizers, this value is
a regular expression. API Gateway will match the aud field of the incoming token from the
client against the specified regular expression. It will invoke the authorizer's Lambda function when
there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda
function. The validation expression does not apply to the REQUEST authorizer.

Returns:

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

setAuthorizerResultTtlInSeconds

The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is
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 it equals 0, authorization caching is disabled. If it
is 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

The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is
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 it equals 0, authorization caching is disabled. If it
is 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

The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is
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 it equals 0, authorization caching is disabled. If it
is 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.