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

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
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,
}

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#acl ⇒ String

The canned ACL to apply to the bucket.

Returns:

  • (String) 


1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
 
# File 'lib/aws-sdk-s3/types.rb', line 1825

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)
  SENSITIVE = []
  include Aws::Structure
end

#bucket ⇒ String

The name of the bucket to create.

Returns:

  • (String) 


1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
 
# File 'lib/aws-sdk-s3/types.rb', line 1825

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)
  SENSITIVE = []
  include Aws::Structure
end

#create_bucket_configuration ⇒ Types::CreateBucketConfiguration

The configuration information for the bucket.

Returns:



1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
 
# File 'lib/aws-sdk-s3/types.rb', line 1825

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)
  SENSITIVE = []
  include Aws::Structure
end

#grant_full_control ⇒ String

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

Returns:

  • (String) 


1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
 
# File 'lib/aws-sdk-s3/types.rb', line 1825

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)
  SENSITIVE = []
  include Aws::Structure
end

#grant_read ⇒ String

Allows grantee to list the objects in the bucket.

Returns:

  • (String) 


1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
 
# File 'lib/aws-sdk-s3/types.rb', line 1825

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)
  SENSITIVE = []
  include Aws::Structure
end

#grant_read_acp ⇒ String

Allows grantee to read the bucket ACL.

Returns:

  • (String) 


1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
 
# File 'lib/aws-sdk-s3/types.rb', line 1825

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)
  SENSITIVE = []
  include Aws::Structure
end

#grant_write ⇒ String

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) 


1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
 
# File 'lib/aws-sdk-s3/types.rb', line 1825

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)
  SENSITIVE = []
  include Aws::Structure
end

#grant_write_acp ⇒ String

Allows grantee to write the ACL for the applicable bucket.

Returns:

  • (String) 


1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
 
# File 'lib/aws-sdk-s3/types.rb', line 1825

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)
  SENSITIVE = []
  include Aws::Structure
end

#object_lock_enabled_for_bucket ⇒ Boolean

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

Returns:

  • (Boolean) 


1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
 
# File 'lib/aws-sdk-s3/types.rb', line 1825

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)
  SENSITIVE = []
  include Aws::Structure
end