Class CfnDocumentationPartProps

Properties for defining a CfnDocumentationPart.

Inheritance

System.Object

CfnDocumentationPartProps

Implements

ICfnDocumentationPartProps

Namespace: Amazon.CDK.AWS.APIGateway

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnDocumentationPartProps : Object, ICfnDocumentationPartProps

Syntax (vb)

Public Class CfnDocumentationPartProps
    Inherits Object
    Implements ICfnDocumentationPartProps

Remarks

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

ExampleMetadata: fixture=_generated

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"
};

Synopsis

Constructors

CfnDocumentationPartProps()

Properties

Location	The location of the targeted API entity of the to-be-created documentation part.
Properties	The new documentation content map of the targeted API entity.
RestApiId	The string identifier of the associated RestApi.

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

System.Object

Remarks

Link: 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.

public string Properties { get; set; }

Property Value

System.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

System.String

Remarks

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

Implements

ICfnDocumentationPartProps