alicloud.ros.StackInstance
Explore with Pulumi AI
Provides a ROS Stack Instance resource.
For information about ROS Stack Instance and how to use it, see What is Stack Instance.
NOTE: Available in v1.145.0+.
Example Usage
Basic Usage
import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";
const config = new pulumi.Config();
const name = config.get("name") || "tf-example";
const this = alicloud.getAccount({});
const default = alicloud.ros.getRegions({});
const defaultStackGroup = new alicloud.ros.StackGroup("default", {
stackGroupName: name,
templateBody: "{\"ROSTemplateFormatVersion\":\"2015-09-01\", \"Parameters\": {\"VpcName\": {\"Type\": \"String\"},\"InstanceType\": {\"Type\": \"String\"}}}",
description: "test for stack groups",
parameters: [
{
parameterKey: "VpcName",
parameterValue: "VpcName",
},
{
parameterKey: "InstanceType",
parameterValue: "InstanceType",
},
],
});
const example = new alicloud.ros.StackInstance("example", {
stackGroupName: defaultStackGroup.stackGroupName,
stackInstanceAccountId: _this.then(_this => _this.id),
stackInstanceRegionId: _default.then(_default => _default.regions?.[0]?.regionId),
operationPreferences: "{\"FailureToleranceCount\": 1, \"MaxConcurrentCount\": 2}",
timeoutInMinutes: "60",
operationDescription: "tf-example",
retainStacks: true,
parameterOverrides: [{
parameterValue: "VpcName",
parameterKey: "VpcName",
}],
});
import pulumi
import pulumi_alicloud as alicloud
config = pulumi.Config()
name = config.get("name")
if name is None:
name = "tf-example"
this = alicloud.get_account()
default = alicloud.ros.get_regions()
default_stack_group = alicloud.ros.StackGroup("default",
stack_group_name=name,
template_body="{\"ROSTemplateFormatVersion\":\"2015-09-01\", \"Parameters\": {\"VpcName\": {\"Type\": \"String\"},\"InstanceType\": {\"Type\": \"String\"}}}",
description="test for stack groups",
parameters=[
{
"parameter_key": "VpcName",
"parameter_value": "VpcName",
},
{
"parameter_key": "InstanceType",
"parameter_value": "InstanceType",
},
])
example = alicloud.ros.StackInstance("example",
stack_group_name=default_stack_group.stack_group_name,
stack_instance_account_id=this.id,
stack_instance_region_id=default.regions[0].region_id,
operation_preferences="{\"FailureToleranceCount\": 1, \"MaxConcurrentCount\": 2}",
timeout_in_minutes="60",
operation_description="tf-example",
retain_stacks=True,
parameter_overrides=[{
"parameter_value": "VpcName",
"parameter_key": "VpcName",
}])
package main
import (
"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud"
"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/ros"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
cfg := config.New(ctx, "")
name := "tf-example"
if param := cfg.Get("name"); param != "" {
name = param
}
this, err := alicloud.GetAccount(ctx, map[string]interface{}{}, nil)
if err != nil {
return err
}
_default, err := ros.GetRegions(ctx, &ros.GetRegionsArgs{}, nil)
if err != nil {
return err
}
defaultStackGroup, err := ros.NewStackGroup(ctx, "default", &ros.StackGroupArgs{
StackGroupName: pulumi.String(name),
TemplateBody: pulumi.String("{\"ROSTemplateFormatVersion\":\"2015-09-01\", \"Parameters\": {\"VpcName\": {\"Type\": \"String\"},\"InstanceType\": {\"Type\": \"String\"}}}"),
Description: pulumi.String("test for stack groups"),
Parameters: ros.StackGroupParameterArray{
&ros.StackGroupParameterArgs{
ParameterKey: pulumi.String("VpcName"),
ParameterValue: pulumi.String("VpcName"),
},
&ros.StackGroupParameterArgs{
ParameterKey: pulumi.String("InstanceType"),
ParameterValue: pulumi.String("InstanceType"),
},
},
})
if err != nil {
return err
}
_, err = ros.NewStackInstance(ctx, "example", &ros.StackInstanceArgs{
StackGroupName: defaultStackGroup.StackGroupName,
StackInstanceAccountId: pulumi.String(this.Id),
StackInstanceRegionId: pulumi.String(_default.Regions[0].RegionId),
OperationPreferences: pulumi.String("{\"FailureToleranceCount\": 1, \"MaxConcurrentCount\": 2}"),
TimeoutInMinutes: pulumi.String("60"),
OperationDescription: pulumi.String("tf-example"),
RetainStacks: pulumi.Bool(true),
ParameterOverrides: ros.StackInstanceParameterOverrideArray{
&ros.StackInstanceParameterOverrideArgs{
ParameterValue: pulumi.String("VpcName"),
ParameterKey: pulumi.String("VpcName"),
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AliCloud = Pulumi.AliCloud;
return await Deployment.RunAsync(() =>
{
var config = new Config();
var name = config.Get("name") ?? "tf-example";
var @this = AliCloud.GetAccount.Invoke();
var @default = AliCloud.Ros.GetRegions.Invoke();
var defaultStackGroup = new AliCloud.Ros.StackGroup("default", new()
{
StackGroupName = name,
TemplateBody = "{\"ROSTemplateFormatVersion\":\"2015-09-01\", \"Parameters\": {\"VpcName\": {\"Type\": \"String\"},\"InstanceType\": {\"Type\": \"String\"}}}",
Description = "test for stack groups",
Parameters = new[]
{
new AliCloud.Ros.Inputs.StackGroupParameterArgs
{
ParameterKey = "VpcName",
ParameterValue = "VpcName",
},
new AliCloud.Ros.Inputs.StackGroupParameterArgs
{
ParameterKey = "InstanceType",
ParameterValue = "InstanceType",
},
},
});
var example = new AliCloud.Ros.StackInstance("example", new()
{
StackGroupName = defaultStackGroup.StackGroupName,
StackInstanceAccountId = @this.Apply(@this => @this.Apply(getAccountResult => getAccountResult.Id)),
StackInstanceRegionId = @default.Apply(@default => @default.Apply(getRegionsResult => getRegionsResult.Regions[0]?.RegionId)),
OperationPreferences = "{\"FailureToleranceCount\": 1, \"MaxConcurrentCount\": 2}",
TimeoutInMinutes = "60",
OperationDescription = "tf-example",
RetainStacks = true,
ParameterOverrides = new[]
{
new AliCloud.Ros.Inputs.StackInstanceParameterOverrideArgs
{
ParameterValue = "VpcName",
ParameterKey = "VpcName",
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.AlicloudFunctions;
import com.pulumi.alicloud.ros.RosFunctions;
import com.pulumi.alicloud.ros.inputs.GetRegionsArgs;
import com.pulumi.alicloud.ros.StackGroup;
import com.pulumi.alicloud.ros.StackGroupArgs;
import com.pulumi.alicloud.ros.inputs.StackGroupParameterArgs;
import com.pulumi.alicloud.ros.StackInstance;
import com.pulumi.alicloud.ros.StackInstanceArgs;
import com.pulumi.alicloud.ros.inputs.StackInstanceParameterOverrideArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var config = ctx.config();
final var name = config.get("name").orElse("tf-example");
final var this = AlicloudFunctions.getAccount();
final var default = RosFunctions.getRegions();
var defaultStackGroup = new StackGroup("defaultStackGroup", StackGroupArgs.builder()
.stackGroupName(name)
.templateBody("{\"ROSTemplateFormatVersion\":\"2015-09-01\", \"Parameters\": {\"VpcName\": {\"Type\": \"String\"},\"InstanceType\": {\"Type\": \"String\"}}}")
.description("test for stack groups")
.parameters(
StackGroupParameterArgs.builder()
.parameterKey("VpcName")
.parameterValue("VpcName")
.build(),
StackGroupParameterArgs.builder()
.parameterKey("InstanceType")
.parameterValue("InstanceType")
.build())
.build());
var example = new StackInstance("example", StackInstanceArgs.builder()
.stackGroupName(defaultStackGroup.stackGroupName())
.stackInstanceAccountId(this_.id())
.stackInstanceRegionId(default_.regions()[0].regionId())
.operationPreferences("{\"FailureToleranceCount\": 1, \"MaxConcurrentCount\": 2}")
.timeoutInMinutes("60")
.operationDescription("tf-example")
.retainStacks("true")
.parameterOverrides(StackInstanceParameterOverrideArgs.builder()
.parameterValue("VpcName")
.parameterKey("VpcName")
.build())
.build());
}
}
configuration:
name:
type: string
default: tf-example
resources:
defaultStackGroup:
type: alicloud:ros:StackGroup
name: default
properties:
stackGroupName: ${name}
templateBody: '{"ROSTemplateFormatVersion":"2015-09-01", "Parameters": {"VpcName": {"Type": "String"},"InstanceType": {"Type": "String"}}}'
description: test for stack groups
parameters:
- parameterKey: VpcName
parameterValue: VpcName
- parameterKey: InstanceType
parameterValue: InstanceType
example:
type: alicloud:ros:StackInstance
properties:
stackGroupName: ${defaultStackGroup.stackGroupName}
stackInstanceAccountId: ${this.id}
stackInstanceRegionId: ${default.regions[0].regionId}
operationPreferences: '{"FailureToleranceCount": 1, "MaxConcurrentCount": 2}'
timeoutInMinutes: '60'
operationDescription: tf-example
retainStacks: 'true'
parameterOverrides:
- parameterValue: VpcName
parameterKey: VpcName
variables:
this:
fn::invoke:
Function: alicloud:getAccount
Arguments: {}
default:
fn::invoke:
Function: alicloud:ros:getRegions
Arguments: {}
Create StackInstance Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new StackInstance(name: string, args: StackInstanceArgs, opts?: CustomResourceOptions);
@overload
def StackInstance(resource_name: str,
args: StackInstanceArgs,
opts: Optional[ResourceOptions] = None)
@overload
def StackInstance(resource_name: str,
opts: Optional[ResourceOptions] = None,
stack_group_name: Optional[str] = None,
stack_instance_account_id: Optional[str] = None,
stack_instance_region_id: Optional[str] = None,
operation_description: Optional[str] = None,
operation_preferences: Optional[str] = None,
parameter_overrides: Optional[Sequence[StackInstanceParameterOverrideArgs]] = None,
retain_stacks: Optional[bool] = None,
timeout_in_minutes: Optional[str] = None)
func NewStackInstance(ctx *Context, name string, args StackInstanceArgs, opts ...ResourceOption) (*StackInstance, error)
public StackInstance(string name, StackInstanceArgs args, CustomResourceOptions? opts = null)
public StackInstance(String name, StackInstanceArgs args)
public StackInstance(String name, StackInstanceArgs args, CustomResourceOptions options)
type: alicloud:ros:StackInstance
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args StackInstanceArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args StackInstanceArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args StackInstanceArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args StackInstanceArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args StackInstanceArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var stackInstanceResource = new AliCloud.Ros.StackInstance("stackInstanceResource", new()
{
StackGroupName = "string",
StackInstanceAccountId = "string",
StackInstanceRegionId = "string",
OperationDescription = "string",
OperationPreferences = "string",
ParameterOverrides = new[]
{
new AliCloud.Ros.Inputs.StackInstanceParameterOverrideArgs
{
ParameterKey = "string",
ParameterValue = "string",
},
},
RetainStacks = false,
TimeoutInMinutes = "string",
});
example, err := ros.NewStackInstance(ctx, "stackInstanceResource", &ros.StackInstanceArgs{
StackGroupName: pulumi.String("string"),
StackInstanceAccountId: pulumi.String("string"),
StackInstanceRegionId: pulumi.String("string"),
OperationDescription: pulumi.String("string"),
OperationPreferences: pulumi.String("string"),
ParameterOverrides: ros.StackInstanceParameterOverrideArray{
&ros.StackInstanceParameterOverrideArgs{
ParameterKey: pulumi.String("string"),
ParameterValue: pulumi.String("string"),
},
},
RetainStacks: pulumi.Bool(false),
TimeoutInMinutes: pulumi.String("string"),
})
var stackInstanceResource = new StackInstance("stackInstanceResource", StackInstanceArgs.builder()
.stackGroupName("string")
.stackInstanceAccountId("string")
.stackInstanceRegionId("string")
.operationDescription("string")
.operationPreferences("string")
.parameterOverrides(StackInstanceParameterOverrideArgs.builder()
.parameterKey("string")
.parameterValue("string")
.build())
.retainStacks(false)
.timeoutInMinutes("string")
.build());
stack_instance_resource = alicloud.ros.StackInstance("stackInstanceResource",
stack_group_name="string",
stack_instance_account_id="string",
stack_instance_region_id="string",
operation_description="string",
operation_preferences="string",
parameter_overrides=[{
"parameter_key": "string",
"parameter_value": "string",
}],
retain_stacks=False,
timeout_in_minutes="string")
const stackInstanceResource = new alicloud.ros.StackInstance("stackInstanceResource", {
stackGroupName: "string",
stackInstanceAccountId: "string",
stackInstanceRegionId: "string",
operationDescription: "string",
operationPreferences: "string",
parameterOverrides: [{
parameterKey: "string",
parameterValue: "string",
}],
retainStacks: false,
timeoutInMinutes: "string",
});
type: alicloud:ros:StackInstance
properties:
operationDescription: string
operationPreferences: string
parameterOverrides:
- parameterKey: string
parameterValue: string
retainStacks: false
stackGroupName: string
stackInstanceAccountId: string
stackInstanceRegionId: string
timeoutInMinutes: string
StackInstance Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The StackInstance resource accepts the following input properties:
- Stack
Group stringName - The name of the stack group.
- Stack
Instance stringAccount Id - The account to which the stack instance belongs.
- Stack
Instance stringRegion Id - The region of the stack instance.
- Operation
Description string - The operation description.
- Operation
Preferences string - The operation preferences. The operation settings. The following fields are supported:
FailureToleranceCount
The maximum number of stack group operation failures that can occur. In a stack group operation, if the total number of failures does not exceed the FailureToleranceCount value, the operation succeeds. Otherwise, the operation fails. If the FailureToleranceCount parameter is not specified, the default value 0 is used. You cannot specify both FailureToleranceCount and FailureTolerancePercentage. Valid values:0
to20
.FailureTolerancePercentage
: The percentage of stack group operation failures that can occur. In a stack group operation, if the percentage of failures does not exceed the FailureTolerancePercentage value, the operation succeeds. Otherwise, the operation fails. You cannot specify both FailureToleranceCount and FailureTolerancePercentage. Valid values:0
to100
.MaxConcurrentCount
: The maximum number of accounts within which to perform this operation at one time. You cannot specify both MaxConcurrentCount and MaxConcurrentPercentage. Valid values:1
to20
.MaxConcurrentPercentage
: The maximum percentage of accounts within which to perform this operation at one time. You cannot specify both MaxConcurrentCount and MaxConcurrentPercentage. Valid values:1
to100
- Parameter
Overrides List<Pulumi.Ali Cloud. Ros. Inputs. Stack Instance Parameter Override> - ParameterOverrides. See the following
Block parameter_overrides
. - Retain
Stacks bool - Specifies whether to retain the stack corresponding to the stack instance.Default value
false
. NOTE: Whenretain_stacks
istrue
, the stack is retained. If the stack is retained, the corresponding stack is not deleted when the stack instance is deleted from the stack group. - Timeout
In stringMinutes - The timeout period that is specified for the stack creation request. Default value:
60
. Unit:minutes
.
- Stack
Group stringName - The name of the stack group.
- Stack
Instance stringAccount Id - The account to which the stack instance belongs.
- Stack
Instance stringRegion Id - The region of the stack instance.
- Operation
Description string - The operation description.
- Operation
Preferences string - The operation preferences. The operation settings. The following fields are supported:
FailureToleranceCount
The maximum number of stack group operation failures that can occur. In a stack group operation, if the total number of failures does not exceed the FailureToleranceCount value, the operation succeeds. Otherwise, the operation fails. If the FailureToleranceCount parameter is not specified, the default value 0 is used. You cannot specify both FailureToleranceCount and FailureTolerancePercentage. Valid values:0
to20
.FailureTolerancePercentage
: The percentage of stack group operation failures that can occur. In a stack group operation, if the percentage of failures does not exceed the FailureTolerancePercentage value, the operation succeeds. Otherwise, the operation fails. You cannot specify both FailureToleranceCount and FailureTolerancePercentage. Valid values:0
to100
.MaxConcurrentCount
: The maximum number of accounts within which to perform this operation at one time. You cannot specify both MaxConcurrentCount and MaxConcurrentPercentage. Valid values:1
to20
.MaxConcurrentPercentage
: The maximum percentage of accounts within which to perform this operation at one time. You cannot specify both MaxConcurrentCount and MaxConcurrentPercentage. Valid values:1
to100
- Parameter
Overrides []StackInstance Parameter Override Args - ParameterOverrides. See the following
Block parameter_overrides
. - Retain
Stacks bool - Specifies whether to retain the stack corresponding to the stack instance.Default value
false
. NOTE: Whenretain_stacks
istrue
, the stack is retained. If the stack is retained, the corresponding stack is not deleted when the stack instance is deleted from the stack group. - Timeout
In stringMinutes - The timeout period that is specified for the stack creation request. Default value:
60
. Unit:minutes
.
- stack
Group StringName - The name of the stack group.
- stack
Instance StringAccount Id - The account to which the stack instance belongs.
- stack
Instance StringRegion Id - The region of the stack instance.
- operation
Description String - The operation description.
- operation
Preferences String - The operation preferences. The operation settings. The following fields are supported:
FailureToleranceCount
The maximum number of stack group operation failures that can occur. In a stack group operation, if the total number of failures does not exceed the FailureToleranceCount value, the operation succeeds. Otherwise, the operation fails. If the FailureToleranceCount parameter is not specified, the default value 0 is used. You cannot specify both FailureToleranceCount and FailureTolerancePercentage. Valid values:0
to20
.FailureTolerancePercentage
: The percentage of stack group operation failures that can occur. In a stack group operation, if the percentage of failures does not exceed the FailureTolerancePercentage value, the operation succeeds. Otherwise, the operation fails. You cannot specify both FailureToleranceCount and FailureTolerancePercentage. Valid values:0
to100
.MaxConcurrentCount
: The maximum number of accounts within which to perform this operation at one time. You cannot specify both MaxConcurrentCount and MaxConcurrentPercentage. Valid values:1
to20
.MaxConcurrentPercentage
: The maximum percentage of accounts within which to perform this operation at one time. You cannot specify both MaxConcurrentCount and MaxConcurrentPercentage. Valid values:1
to100
- parameter
Overrides List<StackInstance Parameter Override> - ParameterOverrides. See the following
Block parameter_overrides
. - retain
Stacks Boolean - Specifies whether to retain the stack corresponding to the stack instance.Default value
false
. NOTE: Whenretain_stacks
istrue
, the stack is retained. If the stack is retained, the corresponding stack is not deleted when the stack instance is deleted from the stack group. - timeout
In StringMinutes - The timeout period that is specified for the stack creation request. Default value:
60
. Unit:minutes
.
- stack
Group stringName - The name of the stack group.
- stack
Instance stringAccount Id - The account to which the stack instance belongs.
- stack
Instance stringRegion Id - The region of the stack instance.
- operation
Description string - The operation description.
- operation
Preferences string - The operation preferences. The operation settings. The following fields are supported:
FailureToleranceCount
The maximum number of stack group operation failures that can occur. In a stack group operation, if the total number of failures does not exceed the FailureToleranceCount value, the operation succeeds. Otherwise, the operation fails. If the FailureToleranceCount parameter is not specified, the default value 0 is used. You cannot specify both FailureToleranceCount and FailureTolerancePercentage. Valid values:0
to20
.FailureTolerancePercentage
: The percentage of stack group operation failures that can occur. In a stack group operation, if the percentage of failures does not exceed the FailureTolerancePercentage value, the operation succeeds. Otherwise, the operation fails. You cannot specify both FailureToleranceCount and FailureTolerancePercentage. Valid values:0
to100
.MaxConcurrentCount
: The maximum number of accounts within which to perform this operation at one time. You cannot specify both MaxConcurrentCount and MaxConcurrentPercentage. Valid values:1
to20
.MaxConcurrentPercentage
: The maximum percentage of accounts within which to perform this operation at one time. You cannot specify both MaxConcurrentCount and MaxConcurrentPercentage. Valid values:1
to100
- parameter
Overrides StackInstance Parameter Override[] - ParameterOverrides. See the following
Block parameter_overrides
. - retain
Stacks boolean - Specifies whether to retain the stack corresponding to the stack instance.Default value
false
. NOTE: Whenretain_stacks
istrue
, the stack is retained. If the stack is retained, the corresponding stack is not deleted when the stack instance is deleted from the stack group. - timeout
In stringMinutes - The timeout period that is specified for the stack creation request. Default value:
60
. Unit:minutes
.
- stack_
group_ strname - The name of the stack group.
- stack_
instance_ straccount_ id - The account to which the stack instance belongs.
- stack_
instance_ strregion_ id - The region of the stack instance.
- operation_
description str - The operation description.
- operation_
preferences str - The operation preferences. The operation settings. The following fields are supported:
FailureToleranceCount
The maximum number of stack group operation failures that can occur. In a stack group operation, if the total number of failures does not exceed the FailureToleranceCount value, the operation succeeds. Otherwise, the operation fails. If the FailureToleranceCount parameter is not specified, the default value 0 is used. You cannot specify both FailureToleranceCount and FailureTolerancePercentage. Valid values:0
to20
.FailureTolerancePercentage
: The percentage of stack group operation failures that can occur. In a stack group operation, if the percentage of failures does not exceed the FailureTolerancePercentage value, the operation succeeds. Otherwise, the operation fails. You cannot specify both FailureToleranceCount and FailureTolerancePercentage. Valid values:0
to100
.MaxConcurrentCount
: The maximum number of accounts within which to perform this operation at one time. You cannot specify both MaxConcurrentCount and MaxConcurrentPercentage. Valid values:1
to20
.MaxConcurrentPercentage
: The maximum percentage of accounts within which to perform this operation at one time. You cannot specify both MaxConcurrentCount and MaxConcurrentPercentage. Valid values:1
to100
- parameter_
overrides Sequence[StackInstance Parameter Override Args] - ParameterOverrides. See the following
Block parameter_overrides
. - retain_
stacks bool - Specifies whether to retain the stack corresponding to the stack instance.Default value
false
. NOTE: Whenretain_stacks
istrue
, the stack is retained. If the stack is retained, the corresponding stack is not deleted when the stack instance is deleted from the stack group. - timeout_
in_ strminutes - The timeout period that is specified for the stack creation request. Default value:
60
. Unit:minutes
.
- stack
Group StringName - The name of the stack group.
- stack
Instance StringAccount Id - The account to which the stack instance belongs.
- stack
Instance StringRegion Id - The region of the stack instance.
- operation
Description String - The operation description.
- operation
Preferences String - The operation preferences. The operation settings. The following fields are supported:
FailureToleranceCount
The maximum number of stack group operation failures that can occur. In a stack group operation, if the total number of failures does not exceed the FailureToleranceCount value, the operation succeeds. Otherwise, the operation fails. If the FailureToleranceCount parameter is not specified, the default value 0 is used. You cannot specify both FailureToleranceCount and FailureTolerancePercentage. Valid values:0
to20
.FailureTolerancePercentage
: The percentage of stack group operation failures that can occur. In a stack group operation, if the percentage of failures does not exceed the FailureTolerancePercentage value, the operation succeeds. Otherwise, the operation fails. You cannot specify both FailureToleranceCount and FailureTolerancePercentage. Valid values:0
to100
.MaxConcurrentCount
: The maximum number of accounts within which to perform this operation at one time. You cannot specify both MaxConcurrentCount and MaxConcurrentPercentage. Valid values:1
to20
.MaxConcurrentPercentage
: The maximum percentage of accounts within which to perform this operation at one time. You cannot specify both MaxConcurrentCount and MaxConcurrentPercentage. Valid values:1
to100
- parameter
Overrides List<Property Map> - ParameterOverrides. See the following
Block parameter_overrides
. - retain
Stacks Boolean - Specifies whether to retain the stack corresponding to the stack instance.Default value
false
. NOTE: Whenretain_stacks
istrue
, the stack is retained. If the stack is retained, the corresponding stack is not deleted when the stack instance is deleted from the stack group. - timeout
In StringMinutes - The timeout period that is specified for the stack creation request. Default value:
60
. Unit:minutes
.
Outputs
All input properties are implicitly available as output properties. Additionally, the StackInstance resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Status string
- The status of the stack instance. Valid values:
CURRENT
orOUTDATED
.CURRENT
: The stack corresponding to the stack instance is up to date with the stack group.OUTDATED
: The stack corresponding to the stack instance is not up to date with the stack group. TheOUTDATED
state has the following possible causes:- When the CreateStackInstances operation is called to create stack instances, the corresponding stacks fail to be created.
- When the UpdateStackInstances or UpdateStackGroup operation is called to update stack instances, the corresponding stacks fail to be updated, or only some of the stack instances are updated.
- The create or update operation is not complete.
- Id string
- The provider-assigned unique ID for this managed resource.
- Status string
- The status of the stack instance. Valid values:
CURRENT
orOUTDATED
.CURRENT
: The stack corresponding to the stack instance is up to date with the stack group.OUTDATED
: The stack corresponding to the stack instance is not up to date with the stack group. TheOUTDATED
state has the following possible causes:- When the CreateStackInstances operation is called to create stack instances, the corresponding stacks fail to be created.
- When the UpdateStackInstances or UpdateStackGroup operation is called to update stack instances, the corresponding stacks fail to be updated, or only some of the stack instances are updated.
- The create or update operation is not complete.
- id String
- The provider-assigned unique ID for this managed resource.
- status String
- The status of the stack instance. Valid values:
CURRENT
orOUTDATED
.CURRENT
: The stack corresponding to the stack instance is up to date with the stack group.OUTDATED
: The stack corresponding to the stack instance is not up to date with the stack group. TheOUTDATED
state has the following possible causes:- When the CreateStackInstances operation is called to create stack instances, the corresponding stacks fail to be created.
- When the UpdateStackInstances or UpdateStackGroup operation is called to update stack instances, the corresponding stacks fail to be updated, or only some of the stack instances are updated.
- The create or update operation is not complete.
- id string
- The provider-assigned unique ID for this managed resource.
- status string
- The status of the stack instance. Valid values:
CURRENT
orOUTDATED
.CURRENT
: The stack corresponding to the stack instance is up to date with the stack group.OUTDATED
: The stack corresponding to the stack instance is not up to date with the stack group. TheOUTDATED
state has the following possible causes:- When the CreateStackInstances operation is called to create stack instances, the corresponding stacks fail to be created.
- When the UpdateStackInstances or UpdateStackGroup operation is called to update stack instances, the corresponding stacks fail to be updated, or only some of the stack instances are updated.
- The create or update operation is not complete.
- id str
- The provider-assigned unique ID for this managed resource.
- status str
- The status of the stack instance. Valid values:
CURRENT
orOUTDATED
.CURRENT
: The stack corresponding to the stack instance is up to date with the stack group.OUTDATED
: The stack corresponding to the stack instance is not up to date with the stack group. TheOUTDATED
state has the following possible causes:- When the CreateStackInstances operation is called to create stack instances, the corresponding stacks fail to be created.
- When the UpdateStackInstances or UpdateStackGroup operation is called to update stack instances, the corresponding stacks fail to be updated, or only some of the stack instances are updated.
- The create or update operation is not complete.
- id String
- The provider-assigned unique ID for this managed resource.
- status String
- The status of the stack instance. Valid values:
CURRENT
orOUTDATED
.CURRENT
: The stack corresponding to the stack instance is up to date with the stack group.OUTDATED
: The stack corresponding to the stack instance is not up to date with the stack group. TheOUTDATED
state has the following possible causes:- When the CreateStackInstances operation is called to create stack instances, the corresponding stacks fail to be created.
- When the UpdateStackInstances or UpdateStackGroup operation is called to update stack instances, the corresponding stacks fail to be updated, or only some of the stack instances are updated.
- The create or update operation is not complete.
Look up Existing StackInstance Resource
Get an existing StackInstance resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: StackInstanceState, opts?: CustomResourceOptions): StackInstance
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
operation_description: Optional[str] = None,
operation_preferences: Optional[str] = None,
parameter_overrides: Optional[Sequence[StackInstanceParameterOverrideArgs]] = None,
retain_stacks: Optional[bool] = None,
stack_group_name: Optional[str] = None,
stack_instance_account_id: Optional[str] = None,
stack_instance_region_id: Optional[str] = None,
status: Optional[str] = None,
timeout_in_minutes: Optional[str] = None) -> StackInstance
func GetStackInstance(ctx *Context, name string, id IDInput, state *StackInstanceState, opts ...ResourceOption) (*StackInstance, error)
public static StackInstance Get(string name, Input<string> id, StackInstanceState? state, CustomResourceOptions? opts = null)
public static StackInstance get(String name, Output<String> id, StackInstanceState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Operation
Description string - The operation description.
- Operation
Preferences string - The operation preferences. The operation settings. The following fields are supported:
FailureToleranceCount
The maximum number of stack group operation failures that can occur. In a stack group operation, if the total number of failures does not exceed the FailureToleranceCount value, the operation succeeds. Otherwise, the operation fails. If the FailureToleranceCount parameter is not specified, the default value 0 is used. You cannot specify both FailureToleranceCount and FailureTolerancePercentage. Valid values:0
to20
.FailureTolerancePercentage
: The percentage of stack group operation failures that can occur. In a stack group operation, if the percentage of failures does not exceed the FailureTolerancePercentage value, the operation succeeds. Otherwise, the operation fails. You cannot specify both FailureToleranceCount and FailureTolerancePercentage. Valid values:0
to100
.MaxConcurrentCount
: The maximum number of accounts within which to perform this operation at one time. You cannot specify both MaxConcurrentCount and MaxConcurrentPercentage. Valid values:1
to20
.MaxConcurrentPercentage
: The maximum percentage of accounts within which to perform this operation at one time. You cannot specify both MaxConcurrentCount and MaxConcurrentPercentage. Valid values:1
to100
- Parameter
Overrides List<Pulumi.Ali Cloud. Ros. Inputs. Stack Instance Parameter Override> - ParameterOverrides. See the following
Block parameter_overrides
. - Retain
Stacks bool - Specifies whether to retain the stack corresponding to the stack instance.Default value
false
. NOTE: Whenretain_stacks
istrue
, the stack is retained. If the stack is retained, the corresponding stack is not deleted when the stack instance is deleted from the stack group. - Stack
Group stringName - The name of the stack group.
- Stack
Instance stringAccount Id - The account to which the stack instance belongs.
- Stack
Instance stringRegion Id - The region of the stack instance.
- Status string
- The status of the stack instance. Valid values:
CURRENT
orOUTDATED
.CURRENT
: The stack corresponding to the stack instance is up to date with the stack group.OUTDATED
: The stack corresponding to the stack instance is not up to date with the stack group. TheOUTDATED
state has the following possible causes:- When the CreateStackInstances operation is called to create stack instances, the corresponding stacks fail to be created.
- When the UpdateStackInstances or UpdateStackGroup operation is called to update stack instances, the corresponding stacks fail to be updated, or only some of the stack instances are updated.
- The create or update operation is not complete.
- Timeout
In stringMinutes - The timeout period that is specified for the stack creation request. Default value:
60
. Unit:minutes
.
- Operation
Description string - The operation description.
- Operation
Preferences string - The operation preferences. The operation settings. The following fields are supported:
FailureToleranceCount
The maximum number of stack group operation failures that can occur. In a stack group operation, if the total number of failures does not exceed the FailureToleranceCount value, the operation succeeds. Otherwise, the operation fails. If the FailureToleranceCount parameter is not specified, the default value 0 is used. You cannot specify both FailureToleranceCount and FailureTolerancePercentage. Valid values:0
to20
.FailureTolerancePercentage
: The percentage of stack group operation failures that can occur. In a stack group operation, if the percentage of failures does not exceed the FailureTolerancePercentage value, the operation succeeds. Otherwise, the operation fails. You cannot specify both FailureToleranceCount and FailureTolerancePercentage. Valid values:0
to100
.MaxConcurrentCount
: The maximum number of accounts within which to perform this operation at one time. You cannot specify both MaxConcurrentCount and MaxConcurrentPercentage. Valid values:1
to20
.MaxConcurrentPercentage
: The maximum percentage of accounts within which to perform this operation at one time. You cannot specify both MaxConcurrentCount and MaxConcurrentPercentage. Valid values:1
to100
- Parameter
Overrides []StackInstance Parameter Override Args - ParameterOverrides. See the following
Block parameter_overrides
. - Retain
Stacks bool - Specifies whether to retain the stack corresponding to the stack instance.Default value
false
. NOTE: Whenretain_stacks
istrue
, the stack is retained. If the stack is retained, the corresponding stack is not deleted when the stack instance is deleted from the stack group. - Stack
Group stringName - The name of the stack group.
- Stack
Instance stringAccount Id - The account to which the stack instance belongs.
- Stack
Instance stringRegion Id - The region of the stack instance.
- Status string
- The status of the stack instance. Valid values:
CURRENT
orOUTDATED
.CURRENT
: The stack corresponding to the stack instance is up to date with the stack group.OUTDATED
: The stack corresponding to the stack instance is not up to date with the stack group. TheOUTDATED
state has the following possible causes:- When the CreateStackInstances operation is called to create stack instances, the corresponding stacks fail to be created.
- When the UpdateStackInstances or UpdateStackGroup operation is called to update stack instances, the corresponding stacks fail to be updated, or only some of the stack instances are updated.
- The create or update operation is not complete.
- Timeout
In stringMinutes - The timeout period that is specified for the stack creation request. Default value:
60
. Unit:minutes
.
- operation
Description String - The operation description.
- operation
Preferences String - The operation preferences. The operation settings. The following fields are supported:
FailureToleranceCount
The maximum number of stack group operation failures that can occur. In a stack group operation, if the total number of failures does not exceed the FailureToleranceCount value, the operation succeeds. Otherwise, the operation fails. If the FailureToleranceCount parameter is not specified, the default value 0 is used. You cannot specify both FailureToleranceCount and FailureTolerancePercentage. Valid values:0
to20
.FailureTolerancePercentage
: The percentage of stack group operation failures that can occur. In a stack group operation, if the percentage of failures does not exceed the FailureTolerancePercentage value, the operation succeeds. Otherwise, the operation fails. You cannot specify both FailureToleranceCount and FailureTolerancePercentage. Valid values:0
to100
.MaxConcurrentCount
: The maximum number of accounts within which to perform this operation at one time. You cannot specify both MaxConcurrentCount and MaxConcurrentPercentage. Valid values:1
to20
.MaxConcurrentPercentage
: The maximum percentage of accounts within which to perform this operation at one time. You cannot specify both MaxConcurrentCount and MaxConcurrentPercentage. Valid values:1
to100
- parameter
Overrides List<StackInstance Parameter Override> - ParameterOverrides. See the following
Block parameter_overrides
. - retain
Stacks Boolean - Specifies whether to retain the stack corresponding to the stack instance.Default value
false
. NOTE: Whenretain_stacks
istrue
, the stack is retained. If the stack is retained, the corresponding stack is not deleted when the stack instance is deleted from the stack group. - stack
Group StringName - The name of the stack group.
- stack
Instance StringAccount Id - The account to which the stack instance belongs.
- stack
Instance StringRegion Id - The region of the stack instance.
- status String
- The status of the stack instance. Valid values:
CURRENT
orOUTDATED
.CURRENT
: The stack corresponding to the stack instance is up to date with the stack group.OUTDATED
: The stack corresponding to the stack instance is not up to date with the stack group. TheOUTDATED
state has the following possible causes:- When the CreateStackInstances operation is called to create stack instances, the corresponding stacks fail to be created.
- When the UpdateStackInstances or UpdateStackGroup operation is called to update stack instances, the corresponding stacks fail to be updated, or only some of the stack instances are updated.
- The create or update operation is not complete.
- timeout
In StringMinutes - The timeout period that is specified for the stack creation request. Default value:
60
. Unit:minutes
.
- operation
Description string - The operation description.
- operation
Preferences string - The operation preferences. The operation settings. The following fields are supported:
FailureToleranceCount
The maximum number of stack group operation failures that can occur. In a stack group operation, if the total number of failures does not exceed the FailureToleranceCount value, the operation succeeds. Otherwise, the operation fails. If the FailureToleranceCount parameter is not specified, the default value 0 is used. You cannot specify both FailureToleranceCount and FailureTolerancePercentage. Valid values:0
to20
.FailureTolerancePercentage
: The percentage of stack group operation failures that can occur. In a stack group operation, if the percentage of failures does not exceed the FailureTolerancePercentage value, the operation succeeds. Otherwise, the operation fails. You cannot specify both FailureToleranceCount and FailureTolerancePercentage. Valid values:0
to100
.MaxConcurrentCount
: The maximum number of accounts within which to perform this operation at one time. You cannot specify both MaxConcurrentCount and MaxConcurrentPercentage. Valid values:1
to20
.MaxConcurrentPercentage
: The maximum percentage of accounts within which to perform this operation at one time. You cannot specify both MaxConcurrentCount and MaxConcurrentPercentage. Valid values:1
to100
- parameter
Overrides StackInstance Parameter Override[] - ParameterOverrides. See the following
Block parameter_overrides
. - retain
Stacks boolean - Specifies whether to retain the stack corresponding to the stack instance.Default value
false
. NOTE: Whenretain_stacks
istrue
, the stack is retained. If the stack is retained, the corresponding stack is not deleted when the stack instance is deleted from the stack group. - stack
Group stringName - The name of the stack group.
- stack
Instance stringAccount Id - The account to which the stack instance belongs.
- stack
Instance stringRegion Id - The region of the stack instance.
- status string
- The status of the stack instance. Valid values:
CURRENT
orOUTDATED
.CURRENT
: The stack corresponding to the stack instance is up to date with the stack group.OUTDATED
: The stack corresponding to the stack instance is not up to date with the stack group. TheOUTDATED
state has the following possible causes:- When the CreateStackInstances operation is called to create stack instances, the corresponding stacks fail to be created.
- When the UpdateStackInstances or UpdateStackGroup operation is called to update stack instances, the corresponding stacks fail to be updated, or only some of the stack instances are updated.
- The create or update operation is not complete.
- timeout
In stringMinutes - The timeout period that is specified for the stack creation request. Default value:
60
. Unit:minutes
.
- operation_
description str - The operation description.
- operation_
preferences str - The operation preferences. The operation settings. The following fields are supported:
FailureToleranceCount
The maximum number of stack group operation failures that can occur. In a stack group operation, if the total number of failures does not exceed the FailureToleranceCount value, the operation succeeds. Otherwise, the operation fails. If the FailureToleranceCount parameter is not specified, the default value 0 is used. You cannot specify both FailureToleranceCount and FailureTolerancePercentage. Valid values:0
to20
.FailureTolerancePercentage
: The percentage of stack group operation failures that can occur. In a stack group operation, if the percentage of failures does not exceed the FailureTolerancePercentage value, the operation succeeds. Otherwise, the operation fails. You cannot specify both FailureToleranceCount and FailureTolerancePercentage. Valid values:0
to100
.MaxConcurrentCount
: The maximum number of accounts within which to perform this operation at one time. You cannot specify both MaxConcurrentCount and MaxConcurrentPercentage. Valid values:1
to20
.MaxConcurrentPercentage
: The maximum percentage of accounts within which to perform this operation at one time. You cannot specify both MaxConcurrentCount and MaxConcurrentPercentage. Valid values:1
to100
- parameter_
overrides Sequence[StackInstance Parameter Override Args] - ParameterOverrides. See the following
Block parameter_overrides
. - retain_
stacks bool - Specifies whether to retain the stack corresponding to the stack instance.Default value
false
. NOTE: Whenretain_stacks
istrue
, the stack is retained. If the stack is retained, the corresponding stack is not deleted when the stack instance is deleted from the stack group. - stack_
group_ strname - The name of the stack group.
- stack_
instance_ straccount_ id - The account to which the stack instance belongs.
- stack_
instance_ strregion_ id - The region of the stack instance.
- status str
- The status of the stack instance. Valid values:
CURRENT
orOUTDATED
.CURRENT
: The stack corresponding to the stack instance is up to date with the stack group.OUTDATED
: The stack corresponding to the stack instance is not up to date with the stack group. TheOUTDATED
state has the following possible causes:- When the CreateStackInstances operation is called to create stack instances, the corresponding stacks fail to be created.
- When the UpdateStackInstances or UpdateStackGroup operation is called to update stack instances, the corresponding stacks fail to be updated, or only some of the stack instances are updated.
- The create or update operation is not complete.
- timeout_
in_ strminutes - The timeout period that is specified for the stack creation request. Default value:
60
. Unit:minutes
.
- operation
Description String - The operation description.
- operation
Preferences String - The operation preferences. The operation settings. The following fields are supported:
FailureToleranceCount
The maximum number of stack group operation failures that can occur. In a stack group operation, if the total number of failures does not exceed the FailureToleranceCount value, the operation succeeds. Otherwise, the operation fails. If the FailureToleranceCount parameter is not specified, the default value 0 is used. You cannot specify both FailureToleranceCount and FailureTolerancePercentage. Valid values:0
to20
.FailureTolerancePercentage
: The percentage of stack group operation failures that can occur. In a stack group operation, if the percentage of failures does not exceed the FailureTolerancePercentage value, the operation succeeds. Otherwise, the operation fails. You cannot specify both FailureToleranceCount and FailureTolerancePercentage. Valid values:0
to100
.MaxConcurrentCount
: The maximum number of accounts within which to perform this operation at one time. You cannot specify both MaxConcurrentCount and MaxConcurrentPercentage. Valid values:1
to20
.MaxConcurrentPercentage
: The maximum percentage of accounts within which to perform this operation at one time. You cannot specify both MaxConcurrentCount and MaxConcurrentPercentage. Valid values:1
to100
- parameter
Overrides List<Property Map> - ParameterOverrides. See the following
Block parameter_overrides
. - retain
Stacks Boolean - Specifies whether to retain the stack corresponding to the stack instance.Default value
false
. NOTE: Whenretain_stacks
istrue
, the stack is retained. If the stack is retained, the corresponding stack is not deleted when the stack instance is deleted from the stack group. - stack
Group StringName - The name of the stack group.
- stack
Instance StringAccount Id - The account to which the stack instance belongs.
- stack
Instance StringRegion Id - The region of the stack instance.
- status String
- The status of the stack instance. Valid values:
CURRENT
orOUTDATED
.CURRENT
: The stack corresponding to the stack instance is up to date with the stack group.OUTDATED
: The stack corresponding to the stack instance is not up to date with the stack group. TheOUTDATED
state has the following possible causes:- When the CreateStackInstances operation is called to create stack instances, the corresponding stacks fail to be created.
- When the UpdateStackInstances or UpdateStackGroup operation is called to update stack instances, the corresponding stacks fail to be updated, or only some of the stack instances are updated.
- The create or update operation is not complete.
- timeout
In StringMinutes - The timeout period that is specified for the stack creation request. Default value:
60
. Unit:minutes
.
Supporting Types
StackInstanceParameterOverride, StackInstanceParameterOverrideArgs
- Parameter
Key string - The key of override parameter. If you do not specify the key and value of the parameter, ROS uses the key and value that you specified when you created the stack group.
- Parameter
Value string - The value of override parameter. If you do not specify the key and value of the parameter, ROS uses the key and value that you specified when you created the stack group.
- Parameter
Key string - The key of override parameter. If you do not specify the key and value of the parameter, ROS uses the key and value that you specified when you created the stack group.
- Parameter
Value string - The value of override parameter. If you do not specify the key and value of the parameter, ROS uses the key and value that you specified when you created the stack group.
- parameter
Key String - The key of override parameter. If you do not specify the key and value of the parameter, ROS uses the key and value that you specified when you created the stack group.
- parameter
Value String - The value of override parameter. If you do not specify the key and value of the parameter, ROS uses the key and value that you specified when you created the stack group.
- parameter
Key string - The key of override parameter. If you do not specify the key and value of the parameter, ROS uses the key and value that you specified when you created the stack group.
- parameter
Value string - The value of override parameter. If you do not specify the key and value of the parameter, ROS uses the key and value that you specified when you created the stack group.
- parameter_
key str - The key of override parameter. If you do not specify the key and value of the parameter, ROS uses the key and value that you specified when you created the stack group.
- parameter_
value str - The value of override parameter. If you do not specify the key and value of the parameter, ROS uses the key and value that you specified when you created the stack group.
- parameter
Key String - The key of override parameter. If you do not specify the key and value of the parameter, ROS uses the key and value that you specified when you created the stack group.
- parameter
Value String - The value of override parameter. If you do not specify the key and value of the parameter, ROS uses the key and value that you specified when you created the stack group.
Import
ROS Stack Instance can be imported using the id, e.g.
$ pulumi import alicloud:ros/stackInstance:StackInstance example <stack_group_name>:<stack_instance_account_id>:<stack_instance_region_id>
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Alibaba Cloud pulumi/pulumi-alicloud
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
alicloud
Terraform Provider.