Package software.amazon.awssdk.services.cloudformation.model

Interface UpdateStackInstancesRequest.Builder

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

  • Method Details

    • stackSetName

      UpdateStackInstancesRequest.Builder stackSetName(String stackSetName)

      The name or unique ID of the stack set associated with the stack instances.

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

    • accounts

      UpdateStackInstancesRequest.Builder accounts(Collection<String> accounts)

      [Self-managed permissions] The names of one or more Amazon Web Services accounts for which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and Amazon Web Services Regions.

      You can specify Accounts or DeploymentTargets, but not both.

      Parameters:
      accounts - [Self-managed permissions] The names of one or more Amazon Web Services accounts for which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and Amazon Web Services Regions.

      You can specify Accounts or DeploymentTargets, but not both.

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

    • accounts

      UpdateStackInstancesRequest.Builder accounts(String... accounts)

      [Self-managed permissions] The names of one or more Amazon Web Services accounts for which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and Amazon Web Services Regions.

      You can specify Accounts or DeploymentTargets, but not both.

      Parameters:
      accounts - [Self-managed permissions] The names of one or more Amazon Web Services accounts for which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and Amazon Web Services Regions.

      You can specify Accounts or DeploymentTargets, but not both.

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

    • deploymentTargets

      UpdateStackInstancesRequest.Builder deploymentTargets(DeploymentTargets deploymentTargets)

      [Service-managed permissions] The Organizations accounts for which you want to update parameter values for stack instances. If your update targets OUs, the overridden parameter values only apply to the accounts that are currently in the target OUs and their child OUs. Accounts added to the target OUs and their child OUs in the future won't use the overridden values.

      You can specify Accounts or DeploymentTargets, but not both.

      Parameters:
      deploymentTargets - [Service-managed permissions] The Organizations accounts for which you want to update parameter values for stack instances. If your update targets OUs, the overridden parameter values only apply to the accounts that are currently in the target OUs and their child OUs. Accounts added to the target OUs and their child OUs in the future won't use the overridden values.

      You can specify Accounts or DeploymentTargets, but not both.

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

    • deploymentTargets

      default UpdateStackInstancesRequest.Builder deploymentTargets(Consumer<DeploymentTargets.Builder> deploymentTargets)

      [Service-managed permissions] The Organizations accounts for which you want to update parameter values for stack instances. If your update targets OUs, the overridden parameter values only apply to the accounts that are currently in the target OUs and their child OUs. Accounts added to the target OUs and their child OUs in the future won't use the overridden values.

      You can specify Accounts or DeploymentTargets, but not both.

      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:

    • regions

      UpdateStackInstancesRequest.Builder regions(Collection<String> regions)

      The names of one or more Amazon Web Services Regions in which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and Amazon Web Services Regions.

      Parameters:
      regions - The names of one or more Amazon Web Services Regions in which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and Amazon Web Services Regions.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • regions

      UpdateStackInstancesRequest.Builder regions(String... regions)

      The names of one or more Amazon Web Services Regions in which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and Amazon Web Services Regions.

      Parameters:
      regions - The names of one or more Amazon Web Services Regions in which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and Amazon Web Services Regions.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • parameterOverrides

      UpdateStackInstancesRequest.Builder parameterOverrides(Collection<Parameter> parameterOverrides)

      A list of input parameters whose values you want to update for the specified stack instances.

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

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

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

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

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

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

      You can only override the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template. If you add a parameter to a template, before you can override the parameter value specified in the stack set you must first use UpdateStackSet to update all stack instances with the updated template and parameter value specified in the stack set. Once a stack instance has been updated with the new parameter, you can then override the parameter value using UpdateStackInstances.

      Parameters:
      parameterOverrides - A list of input parameters whose values you want to update for the specified stack instances.

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

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

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

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

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

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

      You can only override the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template. If you add a parameter to a template, before you can override the parameter value specified in the stack set you must first use UpdateStackSet to update all stack instances with the updated template and parameter value specified in the stack set. Once a stack instance has been updated with the new parameter, you can then override the parameter value using UpdateStackInstances.

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

    • parameterOverrides

      UpdateStackInstancesRequest.Builder parameterOverrides(Parameter... parameterOverrides)

      A list of input parameters whose values you want to update for the specified stack instances.

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

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

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

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

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

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

      You can only override the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template. If you add a parameter to a template, before you can override the parameter value specified in the stack set you must first use UpdateStackSet to update all stack instances with the updated template and parameter value specified in the stack set. Once a stack instance has been updated with the new parameter, you can then override the parameter value using UpdateStackInstances.

      Parameters:
      parameterOverrides - A list of input parameters whose values you want to update for the specified stack instances.

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

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

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

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

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

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

      You can only override the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template. If you add a parameter to a template, before you can override the parameter value specified in the stack set you must first use UpdateStackSet to update all stack instances with the updated template and parameter value specified in the stack set. Once a stack instance has been updated with the new parameter, you can then override the parameter value using UpdateStackInstances.

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

    • parameterOverrides

      UpdateStackInstancesRequest.Builder parameterOverrides(Consumer<Parameter.Builder>... parameterOverrides)

      A list of input parameters whose values you want to update for the specified stack instances.

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

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

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

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

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

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

      You can only override the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template. If you add a parameter to a template, before you can override the parameter value specified in the stack set you must first use UpdateStackSet to update all stack instances with the updated template and parameter value specified in the stack set. Once a stack instance has been updated with the new parameter, you can then override the parameter value using UpdateStackInstances.

      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 parameterOverrides(List<Parameter>).

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

    • operationPreferences

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

    • operationId

      UpdateStackInstancesRequest.Builder operationId(String operationId)

      The unique identifier 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, the SDK generates one automatically.

      Parameters:
      operationId - The unique identifier 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, the SDK generates one automatically.

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

    • callAs

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

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

    • overrideConfiguration

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

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