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

Interface DeleteStackRequest.Builder

    • Method Detail

      • stackName

        DeleteStackRequest.Builder stackName​(String stackName)

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

        Parameters:
        stackName - The name or the unique stack ID that's associated with the stack.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • retainResources

        DeleteStackRequest.Builder retainResources​(Collection<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.

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

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

      • retainResources

        DeleteStackRequest.Builder retainResources​(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.

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

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

      • roleARN

        DeleteStackRequest.Builder roleARN​(String roleARN)

        The Amazon Resource Name (ARN) of an Identity and Access Management (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.

        Parameters:
        roleARN - The Amazon Resource Name (ARN) of an Identity and Access Management (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:
        Returns a reference to this object so that method calls can be chained together.

      • clientRequestToken

        DeleteStackRequest.Builder clientRequestToken​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.