Class CfnDocumentationPart

Namespace

Amazon.CDK.AWS.APIGateway

Assembly

Amazon.CDK.AWS.APIGateway.dll

A CloudFormation AWS::ApiGateway::DocumentationPart.

public class CfnDocumentationPart : CfnResource, IInspectable

Inheritance

object

CfnDocumentationPart

Implements

IInspectable

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 cfnDocumentationPart = new CfnDocumentationPart(this, "MyCfnDocumentationPart", new CfnDocumentationPartProps {
                 Location = new LocationProperty {
                     Method = "method",
                     Name = "name",
                     Path = "path",
                     StatusCode = "statusCode",
                     Type = "type"
                 },
                 Properties = "properties",
                 RestApiId = "restApiId"
             });

Remarks

The AWS::ApiGateway::DocumentationPart resource creates a documentation part for an API. For more information, see Representation of API Documentation in API Gateway in the API Gateway Developer Guide .

CloudformationResource: AWS::ApiGateway::DocumentationPart

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

ExampleMetadata: fixture=_generated

Constructors

CfnDocumentationPart(Construct, string, ICfnDocumentationPartProps)

Create a new AWS::ApiGateway::DocumentationPart.

public CfnDocumentationPart(Construct scope, string id, ICfnDocumentationPartProps props)

Parameters

scope Construct

• scope in which this resource is defined.

id string

• scoped id of the resource.

props ICfnDocumentationPartProps

• resource properties.

Properties

AttrDocumentationPartId

The ID for the documentation part.

public virtual string AttrDocumentationPartId { get; }

Property Value

string

Remarks

CloudformationAttribute: DocumentationPartId

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

CfnProperties

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Location

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

public virtual object Location { get; set; }

Property Value

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 virtual 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 virtual string RestApiId { get; set; }

Property Value

string

Remarks

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

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector

• tree inspector to collect and process attributes.

RenderProperties(IDictionary<string, object>)

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>