com.amazonaws.services.apigatewayv2.model

Class CreateAuthorizerRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.apigatewayv2.model.CreateAuthorizerRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateAuthorizerRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateAuthorizerRequest()

Method Summary

Modifier and Type	Method and Description
CreateAuthorizerRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getApiId() The API identifier.
String	getAuthorizerCredentialsArn() Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer.
Integer	getAuthorizerResultTtlInSeconds() The time to live (TTL), in seconds, of cached authorizer results.
String	getAuthorizerType() The authorizer type.
String	getAuthorizerUri() The authorizer's Uniform Resource Identifier (URI).
List<String>	getIdentitySource() The identity source for which authorization is requested.
String	getIdentityValidationExpression() The validation expression does not apply to the REQUEST authorizer.
String	getName() The name of the authorizer.
List<String>	getProviderArns() For REQUEST authorizer, this is not defined.
int	hashCode()
void	setApiId(String apiId) The API identifier.
void	setAuthorizerCredentialsArn(String authorizerCredentialsArn) Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer.
void	setAuthorizerResultTtlInSeconds(Integer authorizerResultTtlInSeconds) The time to live (TTL), in seconds, of cached authorizer results.
void	setAuthorizerType(String authorizerType) The authorizer type.
void	setAuthorizerUri(String authorizerUri) The authorizer's Uniform Resource Identifier (URI).
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	setName(String name) The name of the authorizer.
void	setProviderArns(Collection<String> providerArns) For REQUEST authorizer, this is not defined.
String	toString() Returns a string representation of this object.
CreateAuthorizerRequest	withApiId(String apiId) The API identifier.
CreateAuthorizerRequest	withAuthorizerCredentialsArn(String authorizerCredentialsArn) Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer.
CreateAuthorizerRequest	withAuthorizerResultTtlInSeconds(Integer authorizerResultTtlInSeconds) The time to live (TTL), in seconds, of cached authorizer results.
CreateAuthorizerRequest	withAuthorizerType(AuthorizerType authorizerType) The authorizer type.
CreateAuthorizerRequest	withAuthorizerType(String authorizerType) The authorizer type.
CreateAuthorizerRequest	withAuthorizerUri(String authorizerUri) The authorizer's Uniform Resource Identifier (URI).
CreateAuthorizerRequest	withIdentitySource(Collection<String> identitySource) The identity source for which authorization is requested.
CreateAuthorizerRequest	withIdentitySource(String... identitySource) The identity source for which authorization is requested.
CreateAuthorizerRequest	withIdentityValidationExpression(String identityValidationExpression) The validation expression does not apply to the REQUEST authorizer.
CreateAuthorizerRequest	withName(String name) The name of the authorizer.
CreateAuthorizerRequest	withProviderArns(Collection<String> providerArns) For REQUEST authorizer, this is not defined.
CreateAuthorizerRequest	withProviderArns(String... providerArns) For REQUEST authorizer, this is not defined.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateAuthorizerRequest

public CreateAuthorizerRequest()

Method Detail

setApiId

public void setApiId(String apiId)

The API identifier.

Parameters:

apiId - The API identifier.

getApiId

public String getApiId()

The API identifier.

Returns:

The API identifier.

withApiId

public CreateAuthorizerRequest withApiId(String apiId)

The API identifier.

Parameters:

apiId - The API identifier.

Returns:

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

setAuthorizerCredentialsArn

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, specify null.

Parameters:

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, specify null.

getAuthorizerCredentialsArn

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, 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.

withAuthorizerCredentialsArn

public CreateAuthorizerRequest 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, specify null.

Parameters:

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, specify null.

Returns:

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

setAuthorizerResultTtlInSeconds

public void setAuthorizerResultTtlInSeconds(Integer authorizerResultTtlInSeconds)

The time to live (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 time to live (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

public Integer getAuthorizerResultTtlInSeconds()

The time to live (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 time to live (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

public CreateAuthorizerRequest withAuthorizerResultTtlInSeconds(Integer authorizerResultTtlInSeconds)

The time to live (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 time to live (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.

setAuthorizerType

public void setAuthorizerType(String authorizerType)

The authorizer type. Currently the only valid value is REQUEST, for a Lambda function using incoming request parameters.

Parameters:

authorizerType - The authorizer type. Currently the only valid value is REQUEST, for a Lambda function using incoming request parameters.

See Also:

AuthorizerType

getAuthorizerType

public String getAuthorizerType()

The authorizer type. Currently the only valid value is REQUEST, for a Lambda function using incoming request parameters.

Returns:

The authorizer type. Currently the only valid value is REQUEST, for a Lambda function using incoming request parameters.

See Also:

AuthorizerType

withAuthorizerType

public CreateAuthorizerRequest withAuthorizerType(String authorizerType)

The authorizer type. Currently the only valid value is REQUEST, for a Lambda function using incoming request parameters.

Parameters:

authorizerType - The authorizer type. Currently the only valid value is REQUEST, for a Lambda function using incoming request parameters.

Returns:

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

See Also:

AuthorizerType

withAuthorizerType

public CreateAuthorizerRequest withAuthorizerType(AuthorizerType authorizerType)

The authorizer type. Currently the only valid value is REQUEST, for a Lambda function using incoming request parameters.

Parameters:

authorizerType - The authorizer type. Currently the only valid value is REQUEST, for a Lambda function using incoming request parameters.

Returns:

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

See Also:

AuthorizerType

setAuthorizerUri

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: {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 - 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:{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()

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: {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:

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:{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 CreateAuthorizerRequest 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: {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 - 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:{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.

getIdentitySource

public List<String> getIdentitySource()

The identity source for which authorization is requested.

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 and a Name query string parameters 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 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 and a Name query string parameters 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.

setIdentitySource

public void setIdentitySource(Collection<String> identitySource)

The identity source for which authorization is requested.

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 and a Name query string parameters 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 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 and a Name query string parameters 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

public CreateAuthorizerRequest withIdentitySource(String... identitySource)

The identity source for which authorization is requested.

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 and a Name query string parameters 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.

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.

Parameters:

identitySource - The identity source for which authorization is requested.

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 and a Name query string parameters 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.

withIdentitySource

public CreateAuthorizerRequest withIdentitySource(Collection<String> identitySource)

The identity source for which authorization is requested.

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 and a Name query string parameters 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 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 and a Name query string parameters 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

public void setIdentityValidationExpression(String identityValidationExpression)

The validation expression does not apply to the REQUEST authorizer.

Parameters:

identityValidationExpression - The validation expression does not apply to the REQUEST authorizer.

getIdentityValidationExpression

public String getIdentityValidationExpression()

The validation expression does not apply to the REQUEST authorizer.

Returns:

The validation expression does not apply to the REQUEST authorizer.

withIdentityValidationExpression

public CreateAuthorizerRequest withIdentityValidationExpression(String identityValidationExpression)

The validation expression does not apply to the REQUEST authorizer.

Parameters:

identityValidationExpression - 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.

setName

public void setName(String name)

The name of the authorizer.

Parameters:

name - The name of the authorizer.

getName

public String getName()

The name of the authorizer.

Returns:

The name of the authorizer.

withName

public CreateAuthorizerRequest withName(String name)

The name of the authorizer.

Parameters:

name - The name of the authorizer.

Returns:

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

getProviderArns

public List<String> getProviderArns()

For REQUEST authorizer, this is not defined.

Returns:

For REQUEST authorizer, this is not defined.

setProviderArns

public void setProviderArns(Collection<String> providerArns)

For REQUEST authorizer, this is not defined.

Parameters:

providerArns - For REQUEST authorizer, this is not defined.

withProviderArns

public CreateAuthorizerRequest withProviderArns(String... providerArns)

For REQUEST authorizer, this is not defined.

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 - For REQUEST authorizer, this is not defined.

Returns:

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

withProviderArns

public CreateAuthorizerRequest withProviderArns(Collection<String> providerArns)

For REQUEST authorizer, this is not defined.

Parameters:

providerArns - For REQUEST authorizer, this is not defined.

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. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

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 CreateAuthorizerRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()