@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:47.493Z") public class CfnDocumentationPart extends CfnResource implements IInspectable
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 .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.apigateway.*; CfnDocumentationPart cfnDocumentationPart = CfnDocumentationPart.Builder.create(this, "MyCfnDocumentationPart") .location(LocationProperty.builder() .method("method") .name("name") .path("path") .statusCode("statusCode") .type("type") .build()) .properties("properties") .restApiId("restApiId") .build();
Modifier and Type | Class and Description |
---|---|
static class |
CfnDocumentationPart.Builder
A fluent builder for
CfnDocumentationPart . |
static interface |
CfnDocumentationPart.LocationProperty
The `Location` property specifies the location of the Amazon API Gateway API entity that the documentation applies to.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnDocumentationPart(Construct scope,
java.lang.String id,
CfnDocumentationPartProps props)
Create a new `AWS::ApiGateway::DocumentationPart`.
|
protected |
CfnDocumentationPart(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnDocumentationPart(software.amazon.jsii.JsiiObjectRef objRef) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAttrDocumentationPartId()
The ID for the documentation part.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.Object |
getLocation()
The location of the targeted API entity of the to-be-created documentation part.
|
java.lang.String |
getProperties()
The new documentation content map of the targeted API entity.
|
java.lang.String |
getRestApiId()
The string identifier of the associated RestApi.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setLocation(CfnDocumentationPart.LocationProperty value)
The location of the targeted API entity of the to-be-created documentation part.
|
void |
setLocation(IResolvable value)
The location of the targeted API entity of the to-be-created documentation part.
|
void |
setProperties(java.lang.String value)
The new documentation content map of the targeted API entity.
|
void |
setRestApiId(java.lang.String value)
The string identifier of the associated RestApi.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnDocumentationPart(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnDocumentationPart(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnDocumentationPart(Construct scope, java.lang.String id, CfnDocumentationPartProps props)
scope
- - scope in which this resource is defined. This parameter is required.id
- - scoped id of the resource. This parameter is required.props
- - resource properties. This parameter is required.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrDocumentationPartId()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public java.lang.Object getLocation()
public void setLocation(IResolvable value)
public void setLocation(CfnDocumentationPart.LocationProperty value)
public java.lang.String getProperties()
Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value pairs can be exported and, hence, published.
public void setProperties(java.lang.String value)
Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value pairs can be exported and, hence, published.
public java.lang.String getRestApiId()
public void setRestApiId(java.lang.String value)