Skip to content

StackInstance

  • Implements: com.aliyun.ros.cdk.ros.datasource.IStackInstance

This class encapsulates and extends the ROS resource type DATASOURCE::ROS::StackInstance.

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.
fetchCondition No description.
fetchDependency No description.
fetchResourceDesc 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

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)

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.
env com.aliyun.ros.cdk.core.IResourceEnvironment The environment this resource belongs to.
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 java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute AccountId: The account id of the stack.
attrDriftDetectionTime java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute DriftDetectionTime: The time when the resource stack group last successfully completed deviation detection.
attrOutputs java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Outputs: The outputs of the stack instance.
attrParameterOverrides java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ParameterOverrides: Override parameter list.
attrRdFolderId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute RdFolderId: The resource folder ID of the resource directory.
attrRegionId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute RegionId: The region id of the stack.
attrStackDriftStatus java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute StackDriftStatus: The status of the last successful deviation detection of the resource stack group.
attrStackGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute StackGroupId: The resource stack group ID.
attrStackGroupName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute StackGroupName: The resource stack group name.
attrStackId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute StackId: The stack id of stack instance.
attrStatus java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Status: Resource stack status.
attrStatusReason java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute StatusReason: Status reason description.
props StackInstanceProps No description.

nodeRequired

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

The construct tree node associated with this construct.


envRequired

public IResourceEnvironment getEnv();
  • Type: com.aliyun.ros.cdk.core.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.


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 java.lang.Object getAttrAccountId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute AccountId: The account id of the stack.


attrDriftDetectionTimeRequired

public java.lang.Object getAttrDriftDetectionTime();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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


attrOutputsRequired

public java.lang.Object getAttrOutputs();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Outputs: The outputs of the stack instance.


attrParameterOverridesRequired

public java.lang.Object getAttrParameterOverrides();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ParameterOverrides: Override parameter list.


attrRdFolderIdRequired

public java.lang.Object getAttrRdFolderId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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


attrRegionIdRequired

public java.lang.Object getAttrRegionId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute RegionId: The region id of the stack.


attrStackDriftStatusRequired

public java.lang.Object getAttrStackDriftStatus();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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


attrStackGroupIdRequired

public java.lang.Object getAttrStackGroupId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute StackGroupId: The resource stack group ID.


attrStackGroupNameRequired

public java.lang.Object getAttrStackGroupName();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute StackGroupName: The resource stack group name.


attrStackIdRequired

public java.lang.Object getAttrStackId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute StackId: The stack id of stack instance.


attrStatusRequired

public java.lang.Object getAttrStatus();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Status: Resource stack status.


attrStatusReasonRequired

public java.lang.Object getAttrStatusReason();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute StatusReason: Status reason description.


propsRequired

public StackInstanceProps getProps();