Interface CreateStackInstancesRequest.Builder

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

  • Method Details

    • stackSetName

      CreateStackInstancesRequest.Builder stackSetName(String stackSetName)

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

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

    • accounts

      CreateStackInstancesRequest.Builder accounts(Collection<String> accounts)

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

      You can specify Accounts or DeploymentTargets, but not both.

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

      You can specify Accounts or DeploymentTargets, but not both.

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

    • accounts

      CreateStackInstancesRequest.Builder accounts(String... accounts)

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

      You can specify Accounts or DeploymentTargets, but not both.

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

      You can specify Accounts or DeploymentTargets, but not both.

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

    • deploymentTargets

      CreateStackInstancesRequest.Builder deploymentTargets(DeploymentTargets deploymentTargets)

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

      You can specify Accounts or DeploymentTargets, but not both.

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

      You can specify Accounts or DeploymentTargets, but not both.

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

    • deploymentTargets

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

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

      You can specify Accounts or DeploymentTargets, but not both.

      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

      CreateStackInstancesRequest.Builder regions(Collection<String> regions)

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

      Parameters:
      regions - The names of one or more Amazon Web Services Regions where you want to create stack instances using the specified Amazon Web Services accounts.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • regions

      CreateStackInstancesRequest.Builder regions(String... regions)

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

      Parameters:
      regions - The names of one or more Amazon Web Services Regions where you want to create stack instances using the specified Amazon Web Services accounts.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • parameterOverrides

      CreateStackInstancesRequest.Builder parameterOverrides(Collection<Parameter> parameterOverrides)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    • parameterOverrides

      CreateStackInstancesRequest.Builder parameterOverrides(Parameter... parameterOverrides)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    • parameterOverrides

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

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

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

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

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

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

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

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

      You can only override the parameter values that are specified in the StackSet; to add or delete a parameter itself, use UpdateStackSet to update the StackSet 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 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

      CreateStackInstancesRequest.Builder operationPreferences(StackSetOperationPreferences operationPreferences)

      Preferences for how CloudFormation performs this StackSet operation.

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

    • operationPreferences

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

      Preferences for how CloudFormation performs this StackSet 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

      CreateStackInstancesRequest.Builder operationId(String operationId)

      The unique identifier for this StackSet operation.

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

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

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

      Parameters:
      operationId - The unique identifier for this StackSet operation.

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

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

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

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

    • callAs

      CreateStackInstancesRequest.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 StackSets with self-managed permissions.

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

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

        Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator 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 StackSets with self-managed permissions.

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

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

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

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

    • callAs

      CreateStackInstancesRequest.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 StackSets with self-managed permissions.

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

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

        Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator 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 StackSets with self-managed permissions.

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

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

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

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

    • overrideConfiguration

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

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