Skip to content

Resource

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.

scopeRequired


idRequired

  • Type: java.lang.String

physicalNameOptional

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

sessionRequired

The synthesis session.


addCondition

public void addCondition(RosCondition condition)

conditionRequired


addCount

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

countRequired


addDependency

public void addDependency(Resource resource)

resourceRequired


addResourceDesc

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired


getAtt

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata

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

keyRequired

  • Type: java.lang.String

valueRequired

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

xRequired

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

nodeRequired

public ConstructNode getNode();

The construct tree node associated with this construct.


refRequired

public java.lang.String getRef();
  • Type: java.lang.String

stackRequired

public Stack getStack();

The stack in which this resource is defined.


resourceOptional

public RosResource getResource();