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 to-be-updated documentation version.rest_api_id (
str
) – The string identifier of the associated RestApi.description (
Optional
[str
]) – A description about the new documentation snapshot.
- See:
- 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 import 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
A description about the new documentation snapshot.
- documentation_version
The version identifier of the to-be-updated documentation version.
- rest_api_id
The string identifier of the associated RestApi.