@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
date="2023-03-22T19:35:47.452Z")
public class CfnAuthorizer
extends CfnResource
implements IInspectable
The AWS::ApiGateway::Authorizer resource creates an authorization layer that API Gateway activates for methods that have authorization enabled. API Gateway activates the authorizer when a client calls those methods.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.apigateway.*;
CfnAuthorizer cfnAuthorizer = CfnAuthorizer.Builder.create(this, "MyCfnAuthorizer")
.name("name")
.restApiId("restApiId")
.type("type")
// the properties below are optional
.authorizerCredentials("authorizerCredentials")
.authorizerResultTtlInSeconds(123)
.authorizerUri("authorizerUri")
.authType("authType")
.identitySource("identitySource")
.identityValidationExpression("identityValidationExpression")
.providerArns(List.of("providerArns"))
.build();
| Modifier and Type | Class and Description |
|---|---|
static class |
CfnAuthorizer.Builder
A fluent builder for
CfnAuthorizer. |
IInspectable.Jsii$Default, IInspectable.Jsii$ProxyIConstruct.Jsii$Default| Modifier and Type | Field and Description |
|---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
| Modifier | Constructor and Description |
|---|---|
|
CfnAuthorizer(Construct scope,
java.lang.String id,
CfnAuthorizerProps props)
Create a new `AWS::ApiGateway::Authorizer`.
|
protected |
CfnAuthorizer(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnAuthorizer(software.amazon.jsii.JsiiObjectRef objRef) |
| Modifier and Type | Method and Description |
|---|---|
java.lang.String |
getAttrAuthorizerId()
The ID for the authorizer.
|
java.lang.String |
getAuthorizerCredentials()
Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer.
|
java.lang.Number |
getAuthorizerResultTtlInSeconds()
The TTL in seconds of cached authorizer results.
|
java.lang.String |
getAuthorizerUri()
Specifies the authorizer's Uniform Resource Identifier (URI).
|
java.lang.String |
getAuthType()
Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.String |
getIdentitySource()
The identity source for which authorization is requested.
|
java.lang.String |
getIdentityValidationExpression()
A validation expression for the incoming identity token.
|
java.lang.String |
getName()
The name of the authorizer.
|
java.util.List<java.lang.String> |
getProviderArns()
A list of the Amazon Cognito user pool ARNs for the `COGNITO_USER_POOLS` authorizer.
|
java.lang.String |
getRestApiId()
The string identifier of the associated RestApi.
|
java.lang.String |
getType()
The authorizer type.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setAuthorizerCredentials(java.lang.String value)
Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer.
|
void |
setAuthorizerResultTtlInSeconds(java.lang.Number value)
The TTL in seconds of cached authorizer results.
|
void |
setAuthorizerUri(java.lang.String value)
Specifies the authorizer's Uniform Resource Identifier (URI).
|
void |
setAuthType(java.lang.String value)
Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
|
void |
setIdentitySource(java.lang.String value)
The identity source for which authorization is requested.
|
void |
setIdentityValidationExpression(java.lang.String value)
A validation expression for the incoming identity token.
|
void |
setName(java.lang.String value)
The name of the authorizer.
|
void |
setProviderArns(java.util.List<java.lang.String> value)
A list of the Amazon Cognito user pool ARNs for the `COGNITO_USER_POOLS` authorizer.
|
void |
setRestApiId(java.lang.String value)
The string identifier of the associated RestApi.
|
void |
setType(java.lang.String value)
The authorizer type.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validatePropertiesgetRefgetCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalIdgetNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validatepublic static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnAuthorizer(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnAuthorizer(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnAuthorizer(Construct scope, java.lang.String id, CfnAuthorizerProps props)
scope - - scope in which this resource is defined. This parameter is required.id - - scoped id of the resource. This parameter is required.props - - resource properties. This parameter is required.public void inspect(TreeInspector inspector)
inspect in interface IInspectableinspector - - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties in class CfnResourceprops - This parameter is required.public java.lang.String getAttrAuthorizerId()
For example: abc123 .
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties in class CfnResourcepublic java.lang.String getName()
public void setName(java.lang.String value)
public java.lang.String getRestApiId()
public void setRestApiId(java.lang.String value)
public java.lang.String getType()
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.
public void setType(java.lang.String value)
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.
public java.lang.String getAuthorizerCredentials()
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 void setAuthorizerCredentials(java.lang.String value)
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 java.lang.Number getAuthorizerResultTtlInSeconds()
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 void setAuthorizerResultTtlInSeconds(java.lang.Number value)
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 java.lang.String getAuthorizerUri()
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 .
public void setAuthorizerUri(java.lang.String value)
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 .
public java.lang.String getAuthType()
public void setAuthType(java.lang.String value)
public java.lang.String getIdentitySource()
For a 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 . 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, 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 void setIdentitySource(java.lang.String value)
For a 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 . 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, 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 java.lang.String getIdentityValidationExpression()
For TOKEN authorizers, this value is a regular expression. For COGNITO_USER_POOLS authorizers, 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 void setIdentityValidationExpression(java.lang.String value)
For TOKEN authorizers, this value is a regular expression. For COGNITO_USER_POOLS authorizers, 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 java.util.List<java.lang.String> getProviderArns()
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 void setProviderArns(java.util.List<java.lang.String> value)
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.