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 targeted API entity of the to-be-created documentation part.

  • properties (str) – The new documentation content map of the targeted API entity. Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value pairs can be exported and, hence, published.

  • rest_api_id (str) – The string identifier of the associated RestApi.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationpart.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 import 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 targeted API entity of the to-be-created documentation part.

See:

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

properties

The new documentation content map of the targeted API entity.

Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value pairs can be exported and, hence, published.

See:

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

rest_api_id

The string identifier of the associated RestApi.

See:

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