Class: Aws::Lightsail::Types::DeleteBucketRequest

Inherits:

Struct

Object
Struct
Aws::Lightsail::Types::DeleteBucketRequest

show all

Includes:: Structure

Defined in:: lib/aws-sdk-lightsail/types.rb

Overview

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#bucket_name ⇒ String

The name of the bucket to delete.
#force_delete ⇒ Boolean

A Boolean value that indicates whether to force delete the bucket.

Instance Attribute Details

#bucket_name ⇒ `String`

The name of the bucket to delete.

Use the [GetBuckets] action to get a list of bucket names that you can specify.

[1]: docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetBuckets.html

Returns:

(String)

# File 'lib/aws-sdk-lightsail/types.rb', line 4853

class DeleteBucketRequest < Struct.new(
  :bucket_name,
  :force_delete)
  SENSITIVE = []
  include Aws::Structure
end

#force_delete ⇒ `Boolean`

A Boolean value that indicates whether to force delete the bucket.

You must force delete the bucket if it has one of the following conditions:

The bucket is the origin of a distribution.
The bucket has instances that were granted access to it using the

SetResourceAccessForBucket][1

action.
The bucket has objects.
The bucket has access keys.

Force deleting a bucket might impact other resources that rely on the bucket, such as instances, distributions, or software that use the issued access keys.

[1]: docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_SetResourceAccessForBucket.html