Package software.amazon.awscdk.services.apigateway

Class CfnDocumentationPart

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.apigateway.CfnDocumentationPart

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.106.0 (build e852934)",
           date="2025-02-12T12:31:57.054Z")
@Stability(Stable)
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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationpart.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final 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.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnDocumentationPart(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDocumentationPart(software.amazon.jsii.JsiiObjectRef objRef)
	CfnDocumentationPart(software.constructs.Construct scope, String id, CfnDocumentationPartProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrDocumentationPartId()	The ID for the documentation part.
protected Map<String,Object>	getCfnProperties()
Object	getLocation()	The location of the targeted API entity of the to-be-created documentation part.
String	getProperties()	The new documentation content map of the targeted API entity.
String	getRestApiId()	The string identifier of the associated RestApi.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setLocation(IResolvable value)	The location of the targeted API entity of the to-be-created documentation part.
void	setLocation(CfnDocumentationPart.LocationProperty value)	The location of the targeted API entity of the to-be-created documentation part.
void	setProperties(String value)	The new documentation content map of the targeted API entity.
void	setRestApiId(String value)	The string identifier of the associated RestApi.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnDocumentationPart

protected CfnDocumentationPart(software.amazon.jsii.JsiiObjectRef objRef)

CfnDocumentationPart

protected CfnDocumentationPart(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnDocumentationPart

@Stability(Stable)
public CfnDocumentationPart(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnDocumentationPartProps props)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrDocumentationPartId

@Stability(Stable)
@NotNull
public String getAttrDocumentationPartId()

The ID for the documentation part.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getLocation

@Stability(Stable)
@NotNull
public Object getLocation()

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

setLocation

@Stability(Stable)
public void setLocation(@NotNull
 IResolvable value)

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

setLocation

@Stability(Stable)
public void setLocation(@NotNull
 CfnDocumentationPart.LocationProperty value)

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

getProperties

@Stability(Stable)
@NotNull
public String getProperties()

The new documentation content map of the targeted API entity.

setProperties

@Stability(Stable)
public void setProperties(@NotNull
 String value)

The new documentation content map of the targeted API entity.

getRestApiId

@Stability(Stable)
@NotNull
public String getRestApiId()

The string identifier of the associated RestApi.

setRestApiId

@Stability(Stable)
public void setRestApiId(@NotNull
 String value)

The string identifier of the associated RestApi.