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

Class: Aws::S3::Types::CreateBucketRequest

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

Overview

Note:

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

{
  acl: "private", # accepts private, public-read, public-read-write, authenticated-read
  bucket: "BucketName", # required
  create_bucket_configuration: {
    location_constraint: "af-south-1", # accepts af-south-1, ap-east-1, ap-northeast-1, ap-northeast-2, ap-northeast-3, ap-south-1, ap-southeast-1, ap-southeast-2, ca-central-1, cn-north-1, cn-northwest-1, EU, eu-central-1, eu-north-1, eu-south-1, eu-west-1, eu-west-2, eu-west-3, me-south-1, sa-east-1, us-east-2, us-gov-east-1, us-gov-west-1, us-west-1, us-west-2
  },
  grant_full_control: "GrantFullControl",
  grant_read: "GrantRead",
  grant_read_acp: "GrantReadACP",
  grant_write: "GrantWrite",
  grant_write_acp: "GrantWriteACP",
  object_lock_enabled_for_bucket: false,
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#acl ⇒ String

The canned ACL to apply to the bucket.

Possible values:

  • private
  • public-read
  • public-read-write
  • authenticated-read

Returns:

  • (String) —

    The canned ACL to apply to the bucket.

#bucket ⇒ String

The name of the bucket to create.

Returns:

  • (String) —

    The name of the bucket to create.

#create_bucket_configuration ⇒ Types::CreateBucketConfiguration

The configuration information for the bucket.

Returns:

#grant_full_control ⇒ String

Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.

Returns:

  • (String) —

    Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.

#grant_read ⇒ String

Allows grantee to list the objects in the bucket.

Returns:

  • (String) —

    Allows grantee to list the objects in the bucket.

#grant_read_acp ⇒ String

Allows grantee to read the bucket ACL.

Returns:

  • (String) —

    Allows grantee to read the bucket ACL.

#grant_write ⇒ String

Allows grantee to create, overwrite, and delete any object in the bucket.

Returns:

  • (String) —

    Allows grantee to create, overwrite, and delete any object in the bucket.

#grant_write_acp ⇒ String

Allows grantee to write the ACL for the applicable bucket.

Returns:

  • (String) —

    Allows grantee to write the ACL for the applicable bucket.

#object_lock_enabled_for_bucket ⇒ Boolean

Specifies whether you want S3 Object Lock to be enabled for the new bucket.

Returns:

  • (Boolean) —

    Specifies whether you want S3 Object Lock to be enabled for the new bucket.