CfnDocumentationPartProps¶
-
class
aws_cdk.aws_apigateway.
CfnDocumentationPartProps
(*, location, properties, rest_api_id)¶ Bases:
object
Properties for defining a
CfnDocumentationPart
.- Parameters
location (
Union
[IResolvable
,LocationProperty
,Dict
[str
,Any
]]) – The location of the API entity that the documentation applies to.properties (
str
) – The documentation content map of the targeted API entity.rest_api_id (
str
) – The identifier of the targeted API entity.
- Link
- 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_part_props = apigateway.CfnDocumentationPartProps( location=apigateway.CfnDocumentationPart.LocationProperty( method="method", name="name", path="path", status_code="statusCode", type="type" ), properties="properties", rest_api_id="restApiId" )
Attributes
-
location
¶ The location of the API entity that the documentation applies to.
-
properties
¶ The documentation content map of the targeted API entity.
-
rest_api_id
¶ The identifier of the targeted API entity.