Class CreateAuthorizerRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
Request to add a new Authorizer to an existing RestApi resource.
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
Creates a shallow clone of this request.boolean
Specifies the credentials required for the authorizer, if any.The TTL of cached authorizer results.[Required] Specifies the authorizer's Uniform Resource Identifier (URI).Optional customer-defined field, used in Swagger imports/exports.[Required] The source of the identity in an incoming request.A validation expression for the incoming identity.getName()
[Required] The name of the authorizer.The RestApi identifier under which the Authorizer will be created.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 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
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
[Required] The name of the authorizer.void
setRestApiId
(String restApiId) The RestApi identifier under which the Authorizer will be created.void
setType
(AuthorizerType type) [Required] The type of the authorizer.void
[Required] The type of the authorizer.toString()
Returns a string representation of this object; useful for testing and debugging.withAuthorizerCredentials
(String authorizerCredentials) Specifies the credentials required for the authorizer, if any.withAuthorizerResultTtlInSeconds
(Integer authorizerResultTtlInSeconds) The TTL of cached authorizer results.withAuthorizerUri
(String authorizerUri) [Required] Specifies the authorizer's Uniform Resource Identifier (URI).withAuthType
(String authType) Optional customer-defined field, used in Swagger imports/exports.withIdentitySource
(String identitySource) [Required] The source of the identity in an incoming request.withIdentityValidationExpression
(String identityValidationExpression) A validation expression for the incoming identity.[Required] The name of the authorizer.withRestApiId
(String restApiId) The RestApi identifier under which the Authorizer will be created.withType
(AuthorizerType type) [Required] The type of the authorizer.[Required] The type of the authorizer.Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
Constructor Details
-
CreateAuthorizerRequest
public CreateAuthorizerRequest()
-
-
Method Details
-
setRestApiId
The RestApi identifier under which the Authorizer will be created.
- Parameters:
restApiId
- The RestApi identifier under which the Authorizer will be created.
-
getRestApiId
The RestApi identifier under which the Authorizer will be created.
- Returns:
- The RestApi identifier under which the Authorizer will be created.
-
withRestApiId
The RestApi identifier under which the Authorizer will be created.
- Parameters:
restApiId
- The RestApi identifier under which the Authorizer will be created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setName
[Required] The name of the authorizer.
- Parameters:
name
- [Required] The name of the authorizer.
-
getName
[Required] The name of the authorizer.
- Returns:
- [Required] The name of the authorizer.
-
withName
[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
[Required] The type of the authorizer.
- Parameters:
type
- [Required] The type of the authorizer.- See Also:
-
getType
[Required] The type of the authorizer.
- Returns:
- [Required] The type of the authorizer.
- See Also:
-
withType
[Required] The type of the authorizer.
- Parameters:
type
- [Required] The type of the authorizer.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setType
[Required] The type of the authorizer.
- Parameters:
type
- [Required] The type of the authorizer.- See Also:
-
withType
[Required] The type of the authorizer.
- Parameters:
type
- [Required] The type of the authorizer.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setAuthType
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
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
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
[Required] Specifies the authorizer's Uniform Resource Identifier (URI).
- Parameters:
authorizerUri
- [Required] Specifies the authorizer's Uniform Resource Identifier (URI).
-
getAuthorizerUri
[Required] Specifies the authorizer's Uniform Resource Identifier (URI).
- Returns:
- [Required] Specifies the authorizer's Uniform Resource Identifier (URI).
-
withAuthorizerUri
[Required] Specifies the authorizer's Uniform Resource Identifier (URI).
- Parameters:
authorizerUri
- [Required] Specifies the authorizer's Uniform Resource Identifier (URI).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setAuthorizerCredentials
Specifies the credentials required for the authorizer, if any.
- Parameters:
authorizerCredentials
- Specifies the credentials required for the authorizer, if any.
-
getAuthorizerCredentials
Specifies the credentials required for the authorizer, if any.
- Returns:
- Specifies the credentials required for the authorizer, if any.
-
withAuthorizerCredentials
Specifies the credentials required for the authorizer, if any.
- Parameters:
authorizerCredentials
- Specifies the credentials required for the authorizer, if any.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setIdentitySource
[Required] The source of the identity in an incoming request.
- Parameters:
identitySource
- [Required] The source of the identity in an incoming request.
-
getIdentitySource
[Required] The source of the identity in an incoming request.
- Returns:
- [Required] The source of the identity in an incoming request.
-
withIdentitySource
[Required] The source of the identity in an incoming request.
- Parameters:
identitySource
- [Required] The source of the identity in an incoming request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setIdentityValidationExpression
A validation expression for the incoming identity.
- Parameters:
identityValidationExpression
- A validation expression for the incoming identity.
-
getIdentityValidationExpression
A validation expression for the incoming identity.
- Returns:
- A validation expression for the incoming identity.
-
withIdentityValidationExpression
public CreateAuthorizerRequest withIdentityValidationExpression(String identityValidationExpression) A validation expression for the incoming identity.
- Parameters:
identityValidationExpression
- A validation expression for the incoming identity.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setAuthorizerResultTtlInSeconds
The TTL of cached authorizer results.
- Parameters:
authorizerResultTtlInSeconds
- The TTL of cached authorizer results.
-
getAuthorizerResultTtlInSeconds
The TTL of cached authorizer results.
- Returns:
- The TTL of cached authorizer results.
-
withAuthorizerResultTtlInSeconds
public CreateAuthorizerRequest withAuthorizerResultTtlInSeconds(Integer authorizerResultTtlInSeconds) The TTL of cached authorizer results.
- Parameters:
authorizerResultTtlInSeconds
- The TTL of cached authorizer results.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
-