Class CfnDocumentationPart

A CloudFormation AWS::ApiGateway::DocumentationPart.

Inheritance
System.Object
CfnElement
CfnRefElement
CfnResource
CfnDocumentationPart
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.APIGateway
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnDocumentationPart : CfnResource, IInspectable
Syntax (vb)
Public Class CfnDocumentationPart
    Inherits CfnResource
    Implements IInspectable
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

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

Synopsis

Constructors

CfnDocumentationPart(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference
CfnDocumentationPart(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps
CfnDocumentationPart(Construct, String, ICfnDocumentationPartProps)

Create a new AWS::ApiGateway::DocumentationPart.

Properties

AttrDocumentationPartId

The ID for the documentation part.
CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CfnProperties
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.

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<String, Object>)

Constructors

CfnDocumentationPart(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnDocumentationPart(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

CfnDocumentationPart(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnDocumentationPart(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

CfnDocumentationPart(Construct, String, ICfnDocumentationPartProps)

Create a new AWS::ApiGateway::DocumentationPart.

public CfnDocumentationPart(Construct scope, string id, ICfnDocumentationPartProps props)
Parameters
scope Constructs.Construct
  • scope in which this resource is defined.
id System.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

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

System.String

CfnProperties

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

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

Location

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

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

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>

Overrides

Implements