You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::CodeStar::Types::DeleteProjectRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing DeleteProjectRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  id: "ProjectId", # required
  client_request_token: "ClientRequestToken",
  delete_stack: false,
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#client_request_token ⇒ String

A user- or system-generated token that identifies the entity that requested project deletion. This token can be used to repeat the request.

Returns:

  • (String) —

    A user- or system-generated token that identifies the entity that requested project deletion.

#delete_stack ⇒ Boolean

Whether to send a delete request for the primary stack in AWS CloudFormation originally used to generate the project and its resources. This option will delete all AWS resources for the project (except for any buckets in Amazon S3) as well as deleting the project itself. Recommended for most use cases.

Returns:

  • (Boolean) —

    Whether to send a delete request for the primary stack in AWS CloudFormation originally used to generate the project and its resources.

#id ⇒ String

The ID of the project to be deleted in AWS CodeStar.

Returns:

  • (String) —

    The ID of the project to be deleted in AWS CodeStar.