Class CfnDocumentationVersion
The AWS::ApiGateway::DocumentationVersion
resource creates a snapshot of the documentation for an API.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.APIGateway
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnDocumentationVersion : CfnResource, IInspectable
Syntax (vb)
Public Class CfnDocumentationVersion
Inherits CfnResource
Implements IInspectable
Remarks
For more information, see Representation of API Documentation in API Gateway in the API Gateway Developer Guide .
CloudformationResource: AWS::ApiGateway::DocumentationVersion
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 cfnDocumentationVersion = new CfnDocumentationVersion(this, "MyCfnDocumentationVersion", new CfnDocumentationVersionProps {
DocumentationVersion = "documentationVersion",
RestApiId = "restApiId",
// the properties below are optional
Description = "description"
});
Synopsis
Constructors
CfnDocumentationVersion(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnDocumentationVersion(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnDocumentationVersion(Construct, String, ICfnDocumentationVersionProps) |
Properties
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Description | A description about the new documentation snapshot. |
DocumentationVersion | The version identifier of the to-be-updated documentation version. |
RestApiId | The string identifier of the associated RestApi. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnDocumentationVersion(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnDocumentationVersion(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnDocumentationVersion(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnDocumentationVersion(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnDocumentationVersion(Construct, String, ICfnDocumentationVersionProps)
public CfnDocumentationVersion(Construct scope, string id, ICfnDocumentationVersionProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- 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
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Description
A description about the new documentation snapshot.
public virtual string Description { get; set; }
Property Value
System.String
DocumentationVersion
The version identifier of the to-be-updated documentation version.
public virtual string DocumentationVersion { get; set; }
Property Value
System.String
RestApiId
The string identifier of the associated RestApi.
public virtual string RestApiId { get; set; }
Property Value
System.String
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 System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>