CfnDocumentationVersionProps

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

Bases: object

Properties for defining a AWS::ApiGateway::DocumentationVersion.

Parameters
  • description (Optional[str]) – AWS::ApiGateway::DocumentationVersion.Description.

  • documentation_version (str) – AWS::ApiGateway::DocumentationVersion.DocumentationVersion.

  • rest_api_id (str) – AWS::ApiGateway::DocumentationVersion.RestApiId.

Link

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

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

AWS::ApiGateway::DocumentationVersion.Description.

Link

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

Return type

Optional[str]

documentation_version

AWS::ApiGateway::DocumentationVersion.DocumentationVersion.

Link

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

Return type

str

rest_api_id

AWS::ApiGateway::DocumentationVersion.RestApiId.

Link

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

Return type

str