Interface ICfnDocumentationPartProps
Properties for defining a CfnDocumentationPart
.
Namespace: Amazon.CDK.AWS.APIGateway
Assembly: Amazon.CDK.AWS.APIGateway.dll
Syntax (csharp)
public interface ICfnDocumentationPartProps
Syntax (vb)
Public Interface ICfnDocumentationPartProps
Remarks
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 cfnDocumentationPartProps = new CfnDocumentationPartProps {
Location = new LocationProperty {
Method = "method",
Name = "name",
Path = "path",
StatusCode = "statusCode",
Type = "type"
},
Properties = "properties",
RestApiId = "restApiId"
};
Synopsis
Properties
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. |
Properties
Location
The location of the targeted API entity of the to-be-created documentation part.
object Location { get; }
Property Value
System.Object
Remarks
Properties
The new documentation content map of the targeted API entity.
string Properties { get; }
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.
RestApiId
The string identifier of the associated RestApi.
string RestApiId { get; }
Property Value
System.String