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

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

Overview

Note:

When making an API call, you may pass CreateBucketRequest data as a 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,
  object_ownership: "BucketOwnerPreferred", # accepts BucketOwnerPreferred, ObjectWriter, BucketOwnerEnforced
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#aclString

The canned ACL to apply to the bucket.

Returns:

  • (String)


1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 1854

class CreateBucketRequest < Struct.new(
  :acl,
  :bucket,
  :create_bucket_configuration,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write,
  :grant_write_acp,
  :object_lock_enabled_for_bucket,
  :object_ownership)
  SENSITIVE = []
  include Aws::Structure
end

#bucketString

The name of the bucket to create.

Returns:

  • (String)


1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 1854

class CreateBucketRequest < Struct.new(
  :acl,
  :bucket,
  :create_bucket_configuration,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write,
  :grant_write_acp,
  :object_lock_enabled_for_bucket,
  :object_ownership)
  SENSITIVE = []
  include Aws::Structure
end

#create_bucket_configurationTypes::CreateBucketConfiguration

The configuration information for the bucket.



1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 1854

class CreateBucketRequest < Struct.new(
  :acl,
  :bucket,
  :create_bucket_configuration,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write,
  :grant_write_acp,
  :object_lock_enabled_for_bucket,
  :object_ownership)
  SENSITIVE = []
  include Aws::Structure
end

#grant_full_controlString

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

Returns:

  • (String)


1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 1854

class CreateBucketRequest < Struct.new(
  :acl,
  :bucket,
  :create_bucket_configuration,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write,
  :grant_write_acp,
  :object_lock_enabled_for_bucket,
  :object_ownership)
  SENSITIVE = []
  include Aws::Structure
end

#grant_readString

Allows grantee to list the objects in the bucket.

Returns:

  • (String)


1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 1854

class CreateBucketRequest < Struct.new(
  :acl,
  :bucket,
  :create_bucket_configuration,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write,
  :grant_write_acp,
  :object_lock_enabled_for_bucket,
  :object_ownership)
  SENSITIVE = []
  include Aws::Structure
end

#grant_read_acpString

Allows grantee to read the bucket ACL.

Returns:

  • (String)


1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 1854

class CreateBucketRequest < Struct.new(
  :acl,
  :bucket,
  :create_bucket_configuration,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write,
  :grant_write_acp,
  :object_lock_enabled_for_bucket,
  :object_ownership)
  SENSITIVE = []
  include Aws::Structure
end

#grant_writeString

Allows grantee to create new objects in the bucket.

For the bucket and object owners of existing objects, also allows deletions and overwrites of those objects.

Returns:

  • (String)


1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 1854

class CreateBucketRequest < Struct.new(
  :acl,
  :bucket,
  :create_bucket_configuration,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write,
  :grant_write_acp,
  :object_lock_enabled_for_bucket,
  :object_ownership)
  SENSITIVE = []
  include Aws::Structure
end

#grant_write_acpString

Allows grantee to write the ACL for the applicable bucket.

Returns:

  • (String)


1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 1854

class CreateBucketRequest < Struct.new(
  :acl,
  :bucket,
  :create_bucket_configuration,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write,
  :grant_write_acp,
  :object_lock_enabled_for_bucket,
  :object_ownership)
  SENSITIVE = []
  include Aws::Structure
end

#object_lock_enabled_for_bucketBoolean

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

Returns:

  • (Boolean)


1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 1854

class CreateBucketRequest < Struct.new(
  :acl,
  :bucket,
  :create_bucket_configuration,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write,
  :grant_write_acp,
  :object_lock_enabled_for_bucket,
  :object_ownership)
  SENSITIVE = []
  include Aws::Structure
end

#object_ownershipString

The container element for object ownership for a bucket's ownership controls.

BucketOwnerPreferred - Objects uploaded to the bucket change ownership to the bucket owner if the objects are uploaded with the bucket-owner-full-control canned ACL.

ObjectWriter - The uploading account will own the object if the object is uploaded with the bucket-owner-full-control canned ACL.

BucketOwnerEnforced - Access control lists (ACLs) are disabled and no longer affect permissions. The bucket owner automatically owns and has full control over every object in the bucket. The bucket only accepts PUT requests that don't specify an ACL or bucket owner full control ACLs, such as the bucket-owner-full-control canned ACL or an equivalent form of this ACL expressed in the XML format.

Returns:

  • (String)


1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 1854

class CreateBucketRequest < Struct.new(
  :acl,
  :bucket,
  :create_bucket_configuration,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write,
  :grant_write_acp,
  :object_lock_enabled_for_bucket,
  :object_ownership)
  SENSITIVE = []
  include Aws::Structure
end