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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-codestar/lib/aws-sdk-codestar/types.rb

Overview

Note:

When making an API call, you may pass DeleteProjectRequest data as a hash:

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

Instance Attribute Summary collapse

Instance Attribute Details

#client_request_tokenString

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)


245
246
247
248
249
250
# File 'gems/aws-sdk-codestar/lib/aws-sdk-codestar/types.rb', line 245

class DeleteProjectRequest < Struct.new(
  :id,
  :client_request_token,
  :delete_stack)
  include Aws::Structure
end

#delete_stackBoolean

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)


245
246
247
248
249
250
# File 'gems/aws-sdk-codestar/lib/aws-sdk-codestar/types.rb', line 245

class DeleteProjectRequest < Struct.new(
  :id,
  :client_request_token,
  :delete_stack)
  include Aws::Structure
end

#idString

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

Returns:

  • (String)


245
246
247
248
249
250
# File 'gems/aws-sdk-codestar/lib/aws-sdk-codestar/types.rb', line 245

class DeleteProjectRequest < Struct.new(
  :id,
  :client_request_token,
  :delete_stack)
  include Aws::Structure
end