CfnDocumentationVersionProps

class aws_cdk.aws_apigateway.CfnDocumentationVersionProps(*, documentation_version, rest_api_id, description=None)

Bases: object

Properties for defining a CfnDocumentationVersion.

Parameters
  • documentation_version (str) – The version identifier of the API documentation snapshot.

  • rest_api_id (str) – The identifier of the API.

  • description (Optional[str]) – The description of the API documentation snapshot.

Link

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.
import aws_cdk.aws_apigateway as apigateway

cfn_documentation_version_props = apigateway.CfnDocumentationVersionProps(
    documentation_version="documentationVersion",
    rest_api_id="restApiId",

    # the properties below are optional
    description="description"
)

Attributes

description

The description of the API documentation snapshot.

Link

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

Return type

Optional[str]

documentation_version

The version identifier of the API documentation snapshot.

Link

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

Return type

str

rest_api_id

The identifier of the API.

Link

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

Return type

str