software.amazon.awscdk.services.apigateway

Class CfnDocumentationPart

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.apigateway.CfnDocumentationPart

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:47.493Z")
public class CfnDocumentationPart
extends CfnResource
implements IInspectable

A CloudFormation `AWS::ApiGateway::DocumentationPart`.

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();
 

Nested Class Summary

Nested Classes

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.

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

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)

Method Summary

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.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnDocumentationPart

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

CfnDocumentationPart

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

CfnDocumentationPart

public CfnDocumentationPart(Construct scope,
                            java.lang.String id,
                            CfnDocumentationPartProps props)

Create a new `AWS::ApiGateway::DocumentationPart`.

Parameters:

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.

Method Detail

inspect

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrDocumentationPartId

public java.lang.String getAttrDocumentationPartId()

The ID for the documentation part.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getLocation

public java.lang.Object getLocation()

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

setLocation

public void setLocation(IResolvable value)

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

setLocation

public void setLocation(CfnDocumentationPart.LocationProperty value)

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

getProperties

public java.lang.String getProperties()

The new documentation content map of the targeted API entity.

Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value pairs can be exported and, hence, published.

setProperties

public void setProperties(java.lang.String value)

The new documentation content map of the targeted API entity.

Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value pairs can be exported and, hence, published.

getRestApiId

public java.lang.String getRestApiId()

The string identifier of the associated RestApi.

setRestApiId

public void setRestApiId(java.lang.String value)

The string identifier of the associated RestApi.