CfnAuthorizerPropsMixin

class aws_cdk.mixins_preview.aws_apigateway.mixins.CfnAuthorizerPropsMixin(props, *, strategy=None)

Bases: Mixin

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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html
CloudformationResource:: AWS::ApiGateway::Authorizer
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_apigateway import mixins as apigateway_mixins

cfn_authorizer_props_mixin = apigateway_mixins.CfnAuthorizerPropsMixin(apigateway_mixins.CfnAuthorizerMixinProps(
    authorizer_credentials="authorizerCredentials",
    authorizer_result_ttl_in_seconds=123,
    authorizer_uri="authorizerUri",
    auth_type="authType",
    identity_source="identitySource",
    identity_validation_expression="identityValidationExpression",
    name="name",
    provider_arns=["providerArns"],
    rest_api_id="restApiId",
    type="type"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::ApiGateway::Authorizer.

Parameters:

props (Union[CfnAuthorizerMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['authorizerCredentials', 'authorizerResultTtlInSeconds', 'authorizerUri', 'authType', 'identitySource', 'identityValidationExpression', 'name', 'providerArns', 'restApiId', 'type']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental