Class CfnDocumentationVersionProps

Namespace

Amazon.CDK.AWS.APIGateway

Assembly

Amazon.CDK.AWS.APIGateway.dll

Properties for defining a CfnDocumentationVersion.

public class CfnDocumentationVersionProps : ICfnDocumentationVersionProps

Inheritance

object

CfnDocumentationVersionProps

Implements

ICfnDocumentationVersionProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

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 cfnDocumentationVersionProps = new CfnDocumentationVersionProps {
                 DocumentationVersion = "documentationVersion",
                 RestApiId = "restApiId",

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

Remarks

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

ExampleMetadata: fixture=_generated

Constructors

CfnDocumentationVersionProps()

public CfnDocumentationVersionProps()

Properties

Description

A description about the new documentation snapshot.

public 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 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 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