alicloud.ros.ChangeSet
Explore with Pulumi AI
Provides a ROS Change Set resource.
For information about ROS Change Set and how to use it, see What is Change Set.
NOTE: Available in v1.105.0+.
Example Usage
Basic Usage
import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";
import * as random from "@pulumi/random";
const _default = new random.index.Integer("default", {
min: 10000,
max: 99999,
});
const example = new alicloud.ros.ChangeSet("example", {
changeSetName: "example_value",
stackName: `tf-example-${_default.result}`,
changeSetType: "CREATE",
description: "Test From Terraform",
templateBody: "{\"ROSTemplateFormatVersion\":\"2015-09-01\"}",
});
import pulumi
import pulumi_alicloud as alicloud
import pulumi_random as random
default = random.index.Integer("default",
min=10000,
max=99999)
example = alicloud.ros.ChangeSet("example",
change_set_name="example_value",
stack_name=f"tf-example-{default['result']}",
change_set_type="CREATE",
description="Test From Terraform",
template_body="{\"ROSTemplateFormatVersion\":\"2015-09-01\"}")
package main
import (
"fmt"
"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/ros"
"github.com/pulumi/pulumi-random/sdk/v4/go/random"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := random.NewInteger(ctx, "default", &random.IntegerArgs{
Min: 10000,
Max: 99999,
})
if err != nil {
return err
}
_, err = ros.NewChangeSet(ctx, "example", &ros.ChangeSetArgs{
ChangeSetName: pulumi.String("example_value"),
StackName: pulumi.Sprintf("tf-example-%v", _default.Result),
ChangeSetType: pulumi.String("CREATE"),
Description: pulumi.String("Test From Terraform"),
TemplateBody: pulumi.String("{\"ROSTemplateFormatVersion\":\"2015-09-01\"}"),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AliCloud = Pulumi.AliCloud;
using Random = Pulumi.Random;
return await Deployment.RunAsync(() =>
{
var @default = new Random.Index.Integer("default", new()
{
Min = 10000,
Max = 99999,
});
var example = new AliCloud.Ros.ChangeSet("example", new()
{
ChangeSetName = "example_value",
StackName = $"tf-example-{@default.Result}",
ChangeSetType = "CREATE",
Description = "Test From Terraform",
TemplateBody = "{\"ROSTemplateFormatVersion\":\"2015-09-01\"}",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.random.integer;
import com.pulumi.random.IntegerArgs;
import com.pulumi.alicloud.ros.ChangeSet;
import com.pulumi.alicloud.ros.ChangeSetArgs;
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) {
var default_ = new Integer("default", IntegerArgs.builder()
.min(10000)
.max(99999)
.build());
var example = new ChangeSet("example", ChangeSetArgs.builder()
.changeSetName("example_value")
.stackName(String.format("tf-example-%s", default_.result()))
.changeSetType("CREATE")
.description("Test From Terraform")
.templateBody("{\"ROSTemplateFormatVersion\":\"2015-09-01\"}")
.build());
}
}
resources:
default:
type: random:integer
properties:
min: 10000
max: 99999
example:
type: alicloud:ros:ChangeSet
properties:
changeSetName: example_value
stackName: tf-example-${default.result}
changeSetType: CREATE
description: Test From Terraform
templateBody: '{"ROSTemplateFormatVersion":"2015-09-01"}'
Create ChangeSet Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ChangeSet(name: string, args: ChangeSetArgs, opts?: CustomResourceOptions);
@overload
def ChangeSet(resource_name: str,
args: ChangeSetArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ChangeSet(resource_name: str,
opts: Optional[ResourceOptions] = None,
change_set_name: Optional[str] = None,
change_set_type: Optional[str] = None,
description: Optional[str] = None,
disable_rollback: Optional[bool] = None,
notification_urls: Optional[Sequence[str]] = None,
parameters: Optional[Sequence[ChangeSetParameterArgs]] = None,
ram_role_name: Optional[str] = None,
replacement_option: Optional[str] = None,
stack_id: Optional[str] = None,
stack_name: Optional[str] = None,
stack_policy_body: Optional[str] = None,
stack_policy_during_update_body: Optional[str] = None,
stack_policy_during_update_url: Optional[str] = None,
stack_policy_url: Optional[str] = None,
template_body: Optional[str] = None,
template_url: Optional[str] = None,
timeout_in_minutes: Optional[int] = None,
use_previous_parameters: Optional[bool] = None)
func NewChangeSet(ctx *Context, name string, args ChangeSetArgs, opts ...ResourceOption) (*ChangeSet, error)
public ChangeSet(string name, ChangeSetArgs args, CustomResourceOptions? opts = null)
public ChangeSet(String name, ChangeSetArgs args)
public ChangeSet(String name, ChangeSetArgs args, CustomResourceOptions options)
type: alicloud:ros:ChangeSet
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 ChangeSetArgs
- 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 ChangeSetArgs
- 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 ChangeSetArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ChangeSetArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ChangeSetArgs
- 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 changeSetResource = new AliCloud.Ros.ChangeSet("changeSetResource", new()
{
ChangeSetName = "string",
ChangeSetType = "string",
Description = "string",
DisableRollback = false,
NotificationUrls = new[]
{
"string",
},
Parameters = new[]
{
new AliCloud.Ros.Inputs.ChangeSetParameterArgs
{
ParameterKey = "string",
ParameterValue = "string",
},
},
RamRoleName = "string",
ReplacementOption = "string",
StackId = "string",
StackName = "string",
StackPolicyBody = "string",
StackPolicyDuringUpdateBody = "string",
StackPolicyDuringUpdateUrl = "string",
StackPolicyUrl = "string",
TemplateBody = "string",
TemplateUrl = "string",
TimeoutInMinutes = 0,
UsePreviousParameters = false,
});
example, err := ros.NewChangeSet(ctx, "changeSetResource", &ros.ChangeSetArgs{
ChangeSetName: pulumi.String("string"),
ChangeSetType: pulumi.String("string"),
Description: pulumi.String("string"),
DisableRollback: pulumi.Bool(false),
NotificationUrls: pulumi.StringArray{
pulumi.String("string"),
},
Parameters: ros.ChangeSetParameterArray{
&ros.ChangeSetParameterArgs{
ParameterKey: pulumi.String("string"),
ParameterValue: pulumi.String("string"),
},
},
RamRoleName: pulumi.String("string"),
ReplacementOption: pulumi.String("string"),
StackId: pulumi.String("string"),
StackName: pulumi.String("string"),
StackPolicyBody: pulumi.String("string"),
StackPolicyDuringUpdateBody: pulumi.String("string"),
StackPolicyDuringUpdateUrl: pulumi.String("string"),
StackPolicyUrl: pulumi.String("string"),
TemplateBody: pulumi.String("string"),
TemplateUrl: pulumi.String("string"),
TimeoutInMinutes: pulumi.Int(0),
UsePreviousParameters: pulumi.Bool(false),
})
var changeSetResource = new ChangeSet("changeSetResource", ChangeSetArgs.builder()
.changeSetName("string")
.changeSetType("string")
.description("string")
.disableRollback(false)
.notificationUrls("string")
.parameters(ChangeSetParameterArgs.builder()
.parameterKey("string")
.parameterValue("string")
.build())
.ramRoleName("string")
.replacementOption("string")
.stackId("string")
.stackName("string")
.stackPolicyBody("string")
.stackPolicyDuringUpdateBody("string")
.stackPolicyDuringUpdateUrl("string")
.stackPolicyUrl("string")
.templateBody("string")
.templateUrl("string")
.timeoutInMinutes(0)
.usePreviousParameters(false)
.build());
change_set_resource = alicloud.ros.ChangeSet("changeSetResource",
change_set_name="string",
change_set_type="string",
description="string",
disable_rollback=False,
notification_urls=["string"],
parameters=[alicloud.ros.ChangeSetParameterArgs(
parameter_key="string",
parameter_value="string",
)],
ram_role_name="string",
replacement_option="string",
stack_id="string",
stack_name="string",
stack_policy_body="string",
stack_policy_during_update_body="string",
stack_policy_during_update_url="string",
stack_policy_url="string",
template_body="string",
template_url="string",
timeout_in_minutes=0,
use_previous_parameters=False)
const changeSetResource = new alicloud.ros.ChangeSet("changeSetResource", {
changeSetName: "string",
changeSetType: "string",
description: "string",
disableRollback: false,
notificationUrls: ["string"],
parameters: [{
parameterKey: "string",
parameterValue: "string",
}],
ramRoleName: "string",
replacementOption: "string",
stackId: "string",
stackName: "string",
stackPolicyBody: "string",
stackPolicyDuringUpdateBody: "string",
stackPolicyDuringUpdateUrl: "string",
stackPolicyUrl: "string",
templateBody: "string",
templateUrl: "string",
timeoutInMinutes: 0,
usePreviousParameters: false,
});
type: alicloud:ros:ChangeSet
properties:
changeSetName: string
changeSetType: string
description: string
disableRollback: false
notificationUrls:
- string
parameters:
- parameterKey: string
parameterValue: string
ramRoleName: string
replacementOption: string
stackId: string
stackName: string
stackPolicyBody: string
stackPolicyDuringUpdateBody: string
stackPolicyDuringUpdateUrl: string
stackPolicyUrl: string
templateBody: string
templateUrl: string
timeoutInMinutes: 0
usePreviousParameters: false
ChangeSet Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The ChangeSet resource accepts the following input properties:
- Change
Set stringName - The name of the change set. The name can be up to 255 characters in length and can contain digits, letters, hyphens (-), and underscores (_). It must start with a digit or letter.
- Change
Set stringType - The type of the change set. Valid values: CREATE: creates a change set for a new stack. UPDATE: creates a change set for an existing stack. IMPORT: creates a change set for a new stack or an existing stack to import non-ROS-managed resources. If you create a change set for a new stack, ROS creates a stack that has a unique stack ID. The stack is in the REVIEW_IN_PROGRESS state until you execute the change set. You cannot use the UPDATE type to create a change set for a new stack or the CREATE type to create a change set for an existing stack.
- Description string
- The description of the change set. The description can be up to 1,024 bytes in length.
- Disable
Rollback bool - Specifies whether to disable rollback on stack creation failure. Default value: false. Valid values: true: disables rollback on stack creation failure. false: enables rollback on stack creation failure. Note This parameter takes effect only when ChangeSetType is set to CREATE or IMPORT.
- Notification
Urls List<string> - The notification urls.
- Parameters
List<Pulumi.
Ali Cloud. Ros. Inputs. Change Set Parameter> - Parameters.
- Ram
Role stringName - The ram role name.
- Replacement
Option string - The replacement option.
- Stack
Id string - The ID of the stack for which you want to create the change set. ROS generates the change set by comparing the stack information with the information that you submit, such as a modified template or different inputs.
- Stack
Name string - The name of the stack for which you want to create the change set. The name can be up to 255 characters in length and can contain digits, letters, hyphens (-), and underscores (_). It must start with a digit or letter. Note This parameter takes effect only when ChangeSetType is set to CREATE or IMPORT.
- Stack
Policy stringBody - The stack policy body.
- Stack
Policy stringDuring Update Body - The stack policy during update body.
- Stack
Policy stringDuring Update Url - The stack policy during update url.
- Stack
Policy stringUrl - The stack policy url.
- Template
Body string - The structure that contains the template body. The template body must be 1 to 524,288 bytes in length. If the length of the template body is longer than required, we recommend that you add parameters to the HTTP POST request body to avoid request failures due to excessive length of URLs. You can specify one of TemplateBody or TemplateURL parameters, but you cannot specify both of them.
- Template
Url string - The template url.
- Timeout
In intMinutes - Timeout In Minutes.
- Use
Previous boolParameters - The use previous parameters.
- Change
Set stringName - The name of the change set. The name can be up to 255 characters in length and can contain digits, letters, hyphens (-), and underscores (_). It must start with a digit or letter.
- Change
Set stringType - The type of the change set. Valid values: CREATE: creates a change set for a new stack. UPDATE: creates a change set for an existing stack. IMPORT: creates a change set for a new stack or an existing stack to import non-ROS-managed resources. If you create a change set for a new stack, ROS creates a stack that has a unique stack ID. The stack is in the REVIEW_IN_PROGRESS state until you execute the change set. You cannot use the UPDATE type to create a change set for a new stack or the CREATE type to create a change set for an existing stack.
- Description string
- The description of the change set. The description can be up to 1,024 bytes in length.
- Disable
Rollback bool - Specifies whether to disable rollback on stack creation failure. Default value: false. Valid values: true: disables rollback on stack creation failure. false: enables rollback on stack creation failure. Note This parameter takes effect only when ChangeSetType is set to CREATE or IMPORT.
- Notification
Urls []string - The notification urls.
- Parameters
[]Change
Set Parameter Args - Parameters.
- Ram
Role stringName - The ram role name.
- Replacement
Option string - The replacement option.
- Stack
Id string - The ID of the stack for which you want to create the change set. ROS generates the change set by comparing the stack information with the information that you submit, such as a modified template or different inputs.
- Stack
Name string - The name of the stack for which you want to create the change set. The name can be up to 255 characters in length and can contain digits, letters, hyphens (-), and underscores (_). It must start with a digit or letter. Note This parameter takes effect only when ChangeSetType is set to CREATE or IMPORT.
- Stack
Policy stringBody - The stack policy body.
- Stack
Policy stringDuring Update Body - The stack policy during update body.
- Stack
Policy stringDuring Update Url - The stack policy during update url.
- Stack
Policy stringUrl - The stack policy url.
- Template
Body string - The structure that contains the template body. The template body must be 1 to 524,288 bytes in length. If the length of the template body is longer than required, we recommend that you add parameters to the HTTP POST request body to avoid request failures due to excessive length of URLs. You can specify one of TemplateBody or TemplateURL parameters, but you cannot specify both of them.
- Template
Url string - The template url.
- Timeout
In intMinutes - Timeout In Minutes.
- Use
Previous boolParameters - The use previous parameters.
- change
Set StringName - The name of the change set. The name can be up to 255 characters in length and can contain digits, letters, hyphens (-), and underscores (_). It must start with a digit or letter.
- change
Set StringType - The type of the change set. Valid values: CREATE: creates a change set for a new stack. UPDATE: creates a change set for an existing stack. IMPORT: creates a change set for a new stack or an existing stack to import non-ROS-managed resources. If you create a change set for a new stack, ROS creates a stack that has a unique stack ID. The stack is in the REVIEW_IN_PROGRESS state until you execute the change set. You cannot use the UPDATE type to create a change set for a new stack or the CREATE type to create a change set for an existing stack.
- description String
- The description of the change set. The description can be up to 1,024 bytes in length.
- disable
Rollback Boolean - Specifies whether to disable rollback on stack creation failure. Default value: false. Valid values: true: disables rollback on stack creation failure. false: enables rollback on stack creation failure. Note This parameter takes effect only when ChangeSetType is set to CREATE or IMPORT.
- notification
Urls List<String> - The notification urls.
- parameters
List<Change
Set Parameter> - Parameters.
- ram
Role StringName - The ram role name.
- replacement
Option String - The replacement option.
- stack
Id String - The ID of the stack for which you want to create the change set. ROS generates the change set by comparing the stack information with the information that you submit, such as a modified template or different inputs.
- stack
Name String - The name of the stack for which you want to create the change set. The name can be up to 255 characters in length and can contain digits, letters, hyphens (-), and underscores (_). It must start with a digit or letter. Note This parameter takes effect only when ChangeSetType is set to CREATE or IMPORT.
- stack
Policy StringBody - The stack policy body.
- stack
Policy StringDuring Update Body - The stack policy during update body.
- stack
Policy StringDuring Update Url - The stack policy during update url.
- stack
Policy StringUrl - The stack policy url.
- template
Body String - The structure that contains the template body. The template body must be 1 to 524,288 bytes in length. If the length of the template body is longer than required, we recommend that you add parameters to the HTTP POST request body to avoid request failures due to excessive length of URLs. You can specify one of TemplateBody or TemplateURL parameters, but you cannot specify both of them.
- template
Url String - The template url.
- timeout
In IntegerMinutes - Timeout In Minutes.
- use
Previous BooleanParameters - The use previous parameters.
- change
Set stringName - The name of the change set. The name can be up to 255 characters in length and can contain digits, letters, hyphens (-), and underscores (_). It must start with a digit or letter.
- change
Set stringType - The type of the change set. Valid values: CREATE: creates a change set for a new stack. UPDATE: creates a change set for an existing stack. IMPORT: creates a change set for a new stack or an existing stack to import non-ROS-managed resources. If you create a change set for a new stack, ROS creates a stack that has a unique stack ID. The stack is in the REVIEW_IN_PROGRESS state until you execute the change set. You cannot use the UPDATE type to create a change set for a new stack or the CREATE type to create a change set for an existing stack.
- description string
- The description of the change set. The description can be up to 1,024 bytes in length.
- disable
Rollback boolean - Specifies whether to disable rollback on stack creation failure. Default value: false. Valid values: true: disables rollback on stack creation failure. false: enables rollback on stack creation failure. Note This parameter takes effect only when ChangeSetType is set to CREATE or IMPORT.
- notification
Urls string[] - The notification urls.
- parameters
Change
Set Parameter[] - Parameters.
- ram
Role stringName - The ram role name.
- replacement
Option string - The replacement option.
- stack
Id string - The ID of the stack for which you want to create the change set. ROS generates the change set by comparing the stack information with the information that you submit, such as a modified template or different inputs.
- stack
Name string - The name of the stack for which you want to create the change set. The name can be up to 255 characters in length and can contain digits, letters, hyphens (-), and underscores (_). It must start with a digit or letter. Note This parameter takes effect only when ChangeSetType is set to CREATE or IMPORT.
- stack
Policy stringBody - The stack policy body.
- stack
Policy stringDuring Update Body - The stack policy during update body.
- stack
Policy stringDuring Update Url - The stack policy during update url.
- stack
Policy stringUrl - The stack policy url.
- template
Body string - The structure that contains the template body. The template body must be 1 to 524,288 bytes in length. If the length of the template body is longer than required, we recommend that you add parameters to the HTTP POST request body to avoid request failures due to excessive length of URLs. You can specify one of TemplateBody or TemplateURL parameters, but you cannot specify both of them.
- template
Url string - The template url.
- timeout
In numberMinutes - Timeout In Minutes.
- use
Previous booleanParameters - The use previous parameters.
- change_
set_ strname - The name of the change set. The name can be up to 255 characters in length and can contain digits, letters, hyphens (-), and underscores (_). It must start with a digit or letter.
- change_
set_ strtype - The type of the change set. Valid values: CREATE: creates a change set for a new stack. UPDATE: creates a change set for an existing stack. IMPORT: creates a change set for a new stack or an existing stack to import non-ROS-managed resources. If you create a change set for a new stack, ROS creates a stack that has a unique stack ID. The stack is in the REVIEW_IN_PROGRESS state until you execute the change set. You cannot use the UPDATE type to create a change set for a new stack or the CREATE type to create a change set for an existing stack.
- description str
- The description of the change set. The description can be up to 1,024 bytes in length.
- disable_
rollback bool - Specifies whether to disable rollback on stack creation failure. Default value: false. Valid values: true: disables rollback on stack creation failure. false: enables rollback on stack creation failure. Note This parameter takes effect only when ChangeSetType is set to CREATE or IMPORT.
- notification_
urls Sequence[str] - The notification urls.
- parameters
Sequence[Change
Set Parameter Args] - Parameters.
- ram_
role_ strname - The ram role name.
- replacement_
option str - The replacement option.
- stack_
id str - The ID of the stack for which you want to create the change set. ROS generates the change set by comparing the stack information with the information that you submit, such as a modified template or different inputs.
- stack_
name str - The name of the stack for which you want to create the change set. The name can be up to 255 characters in length and can contain digits, letters, hyphens (-), and underscores (_). It must start with a digit or letter. Note This parameter takes effect only when ChangeSetType is set to CREATE or IMPORT.
- stack_
policy_ strbody - The stack policy body.
- stack_
policy_ strduring_ update_ body - The stack policy during update body.
- stack_
policy_ strduring_ update_ url - The stack policy during update url.
- stack_
policy_ strurl - The stack policy url.
- template_
body str - The structure that contains the template body. The template body must be 1 to 524,288 bytes in length. If the length of the template body is longer than required, we recommend that you add parameters to the HTTP POST request body to avoid request failures due to excessive length of URLs. You can specify one of TemplateBody or TemplateURL parameters, but you cannot specify both of them.
- template_
url str - The template url.
- timeout_
in_ intminutes - Timeout In Minutes.
- use_
previous_ boolparameters - The use previous parameters.
- change
Set StringName - The name of the change set. The name can be up to 255 characters in length and can contain digits, letters, hyphens (-), and underscores (_). It must start with a digit or letter.
- change
Set StringType - The type of the change set. Valid values: CREATE: creates a change set for a new stack. UPDATE: creates a change set for an existing stack. IMPORT: creates a change set for a new stack or an existing stack to import non-ROS-managed resources. If you create a change set for a new stack, ROS creates a stack that has a unique stack ID. The stack is in the REVIEW_IN_PROGRESS state until you execute the change set. You cannot use the UPDATE type to create a change set for a new stack or the CREATE type to create a change set for an existing stack.
- description String
- The description of the change set. The description can be up to 1,024 bytes in length.
- disable
Rollback Boolean - Specifies whether to disable rollback on stack creation failure. Default value: false. Valid values: true: disables rollback on stack creation failure. false: enables rollback on stack creation failure. Note This parameter takes effect only when ChangeSetType is set to CREATE or IMPORT.
- notification
Urls List<String> - The notification urls.
- parameters List<Property Map>
- Parameters.
- ram
Role StringName - The ram role name.
- replacement
Option String - The replacement option.
- stack
Id String - The ID of the stack for which you want to create the change set. ROS generates the change set by comparing the stack information with the information that you submit, such as a modified template or different inputs.
- stack
Name String - The name of the stack for which you want to create the change set. The name can be up to 255 characters in length and can contain digits, letters, hyphens (-), and underscores (_). It must start with a digit or letter. Note This parameter takes effect only when ChangeSetType is set to CREATE or IMPORT.
- stack
Policy StringBody - The stack policy body.
- stack
Policy StringDuring Update Body - The stack policy during update body.
- stack
Policy StringDuring Update Url - The stack policy during update url.
- stack
Policy StringUrl - The stack policy url.
- template
Body String - The structure that contains the template body. The template body must be 1 to 524,288 bytes in length. If the length of the template body is longer than required, we recommend that you add parameters to the HTTP POST request body to avoid request failures due to excessive length of URLs. You can specify one of TemplateBody or TemplateURL parameters, but you cannot specify both of them.
- template
Url String - The template url.
- timeout
In NumberMinutes - Timeout In Minutes.
- use
Previous BooleanParameters - The use previous parameters.
Outputs
All input properties are implicitly available as output properties. Additionally, the ChangeSet resource produces the following output properties:
Look up Existing ChangeSet Resource
Get an existing ChangeSet 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?: ChangeSetState, opts?: CustomResourceOptions): ChangeSet
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
change_set_name: Optional[str] = None,
change_set_type: Optional[str] = None,
description: Optional[str] = None,
disable_rollback: Optional[bool] = None,
notification_urls: Optional[Sequence[str]] = None,
parameters: Optional[Sequence[ChangeSetParameterArgs]] = None,
ram_role_name: Optional[str] = None,
replacement_option: Optional[str] = None,
stack_id: Optional[str] = None,
stack_name: Optional[str] = None,
stack_policy_body: Optional[str] = None,
stack_policy_during_update_body: Optional[str] = None,
stack_policy_during_update_url: Optional[str] = None,
stack_policy_url: Optional[str] = None,
status: Optional[str] = None,
template_body: Optional[str] = None,
template_url: Optional[str] = None,
timeout_in_minutes: Optional[int] = None,
use_previous_parameters: Optional[bool] = None) -> ChangeSet
func GetChangeSet(ctx *Context, name string, id IDInput, state *ChangeSetState, opts ...ResourceOption) (*ChangeSet, error)
public static ChangeSet Get(string name, Input<string> id, ChangeSetState? state, CustomResourceOptions? opts = null)
public static ChangeSet get(String name, Output<String> id, ChangeSetState 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.
- Change
Set stringName - The name of the change set. The name can be up to 255 characters in length and can contain digits, letters, hyphens (-), and underscores (_). It must start with a digit or letter.
- Change
Set stringType - The type of the change set. Valid values: CREATE: creates a change set for a new stack. UPDATE: creates a change set for an existing stack. IMPORT: creates a change set for a new stack or an existing stack to import non-ROS-managed resources. If you create a change set for a new stack, ROS creates a stack that has a unique stack ID. The stack is in the REVIEW_IN_PROGRESS state until you execute the change set. You cannot use the UPDATE type to create a change set for a new stack or the CREATE type to create a change set for an existing stack.
- Description string
- The description of the change set. The description can be up to 1,024 bytes in length.
- Disable
Rollback bool - Specifies whether to disable rollback on stack creation failure. Default value: false. Valid values: true: disables rollback on stack creation failure. false: enables rollback on stack creation failure. Note This parameter takes effect only when ChangeSetType is set to CREATE or IMPORT.
- Notification
Urls List<string> - The notification urls.
- Parameters
List<Pulumi.
Ali Cloud. Ros. Inputs. Change Set Parameter> - Parameters.
- Ram
Role stringName - The ram role name.
- Replacement
Option string - The replacement option.
- Stack
Id string - The ID of the stack for which you want to create the change set. ROS generates the change set by comparing the stack information with the information that you submit, such as a modified template or different inputs.
- Stack
Name string - The name of the stack for which you want to create the change set. The name can be up to 255 characters in length and can contain digits, letters, hyphens (-), and underscores (_). It must start with a digit or letter. Note This parameter takes effect only when ChangeSetType is set to CREATE or IMPORT.
- Stack
Policy stringBody - The stack policy body.
- Stack
Policy stringDuring Update Body - The stack policy during update body.
- Stack
Policy stringDuring Update Url - The stack policy during update url.
- Stack
Policy stringUrl - The stack policy url.
- Status string
- The status of the change set.
- Template
Body string - The structure that contains the template body. The template body must be 1 to 524,288 bytes in length. If the length of the template body is longer than required, we recommend that you add parameters to the HTTP POST request body to avoid request failures due to excessive length of URLs. You can specify one of TemplateBody or TemplateURL parameters, but you cannot specify both of them.
- Template
Url string - The template url.
- Timeout
In intMinutes - Timeout In Minutes.
- Use
Previous boolParameters - The use previous parameters.
- Change
Set stringName - The name of the change set. The name can be up to 255 characters in length and can contain digits, letters, hyphens (-), and underscores (_). It must start with a digit or letter.
- Change
Set stringType - The type of the change set. Valid values: CREATE: creates a change set for a new stack. UPDATE: creates a change set for an existing stack. IMPORT: creates a change set for a new stack or an existing stack to import non-ROS-managed resources. If you create a change set for a new stack, ROS creates a stack that has a unique stack ID. The stack is in the REVIEW_IN_PROGRESS state until you execute the change set. You cannot use the UPDATE type to create a change set for a new stack or the CREATE type to create a change set for an existing stack.
- Description string
- The description of the change set. The description can be up to 1,024 bytes in length.
- Disable
Rollback bool - Specifies whether to disable rollback on stack creation failure. Default value: false. Valid values: true: disables rollback on stack creation failure. false: enables rollback on stack creation failure. Note This parameter takes effect only when ChangeSetType is set to CREATE or IMPORT.
- Notification
Urls []string - The notification urls.
- Parameters
[]Change
Set Parameter Args - Parameters.
- Ram
Role stringName - The ram role name.
- Replacement
Option string - The replacement option.
- Stack
Id string - The ID of the stack for which you want to create the change set. ROS generates the change set by comparing the stack information with the information that you submit, such as a modified template or different inputs.
- Stack
Name string - The name of the stack for which you want to create the change set. The name can be up to 255 characters in length and can contain digits, letters, hyphens (-), and underscores (_). It must start with a digit or letter. Note This parameter takes effect only when ChangeSetType is set to CREATE or IMPORT.
- Stack
Policy stringBody - The stack policy body.
- Stack
Policy stringDuring Update Body - The stack policy during update body.
- Stack
Policy stringDuring Update Url - The stack policy during update url.
- Stack
Policy stringUrl - The stack policy url.
- Status string
- The status of the change set.
- Template
Body string - The structure that contains the template body. The template body must be 1 to 524,288 bytes in length. If the length of the template body is longer than required, we recommend that you add parameters to the HTTP POST request body to avoid request failures due to excessive length of URLs. You can specify one of TemplateBody or TemplateURL parameters, but you cannot specify both of them.
- Template
Url string - The template url.
- Timeout
In intMinutes - Timeout In Minutes.
- Use
Previous boolParameters - The use previous parameters.
- change
Set StringName - The name of the change set. The name can be up to 255 characters in length and can contain digits, letters, hyphens (-), and underscores (_). It must start with a digit or letter.
- change
Set StringType - The type of the change set. Valid values: CREATE: creates a change set for a new stack. UPDATE: creates a change set for an existing stack. IMPORT: creates a change set for a new stack or an existing stack to import non-ROS-managed resources. If you create a change set for a new stack, ROS creates a stack that has a unique stack ID. The stack is in the REVIEW_IN_PROGRESS state until you execute the change set. You cannot use the UPDATE type to create a change set for a new stack or the CREATE type to create a change set for an existing stack.
- description String
- The description of the change set. The description can be up to 1,024 bytes in length.
- disable
Rollback Boolean - Specifies whether to disable rollback on stack creation failure. Default value: false. Valid values: true: disables rollback on stack creation failure. false: enables rollback on stack creation failure. Note This parameter takes effect only when ChangeSetType is set to CREATE or IMPORT.
- notification
Urls List<String> - The notification urls.
- parameters
List<Change
Set Parameter> - Parameters.
- ram
Role StringName - The ram role name.
- replacement
Option String - The replacement option.
- stack
Id String - The ID of the stack for which you want to create the change set. ROS generates the change set by comparing the stack information with the information that you submit, such as a modified template or different inputs.
- stack
Name String - The name of the stack for which you want to create the change set. The name can be up to 255 characters in length and can contain digits, letters, hyphens (-), and underscores (_). It must start with a digit or letter. Note This parameter takes effect only when ChangeSetType is set to CREATE or IMPORT.
- stack
Policy StringBody - The stack policy body.
- stack
Policy StringDuring Update Body - The stack policy during update body.
- stack
Policy StringDuring Update Url - The stack policy during update url.
- stack
Policy StringUrl - The stack policy url.
- status String
- The status of the change set.
- template
Body String - The structure that contains the template body. The template body must be 1 to 524,288 bytes in length. If the length of the template body is longer than required, we recommend that you add parameters to the HTTP POST request body to avoid request failures due to excessive length of URLs. You can specify one of TemplateBody or TemplateURL parameters, but you cannot specify both of them.
- template
Url String - The template url.
- timeout
In IntegerMinutes - Timeout In Minutes.
- use
Previous BooleanParameters - The use previous parameters.
- change
Set stringName - The name of the change set. The name can be up to 255 characters in length and can contain digits, letters, hyphens (-), and underscores (_). It must start with a digit or letter.
- change
Set stringType - The type of the change set. Valid values: CREATE: creates a change set for a new stack. UPDATE: creates a change set for an existing stack. IMPORT: creates a change set for a new stack or an existing stack to import non-ROS-managed resources. If you create a change set for a new stack, ROS creates a stack that has a unique stack ID. The stack is in the REVIEW_IN_PROGRESS state until you execute the change set. You cannot use the UPDATE type to create a change set for a new stack or the CREATE type to create a change set for an existing stack.
- description string
- The description of the change set. The description can be up to 1,024 bytes in length.
- disable
Rollback boolean - Specifies whether to disable rollback on stack creation failure. Default value: false. Valid values: true: disables rollback on stack creation failure. false: enables rollback on stack creation failure. Note This parameter takes effect only when ChangeSetType is set to CREATE or IMPORT.
- notification
Urls string[] - The notification urls.
- parameters
Change
Set Parameter[] - Parameters.
- ram
Role stringName - The ram role name.
- replacement
Option string - The replacement option.
- stack
Id string - The ID of the stack for which you want to create the change set. ROS generates the change set by comparing the stack information with the information that you submit, such as a modified template or different inputs.
- stack
Name string - The name of the stack for which you want to create the change set. The name can be up to 255 characters in length and can contain digits, letters, hyphens (-), and underscores (_). It must start with a digit or letter. Note This parameter takes effect only when ChangeSetType is set to CREATE or IMPORT.
- stack
Policy stringBody - The stack policy body.
- stack
Policy stringDuring Update Body - The stack policy during update body.
- stack
Policy stringDuring Update Url - The stack policy during update url.
- stack
Policy stringUrl - The stack policy url.
- status string
- The status of the change set.
- template
Body string - The structure that contains the template body. The template body must be 1 to 524,288 bytes in length. If the length of the template body is longer than required, we recommend that you add parameters to the HTTP POST request body to avoid request failures due to excessive length of URLs. You can specify one of TemplateBody or TemplateURL parameters, but you cannot specify both of them.
- template
Url string - The template url.
- timeout
In numberMinutes - Timeout In Minutes.
- use
Previous booleanParameters - The use previous parameters.
- change_
set_ strname - The name of the change set. The name can be up to 255 characters in length and can contain digits, letters, hyphens (-), and underscores (_). It must start with a digit or letter.
- change_
set_ strtype - The type of the change set. Valid values: CREATE: creates a change set for a new stack. UPDATE: creates a change set for an existing stack. IMPORT: creates a change set for a new stack or an existing stack to import non-ROS-managed resources. If you create a change set for a new stack, ROS creates a stack that has a unique stack ID. The stack is in the REVIEW_IN_PROGRESS state until you execute the change set. You cannot use the UPDATE type to create a change set for a new stack or the CREATE type to create a change set for an existing stack.
- description str
- The description of the change set. The description can be up to 1,024 bytes in length.
- disable_
rollback bool - Specifies whether to disable rollback on stack creation failure. Default value: false. Valid values: true: disables rollback on stack creation failure. false: enables rollback on stack creation failure. Note This parameter takes effect only when ChangeSetType is set to CREATE or IMPORT.
- notification_
urls Sequence[str] - The notification urls.
- parameters
Sequence[Change
Set Parameter Args] - Parameters.
- ram_
role_ strname - The ram role name.
- replacement_
option str - The replacement option.
- stack_
id str - The ID of the stack for which you want to create the change set. ROS generates the change set by comparing the stack information with the information that you submit, such as a modified template or different inputs.
- stack_
name str - The name of the stack for which you want to create the change set. The name can be up to 255 characters in length and can contain digits, letters, hyphens (-), and underscores (_). It must start with a digit or letter. Note This parameter takes effect only when ChangeSetType is set to CREATE or IMPORT.
- stack_
policy_ strbody - The stack policy body.
- stack_
policy_ strduring_ update_ body - The stack policy during update body.
- stack_
policy_ strduring_ update_ url - The stack policy during update url.
- stack_
policy_ strurl - The stack policy url.
- status str
- The status of the change set.
- template_
body str - The structure that contains the template body. The template body must be 1 to 524,288 bytes in length. If the length of the template body is longer than required, we recommend that you add parameters to the HTTP POST request body to avoid request failures due to excessive length of URLs. You can specify one of TemplateBody or TemplateURL parameters, but you cannot specify both of them.
- template_
url str - The template url.
- timeout_
in_ intminutes - Timeout In Minutes.
- use_
previous_ boolparameters - The use previous parameters.
- change
Set StringName - The name of the change set. The name can be up to 255 characters in length and can contain digits, letters, hyphens (-), and underscores (_). It must start with a digit or letter.
- change
Set StringType - The type of the change set. Valid values: CREATE: creates a change set for a new stack. UPDATE: creates a change set for an existing stack. IMPORT: creates a change set for a new stack or an existing stack to import non-ROS-managed resources. If you create a change set for a new stack, ROS creates a stack that has a unique stack ID. The stack is in the REVIEW_IN_PROGRESS state until you execute the change set. You cannot use the UPDATE type to create a change set for a new stack or the CREATE type to create a change set for an existing stack.
- description String
- The description of the change set. The description can be up to 1,024 bytes in length.
- disable
Rollback Boolean - Specifies whether to disable rollback on stack creation failure. Default value: false. Valid values: true: disables rollback on stack creation failure. false: enables rollback on stack creation failure. Note This parameter takes effect only when ChangeSetType is set to CREATE or IMPORT.
- notification
Urls List<String> - The notification urls.
- parameters List<Property Map>
- Parameters.
- ram
Role StringName - The ram role name.
- replacement
Option String - The replacement option.
- stack
Id String - The ID of the stack for which you want to create the change set. ROS generates the change set by comparing the stack information with the information that you submit, such as a modified template or different inputs.
- stack
Name String - The name of the stack for which you want to create the change set. The name can be up to 255 characters in length and can contain digits, letters, hyphens (-), and underscores (_). It must start with a digit or letter. Note This parameter takes effect only when ChangeSetType is set to CREATE or IMPORT.
- stack
Policy StringBody - The stack policy body.
- stack
Policy StringDuring Update Body - The stack policy during update body.
- stack
Policy StringDuring Update Url - The stack policy during update url.
- stack
Policy StringUrl - The stack policy url.
- status String
- The status of the change set.
- template
Body String - The structure that contains the template body. The template body must be 1 to 524,288 bytes in length. If the length of the template body is longer than required, we recommend that you add parameters to the HTTP POST request body to avoid request failures due to excessive length of URLs. You can specify one of TemplateBody or TemplateURL parameters, but you cannot specify both of them.
- template
Url String - The template url.
- timeout
In NumberMinutes - Timeout In Minutes.
- use
Previous BooleanParameters - The use previous parameters.
Supporting Types
ChangeSetParameter, ChangeSetParameterArgs
- Parameter
Key string - The parameter key.
- Parameter
Value string - The parameter value.
- Parameter
Key string - The parameter key.
- Parameter
Value string - The parameter value.
- parameter
Key String - The parameter key.
- parameter
Value String - The parameter value.
- parameter
Key string - The parameter key.
- parameter
Value string - The parameter value.
- parameter_
key str - The parameter key.
- parameter_
value str - The parameter value.
- parameter
Key String - The parameter key.
- parameter
Value String - The parameter value.
Import
ROS Change Set can be imported using the id, e.g.
$ pulumi import alicloud:ros/changeSet:ChangeSet example <change_set_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.