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

Class DeleteStackRequest

    • Method Detail

      • stackName

        public final String stackName()

        The name or the unique stack ID that's associated with the stack.

        Returns:
        The name or the unique stack ID that's associated with the stack.

      • hasRetainResources

        public final boolean hasRetainResources()
        For responses, this returns true if the service returned a value for the RetainResources 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.

      • retainResources

        public final List<String> retainResources()

        For stacks in the DELETE_FAILED state, a list of resource logical IDs that are associated with the resources you want to retain. During deletion, CloudFormation deletes the stack but doesn't delete the retained resources.

        Retaining resources is useful when you can't delete a resource, such as a non-empty S3 bucket, but you want to delete the stack.

        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 hasRetainResources() method.

        Returns:
        For stacks in the DELETE_FAILED state, a list of resource logical IDs that are associated with the resources you want to retain. During deletion, CloudFormation deletes the stack but doesn't delete the retained resources.

        Retaining resources is useful when you can't delete a resource, such as a non-empty S3 bucket, but you want to delete the stack.

      • roleARN

        public final String roleARN()

        The Amazon Resource Name (ARN) of an IAM role that CloudFormation assumes to delete the stack. CloudFormation uses the role's credentials to make calls on your behalf.

        If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that's generated from your user credentials.

        Returns:
        The Amazon Resource Name (ARN) of an IAM role that CloudFormation assumes to delete the stack. CloudFormation uses the role's credentials to make calls on your behalf.

        If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that's generated from your user credentials.

      • clientRequestToken

        public final String clientRequestToken()

        A unique identifier for this DeleteStack request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to delete a stack with the same name. You might retry DeleteStack requests to ensure that CloudFormation successfully received them.

        All events initiated by a given stack operation are assigned the same client request token, which you can use to track operations. For example, if you execute a CreateStack operation with the token token1, then all the StackEvents generated by that operation will have ClientRequestToken set as token1.

        In the console, stack operations display the client request token on the Events tab. Stack operations that are initiated from the console use the token format Console-StackOperation-ID, which helps you easily identify the stack operation . For example, if you create a stack using the console, each stack event would be assigned the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.

        Returns:
        A unique identifier for this DeleteStack request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to delete a stack with the same name. You might retry DeleteStack requests to ensure that CloudFormation successfully received them.

        All events initiated by a given stack operation are assigned the same client request token, which you can use to track operations. For example, if you execute a CreateStack operation with the token token1, then all the StackEvents generated by that operation will have ClientRequestToken set as token1.

        In the console, stack operations display the client request token on the Events tab. Stack operations that are initiated from the console use the token format Console-StackOperation-ID, which helps you easily identify the stack operation . For example, if you create a stack using the console, each stack event would be assigned the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.

      • deletionMode

        public final DeletionMode deletionMode()

        Specifies the deletion mode for the stack. Possible values are:

        • STANDARD - Use the standard behavior. Specifying this value is the same as not specifying this parameter.

        • FORCE_DELETE_STACK - Delete the stack if it's stuck in a DELETE_FAILED state due to resource deletion failure.

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

        Returns:
        Specifies the deletion mode for the stack. Possible values are:

        • STANDARD - Use the standard behavior. Specifying this value is the same as not specifying this parameter.

        • FORCE_DELETE_STACK - Delete the stack if it's stuck in a DELETE_FAILED state due to resource deletion failure.

        See Also:
        DeletionMode

      • deletionModeAsString

        public final String deletionModeAsString()

        Specifies the deletion mode for the stack. Possible values are:

        • STANDARD - Use the standard behavior. Specifying this value is the same as not specifying this parameter.

        • FORCE_DELETE_STACK - Delete the stack if it's stuck in a DELETE_FAILED state due to resource deletion failure.

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

        Returns:
        Specifies the deletion mode for the stack. Possible values are:

        • STANDARD - Use the standard behavior. Specifying this value is the same as not specifying this parameter.

        • FORCE_DELETE_STACK - Delete the stack if it's stuck in a DELETE_FAILED state due to resource deletion failure.

        See Also:
        DeletionMode

      • 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