CfnDocumentationVersionPropsMixin

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

Bases: Mixin

The AWS::ApiGateway::DocumentationVersion resource creates a snapshot of the documentation for an API.

For more information, see Representation of API Documentation in API Gateway in the API Gateway Developer Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationversion.html
CloudformationResource:: AWS::ApiGateway::DocumentationVersion
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_documentation_version_props_mixin = apigateway_mixins.CfnDocumentationVersionPropsMixin(apigateway_mixins.CfnDocumentationVersionMixinProps(
    description="description",
    documentation_version="documentationVersion",
    rest_api_id="restApiId"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

props (Union[CfnDocumentationVersionMixinProps, 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 = ['description', 'documentationVersion', 'restApiId']

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