Resource
- Implements: IResource
A construct which represents a resource.
Initializers
import com.aliyun.ros.cdk.core.Resource;
Resource.Builder.create(Construct scope, java.lang.String id)
// .physicalName(java.lang.String)
.build();
Name | Type | Description |
---|---|---|
scope |
Construct |
No description. |
id |
java.lang.String |
No description. |
physicalName |
java.lang.String |
The value passed in by users to the physical name prop of the resource. |
scope
Required
- Type: Construct
id
Required
- Type: java.lang.String
physicalName
Optional
- Type: java.lang.String
- Default: The physical name will be allocated at deployment time
The value passed in by users to the physical name prop of the resource.
undefined
implies that a physical name will be allocated during deployment.- a concrete value implies a specific physical name
PhysicalName.GENERATE_IF_NEEDED
is a marker that indicates that a physical will only be generated by the CDK if it is needed for cross-environment references. Otherwise, it will be allocated.
Methods
Name | Description |
---|---|
toString |
Returns a string representation of this construct. |
synthesize |
Allows this construct to emit artifacts into the cloud assembly during synthesis. |
addCondition |
No description. |
addCount |
No description. |
addDependency |
No description. |
addResourceDesc |
No description. |
applyRemovalPolicy |
No description. |
getAtt |
No description. |
setMetadata |
No description. |
toString
public java.lang.String toString()
Returns a string representation of this construct.
synthesize
public void synthesize(ISynthesisSession session)
Allows this construct to emit artifacts into the cloud assembly during synthesis.
This method is usually implemented by framework-level constructs such as Stack
and Asset
as they participate in synthesizing the cloud assembly.
- Type: ISynthesisSession
The synthesis session.
addCondition
public void addCondition(RosCondition condition)
- Type: RosCondition
addCount
public void addCount(java.lang.Number OR IResolvable count)
- Type: java.lang.Number OR IResolvable
addDependency
public void addDependency(Resource resource)
- Type: Resource
addResourceDesc
public void addResourceDesc(java.lang.String desc)
- Type: java.lang.String
applyRemovalPolicy
public void applyRemovalPolicy(RemovalPolicy policy)
- Type: RemovalPolicy
getAtt
public IResolvable getAtt(java.lang.String name)
- Type: java.lang.String
setMetadata
public void setMetadata(java.lang.String key, java.lang.Object value)
- Type: java.lang.String
- Type: java.lang.Object
Static Functions
Name | Description |
---|---|
isConstruct |
Return whether the given object is a Construct. |
isConstruct
import com.aliyun.ros.cdk.core.Resource;
Resource.isConstruct(java.lang.Object x)
Return whether the given object is a Construct.
- Type: java.lang.Object
Properties
Name | Type | Description |
---|---|---|
node |
ConstructNode |
The construct tree node associated with this construct. |
ref |
java.lang.String |
No description. |
stack |
Stack |
The stack in which this resource is defined. |
resource |
RosResource |
No description. |
node
Required
public ConstructNode getNode();
- Type: ConstructNode
The construct tree node associated with this construct.
ref
Required
public java.lang.String getRef();
- Type: java.lang.String
stack
Required
public Stack getStack();
- Type: Stack
The stack in which this resource is defined.
resource
Optional
public RosResource getResource();
- Type: RosResource