CfnDeploymentPropsMixin

class aws_cdk.mixins_preview.aws_apigatewayv2.mixins.CfnDeploymentPropsMixin(props, *, strategy=None)

Bases: Mixin

The AWS::ApiGatewayV2::Deployment resource creates a deployment for an API.

See:

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

CloudformationResource:

AWS::ApiGatewayV2::Deployment

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_apigatewayv2 import mixins as apigatewayv2_mixins

cfn_deployment_props_mixin = apigatewayv2_mixins.CfnDeploymentPropsMixin(apigatewayv2_mixins.CfnDeploymentMixinProps(
    api_id="apiId",
    description="description",
    stage_name="stageName"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::ApiGatewayV2::Deployment.

Parameters:
  • props (Union[CfnDeploymentMixinProps, 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 = ['apiId', 'description', 'stageName']

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