Class: Aws::Lightsail::Types::CreateBucketRequest

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 CreateBucketRequest data as a hash:

{
  bucket_name: "BucketName", # required
  bundle_id: "NonEmptyString", # required
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
  enable_object_versioning: false,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#bucket_nameString

The name for the bucket.

For more information about bucket names, see Bucket naming rules in Amazon Lightsail in the Amazon Lightsail Developer Guide.

Returns:

  • (String)


2866
2867
2868
2869
2870
2871
2872
2873
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 2866

class CreateBucketRequest < Struct.new(
  :bucket_name,
  :bundle_id,
  :tags,
  :enable_object_versioning)
  SENSITIVE = []
  include Aws::Structure
end

#bundle_idString

The ID of the bundle to use for the bucket.

A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a bucket.

Use the GetBucketBundles action to get a list of bundle IDs that you can specify.

Use the UpdateBucketBundle action to change the bundle after the bucket is created.

Returns:

  • (String)


2866
2867
2868
2869
2870
2871
2872
2873
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 2866

class CreateBucketRequest < Struct.new(
  :bucket_name,
  :bundle_id,
  :tags,
  :enable_object_versioning)
  SENSITIVE = []
  include Aws::Structure
end

#enable_object_versioningBoolean

A Boolean value that indicates whether to enable versioning of objects in the bucket.

For more information about versioning, see Enabling and suspending object versioning in a bucket in Amazon Lightsail in the Amazon Lightsail Developer Guide.

Returns:

  • (Boolean)


2866
2867
2868
2869
2870
2871
2872
2873
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 2866

class CreateBucketRequest < Struct.new(
  :bucket_name,
  :bundle_id,
  :tags,
  :enable_object_versioning)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

The tag keys and optional values to add to the bucket during creation.

Use the TagResource action to tag the bucket after it's created.

Returns:



2866
2867
2868
2869
2870
2871
2872
2873
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 2866

class CreateBucketRequest < Struct.new(
  :bucket_name,
  :bundle_id,
  :tags,
  :enable_object_versioning)
  SENSITIVE = []
  include Aws::Structure
end