Interface UpdateStackSetRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CloudFormationRequest.Builder, CopyableBuilder<UpdateStackSetRequest.Builder,UpdateStackSetRequest>, SdkBuilder<UpdateStackSetRequest.Builder,UpdateStackSetRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
UpdateStackSetRequest
@Mutable @NotThreadSafe public static interface UpdateStackSetRequest.Builder extends CloudFormationRequest.Builder, SdkPojo, CopyableBuilder<UpdateStackSetRequest.Builder,UpdateStackSetRequest>

  • Method Details

    • stackSetName

      UpdateStackSetRequest.Builder stackSetName(String stackSetName)

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

      Parameters:
      stackSetName - The name or unique ID of the stack set that you want to update.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      UpdateStackSetRequest.Builder description(String description)

      A brief description of updates that you are making.

      Parameters:
      description - A brief description of updates that you are making.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • templateBody

      UpdateStackSetRequest.Builder templateBody(String templateBody)

      The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes.

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

      Parameters:
      templateBody - The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • templateURL

      UpdateStackSetRequest.Builder templateURL(String templateURL)

      The URL of a file that contains the template body. The URL must point to a template (maximum size: 1 MB) that is located in an Amazon S3 bucket or a Systems Manager document. The location for an Amazon S3 bucket must start with https://. S3 static website URLs are not supported.

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

      Parameters:
      templateURL - The URL of a file that contains the template body. The URL must point to a template (maximum size: 1 MB) that is located in an Amazon S3 bucket or a Systems Manager document. The location for an Amazon S3 bucket must start with https://. S3 static website URLs are not supported.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • usePreviousTemplate

      UpdateStackSetRequest.Builder usePreviousTemplate(Boolean 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • parameters

      UpdateStackSetRequest.Builder parameters(Collection<Parameter> parameters)

      A list of input parameters for the stack set template.

      Parameters:
      parameters - A list of input parameters for the stack set template.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • parameters

      UpdateStackSetRequest.Builder parameters(Parameter... parameters)

      A list of input parameters for the stack set template.

      Parameters:
      parameters - A list of input parameters for the stack set template.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • parameters

      UpdateStackSetRequest.Builder parameters(Consumer<Parameter.Builder>... parameters)

      A list of input parameters for the stack set template.

      This is a convenience method that creates an instance of the Parameter.Builder avoiding the need to create one manually via Parameter.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to parameters(List<Parameter>).

      Parameters:
      parameters - a consumer that will call methods on Parameter.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • capabilitiesWithStrings

      UpdateStackSetRequest.Builder capabilitiesWithStrings(Collection<String> 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 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.

        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 Perform custom processing on CloudFormation templates with template macros.

        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.

      Parameters:
      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 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.

        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 Perform custom processing on CloudFormation templates with template macros.

        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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • capabilitiesWithStrings

      UpdateStackSetRequest.Builder capabilitiesWithStrings(String... 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 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.

        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 Perform custom processing on CloudFormation templates with template macros.

        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.

      Parameters:
      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 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.

        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 Perform custom processing on CloudFormation templates with template macros.

        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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • capabilities

      UpdateStackSetRequest.Builder capabilities(Collection<Capability> 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 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.

        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 Perform custom processing on CloudFormation templates with template macros.

        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.

      Parameters:
      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 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.

        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 Perform custom processing on CloudFormation templates with template macros.

        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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • capabilities

      UpdateStackSetRequest.Builder capabilities(Capability... 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 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.

        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 Perform custom processing on CloudFormation templates with template macros.

        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.

      Parameters:
      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 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.

        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 Perform custom processing on CloudFormation templates with template macros.

        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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      UpdateStackSetRequest.Builder tags(Collection<Tag> 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      UpdateStackSetRequest.Builder tags(Tag... 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      UpdateStackSetRequest.Builder tags(Consumer<Tag.Builder>... 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.

      This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

      Parameters:
      tags - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • operationPreferences

      UpdateStackSetRequest.Builder operationPreferences(StackSetOperationPreferences operationPreferences)

      Preferences for how CloudFormation performs this stack set operation.

      Parameters:
      operationPreferences - Preferences for how CloudFormation performs this stack set operation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • operationPreferences

      default UpdateStackSetRequest.Builder operationPreferences(Consumer<StackSetOperationPreferences.Builder> operationPreferences)

      Preferences for how CloudFormation performs this stack set operation.

      This is a convenience method that creates an instance of the StackSetOperationPreferences.Builder avoiding the need to create one manually via StackSetOperationPreferences.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to operationPreferences(StackSetOperationPreferences).

      Parameters:
      operationPreferences - a consumer that will call methods on StackSetOperationPreferences.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • administrationRoleARN

      UpdateStackSetRequest.Builder administrationRoleARN(String administrationRoleARN)

      [Self-managed permissions] 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 Grant self-managed permissions 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.

      Parameters:
      administrationRoleARN - [Self-managed permissions] 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 Grant self-managed permissions 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • executionRoleName

      UpdateStackSetRequest.Builder executionRoleName(String executionRoleName)

      [Self-managed permissions] 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.

      Parameters:
      executionRoleName - [Self-managed permissions] 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • deploymentTargets

      UpdateStackSetRequest.Builder deploymentTargets(DeploymentTargets 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • deploymentTargets

      default UpdateStackSetRequest.Builder deploymentTargets(Consumer<DeploymentTargets.Builder> 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.

      This is a convenience method that creates an instance of the DeploymentTargets.Builder avoiding the need to create one manually via DeploymentTargets.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to deploymentTargets(DeploymentTargets).

      Parameters:
      deploymentTargets - a consumer that will call methods on DeploymentTargets.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • permissionModel

      UpdateStackSetRequest.Builder permissionModel(String 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • permissionModel

      UpdateStackSetRequest.Builder permissionModel(PermissionModels 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • autoDeployment

      UpdateStackSetRequest.Builder autoDeployment(AutoDeployment autoDeployment)

      [Service-managed permissions] Describes whether StackSets automatically deploys to Organizations accounts that are added to a target organization or organizational unit (OU). For more information, see Manage automatic deployments for CloudFormation StackSets that use service-managed permissions in the CloudFormation User Guide.

      If you specify AutoDeployment, don't specify DeploymentTargets or Regions.

      Parameters:
      autoDeployment - [Service-managed permissions] Describes whether StackSets automatically deploys to Organizations accounts that are added to a target organization or organizational unit (OU). For more information, see Manage automatic deployments for CloudFormation StackSets that use service-managed permissions in the CloudFormation User Guide.

      If you specify AutoDeployment, don't specify DeploymentTargets or Regions.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • autoDeployment

      default UpdateStackSetRequest.Builder autoDeployment(Consumer<AutoDeployment.Builder> autoDeployment)

      [Service-managed permissions] Describes whether StackSets automatically deploys to Organizations accounts that are added to a target organization or organizational unit (OU). For more information, see Manage automatic deployments for CloudFormation StackSets that use service-managed permissions in the CloudFormation User Guide.

      If you specify AutoDeployment, don't specify DeploymentTargets or Regions.

      This is a convenience method that creates an instance of the AutoDeployment.Builder avoiding the need to create one manually via AutoDeployment.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to autoDeployment(AutoDeployment).

      Parameters:
      autoDeployment - a consumer that will call methods on AutoDeployment.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • operationId

      UpdateStackSetRequest.Builder operationId(String 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • accounts

      UpdateStackSetRequest.Builder accounts(Collection<String> 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • accounts

      UpdateStackSetRequest.Builder accounts(String... 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • regions

      UpdateStackSetRequest.Builder regions(Collection<String> 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • regions

      UpdateStackSetRequest.Builder regions(String... 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • callAs

      UpdateStackSetRequest.Builder callAs(String 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • callAs

      UpdateStackSetRequest.Builder callAs(CallAs 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • managedExecution

      UpdateStackSetRequest.Builder managedExecution(ManagedExecution managedExecution)

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

      Parameters:
      managedExecution - Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • managedExecution

      default UpdateStackSetRequest.Builder managedExecution(Consumer<ManagedExecution.Builder> managedExecution)

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

      This is a convenience method that creates an instance of the ManagedExecution.Builder avoiding the need to create one manually via ManagedExecution.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to managedExecution(ManagedExecution).

      Parameters:
      managedExecution - a consumer that will call methods on ManagedExecution.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      UpdateStackSetRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      UpdateStackSetRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.