CfnAuthorizerV2Props

class aws_cdk.aws_apigateway.CfnAuthorizerV2Props(*, api_id, authorizer_credentials_arn=None, authorizer_result_ttl_in_seconds=None, authorizer_type, authorizer_uri=None, identity_source, identity_validation_expression=None, jwt_configuration=None, name)

Bases: object

(deprecated) Properties for defining a AWS::ApiGatewayV2::Authorizer.

Parameters
  • api_id (str) – (deprecated) AWS::ApiGatewayV2::Authorizer.ApiId.

  • authorizer_credentials_arn (Optional[str]) – (deprecated) AWS::ApiGatewayV2::Authorizer.AuthorizerCredentialsArn.

  • authorizer_result_ttl_in_seconds (Union[int, float, None]) – (deprecated) AWS::ApiGatewayV2::Authorizer.AuthorizerResultTtlInSeconds.

  • authorizer_type (str) – (deprecated) AWS::ApiGatewayV2::Authorizer.AuthorizerType.

  • authorizer_uri (Optional[str]) – (deprecated) AWS::ApiGatewayV2::Authorizer.AuthorizerUri.

  • identity_source (Sequence[str]) – (deprecated) AWS::ApiGatewayV2::Authorizer.IdentitySource.

  • identity_validation_expression (Optional[str]) – (deprecated) AWS::ApiGatewayV2::Authorizer.IdentityValidationExpression.

  • jwt_configuration (Union[IResolvable, JWTConfigurationProperty, None]) – (deprecated) AWS::ApiGatewayV2::Authorizer.JwtConfiguration.

  • name (str) – (deprecated) AWS::ApiGatewayV2::Authorizer.Name.

Deprecated

moved to package aws-apigatewayv2

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html

Stability

deprecated

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_v2_props = apigateway.CfnAuthorizerV2Props(
    api_id="apiId",
    authorizer_type="authorizerType",
    identity_source=["identitySource"],
    name="name",

    # the properties below are optional
    authorizer_credentials_arn="authorizerCredentialsArn",
    authorizer_result_ttl_in_seconds=123,
    authorizer_uri="authorizerUri",
    identity_validation_expression="identityValidationExpression",
    jwt_configuration=apigateway.CfnAuthorizerV2.JWTConfigurationProperty(
        audience=["audience"],
        issuer="issuer"
    )
)

Attributes

api_id

(deprecated) AWS::ApiGatewayV2::Authorizer.ApiId.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-apiid

Stability

deprecated

Return type

str

authorizer_credentials_arn

(deprecated) AWS::ApiGatewayV2::Authorizer.AuthorizerCredentialsArn.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-authorizercredentialsarn

Stability

deprecated

Return type

Optional[str]

authorizer_result_ttl_in_seconds

(deprecated) AWS::ApiGatewayV2::Authorizer.AuthorizerResultTtlInSeconds.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-authorizerresultttlinseconds

Stability

deprecated

Return type

Union[int, float, None]

authorizer_type

(deprecated) AWS::ApiGatewayV2::Authorizer.AuthorizerType.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-authorizertype

Stability

deprecated

Return type

str

authorizer_uri

(deprecated) AWS::ApiGatewayV2::Authorizer.AuthorizerUri.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-authorizeruri

Stability

deprecated

Return type

Optional[str]

identity_source

(deprecated) AWS::ApiGatewayV2::Authorizer.IdentitySource.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-identitysource

Stability

deprecated

Return type

List[str]

identity_validation_expression

(deprecated) AWS::ApiGatewayV2::Authorizer.IdentityValidationExpression.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-identityvalidationexpression

Stability

deprecated

Return type

Optional[str]

jwt_configuration

(deprecated) AWS::ApiGatewayV2::Authorizer.JwtConfiguration.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-jwtconfiguration

Stability

deprecated

Return type

Union[IResolvable, JWTConfigurationProperty, None]

name

(deprecated) AWS::ApiGatewayV2::Authorizer.Name.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-name

Stability

deprecated

Return type

str