Skip to content

StackInstance

This class encapsulates and extends the ROS resource type DATASOURCE::ROS::StackInstance, which is used to query the information about a stack instance that is associated with a stack group.

Initializers 

import com.aliyun.ros.cdk.ros.datasource.StackInstance;
StackInstance.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .stackGroupName(java.lang.String)
    .stackGroupName(IResolvable)
    .stackInstanceAccountId(java.lang.String)
    .stackInstanceAccountId(IResolvable)
    .stackInstanceRegionId(java.lang.String)
    .stackInstanceRegionId(IResolvable)
//  .outputOption(java.lang.String)
//  .outputOption(IResolvable)
//  .refreshOptions(java.lang.String)
//  .refreshOptions(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.
stackGroupName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property stackGroupName: Resource stack group name.
stackInstanceAccountId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property stackInstanceAccountId: The target account ID to which the resource stack belongs.
stackInstanceRegionId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property stackInstanceRegionId: The region to which the resource stack belongs.
outputOption java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property outputOption: Whether to return the Outputs parameter resource stack output list.
refreshOptions java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

stackGroupNameRequired

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

Property stackGroupName: Resource stack group name.

Names are unique within a single region. The length must not exceed 255 characters, must start with a number or an English letter, and can contain numbers, English letters, dashes (-) and underscores (_)

stackInstanceAccountIdRequired

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

Property stackInstanceAccountId: The target account ID to which the resource stack belongs.

In the self-service management permission mode, the account is an Alibaba Cloud account. In service management permission mode, this account is a member account of the resource directory.

stackInstanceRegionIdRequired

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

Property stackInstanceRegionId: The region to which the resource stack belongs.

outputOptionOptional

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

Property outputOption: Whether to return the Outputs parameter resource stack output list.

refreshOptionsOptional

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

Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

Valid values:

  • Never: Never refresh the datasource resource when the stack is updated.
  • Always: Always refresh the datasource resource when the stack is updated. Default is Never.

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.datasource.StackInstance;
StackInstance.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.
attrAccountId com.aliyun.ros.cdk.core.IResolvable Attribute AccountId: The account id of the stack.
attrDriftDetectionTime com.aliyun.ros.cdk.core.IResolvable Attribute DriftDetectionTime: The time when the resource stack group last successfully completed deviation detection.
attrOutputs com.aliyun.ros.cdk.core.IResolvable Attribute Outputs: The outputs of the stack instance.
attrParameterOverrides com.aliyun.ros.cdk.core.IResolvable Attribute ParameterOverrides: Override parameter list.
attrRdFolderId com.aliyun.ros.cdk.core.IResolvable Attribute RdFolderId: The resource folder ID of the resource directory.
attrRegionId com.aliyun.ros.cdk.core.IResolvable Attribute RegionId: The region id of the stack.
attrStackDriftStatus com.aliyun.ros.cdk.core.IResolvable Attribute StackDriftStatus: The status of the last successful deviation detection of the resource stack group.
attrStackGroupId com.aliyun.ros.cdk.core.IResolvable Attribute StackGroupId: The resource stack group ID.
attrStackGroupName com.aliyun.ros.cdk.core.IResolvable Attribute StackGroupName: The resource stack group name.
attrStackId com.aliyun.ros.cdk.core.IResolvable Attribute StackId: The stack id of stack instance.
attrStatus com.aliyun.ros.cdk.core.IResolvable Attribute Status: Resource stack status.
attrStatusReason com.aliyun.ros.cdk.core.IResolvable Attribute StatusReason: Status reason 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

attrAccountIdRequired 

public IResolvable getAttrAccountId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute AccountId: The account id of the stack.

attrDriftDetectionTimeRequired 

public IResolvable getAttrDriftDetectionTime();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute DriftDetectionTime: The time when the resource stack group last successfully completed deviation detection.

attrOutputsRequired 

public IResolvable getAttrOutputs();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Outputs: The outputs of the stack instance.

attrParameterOverridesRequired 

public IResolvable getAttrParameterOverrides();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ParameterOverrides: Override parameter list.

attrRdFolderIdRequired 

public IResolvable getAttrRdFolderId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute RdFolderId: The resource folder ID of the resource directory.

attrRegionIdRequired 

public IResolvable getAttrRegionId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute RegionId: The region id of the stack.

attrStackDriftStatusRequired 

public IResolvable getAttrStackDriftStatus();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute StackDriftStatus: The status of the last successful deviation detection of the resource stack group.

attrStackGroupIdRequired 

public IResolvable getAttrStackGroupId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute StackGroupId: The resource stack group ID.

attrStackGroupNameRequired 

public IResolvable getAttrStackGroupName();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute StackGroupName: The resource stack group name.

attrStackIdRequired 

public IResolvable getAttrStackId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute StackId: The stack id of stack instance.

attrStatusRequired 

public IResolvable getAttrStatus();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Status: Resource stack status.

attrStatusReasonRequired 

public IResolvable getAttrStatusReason();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute StatusReason: Status reason description.