Class CfnDocumentationVersion

Namespace

Amazon.CDK.AWS.APIGateway

Assembly

Amazon.CDK.AWS.APIGateway.dll

A CloudFormation AWS::ApiGateway::DocumentationVersion.

public class CfnDocumentationVersion : CfnResource, IInspectable

Inheritance

object

CfnDocumentationVersion

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 cfnDocumentationVersion = new CfnDocumentationVersion(this, "MyCfnDocumentationVersion", new CfnDocumentationVersionProps {
                 DocumentationVersion = "documentationVersion",
                 RestApiId = "restApiId",

                 // the properties below are optional
                 Description = "description"
             });

Remarks

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

CloudformationResource: AWS::ApiGateway::DocumentationVersion

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

ExampleMetadata: fixture=_generated

Constructors

CfnDocumentationVersion(Construct, string, ICfnDocumentationVersionProps)

Create a new AWS::ApiGateway::DocumentationVersion.

public CfnDocumentationVersion(Construct scope, string id, ICfnDocumentationVersionProps props)

Parameters

scope Construct

• scope in which this resource is defined.

id string

• scoped id of the resource.

props ICfnDocumentationVersionProps

• resource properties.

Properties

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>

Description

A description about the new documentation snapshot.

public virtual string? Description { get; set; }

Property Value

string

Remarks

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

DocumentationVersion

The version identifier of the to-be-updated documentation version.

public virtual string DocumentationVersion { get; set; }

Property Value

string

Remarks

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

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-documentationversion.html#cfn-apigateway-documentationversion-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>