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: "EU", # accepts EU, eu-west-1, us-west-1, us-west-2, ap-south-1, ap-southeast-1, ap-southeast-2, ap-northeast-1, sa-east-1, cn-north-1, eu-central-1
  },
  grant_full_control: "GrantFullControl",
  grant_read: "GrantRead",
  grant_read_acp: "GrantReadACP",
  grant_write: "GrantWrite",
  grant_write_acp: "GrantWriteACP",
  object_lock_enabled_for_bucket: false,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#aclString

The canned ACL to apply to the bucket.

Returns:

  • (String)


1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 1609

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

#bucketString

The name of the bucket to create.

Returns:

  • (String)


1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 1609

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_configurationTypes::CreateBucketConfiguration

The configuration information for the bucket.



1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 1609

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_controlString

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

Returns:

  • (String)


1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 1609

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_readString

Allows grantee to list the objects in the bucket.

Returns:

  • (String)


1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 1609

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_acpString

Allows grantee to read the bucket ACL.

Returns:

  • (String)


1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 1609

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_writeString

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

Returns:

  • (String)


1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 1609

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_acpString

Allows grantee to write the ACL for the applicable bucket.

Returns:

  • (String)


1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 1609

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_bucketBoolean

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

Returns:

  • (Boolean)


1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 1609

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