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

Class DeleteStackInstancesRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.cloudformation.model.CloudFormationRequest
software.amazon.awssdk.services.cloudformation.model.DeleteStackInstancesRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DeleteStackInstancesRequest.Builder,DeleteStackInstancesRequest>
@Generated("software.amazon.awssdk:codegen") public final class DeleteStackInstancesRequest extends CloudFormationRequest implements ToCopyableBuilder<DeleteStackInstancesRequest.Builder,DeleteStackInstancesRequest>

  • Method Details

    • stackSetName

      public final String stackSetName()

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

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

    • hasAccounts

      public final boolean hasAccounts()
      For responses, this returns true if the service returned a value for the Accounts property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • accounts

      public final List<String> accounts()

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

      You can specify Accounts or DeploymentTargets, but not both.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAccounts() method.

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

      You can specify Accounts or DeploymentTargets, but not both.

    • deploymentTargets

      public final DeploymentTargets deploymentTargets()

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

      You can specify Accounts or DeploymentTargets, but not both.

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

      You can specify Accounts or DeploymentTargets, but not both.

    • hasRegions

      public final boolean hasRegions()
      For responses, this returns true if the service returned a value for the Regions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • regions

      public final List<String> regions()

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

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRegions() method.

      Returns:
      The Amazon Web Services Regions where you want to delete StackSet instances.

    • operationPreferences

      public final StackSetOperationPreferences operationPreferences()

      Preferences for how CloudFormation performs this StackSet operation.

      Returns:
      Preferences for how CloudFormation performs this StackSet operation.

    • retainStacks

      public final Boolean retainStacks()

      Removes the stack instances from the specified StackSet, 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 StackSet operation options.

      Returns:
      Removes the stack instances from the specified StackSet, 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 StackSet operation options.

    • operationId

      public final String operationId()

      The unique identifier for this StackSet 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 StackSet operation only once, even if you retry the request multiple times. You can retry StackSet operation requests to ensure that CloudFormation successfully received them.

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

      Returns:
      The unique identifier for this StackSet 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 StackSet operation only once, even if you retry the request multiple times. You can retry StackSet operation requests to ensure that CloudFormation successfully received them.

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

    • callAs

      public final 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.

      If the service returns an enum value that is not available in the current SDK version, callAs will return CallAs.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from callAsAsString().

      Returns:
      [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.

      See Also:

    • callAsAsString

      public final String callAsAsString()

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

      If the service returns an enum value that is not available in the current SDK version, callAs will return CallAs.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from callAsAsString().

      Returns:
      [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.

      See Also:

    • toBuilder

      public DeleteStackInstancesRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<DeleteStackInstancesRequest.Builder,DeleteStackInstancesRequest>
      Specified by:
      toBuilder in class CloudFormationRequest

    • builder

      public static DeleteStackInstancesRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DeleteStackInstancesRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Overrides:
      getValueForField in class SdkRequest

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo