@Generated(value="software.amazon.awssdk:codegen") public final class CreateAuthorizerRequest extends ApiGatewayRequest implements ToCopyableBuilder<CreateAuthorizerRequest.Builder,CreateAuthorizerRequest>
Request to add a new Authorizer to an existing RestApi resource.
| Modifier and Type | Class and Description |
|---|---|
static interface |
CreateAuthorizerRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
String |
authorizerCredentials()
Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer.
|
Integer |
authorizerResultTtlInSeconds()
The TTL in seconds of cached authorizer results.
|
String |
authorizerUri()
Specifies the authorizer's Uniform Resource Identifier (URI).
|
String |
authType()
Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
|
static CreateAuthorizerRequest.Builder |
builder() |
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest. |
int |
hashCode() |
String |
identitySource()
The identity source for which authorization is requested.
|
String |
identityValidationExpression()
A validation expression for the incoming identity token.
|
String |
name()
[Required] The name of the authorizer.
|
List<String> |
providerARNs()
A list of the Amazon Cognito user pool ARNs for the
COGNITO_USER_POOLS authorizer. |
String |
restApiId()
[Required] The string identifier of the associated RestApi.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends CreateAuthorizerRequest.Builder> |
serializableBuilderClass() |
CreateAuthorizerRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
AuthorizerType |
type()
[Required] The authorizer type.
|
String |
typeAsString()
[Required] The authorizer type.
|
overrideConfigurationcopypublic String restApiId()
[Required] The string identifier of the associated RestApi.
public String name()
[Required] The name of the authorizer.
public AuthorizerType 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.
If the service returns an enum value that is not available in the current SDK version, type will return
AuthorizerType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
typeAsString().
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.AuthorizerTypepublic String typeAsString()
[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.
If the service returns an enum value that is not available in the current SDK version, type will return
AuthorizerType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
typeAsString().
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.AuthorizerTypepublic List<String> 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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
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.public String authType()
Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
public String 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.
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.public String 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.
public String identitySource()
The identity source for which authorization is requested.
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.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.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.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.public String 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.
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.public Integer 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.
public CreateAuthorizerRequest.Builder toBuilder()
ToCopyableBuildertoBuilder in interface ToCopyableBuilder<CreateAuthorizerRequest.Builder,CreateAuthorizerRequest>toBuilder in class ApiGatewayRequestpublic static CreateAuthorizerRequest.Builder builder()
public static Class<? extends CreateAuthorizerRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequestSdkRequest. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will
again be available.getValueForField in class SdkRequestfieldName - The name of the member to be retrieved.clazz - The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.