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

Interface DeleteStackInstancesRequest.Builder

    • Method Detail

      • stackSetName

        DeleteStackInstancesRequest.Builder stackSetName​(String stackSetName)

        The name or unique ID of the stack set that you want to delete stack instances for.

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

      • accounts

        DeleteStackInstancesRequest.Builder accounts​(Collection<String> accounts)

        [Self-managed permissions] The names of the Amazon Web Services accounts that you want to delete stack instances for.

        You can specify Accounts or DeploymentTargets, but not both.

        Parameters:
        accounts - [Self-managed permissions] The names of the Amazon Web Services accounts that you want to delete stack instances 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

        DeleteStackInstancesRequest.Builder accounts​(String... accounts)

        [Self-managed permissions] The names of the Amazon Web Services accounts that you want to delete stack instances for.

        You can specify Accounts or DeploymentTargets, but not both.

        Parameters:
        accounts - [Self-managed permissions] The names of the Amazon Web Services accounts that you want to delete stack instances 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

        DeleteStackInstancesRequest.Builder deploymentTargets​(DeploymentTargets deploymentTargets)

        [Service-managed permissions] The Organizations accounts from which to delete stack instances.

        You can specify Accounts or DeploymentTargets, but not both.

        Parameters:
        deploymentTargets - [Service-managed permissions] The Organizations accounts from which to delete stack instances.

        You can specify Accounts or DeploymentTargets, but not both.

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

      • regions

        DeleteStackInstancesRequest.Builder regions​(Collection<String> regions)

        The Amazon Web Services Regions where you want to delete stack set instances.

        Parameters:
        regions - The Amazon Web Services Regions where you want to delete stack set instances.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • regions

        DeleteStackInstancesRequest.Builder regions​(String... regions)

        The Amazon Web Services Regions where you want to delete stack set instances.

        Parameters:
        regions - The Amazon Web Services Regions where you want to delete stack set instances.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • operationPreferences

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

      • retainStacks

        DeleteStackInstancesRequest.Builder retainStacks​(Boolean retainStacks)

        Removes the stack instances from the specified stack set, but doesn't delete the stacks. You can't reassociate a retained stack or add an existing, saved stack to a new stack set.

        For more information, see Stack set operation options.

        Parameters:
        retainStacks - Removes the stack instances from the specified stack set, but doesn't delete the stacks. You can't reassociate a retained stack or add an existing, saved stack to a new stack set.

        For more information, see Stack set operation options.

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

      • operationId

        DeleteStackInstancesRequest.Builder operationId​(String operationId)

        The unique identifier for this stack set operation.

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

        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 can retry stack set operation requests to ensure that CloudFormation successfully received them.

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

        Parameters:
        operationId - The unique identifier for this stack set operation.

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

        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 can retry stack set operation requests to ensure that CloudFormation successfully received them.

        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.

      • callAs

        DeleteStackInstancesRequest.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, CallAs

      • callAs

        DeleteStackInstancesRequest.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:
        CallAs, CallAs