CfnAuthorizer¶
-
class
aws_cdk.aws_apigateway.
CfnAuthorizer
(scope, id, *, name, rest_api_id, type, authorizer_credentials=None, authorizer_result_ttl_in_seconds=None, authorizer_uri=None, auth_type=None, identity_source=None, identity_validation_expression=None, provider_arns=None)¶ Bases:
aws_cdk.core.CfnResource
A CloudFormation
AWS::ApiGateway::Authorizer
.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.- CloudformationResource
AWS::ApiGateway::Authorizer
- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_apigateway as apigateway cfn_authorizer = apigateway.CfnAuthorizer(self, "MyCfnAuthorizer", name="name", rest_api_id="restApiId", type="type", # the properties below are optional authorizer_credentials="authorizerCredentials", authorizer_result_ttl_in_seconds=123, authorizer_uri="authorizerUri", auth_type="authType", identity_source="identitySource", identity_validation_expression="identityValidationExpression", provider_arns=["providerArns"] )
Create a new
AWS::ApiGateway::Authorizer
.- Parameters
scope (
Construct
) –scope in which this resource is defined.
id (
str
) –scoped id of the resource.
name (
str
) – The name of the authorizer.rest_api_id (
str
) – The ID of theRestApi
resource that API Gateway creates the authorizer in.type (
str
) – The type of authorizer. Valid values include:. -TOKEN
: A custom authorizer that uses a Lambda function. -COGNITO_USER_POOLS
: An authorizer that uses Amazon Cognito user pools. -REQUEST
: An authorizer that uses a Lambda function using incoming request parameters.authorizer_credentials (
Optional
[str
]) – The credentials that are required for the authorizer. To specify an IAM role that API Gateway assumes, specify the role’s Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.authorizer_result_ttl_in_seconds (
Union
[int
,float
,None
]) – The time-to-live (TTL) period, in seconds, that specifies how long API Gateway caches authorizer results. If you specify a value greater than 0, API Gateway caches the authorizer responses. By default, API Gateway sets this property to 300. The maximum value is 3600, or 1 hour.authorizer_uri (
Optional
[str
]) – The authorizer’s Uniform Resource Identifier (URI). If you specifyTOKEN
for the authorizer’sType
property, specify a Lambda function URI that has the formarn:aws:apigateway: *region* :lambda:path/ *path*
. The path usually has the form /2015-03-31/functions/ LambdaFunctionARN /invocations.auth_type (
Optional
[str
]) – An optional customer-defined field that’s used in OpenApi imports and exports without functional impact.identity_source (
Optional
[str
]) – The source of the identity in an incoming request. If you specifyTOKEN
orCOGNITO_USER_POOLS
for theType
property, this property is required. Specify a header mapping expression using the formmethod.request.header. *name*
, where name is the name of a custom authorization header that clients submit as part of their requests. If you specifyREQUEST
for theType
property, this property is required when authorization caching is enabled. Specify a comma-separated string of one or more mapping expressions of the specified request parameter using the formmethod.request.parameter. *name*
. For supported parameter types, see Configure Lambda Authorizer Using the API Gateway Console in the API Gateway Developer Guide .identity_validation_expression (
Optional
[str
]) – A validation expression for the incoming identity. If you specifyTOKEN
for the authorizer’sType
property, specify a regular expression. API Gateway uses the expression to attempt to match the incoming client token, and proceeds if the token matches. If the token doesn’t match, API Gateway responds with a 401 (unauthorized request) error code.provider_arns (
Optional
[Sequence
[str
]]) – A list of the Amazon Cognito user pool Amazon Resource Names (ARNs) to associate with this authorizer. Required if you specifyCOGNITO_USER_POOLS
as the authorizerType
. For more information, see Use Amazon Cognito User Pools in the API Gateway Developer Guide .
Methods
-
add_deletion_override
(path)¶ Syntactic sugar for
addOverride(path, undefined)
.- Parameters
path (
str
) – The path of the value to delete.- Return type
None
-
add_depends_on
(target)¶ Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
- Parameters
target (
CfnResource
) –- Return type
None
-
add_metadata
(key, value)¶ Add a value to the CloudFormation Resource Metadata.
- Parameters
key (
str
) –value (
Any
) –
- See
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- Return type
None
-
add_override
(path, value)¶ Adds an override to the synthesized CloudFormation resource.
To add a property override, either use
addPropertyOverride
or prefixpath
with “Properties.” (i.e.Properties.TopicName
).If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal
.
in the property name, prefix with a\
. In most programming languages you will need to write this as"\\."
because the\
itself will need to be escaped.For example:
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"]) cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")
would add the overrides Example:
"Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... }
The
value
argument toaddOverride
will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.- Parameters
path (
str
) –The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
value (
Any
) –The value. Could be primitive or complex.
- Return type
None
-
add_property_deletion_override
(property_path)¶ Adds an override that deletes the value of a property from the resource definition.
- Parameters
property_path (
str
) – The path to the property.- Return type
None
-
add_property_override
(property_path, value)¶ Adds an override to a resource property.
Syntactic sugar for
addOverride("Properties.<...>", value)
.- Parameters
property_path (
str
) – The path of the property.value (
Any
) – The value.
- Return type
None
-
apply_removal_policy
(policy=None, *, apply_to_update_replace_policy=None, default=None)¶ Sets the deletion policy of the resource based on the removal policy specified.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.
The resource can be deleted (
RemovalPolicy.DESTROY
), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN
).- Parameters
policy (
Optional
[RemovalPolicy
]) –apply_to_update_replace_policy (
Optional
[bool
]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
Optional
[RemovalPolicy
]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.
- Return type
None
-
get_att
(attribute_name)¶ Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g.
resource.arn
), but this can be used for future compatibility in case there is no generated attribute.- Parameters
attribute_name (
str
) – The name of the attribute.- Return type
-
get_metadata
(key)¶ Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters
key (
str
) –- See
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- Return type
Any
-
inspect
(inspector)¶ Examines the CloudFormation resource and discloses attributes.
- Parameters
inspector (
TreeInspector
) –tree inspector to collect and process attributes.
- Return type
None
-
override_logical_id
(new_logical_id)¶ Overrides the auto-generated logical ID with a specific ID.
- Parameters
new_logical_id (
str
) – The new logical ID to use for this stack element.- Return type
None
-
to_string
()¶ Returns a string representation of this construct.
- Return type
str
- Returns
a string representation of this resource
Attributes
-
CFN_RESOURCE_TYPE_NAME
= 'AWS::ApiGateway::Authorizer'¶
The ID for the authorizer.
For example:
abc123
.- CloudformationAttribute
AuthorizerId
- Return type
str
-
auth_type
¶ An optional customer-defined field that’s used in OpenApi imports and exports without functional impact.
The credentials that are required for the authorizer.
To specify an IAM role that API Gateway assumes, specify the role’s Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.
The time-to-live (TTL) period, in seconds, that specifies how long API Gateway caches authorizer results.
If you specify a value greater than 0, API Gateway caches the authorizer responses. By default, API Gateway sets this property to 300. The maximum value is 3600, or 1 hour.
- Link
- Return type
Union
[int
,float
,None
]
The authorizer’s Uniform Resource Identifier (URI).
If you specify
TOKEN
for the authorizer’sType
property, specify a Lambda function URI that has the formarn:aws:apigateway: *region* :lambda:path/ *path*
. The path usually has the form /2015-03-31/functions/ LambdaFunctionARN /invocations.
-
cfn_options
¶ Options for this resource, such as condition, update policy etc.
- Return type
-
cfn_resource_type
¶ AWS resource type.
- Return type
str
-
creation_stack
¶ return:
the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.
- Return type
List
[str
]
-
identity_source
¶ The source of the identity in an incoming request.
If you specify
TOKEN
orCOGNITO_USER_POOLS
for theType
property, this property is required. Specify a header mapping expression using the formmethod.request.header. *name*
, where name is the name of a custom authorization header that clients submit as part of their requests.If you specify
REQUEST
for theType
property, this property is required when authorization caching is enabled. Specify a comma-separated string of one or more mapping expressions of the specified request parameter using the formmethod.request.parameter. *name*
. For supported parameter types, see Configure Lambda Authorizer Using the API Gateway Console in the API Gateway Developer Guide .
-
identity_validation_expression
¶ A validation expression for the incoming identity.
If you specify
TOKEN
for the authorizer’sType
property, specify a regular expression. API Gateway uses the expression to attempt to match the incoming client token, and proceeds if the token matches. If the token doesn’t match, API Gateway responds with a 401 (unauthorized request) error code.
-
logical_id
¶ The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use
overrideLogicalId(newLogicalId)
.- Return type
str
- Returns
the logical ID as a stringified token. This value will only get resolved during synthesis.
-
name
¶ The name of the authorizer.
-
node
¶ The construct tree node associated with this construct.
- Return type
-
provider_arns
¶ A list of the Amazon Cognito user pool Amazon Resource Names (ARNs) to associate with this authorizer.
Required if you specify
COGNITO_USER_POOLS
as the authorizerType
. For more information, see Use Amazon Cognito User Pools in the API Gateway Developer Guide .- Link
- Return type
Optional
[List
[str
]]
-
ref
¶ Return a string that will be resolved to a CloudFormation
{ Ref }
for this element.If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through
Lazy.any({ produce: resource.ref })
.- Return type
str
-
rest_api_id
¶ The ID of the
RestApi
resource that API Gateway creates the authorizer in.
-
stack
¶ The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- Return type
-
type
¶ .
TOKEN
: A custom authorizer that uses a Lambda function.COGNITO_USER_POOLS
: An authorizer that uses Amazon Cognito user pools.REQUEST
: An authorizer that uses a Lambda function using incoming request parameters.
- Link
- Type
The type of authorizer. Valid values include
- Return type
str
Static Methods
-
classmethod
is_cfn_element
(x)¶ Returns
true
if a construct is a stack element (i.e. part of the synthesized cloudformation template).Uses duck-typing instead of
instanceof
to allow stack elements from different versions of this library to be included in the same stack.- Parameters
x (
Any
) –- Return type
bool
- Returns
The construct as a stack element or undefined if it is not a stack element.
-
classmethod
is_cfn_resource
(construct)¶ Check whether the given construct is a CfnResource.
- Parameters
construct (
IConstruct
) –- Return type
bool
-
classmethod
is_construct
(x)¶ Return whether the given object is a Construct.
- Parameters
x (
Any
) –- Return type
bool