Class: Aws::CloudFormation::Types::CreateStackInstancesInput

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-cloudformation/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#accounts ⇒ Array<String>

[Self-managed permissions] The account IDs of one or more Amazon Web Services accounts that you want to create stack instances in the specified Region(s) for.

You can specify ‘Accounts` or `DeploymentTargets`, but not both.

Returns:

  • (Array<String>) 


1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 1532

class CreateStackInstancesInput < Struct.new(
  :stack_set_name,
  :accounts,
  :deployment_targets,
  :regions,
  :parameter_overrides,
  :operation_preferences,
  :operation_id,
  :call_as)
  SENSITIVE = []
  include Aws::Structure
end

#call_as ⇒ String

[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization’s management account or as a delegated administrator in a member account.

By default, ‘SELF` is specified. Use `SELF` for StackSets with self-managed permissions.

  • If you are signed in to the management account, specify ‘SELF`.

  • If you are signed in to a delegated administrator account, specify ‘DELEGATED_ADMIN`.

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see

    Register a delegated administrator][1

    in the *CloudFormation

    User Guide*.

[1]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html

Returns:

  • (String) 


1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 1532

class CreateStackInstancesInput < Struct.new(
  :stack_set_name,
  :accounts,
  :deployment_targets,
  :regions,
  :parameter_overrides,
  :operation_preferences,
  :operation_id,
  :call_as)
  SENSITIVE = []
  include Aws::Structure
end

#deployment_targets ⇒ Types::DeploymentTargets

[Service-managed permissions] The Organizations accounts in which to create stack instances in the specified Amazon Web Services Regions.

You can specify ‘Accounts` or `DeploymentTargets`, but not both.

Returns:



1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 1532

class CreateStackInstancesInput < Struct.new(
  :stack_set_name,
  :accounts,
  :deployment_targets,
  :regions,
  :parameter_overrides,
  :operation_preferences,
  :operation_id,
  :call_as)
  SENSITIVE = []
  include Aws::Structure
end

#operation_id ⇒ String

The unique identifier for this StackSet operation.

The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the StackSet operation only once, even if you retry the request multiple times. You might retry StackSet operation requests to ensure that CloudFormation successfully received them.

If you don’t specify an operation ID, the SDK generates one automatically.

Repeating this StackSet operation with a new operation ID retries all stack instances whose status is ‘OUTDATED`.

**A suitable default value is auto-generated.** You should normally not need to pass this option.

Returns:

  • (String) 


1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 1532

class CreateStackInstancesInput < Struct.new(
  :stack_set_name,
  :accounts,
  :deployment_targets,
  :regions,
  :parameter_overrides,
  :operation_preferences,
  :operation_id,
  :call_as)
  SENSITIVE = []
  include Aws::Structure
end

#operation_preferences ⇒ Types::StackSetOperationPreferences

Preferences for how CloudFormation performs this StackSet operation.

Returns:



1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 1532

class CreateStackInstancesInput < Struct.new(
  :stack_set_name,
  :accounts,
  :deployment_targets,
  :regions,
  :parameter_overrides,
  :operation_preferences,
  :operation_id,
  :call_as)
  SENSITIVE = []
  include Aws::Structure
end

#parameter_overrides ⇒ Array<Types::Parameter>

A list of StackSet parameters whose values you want to override in the selected stack instances.

Any overridden parameter values will be applied to all stack instances in the specified accounts and Amazon Web Services Regions. When specifying parameters and their values, be aware of how CloudFormation sets parameter values during stack instance operations:

  • To override the current value for a parameter, include the parameter and specify its value.

  • To leave an overridden parameter set to its present value, include the parameter and specify ‘UsePreviousValue` as `true`. (You can’t specify both a value and set ‘UsePreviousValue` to `true`.)

  • To set an overridden parameter back to the value specified in the StackSet, specify a parameter list but don’t include the parameter in the list.

  • To leave all parameters set to their present values, don’t specify this property at all.

During StackSet updates, any parameter values overridden for a stack instance aren’t updated, but retain their overridden value.

You can only override the parameter values that are specified in the StackSet; to add or delete a parameter itself, use

UpdateStackSet][1

to update the StackSet template.

[1]: docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html

Returns:



1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 1532

class CreateStackInstancesInput < Struct.new(
  :stack_set_name,
  :accounts,
  :deployment_targets,
  :regions,
  :parameter_overrides,
  :operation_preferences,
  :operation_id,
  :call_as)
  SENSITIVE = []
  include Aws::Structure
end

#regions ⇒ Array<String>

The names of one or more Amazon Web Services Regions where you want to create stack instances using the specified Amazon Web Services accounts.

Returns:

  • (Array<String>) 


1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 1532

class CreateStackInstancesInput < Struct.new(
  :stack_set_name,
  :accounts,
  :deployment_targets,
  :regions,
  :parameter_overrides,
  :operation_preferences,
  :operation_id,
  :call_as)
  SENSITIVE = []
  include Aws::Structure
end

#stack_set_name ⇒ String

The name or unique ID of the StackSet that you want to create stack instances from.

Returns:

  • (String) 


1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 1532

class CreateStackInstancesInput < Struct.new(
  :stack_set_name,
  :accounts,
  :deployment_targets,
  :regions,
  :parameter_overrides,
  :operation_preferences,
  :operation_id,
  :call_as)
  SENSITIVE = []
  include Aws::Structure
end