Amazonka.CloudFormation.UpdateStackSet

Updates the stack set, and associated stack instances in the specified accounts and Amazon Web Services Regions.

Even if the stack set operation created by updating the stack set fails (completely or partially, below or above a specified failure tolerance), the stack set is updated with your changes. Subsequent CreateStackInstances calls on the specified stack set use the updated stack set.

Creating a Request

data UpdateStackSet

See: newUpdateStackSet smart constructor.

Constructors

UpdateStackSet'

Fields

• accounts :: Maybe [Text]

  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.

• administrationRoleARN :: Maybe Text

  The Amazon Resource Name (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 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.

• autoDeployment :: Maybe AutoDeployment

  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.

• callAs :: Maybe CallAs

  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 in the CloudFormation User Guide.

• capabilities :: Maybe [Capability]

  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
    • AWS::IAM::Group
    • AWS::IAM::InstanceProfile
    • AWS::IAM::Policy
    • AWS::IAM::Role
    • AWS::IAM::User
    • AWS::IAM::UserToGroupAddition

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

  • 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.

    Stack sets with service-managed permissions do not currently support the use of macros in templates. (This includes the AWS::Include and AWS::Serverless 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.

• deploymentTargets :: Maybe DeploymentTargets

  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.

• description :: Maybe Text

  A brief description of updates that you are making.

• executionRoleName :: Maybe Text

  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.

• managedExecution :: Maybe ManagedExecution

  Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.

• operationId :: Maybe Text

  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.

• operationPreferences :: Maybe StackSetOperationPreferences

  Preferences for how CloudFormation performs this stack set operation.

• parameters :: Maybe [Parameter]

  A list of input parameters for the stack set template.

• permissionModel :: Maybe PermissionModels

  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.
  • 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.
• regions :: Maybe [Text]

  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.

• tags :: Maybe [Tag]

  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.

• templateBody :: Maybe Text

  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 in the CloudFormation User Guide.

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

• templateURL :: Maybe Text

  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 in the CloudFormation User Guide.

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

• usePreviousTemplate :: Maybe Bool

  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.

• stackSetName :: Text

  The name or unique ID of the stack set that you want to update.

Instances

ToHeaders UpdateStackSet

Defined in Amazonka.CloudFormation.UpdateStackSet

Methods

toHeaders :: UpdateStackSet -> [Header]

ToPath UpdateStackSet

Defined in Amazonka.CloudFormation.UpdateStackSet

Methods

toPath :: UpdateStackSet -> ByteString

ToQuery UpdateStackSet

Defined in Amazonka.CloudFormation.UpdateStackSet

Methods

toQuery :: UpdateStackSet -> QueryString

AWSRequest UpdateStackSet

Defined in Amazonka.CloudFormation.UpdateStackSet

Associated Types

type AWSResponse UpdateStackSet

Methods

request :: (Service -> Service) -> UpdateStackSet -> Request UpdateStackSet

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateStackSet -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateStackSet)))

Generic UpdateStackSet

Defined in Amazonka.CloudFormation.UpdateStackSet

Associated Types

type Rep UpdateStackSet :: Type -> Type

Methods

from :: UpdateStackSet -> Rep UpdateStackSet x

to :: Rep UpdateStackSet x -> UpdateStackSet

Read UpdateStackSet

Defined in Amazonka.CloudFormation.UpdateStackSet

Methods

readsPrec :: Int -> ReadS UpdateStackSet

readList :: ReadS [UpdateStackSet]

readPrec :: ReadPrec UpdateStackSet

readListPrec :: ReadPrec [UpdateStackSet]

Show UpdateStackSet

Defined in Amazonka.CloudFormation.UpdateStackSet

Methods

showsPrec :: Int -> UpdateStackSet -> ShowS

show :: UpdateStackSet -> String

showList :: [UpdateStackSet] -> ShowS

NFData UpdateStackSet

Defined in Amazonka.CloudFormation.UpdateStackSet

Methods

rnf :: UpdateStackSet -> ()

Eq UpdateStackSet

Defined in Amazonka.CloudFormation.UpdateStackSet

Methods

(==) :: UpdateStackSet -> UpdateStackSet -> Bool

(/=) :: UpdateStackSet -> UpdateStackSet -> Bool

Hashable UpdateStackSet

Defined in Amazonka.CloudFormation.UpdateStackSet

Methods

hashWithSalt :: Int -> UpdateStackSet -> Int

hash :: UpdateStackSet -> Int

type AWSResponse UpdateStackSet

Defined in Amazonka.CloudFormation.UpdateStackSet

type AWSResponse UpdateStackSet = UpdateStackSetResponse

type Rep UpdateStackSet

Defined in Amazonka.CloudFormation.UpdateStackSet

type Rep UpdateStackSet = D1 ('MetaData "UpdateStackSet" "Amazonka.CloudFormation.UpdateStackSet" "amazonka-cloudformation-2.0-2g2oPzedi5AcwbDRlNZfB" 'False) (C1 ('MetaCons "UpdateStackSet'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "accounts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "administrationRoleARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "autoDeployment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AutoDeployment)) :*: S1 ('MetaSel ('Just "callAs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CallAs)))) :*: ((S1 ('MetaSel ('Just "capabilities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Capability])) :*: S1 ('MetaSel ('Just "deploymentTargets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DeploymentTargets))) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "executionRoleName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "managedExecution") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ManagedExecution)))))) :*: (((S1 ('MetaSel ('Just "operationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "operationPreferences") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StackSetOperationPreferences))) :*: (S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Parameter])) :*: (S1 ('MetaSel ('Just "permissionModel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PermissionModels)) :*: S1 ('MetaSel ('Just "regions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))) :*: ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 ('MetaSel ('Just "templateBody") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "templateURL") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "usePreviousTemplate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "stackSetName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))))

newUpdateStackSet

Arguments

:: Text

UpdateStackSet

-> UpdateStackSet

Create a value of UpdateStackSet with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

UpdateStackSet, updateStackSet_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.

UpdateStackSet, updateStackSet_administrationRoleARN - The Amazon Resource Name (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 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.

UpdateStackSet, updateStackSet_autoDeployment - [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.

$sel:callAs:UpdateStackSet', updateStackSet_callAs - [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 in the CloudFormation User Guide.

UpdateStackSet, updateStackSet_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
  • AWS::IAM::Group
  • AWS::IAM::InstanceProfile
  • AWS::IAM::Policy
  • AWS::IAM::Role
  • AWS::IAM::User
  • AWS::IAM::UserToGroupAddition

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

• 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.

  Stack sets with service-managed permissions do not currently support the use of macros in templates. (This includes the AWS::Include and AWS::Serverless 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.

UpdateStackSet, updateStackSet_deploymentTargets - [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.

UpdateStackSet, updateStackSet_description - A brief description of updates that you are making.

UpdateStackSet, updateStackSet_executionRoleName - 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.

UpdateStackSet, updateStackSet_managedExecution - Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.

UpdateStackSet, updateStackSet_operationId - 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.

UpdateStackSet, updateStackSet_operationPreferences - Preferences for how CloudFormation performs this stack set operation.

UpdateStackSet, updateStackSet_parameters - A list of input parameters for the stack set template.

UpdateStackSet, updateStackSet_permissionModel - 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.
• 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.

$sel:regions:UpdateStackSet', updateStackSet_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.

UpdateStackSet, updateStackSet_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.

UpdateStackSet, updateStackSet_templateBody - 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 in the CloudFormation User Guide.

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

$sel:templateURL:UpdateStackSet', updateStackSet_templateURL - 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 in the CloudFormation User Guide.

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

$sel:usePreviousTemplate:UpdateStackSet', updateStackSet_usePreviousTemplate - 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.

UpdateStackSet, updateStackSet_stackSetName - The name or unique ID of the stack set that you want to update.

Request Lenses

updateStackSet_accounts :: Lens' UpdateStackSet (Maybe [Text])

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.

updateStackSet_administrationRoleARN :: Lens' UpdateStackSet (Maybe Text)

The Amazon Resource Name (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 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.

updateStackSet_autoDeployment :: Lens' UpdateStackSet (Maybe AutoDeployment)

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.

updateStackSet_callAs :: Lens' UpdateStackSet (Maybe CallAs)

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 in the CloudFormation User Guide.

updateStackSet_capabilities :: Lens' UpdateStackSet (Maybe [Capability])

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
  • AWS::IAM::Group
  • AWS::IAM::InstanceProfile
  • AWS::IAM::Policy
  • AWS::IAM::Role
  • AWS::IAM::User
  • AWS::IAM::UserToGroupAddition

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

• 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.

  Stack sets with service-managed permissions do not currently support the use of macros in templates. (This includes the AWS::Include and AWS::Serverless 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.

updateStackSet_deploymentTargets :: Lens' UpdateStackSet (Maybe DeploymentTargets)

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.

updateStackSet_description :: Lens' UpdateStackSet (Maybe Text)

A brief description of updates that you are making.

updateStackSet_executionRoleName :: Lens' UpdateStackSet (Maybe Text)

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.

updateStackSet_managedExecution :: Lens' UpdateStackSet (Maybe ManagedExecution)

Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.

updateStackSet_operationId :: Lens' UpdateStackSet (Maybe Text)

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.

updateStackSet_operationPreferences :: Lens' UpdateStackSet (Maybe StackSetOperationPreferences)

Preferences for how CloudFormation performs this stack set operation.

updateStackSet_parameters :: Lens' UpdateStackSet (Maybe [Parameter])

A list of input parameters for the stack set template.

updateStackSet_permissionModel :: Lens' UpdateStackSet (Maybe PermissionModels)

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.
• 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.

updateStackSet_regions :: Lens' UpdateStackSet (Maybe [Text])

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.

updateStackSet_tags :: Lens' UpdateStackSet (Maybe [Tag])

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.

updateStackSet_templateBody :: Lens' UpdateStackSet (Maybe Text)

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 in the CloudFormation User Guide.

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

updateStackSet_templateURL :: Lens' UpdateStackSet (Maybe Text)

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 in the CloudFormation User Guide.

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

updateStackSet_usePreviousTemplate :: Lens' UpdateStackSet (Maybe Bool)

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.

updateStackSet_stackSetName :: Lens' UpdateStackSet Text

The name or unique ID of the stack set that you want to update.

Destructuring the Response

data UpdateStackSetResponse

See: newUpdateStackSetResponse smart constructor.

Constructors

UpdateStackSetResponse'

Fields

• operationId :: Maybe Text

  The unique ID for this stack set operation.

• httpStatus :: Int

  The response's http status code.

Instances

Generic UpdateStackSetResponse

Defined in Amazonka.CloudFormation.UpdateStackSet

Associated Types

type Rep UpdateStackSetResponse :: Type -> Type

Methods

from :: UpdateStackSetResponse -> Rep UpdateStackSetResponse x

to :: Rep UpdateStackSetResponse x -> UpdateStackSetResponse

Read UpdateStackSetResponse

Defined in Amazonka.CloudFormation.UpdateStackSet

Methods

readsPrec :: Int -> ReadS UpdateStackSetResponse

readList :: ReadS [UpdateStackSetResponse]

readPrec :: ReadPrec UpdateStackSetResponse

readListPrec :: ReadPrec [UpdateStackSetResponse]

Show UpdateStackSetResponse

Defined in Amazonka.CloudFormation.UpdateStackSet

Methods

showsPrec :: Int -> UpdateStackSetResponse -> ShowS

show :: UpdateStackSetResponse -> String

showList :: [UpdateStackSetResponse] -> ShowS

NFData UpdateStackSetResponse

Defined in Amazonka.CloudFormation.UpdateStackSet

Methods

rnf :: UpdateStackSetResponse -> ()

Eq UpdateStackSetResponse

Defined in Amazonka.CloudFormation.UpdateStackSet

Methods

(==) :: UpdateStackSetResponse -> UpdateStackSetResponse -> Bool

(/=) :: UpdateStackSetResponse -> UpdateStackSetResponse -> Bool

type Rep UpdateStackSetResponse

Defined in Amazonka.CloudFormation.UpdateStackSet

type Rep UpdateStackSetResponse = D1 ('MetaData "UpdateStackSetResponse" "Amazonka.CloudFormation.UpdateStackSet" "amazonka-cloudformation-2.0-2g2oPzedi5AcwbDRlNZfB" 'False) (C1 ('MetaCons "UpdateStackSetResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "operationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateStackSetResponse

Arguments

:: Int

$sel:httpStatus:UpdateStackSetResponse'

-> UpdateStackSetResponse

Create a value of UpdateStackSetResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

UpdateStackSet, updateStackSetResponse_operationId - The unique ID for this stack set operation.

$sel:httpStatus:UpdateStackSetResponse', updateStackSetResponse_httpStatus - The response's http status code.

Response Lenses

updateStackSetResponse_operationId :: Lens' UpdateStackSetResponse (Maybe Text)

The unique ID for this stack set operation.

updateStackSetResponse_httpStatus :: Lens' UpdateStackSetResponse Int

The response's http status code.