@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateAuthorizerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable, Cloneable
Constructor and Description |
---|
CreateAuthorizerResult() |
Modifier and Type | Method and Description |
---|---|
CreateAuthorizerResult |
clone() |
boolean |
equals(Object obj) |
String |
getAuthorizerCredentialsArn()
Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer.
|
String |
getAuthorizerId()
The authorizer identifier.
|
String |
getAuthorizerPayloadFormatVersion()
Specifies the format of the payload sent to an HTTP API Lambda authorizer.
|
Integer |
getAuthorizerResultTtlInSeconds()
The time to live (TTL) for cached authorizer results, in seconds.
|
String |
getAuthorizerType()
The authorizer type.
|
String |
getAuthorizerUri()
The authorizer's Uniform Resource Identifier (URI).
|
Boolean |
getEnableSimpleResponses()
Specifies whether a Lambda authorizer returns a response in a simple format.
|
List<String> |
getIdentitySource()
The identity source for which authorization is requested.
|
String |
getIdentityValidationExpression()
The validation expression does not apply to the REQUEST authorizer.
|
JWTConfiguration |
getJwtConfiguration()
Represents the configuration of a JWT authorizer.
|
String |
getName()
The name of the authorizer.
|
int |
hashCode() |
Boolean |
isEnableSimpleResponses()
Specifies whether a Lambda authorizer returns a response in a simple format.
|
void |
setAuthorizerCredentialsArn(String authorizerCredentialsArn)
Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer.
|
void |
setAuthorizerId(String authorizerId)
The authorizer identifier.
|
void |
setAuthorizerPayloadFormatVersion(String authorizerPayloadFormatVersion)
Specifies the format of the payload sent to an HTTP API Lambda authorizer.
|
void |
setAuthorizerResultTtlInSeconds(Integer authorizerResultTtlInSeconds)
The time to live (TTL) for cached authorizer results, in seconds.
|
void |
setAuthorizerType(String authorizerType)
The authorizer type.
|
void |
setAuthorizerUri(String authorizerUri)
The authorizer's Uniform Resource Identifier (URI).
|
void |
setEnableSimpleResponses(Boolean enableSimpleResponses)
Specifies whether a Lambda authorizer returns a response in a simple format.
|
void |
setIdentitySource(Collection<String> identitySource)
The identity source for which authorization is requested.
|
void |
setIdentityValidationExpression(String identityValidationExpression)
The validation expression does not apply to the REQUEST authorizer.
|
void |
setJwtConfiguration(JWTConfiguration jwtConfiguration)
Represents the configuration of a JWT authorizer.
|
void |
setName(String name)
The name of the authorizer.
|
String |
toString()
Returns a string representation of this object.
|
CreateAuthorizerResult |
withAuthorizerCredentialsArn(String authorizerCredentialsArn)
Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer.
|
CreateAuthorizerResult |
withAuthorizerId(String authorizerId)
The authorizer identifier.
|
CreateAuthorizerResult |
withAuthorizerPayloadFormatVersion(String authorizerPayloadFormatVersion)
Specifies the format of the payload sent to an HTTP API Lambda authorizer.
|
CreateAuthorizerResult |
withAuthorizerResultTtlInSeconds(Integer authorizerResultTtlInSeconds)
The time to live (TTL) for cached authorizer results, in seconds.
|
CreateAuthorizerResult |
withAuthorizerType(AuthorizerType authorizerType)
The authorizer type.
|
CreateAuthorizerResult |
withAuthorizerType(String authorizerType)
The authorizer type.
|
CreateAuthorizerResult |
withAuthorizerUri(String authorizerUri)
The authorizer's Uniform Resource Identifier (URI).
|
CreateAuthorizerResult |
withEnableSimpleResponses(Boolean enableSimpleResponses)
Specifies whether a Lambda authorizer returns a response in a simple format.
|
CreateAuthorizerResult |
withIdentitySource(Collection<String> identitySource)
The identity source for which authorization is requested.
|
CreateAuthorizerResult |
withIdentitySource(String... identitySource)
The identity source for which authorization is requested.
|
CreateAuthorizerResult |
withIdentityValidationExpression(String identityValidationExpression)
The validation expression does not apply to the REQUEST authorizer.
|
CreateAuthorizerResult |
withJwtConfiguration(JWTConfiguration jwtConfiguration)
Represents the configuration of a JWT authorizer.
|
CreateAuthorizerResult |
withName(String name)
The name of the authorizer.
|
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata
public void setAuthorizerCredentialsArn(String authorizerCredentialsArn)
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, don't specify this parameter. Supported only for REQUEST authorizers.
authorizerCredentialsArn
- 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, don't specify this parameter. Supported only for REQUEST authorizers.public String getAuthorizerCredentialsArn()
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, don't specify this parameter. Supported only for REQUEST authorizers.
public CreateAuthorizerResult withAuthorizerCredentialsArn(String authorizerCredentialsArn)
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, don't specify this parameter. Supported only for REQUEST authorizers.
authorizerCredentialsArn
- 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, don't specify this parameter. Supported only for REQUEST authorizers.public void setAuthorizerId(String authorizerId)
The authorizer identifier.
authorizerId
- The authorizer identifier.public String getAuthorizerId()
The authorizer identifier.
public CreateAuthorizerResult withAuthorizerId(String authorizerId)
The authorizer identifier.
authorizerId
- The authorizer identifier.public void setAuthorizerPayloadFormatVersion(String authorizerPayloadFormatVersion)
Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.
authorizerPayloadFormatVersion
- Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda
authorizers. Supported values are 1.0 and 2.0. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.public String getAuthorizerPayloadFormatVersion()
Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.
public CreateAuthorizerResult withAuthorizerPayloadFormatVersion(String authorizerPayloadFormatVersion)
Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.
authorizerPayloadFormatVersion
- Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda
authorizers. Supported values are 1.0 and 2.0. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.public void setAuthorizerResultTtlInSeconds(Integer authorizerResultTtlInSeconds)
The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.
authorizerResultTtlInSeconds
- The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is
disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or
1 hour. Supported only for HTTP API Lambda authorizers.public Integer getAuthorizerResultTtlInSeconds()
The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.
public CreateAuthorizerResult withAuthorizerResultTtlInSeconds(Integer authorizerResultTtlInSeconds)
The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.
authorizerResultTtlInSeconds
- The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is
disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or
1 hour. Supported only for HTTP API Lambda authorizers.public void setAuthorizerType(String authorizerType)
The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).
authorizerType
- The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT
to use JSON Web Tokens (supported only for HTTP APIs).AuthorizerType
public String getAuthorizerType()
The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).
AuthorizerType
public CreateAuthorizerResult withAuthorizerType(String authorizerType)
The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).
authorizerType
- The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT
to use JSON Web Tokens (supported only for HTTP APIs).AuthorizerType
public CreateAuthorizerResult withAuthorizerType(AuthorizerType authorizerType)
The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).
authorizerType
- The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT
to use JSON Web Tokens (supported only for HTTP APIs).AuthorizerType
public void setAuthorizerUri(String authorizerUri)
The authorizer's Uniform Resource Identifier (URI). For 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:
authorizerUri
- The authorizer's Uniform Resource Identifier (URI). For 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:public String getAuthorizerUri()
The authorizer's Uniform Resource Identifier (URI). For 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:
public CreateAuthorizerResult withAuthorizerUri(String authorizerUri)
The authorizer's Uniform Resource Identifier (URI). For 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:
authorizerUri
- The authorizer's Uniform Resource Identifier (URI). For 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:public void setEnableSimpleResponses(Boolean enableSimpleResponses)
Specifies whether a Lambda authorizer returns a response in a simple format. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see Working with AWS Lambda authorizers for HTTP APIs
enableSimpleResponses
- Specifies whether a Lambda authorizer returns a response in a simple format. If enabled, the Lambda
authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn
more, see Working with AWS Lambda authorizers for HTTP APIspublic Boolean getEnableSimpleResponses()
Specifies whether a Lambda authorizer returns a response in a simple format. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see Working with AWS Lambda authorizers for HTTP APIs
public CreateAuthorizerResult withEnableSimpleResponses(Boolean enableSimpleResponses)
Specifies whether a Lambda authorizer returns a response in a simple format. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see Working with AWS Lambda authorizers for HTTP APIs
enableSimpleResponses
- Specifies whether a Lambda authorizer returns a response in a simple format. If enabled, the Lambda
authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn
more, see Working with AWS Lambda authorizers for HTTP APIspublic Boolean isEnableSimpleResponses()
Specifies whether a Lambda authorizer returns a response in a simple format. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see Working with AWS Lambda authorizers for HTTP APIs
public List<String> getIdentitySource()
The identity source for which authorization is requested.
For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, 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. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.
For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.
For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, 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. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.
For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.
public void setIdentitySource(Collection<String> identitySource)
The identity source for which authorization is requested.
For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, 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. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.
For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.
identitySource
- The identity source for which authorization is requested.
For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, 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. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.
For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.
public CreateAuthorizerResult withIdentitySource(String... identitySource)
The identity source for which authorization is requested.
For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, 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. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.
For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.
NOTE: This method appends the values to the existing list (if any). Use
setIdentitySource(java.util.Collection)
or withIdentitySource(java.util.Collection)
if you want
to override the existing values.
identitySource
- The identity source for which authorization is requested.
For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, 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. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.
For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.
public CreateAuthorizerResult withIdentitySource(Collection<String> identitySource)
The identity source for which authorization is requested.
For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, 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. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.
For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.
identitySource
- The identity source for which authorization is requested.
For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, 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. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.
For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.
public void setIdentityValidationExpression(String identityValidationExpression)
The validation expression does not apply to the REQUEST authorizer.
identityValidationExpression
- The validation expression does not apply to the REQUEST authorizer.public String getIdentityValidationExpression()
The validation expression does not apply to the REQUEST authorizer.
public CreateAuthorizerResult withIdentityValidationExpression(String identityValidationExpression)
The validation expression does not apply to the REQUEST authorizer.
identityValidationExpression
- The validation expression does not apply to the REQUEST authorizer.public void setJwtConfiguration(JWTConfiguration jwtConfiguration)
Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
jwtConfiguration
- Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for
HTTP APIs.public JWTConfiguration getJwtConfiguration()
Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
public CreateAuthorizerResult withJwtConfiguration(JWTConfiguration jwtConfiguration)
Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
jwtConfiguration
- Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for
HTTP APIs.public void setName(String name)
The name of the authorizer.
name
- The name of the authorizer.public String getName()
The name of the authorizer.
public CreateAuthorizerResult withName(String name)
The name of the authorizer.
name
- The name of the authorizer.public String toString()
toString
in class Object
Object.toString()
public CreateAuthorizerResult clone()