Skip to content

Stack

This class encapsulates and extends the ROS resource type ALIYUN::ROS::Stack, which is used to create a nested stack.

You can nest stacks up to five levels of depth.

Initializers 

import com.aliyun.ros.cdk.ros.Stack;
Stack.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
//  .parameters(IResolvable)
//  .parameters(java.util.Map<java.lang.String, java.lang.Object>)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .tags(java.util.List<TagsProperty>)
//  .templateBody(IResolvable)
//  .templateBody(java.util.Map<java.lang.String, java.lang.Object>)
//  .templateId(java.lang.String)
//  .templateId(IResolvable)
//  .templateUrl(java.lang.String)
//  .templateUrl(IResolvable)
//  .templateVersion(java.lang.String)
//  .templateVersion(IResolvable)
//  .timeoutMins(java.lang.Number)
//  .timeoutMins(IResolvable)
    .build();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct No description.
id java.lang.String No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
parameters com.aliyun.ros.cdk.core.IResolvable OR java.util.Map Property parameters: The set of parameters passed to this nested stack.
resourceGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property resourceGroupId: Resource group.
tags java.util.List<TagsProperty> Property tags: The tags of nested stack.
templateBody com.aliyun.ros.cdk.core.IResolvable OR java.util.Map Property templateBody: Structure containing the template body.
templateId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property templateId: Template ID of template containing the template body.
templateUrl java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property templateUrl: Location of file containing the template body.
templateVersion java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property templateVersion: Template version of template containing the template body.
timeoutMins java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property timeoutMins: The length of time, in minutes, to wait for the nested stack creation or update.

scopeRequired

  • Type: com.aliyun.ros.cdk.core.Construct

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

parametersOptional

  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.Map

Property parameters: The set of parameters passed to this nested stack.

resourceGroupIdOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property resourceGroupId: Resource group.

tagsOptional

Property tags: The tags of nested stack.

If it is specified, it will be passed to all tag-supported resources in the nested stack.

templateBodyOptional

  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.Map

Property templateBody: Structure containing the template body.

It is just to facilitate the passing of template. It is raw content.Functions in TemplateBody will not be resolved in parent stack. You must specify either the TemplateBody or the TemplateURL property. If both are specified, TemplateBody will be used.

templateIdOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property templateId: Template ID of template containing the template body.

templateUrlOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property templateUrl: Location of file containing the template body.

The URL must point to a template (max size: 524288 bytes) that is located in a http web server(http, https), or an Aliyun OSS bucket(Such as oss://ros-template/demo?RegionId=cn-hangzhou, oss://ros-template/demo. RegionId is default to the value of RegionId Parameter of the request.). You must specify either the TemplateBody or the TemplateURL property. If both are specified, TemplateBody will be used.

templateVersionOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property templateVersion: Template version of template containing the template body.

timeoutMinsOptional

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property timeoutMins: The length of time, in minutes, to wait for the nested stack creation or update.

Default to 60 minutes.

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

  • Type: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

addCondition 

public void addCondition(RosCondition condition)

conditionRequired

  • Type: com.aliyun.ros.cdk.core.RosCondition

addCount 

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

countRequired

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency 

public void addDependency(Resource resource)

resourceRequired

  • Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc 

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy 

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

  • Type: com.aliyun.ros.cdk.core.RemovalPolicy

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.ros.Stack;
Stack.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
ref java.lang.String No description.
stack com.aliyun.ros.cdk.core.Stack The stack in which this resource is defined.
resource com.aliyun.ros.cdk.core.RosResource No description.

nodeRequired 

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

refRequired 

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

stackRequired 

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resourceOptional 

public RosResource getResource();
  • Type: com.aliyun.ros.cdk.core.RosResource