public class CreateAuthorizerResult
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable
Represents an authorization layer for methods. If enabled on a method, API Gateway will activate the authorizer when a client calls the method.
Modifier and Type | Field and Description |
---|---|
private java.lang.String |
authorizerCredentials
Specifies the credentials required for the authorizer, if any.
|
private java.lang.Integer |
authorizerResultTtlInSeconds
The TTL in seconds of cached authorizer results.
|
private java.lang.String |
authorizerUri
[Required] Specifies the authorizer's Uniform Resource Identifier (URI).
|
private java.lang.String |
authType
Optional customer-defined field, used in Swagger imports/exports.
|
private java.lang.String |
id
The identifier for the authorizer resource.
|
private java.lang.String |
identitySource
[Required] The source of the identity in an incoming request.
|
private java.lang.String |
identityValidationExpression
A validation expression for the incoming identity.
|
private java.lang.String |
name
[Required] The name of the authorizer.
|
private java.lang.String |
type
[Required] The type of the authorizer.
|
Constructor and Description |
---|
CreateAuthorizerResult() |
Modifier and Type | Method and Description |
---|---|
CreateAuthorizerResult |
clone() |
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getAuthorizerCredentials()
Specifies the credentials required for the authorizer, if any.
|
java.lang.Integer |
getAuthorizerResultTtlInSeconds()
The TTL in seconds of cached authorizer results.
|
java.lang.String |
getAuthorizerUri()
[Required] Specifies the authorizer's Uniform Resource Identifier (URI).
|
java.lang.String |
getAuthType()
Optional customer-defined field, used in Swagger imports/exports.
|
java.lang.String |
getId()
The identifier for the authorizer resource.
|
java.lang.String |
getIdentitySource()
[Required] The source of the identity in an incoming request.
|
java.lang.String |
getIdentityValidationExpression()
A validation expression for the incoming identity.
|
java.lang.String |
getName()
[Required] The name of the authorizer.
|
java.lang.String |
getType()
[Required] The type of the authorizer.
|
int |
hashCode() |
void |
setAuthorizerCredentials(java.lang.String authorizerCredentials)
Specifies the credentials required for the authorizer, if any.
|
void |
setAuthorizerResultTtlInSeconds(java.lang.Integer authorizerResultTtlInSeconds)
The TTL in seconds of cached authorizer results.
|
void |
setAuthorizerUri(java.lang.String authorizerUri)
[Required] Specifies the authorizer's Uniform Resource Identifier (URI).
|
void |
setAuthType(java.lang.String authType)
Optional customer-defined field, used in Swagger imports/exports.
|
void |
setId(java.lang.String id)
The identifier for the authorizer resource.
|
void |
setIdentitySource(java.lang.String identitySource)
[Required] The source of the identity in an incoming request.
|
void |
setIdentityValidationExpression(java.lang.String identityValidationExpression)
A validation expression for the incoming identity.
|
void |
setName(java.lang.String name)
[Required] The name of the authorizer.
|
void |
setType(AuthorizerType type)
[Required] The type of the authorizer.
|
void |
setType(java.lang.String type)
[Required] The type of the authorizer.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
CreateAuthorizerResult |
withAuthorizerCredentials(java.lang.String authorizerCredentials)
Specifies the credentials required for the authorizer, if any.
|
CreateAuthorizerResult |
withAuthorizerResultTtlInSeconds(java.lang.Integer authorizerResultTtlInSeconds)
The TTL in seconds of cached authorizer results.
|
CreateAuthorizerResult |
withAuthorizerUri(java.lang.String authorizerUri)
[Required] Specifies the authorizer's Uniform Resource Identifier (URI).
|
CreateAuthorizerResult |
withAuthType(java.lang.String authType)
Optional customer-defined field, used in Swagger imports/exports.
|
CreateAuthorizerResult |
withId(java.lang.String id)
The identifier for the authorizer resource.
|
CreateAuthorizerResult |
withIdentitySource(java.lang.String identitySource)
[Required] The source of the identity in an incoming request.
|
CreateAuthorizerResult |
withIdentityValidationExpression(java.lang.String identityValidationExpression)
A validation expression for the incoming identity.
|
CreateAuthorizerResult |
withName(java.lang.String name)
[Required] The name of the authorizer.
|
CreateAuthorizerResult |
withType(AuthorizerType type)
[Required] The type of the authorizer.
|
CreateAuthorizerResult |
withType(java.lang.String type)
[Required] The type of the authorizer.
|
private java.lang.String id
The identifier for the authorizer resource.
private java.lang.String name
[Required] The name of the authorizer.
private java.lang.String type
[Required] The type of the authorizer. Currently, the only valid type is TOKEN.
private java.lang.String authType
Optional customer-defined field, used in Swagger imports/exports. Has no functional impact.
private java.lang.String authorizerUri
[Required] Specifies the authorizer's Uniform Resource Identifier (URI).
For TOKEN authorizers, this must be a well-formed Lambda function URI.
The URI should be of the form
arn:aws:apigateway:{region}:lambda:path/{service_api}
.
Region
is used to determine the right endpoint. In this
case, path
is used to indicate 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
private java.lang.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.
private java.lang.String identitySource
[Required] The source of the identity in an incoming request. For TOKEN authorizers, 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.
private java.lang.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.
private java.lang.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.
public void setId(java.lang.String id)
The identifier for the authorizer resource.
id
- The identifier for the authorizer resource.public java.lang.String getId()
The identifier for the authorizer resource.
public CreateAuthorizerResult withId(java.lang.String id)
The identifier for the authorizer resource.
id
- The identifier for the authorizer resource.public void setName(java.lang.String name)
[Required] The name of the authorizer.
name
- [Required] The name of the authorizer.public java.lang.String getName()
[Required] The name of the authorizer.
public CreateAuthorizerResult withName(java.lang.String name)
[Required] The name of the authorizer.
name
- [Required] The name of the authorizer.public void setType(java.lang.String type)
[Required] The type of the authorizer. Currently, the only valid type is TOKEN.
type
- [Required] The type of the authorizer. Currently, the only valid
type is TOKEN.AuthorizerType
public java.lang.String getType()
[Required] The type of the authorizer. Currently, the only valid type is TOKEN.
AuthorizerType
public CreateAuthorizerResult withType(java.lang.String type)
[Required] The type of the authorizer. Currently, the only valid type is TOKEN.
type
- [Required] The type of the authorizer. Currently, the only valid
type is TOKEN.AuthorizerType
public void setType(AuthorizerType type)
[Required] The type of the authorizer. Currently, the only valid type is TOKEN.
type
- [Required] The type of the authorizer. Currently, the only valid
type is TOKEN.AuthorizerType
public CreateAuthorizerResult withType(AuthorizerType type)
[Required] The type of the authorizer. Currently, the only valid type is TOKEN.
type
- [Required] The type of the authorizer. Currently, the only valid
type is TOKEN.AuthorizerType
public void setAuthType(java.lang.String authType)
Optional customer-defined field, used in Swagger imports/exports. Has no functional impact.
authType
- Optional customer-defined field, used in Swagger imports/exports.
Has no functional impact.public java.lang.String getAuthType()
Optional customer-defined field, used in Swagger imports/exports. Has no functional impact.
public CreateAuthorizerResult withAuthType(java.lang.String authType)
Optional customer-defined field, used in Swagger imports/exports. Has no functional impact.
authType
- Optional customer-defined field, used in Swagger imports/exports.
Has no functional impact.public void setAuthorizerUri(java.lang.String authorizerUri)
[Required] Specifies the authorizer's Uniform Resource Identifier (URI).
For TOKEN authorizers, this must be a well-formed Lambda function URI.
The URI should be of the form
arn:aws:apigateway:{region}:lambda:path/{service_api}
.
Region
is used to determine the right endpoint. In this
case, path
is used to indicate 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
authorizerUri
- [Required] Specifies the authorizer's Uniform Resource Identifier
(URI). For TOKEN authorizers, this must be a well-formed Lambda
function URI. The URI should be of the form
arn:aws:apigateway:{region}:lambda:path/{service_api}
. Region
is used to determine the right endpoint. In
this case, path
is used to indicate 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]/invocationspublic java.lang.String getAuthorizerUri()
[Required] Specifies the authorizer's Uniform Resource Identifier (URI).
For TOKEN authorizers, this must be a well-formed Lambda function URI.
The URI should be of the form
arn:aws:apigateway:{region}:lambda:path/{service_api}
.
Region
is used to determine the right endpoint. In this
case, path
is used to indicate 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
arn:aws:apigateway:{region}:lambda:path/{service_api}
. Region
is used to determine the right endpoint. In
this case, path
is used to indicate 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]/invocationspublic CreateAuthorizerResult withAuthorizerUri(java.lang.String authorizerUri)
[Required] Specifies the authorizer's Uniform Resource Identifier (URI).
For TOKEN authorizers, this must be a well-formed Lambda function URI.
The URI should be of the form
arn:aws:apigateway:{region}:lambda:path/{service_api}
.
Region
is used to determine the right endpoint. In this
case, path
is used to indicate 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
authorizerUri
- [Required] Specifies the authorizer's Uniform Resource Identifier
(URI). For TOKEN authorizers, this must be a well-formed Lambda
function URI. The URI should be of the form
arn:aws:apigateway:{region}:lambda:path/{service_api}
. Region
is used to determine the right endpoint. In
this case, path
is used to indicate 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]/invocationspublic void setAuthorizerCredentials(java.lang.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.
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.public java.lang.String getAuthorizerCredentials()
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.
public CreateAuthorizerResult withAuthorizerCredentials(java.lang.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.
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.public void setIdentitySource(java.lang.String identitySource)
[Required] The source of the identity in an incoming request. For TOKEN authorizers, 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.
identitySource
- [Required] The source of the identity in an incoming request. For
TOKEN authorizers, 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.public java.lang.String getIdentitySource()
[Required] The source of the identity in an incoming request. For TOKEN authorizers, 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.
public CreateAuthorizerResult withIdentitySource(java.lang.String identitySource)
[Required] The source of the identity in an incoming request. For TOKEN authorizers, 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.
identitySource
- [Required] The source of the identity in an incoming request. For
TOKEN authorizers, 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.public void setIdentityValidationExpression(java.lang.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.
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.public java.lang.String getIdentityValidationExpression()
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.
public CreateAuthorizerResult withIdentityValidationExpression(java.lang.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.
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.public void setAuthorizerResultTtlInSeconds(java.lang.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.
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.public java.lang.Integer getAuthorizerResultTtlInSeconds()
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.
public CreateAuthorizerResult withAuthorizerResultTtlInSeconds(java.lang.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.
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.public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public CreateAuthorizerResult clone()
clone
in class java.lang.Object