class Aws::CloudFormation::Types::UpdateStackSetInput

@note When making an API call, you may pass UpdateStackSetInput

data as a hash:

    {
      stack_set_name: "StackSetName", # required
      description: "Description",
      template_body: "TemplateBody",
      template_url: "TemplateURL",
      use_previous_template: false,
      parameters: [
        {
          parameter_key: "ParameterKey",
          parameter_value: "ParameterValue",
          use_previous_value: false,
          resolved_value: "ParameterValue",
        },
      ],
      capabilities: ["CAPABILITY_IAM"], # accepts CAPABILITY_IAM, CAPABILITY_NAMED_IAM, CAPABILITY_AUTO_EXPAND
      tags: [
        {
          key: "TagKey", # required
          value: "TagValue", # required
        },
      ],
      operation_preferences: {
        region_concurrency_type: "SEQUENTIAL", # accepts SEQUENTIAL, PARALLEL
        region_order: ["Region"],
        failure_tolerance_count: 1,
        failure_tolerance_percentage: 1,
        max_concurrent_count: 1,
        max_concurrent_percentage: 1,
      },
      administration_role_arn: "RoleARN",
      execution_role_name: "ExecutionRoleName",
      deployment_targets: {
        accounts: ["Account"],
        accounts_url: "AccountsUrl",
        organizational_unit_ids: ["OrganizationalUnitId"],
      },
      permission_model: "SERVICE_MANAGED", # accepts SERVICE_MANAGED, SELF_MANAGED
      auto_deployment: {
        enabled: false,
        retain_stacks_on_account_removal: false,
      },
      operation_id: "ClientRequestToken",
      accounts: ["Account"],
      regions: ["Region"],
      call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
      managed_execution: {
        active: false,
      },
    }

@!attribute [rw] stack_set_name

The name or unique ID of the stack set that you want to update.
@return [String]

@!attribute [rw] description

A brief description of updates that you are making.
@return [String]

@!attribute [rw] template_body

The structure that contains the template body, with a minimum length
of 1 byte and a maximum length of 51,200 bytes. For more
information, see [Template Anatomy][1] in the CloudFormation User
Guide.

Conditional: You must specify only one of the following parameters:
`TemplateBody` or `TemplateURL`—or set `UsePreviousTemplate` to
true.

[1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html
@return [String]

@!attribute [rw] template_url

The location of the file that contains the template body. The URL
must point to a template (maximum size: 460,800 bytes) that is
located in an Amazon S3 bucket or a Systems Manager document. For
more information, see [Template Anatomy][1] in the CloudFormation
User Guide.

Conditional: You must specify only one of the following parameters:
`TemplateBody` or `TemplateURL`—or set `UsePreviousTemplate` to
true.

[1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html
@return [String]

@!attribute [rw] use_previous_template

Use the existing template that's associated with the stack set that
you're updating.

Conditional: You must specify only one of the following parameters:
`TemplateBody` or `TemplateURL`—or set `UsePreviousTemplate` to
true.
@return [Boolean]

@!attribute [rw] parameters

A list of input parameters for the stack set template.
@return [Array<Types::Parameter>]

@!attribute [rw] capabilities

In some cases, you must explicitly acknowledge that your stack
template contains certain capabilities in order for CloudFormation
to update the stack set and its associated stack instances.

* `CAPABILITY_IAM` and `CAPABILITY_NAMED_IAM`

  Some stack templates might include resources that can affect
  permissions in your Amazon Web Services account; for example, by
  creating new Identity and Access Management (IAM) users. For those
  stacks sets, you must explicitly acknowledge this by specifying
  one of these capabilities.

  The following IAM resources require you to specify either the
  `CAPABILITY_IAM` or `CAPABILITY_NAMED_IAM` capability.

  * If you have IAM resources, you can specify either capability.

  * If you have IAM resources with custom names, you *must* specify
    `CAPABILITY_NAMED_IAM`.

  * If you don't specify either of these capabilities,
    CloudFormation returns an `InsufficientCapabilities` error.

  If your stack template contains these resources, we recommend that
  you review all permissions associated with them and edit their
  permissions if necessary.

  * [ AWS::IAM::AccessKey][1]

  * [ AWS::IAM::Group][2]

  * [ AWS::IAM::InstanceProfile][3]

  * [ AWS::IAM::Policy][4]

  * [ AWS::IAM::Role][5]

  * [ AWS::IAM::User][6]

  * [ AWS::IAM::UserToGroupAddition][7]

  For more information, see [Acknowledging IAM Resources in
  CloudFormation Templates][8].

* `CAPABILITY_AUTO_EXPAND`

  Some templates reference macros. If your stack set template
  references one or more macros, you must update the stack set
  directly from the processed template, without first reviewing the
  resulting changes in a change set. To update the stack set
  directly, you must acknowledge this capability. For more
  information, see [Using CloudFormation Macros to Perform Custom
  Processing on Templates][9].

  Stack sets with service-managed permissions do not currently
  support the use of macros in templates. (This includes the
  [AWS::Include][10] and [AWS::Serverless][11] transforms, which are
  macros hosted by CloudFormation.) Even if you specify this
  capability for a stack set with service-managed permissions, if
  you reference a macro in your template the stack set operation
  will fail.

[1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html
[2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html
[3]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html
[4]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html
[5]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html
[6]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html
[7]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html
[8]: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities
[9]: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html
[10]: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html
[11]: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html
@return [Array<String>]

@!attribute [rw] tags

The key-value pairs to associate with this stack set and the stacks
created from it. CloudFormation also propagates these tags to
supported resources that are created in the stacks. You can specify
a maximum number of 50 tags.

If you specify tags for this parameter, those tags replace any list
of tags that are currently associated with this stack set. This
means:

* If you don't specify this parameter, CloudFormation doesn't
  modify the stack's tags.

* If you specify *any* tags using this parameter, you must specify
  *all* the tags that you want associated with this stack set, even
  tags you've specified before (for example, when creating the
  stack set or during a previous update of the stack set.). Any tags
  that you don't include in the updated list of tags are removed
  from the stack set, and therefore from the stacks and resources as
  well.

* If you specify an empty value, CloudFormation removes all
  currently associated tags.

If you specify new tags as part of an `UpdateStackSet` action,
CloudFormation checks to see if you have the required IAM permission
to tag resources. If you omit tags that are currently associated
with the stack set from the list of tags you specify, CloudFormation
assumes that you want to remove those tags from the stack set, and
checks to see if you have permission to untag resources. If you
don't have the necessary permission(s), the entire `UpdateStackSet`
action fails with an `access denied` error, and the stack set is not
updated.
@return [Array<Types::Tag>]

@!attribute [rw] operation_preferences

Preferences for how CloudFormation performs this stack set
operation.
@return [Types::StackSetOperationPreferences]

@!attribute [rw] administration_role_arn

The Amazon Resource Number (ARN) of the IAM role to use to update
this stack set.

Specify an IAM role only if you are using customized administrator
roles to control which users or groups can manage specific stack
sets within the same administrator account. For more information,
see [Granting Permissions for Stack Set Operations][1] in the
*CloudFormation User Guide*.

If you specified a customized administrator role when you created
the stack set, you must specify a customized administrator role,
even if it is the same customized administrator role used with this
stack set previously.

[1]: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html
@return [String]

@!attribute [rw] execution_role_name

The name of the IAM execution role to use to update the stack set.
If you do not specify an execution role, CloudFormation uses the
`AWSCloudFormationStackSetExecutionRole` role for the stack set
operation.

Specify an IAM role only if you are using customized execution roles
to control which stack resources users and groups can include in
their stack sets.

If you specify a customized execution role, CloudFormation uses that
role to update the stack. If you do not specify a customized
execution role, CloudFormation performs the update using the role
previously associated with the stack set, so long as you have
permissions to perform operations on the stack set.
@return [String]

@!attribute [rw] deployment_targets

\[Service-managed permissions\] The Organizations accounts in which
to update associated stack instances.

To update all the stack instances associated with this stack set, do
not specify `DeploymentTargets` or `Regions`.

If the stack set update includes changes to the template (that is,
if `TemplateBody` or `TemplateURL` is specified), or the
`Parameters`, CloudFormation marks all stack instances with a status
of `OUTDATED` prior to updating the stack instances in the specified
accounts and Amazon Web Services Regions. If the stack set update
doesn't include changes to the template or parameters,
CloudFormation updates the stack instances in the specified accounts
and Regions, while leaving all other stack instances with their
existing stack instance status.
@return [Types::DeploymentTargets]

@!attribute [rw] permission_model

Describes how the IAM roles required for stack set operations are
created. You cannot modify `PermissionModel` if there are stack
instances associated with your stack set.

* With `self-managed` permissions, you must create the administrator
  and execution roles required to deploy to target accounts. For
  more information, see [Grant Self-Managed Stack Set
  Permissions][1].

* With `service-managed` permissions, StackSets automatically
  creates the IAM roles required to deploy to accounts managed by
  Organizations. For more information, see [Grant Service-Managed
  Stack Set Permissions][2].

[1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-self-managed.html
[2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-service-managed.html
@return [String]

@!attribute [rw] auto_deployment

\[Service-managed permissions\] Describes whether StackSets
automatically deploys to Organizations accounts that are added to a
target organization or organizational unit (OU).

If you specify `AutoDeployment`, don't specify `DeploymentTargets`
or `Regions`.
@return [Types::AutoDeployment]

@!attribute [rw] operation_id

The unique ID for this stack set operation.

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

If you don't specify an operation ID, CloudFormation generates one
automatically.

Repeating this stack set 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.
@return [String]

@!attribute [rw] accounts

\[Self-managed permissions\] The accounts in which to update
associated stack instances. If you specify accounts, you must also
specify the Amazon Web Services Regions in which to update stack set
instances.

To update *all* the stack instances associated with this stack set,
don't specify the `Accounts` or `Regions` properties.

If the stack set update includes changes to the template (that is,
if the `TemplateBody` or `TemplateURL` properties are specified), or
the `Parameters` property, CloudFormation marks all stack instances
with a status of `OUTDATED` prior to updating the stack instances in
the specified accounts and Amazon Web Services Regions. If the stack
set update does not include changes to the template or parameters,
CloudFormation updates the stack instances in the specified accounts
and Amazon Web Services Regions, while leaving all other stack
instances with their existing stack instance status.
@return [Array<String>]

@!attribute [rw] regions

The Amazon Web Services Regions in which to update associated stack
instances. If you specify Regions, you must also specify accounts in
which to update stack set instances.

To update *all* the stack instances associated with this stack set,
do not specify the `Accounts` or `Regions` properties.

If the stack set update includes changes to the template (that is,
if the `TemplateBody` or `TemplateURL` properties are specified), or
the `Parameters` property, CloudFormation marks all stack instances
with a status of `OUTDATED` prior to updating the stack instances in
the specified accounts and Regions. If the stack set update does not
include changes to the template or parameters, CloudFormation
updates the stack instances in the specified accounts and Regions,
while leaving all other stack instances with their existing stack
instance status.
@return [Array<String>]

@!attribute [rw] call_as

\[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 stack sets 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]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html
@return [String]

@!attribute [rw] managed_execution

Describes whether StackSets performs non-conflicting operations
concurrently and queues conflicting operations.
@return [Types::ManagedExecution]

@see docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/UpdateStackSetInput AWS API Documentation

Constants

SENSITIVE