Package software.amazon.awscdk.services.apigateway

Class CfnResource

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

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)",
           date="2024-07-12T19:33:56.719Z")
@Stability(Stable)
public class CfnResource
extends CfnResource
implements IInspectable

The AWS::ApiGateway::Resource resource creates a resource in an API.

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.*;
 CfnResource cfnResource = CfnResource.Builder.create(this, "MyCfnResource")
         .parentId("parentId")
         .pathPart("pathPart")
         .restApiId("restApiId")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnResource.Builder	A fluent builder for CfnResource.

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	CfnResource(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnResource(software.amazon.jsii.JsiiObjectRef objRef)
	CfnResource(software.constructs.Construct scope, String id, CfnResourceProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrResourceId()	The ID for the resource.
protected Map<String,Object>	getCfnProperties()
String	getParentId()	The parent resource's identifier.
String	getPathPart()	The last path segment for this resource.
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	setParentId(String value)	The parent resource's identifier.
void	setPathPart(String value)	The last path segment for this resource.
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

CfnResource

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

CfnResource

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

CfnResource

@Stability(Stable)
public CfnResource(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnResourceProps 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.

getAttrResourceId

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

The ID for the resource.

For example: abc123 .

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getParentId

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

The parent resource's identifier.

setParentId

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

The parent resource's identifier.

getPathPart

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

The last path segment for this resource.

setPathPart

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

The last path segment for this resource.

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.