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

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

Overview

Note:

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

{
  bucket_name: "BucketName", # required
  force_delete: false,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#bucket_nameString

The name of the bucket to delete.

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

Returns:

  • (String)


5444
5445
5446
5447
5448
5449
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 5444

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

#force_deleteBoolean

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

Returns:

  • (Boolean)


5444
5445
5446
5447
5448
5449
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 5444

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