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)
//  .account(java.lang.String)
//  .environmentFromArn(java.lang.String)
//  .environmentFromArn(IResolvable)
//  .physicalName(java.lang.String)
//  .region(java.lang.String)
    .build();

scope^Required

• Type: Construct

id^Required

• Type: java.lang.String

account^Optional

• Type: java.lang.String
• Default: the resource is in the same account as the stack it belongs to

The Alibaba Cloud account ID this resource belongs to.

environmentFromArn^Optional

• Type: java.lang.String OR IResolvable
• Default: take environment from account, region parameters, or use Stack environment.

ARN to deduce region and account from.

The ARN is parsed and the account and region are taken from the ARN. This should be used for imported resources.

Cannot be supplied together with either account or region.

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.

region^Optional

• Type: java.lang.String
• Default: the resource is in the same region as the stack it belongs to

The Alibaba Cloud region this resource belongs to.

Methods

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.

session^Required

• Type: ISynthesisSession

The synthesis session.

addCondition

public void addCondition(RosCondition condition)

condition^Required

• Type: RosCondition

addCount

public void addCount(java.lang.Number OR IResolvable count)

count^Required

• Type: java.lang.Number OR IResolvable

addDependency

public void addDependency(Resource resource)

resource^Required

• Type: Resource

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

• Type: RemovalPolicy

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

getAtt

public IResolvable getAtt(java.lang.String name)

name^Required

• Type: java.lang.String

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

key^Required

• Type: java.lang.String

value^Required

• Type: java.lang.Object

Static Functions

isConstruct

import com.aliyun.ros.cdk.core.Resource;
Resource.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

Properties

node^Required

public ConstructNode getNode();

• Type: ConstructNode

The construct tree node associated with this construct.

env^Required

public IResourceEnvironment getEnv();

• Type: IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

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