software.amazon.awscdk.core

Class Resource

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

All Implemented Interfaces:

IConstruct, IDependable, IResource, software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/0.20.11 (build d4fd44f)",
           date="2019-12-17T13:05:19.644Z")
 @Stability(value=Stable)
public abstract class Resource
extends Construct
implements IResource

A construct which represents an AWS resource.

Nested Class Summary

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

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Resource(Construct scope, String id)
protected	Resource(Construct scope, String id, ResourceProps props)
protected	Resource(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Resource(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
protected String	generatePhysicalName()
protected String	getPhysicalName() Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.
protected String	getResourceArnAttribute(String arnAttr, ArnComponents arnComponents) Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g.
protected String	getResourceNameAttribute(String nameAttr) Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g.
Stack	getStack() The stack in which this resource is defined.

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

getNode, isConstruct, prepare, synthesize, toString, validate

Methods inherited from class software.amazon.jsii.JsiiObject

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

Resource

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

Resource

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

Resource

@Stability(value=Stable)
protected Resource(Construct scope,
                                            String id,
                                            ResourceProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

Resource

@Stability(value=Stable)
protected Resource(Construct scope,
                                            String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Detail

generatePhysicalName

@Stability(value=Stable)
protected String generatePhysicalName()

getResourceArnAttribute

@Stability(value=Experimental)
protected String getResourceArnAttribute(String arnAttr,
                                                                        ArnComponents arnComponents)

Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. `bucket.bucketArn`).

Normally, this token will resolve to arnAttr, but if the resource is referenced across environments, arnComponents will be used to synthesize a concrete ARN with the resource's physical name. Make sure to reference this.physicalName in arnComponents.

EXPERIMENTAL

Parameters:

arnAttr - The CFN attribute which resolves to the ARN of the resource. Commonly it will be called "Arn" (e.g. `resource.attrArn`), but sometimes it's the CFN resource's `ref`. This parameter is required.

arnComponents - The format of the ARN of this resource. This parameter is required.

getResourceNameAttribute

@Stability(value=Experimental)
protected String getResourceNameAttribute(String nameAttr)

Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. `bucket.bucketName`).

Normally, this token will resolve to nameAttr, but if the resource is referenced across environments, it will be resolved to this.physicalName, which will be a concrete name.

EXPERIMENTAL

Parameters:

nameAttr - The CFN attribute which resolves to the resource's name. Commonly this is the resource's `ref`. This parameter is required.

getPhysicalName

@Stability(value=Experimental)
protected String getPhysicalName()

Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.

This value will resolve to one of the following:

• a concrete value (e.g. "my-awesome-bucket")
• undefined, when a name should be generated by CloudFormation
• a concrete name generated automatically during synthesis, in cross-environment scenarios.

EXPERIMENTAL

getStack

@Stability(value=Stable)
public Stack getStack()

The stack in which this resource is defined.

Specified by:

getStack in interface IResource