CfnDocumentationVersionMixinProps

class aws_cdk.mixins_preview.aws_apigateway.mixins.CfnDocumentationVersionMixinProps(*, description=None, documentation_version=None, rest_api_id=None)

Bases: object

Properties for CfnDocumentationVersionPropsMixin.

Parameters:

description (Optional[str]) – A description about the new documentation snapshot.
documentation_version (Optional[str]) – The version identifier of the to-be-updated documentation version.
rest_api_id (Optional[str]) – The string identifier of the associated RestApi.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationversion.html

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.aws_apigateway import mixins as apigateway_mixins

cfn_documentation_version_mixin_props = apigateway_mixins.CfnDocumentationVersionMixinProps(
    description="description",
    documentation_version="documentationVersion",
    rest_api_id="restApiId"
)

Attributes

description

A description about the new documentation snapshot.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationversion.html#cfn-apigateway-documentationversion-description

documentation_version

The version identifier of the to-be-updated documentation version.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationversion.html#cfn-apigateway-documentationversion-documentationversion

rest_api_id

The string identifier of the associated RestApi.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationversion.html#cfn-apigateway-documentationversion-restapiid