Table of Contents

Class CfnDocumentationPartProps

Namespace
Amazon.CDK.AWS.APIGateway
Assembly
Amazon.CDK.AWS.APIGateway.dll

Properties for defining a CfnDocumentationPart.

public class CfnDocumentationPartProps : ICfnDocumentationPartProps
Inheritance
CfnDocumentationPartProps
Implements
Inherited Members

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.APIGateway;

             var cfnDocumentationPartProps = new CfnDocumentationPartProps {
                 Location = new LocationProperty {
                     Method = "method",
                     Name = "name",
                     Path = "path",
                     StatusCode = "statusCode",
                     Type = "type"
                 },
                 Properties = "properties",
                 RestApiId = "restApiId"
             };

Remarks

Constructors

CfnDocumentationPartProps()

public CfnDocumentationPartProps()

Properties

Location

The location of the targeted API entity of the to-be-created documentation part.

public object Location { get; set; }

Property Value

object

Remarks

Properties

The new documentation content map of the targeted API entity.

public string Properties { get; set; }

Property Value

string

Remarks

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

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

RestApiId

The string identifier of the associated RestApi.

public string RestApiId { get; set; }

Property Value

string

Remarks