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

Inherits:

Struct

• Object
• Struct
• Aws::S3::Types::CreateBucketRequest

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-s3/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #acl ⇒ String

  The canned ACL to apply to the bucket.

• #bucket ⇒ String

  The name of the bucket to create.

• #create_bucket_configuration ⇒ Types::CreateBucketConfiguration

  The configuration information for the bucket.

• #grant_full_control ⇒ 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.

• #grant_read_acp ⇒ String

  Allows grantee to read the bucket ACL.

• #grant_write ⇒ String

  Allows grantee to create new objects in the bucket.

• #grant_write_acp ⇒ 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.

• #object_ownership ⇒ String

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

Instance Attribute Details

#acl ⇒ String

The canned ACL to apply to the bucket.

<note markdown=“1”> This functionality is not supported for directory buckets.

</note>

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 2653

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

#bucket ⇒ String

The name of the bucket to create.

**General purpose buckets** - For information about bucket naming restrictions, see [Bucket naming rules] in the *Amazon S3 User Guide*.

Directory buckets - When you use this operation with a directory bucket, you must use path-style requests in the format ‘s3express-control.region_code.amazonaws.com/bucket-name `. Virtual-hosted-style requests aren’t supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must also follow the format ‘ bucket_base_name–az_id–x-s3` (for example, ` DOC-EXAMPLE-BUCKET–usw2-az1–x-s3`). For information about bucket naming restrictions, see [Directory bucket naming rules] in the *Amazon S3 User Guide*

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 2653

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_configuration ⇒ Types::CreateBucketConfiguration

The configuration information for the bucket.

Returns:

• (Types::CreateBucketConfiguration)

# File 'lib/aws-sdk-s3/types.rb', line 2653

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_control ⇒ String

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

<note markdown=“1”> This functionality is not supported for directory buckets.

</note>

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 2653

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 ⇒ String

Allows grantee to list the objects in the bucket.

<note markdown=“1”> This functionality is not supported for directory buckets.

</note>

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 2653

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_acp ⇒ String

Allows grantee to read the bucket ACL.

<note markdown=“1”> This functionality is not supported for directory buckets.

</note>

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 2653

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 ⇒ 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.

<note markdown=“1”> This functionality is not supported for directory buckets.

</note>

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 2653

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_acp ⇒ String

Allows grantee to write the ACL for the applicable bucket.

<note markdown=“1”> This functionality is not supported for directory buckets.

</note>

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 2653

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_bucket ⇒ Boolean

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

<note markdown=“1”> This functionality is not supported for directory buckets.

</note>

Returns:

• (Boolean)

# File 'lib/aws-sdk-s3/types.rb', line 2653

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_ownership ⇒ String

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 specify bucket owner full control ACLs (such as the predefined ‘bucket-owner-full-control` canned ACL or a custom ACL in XML format that grants the same permissions).

By default, ‘ObjectOwnership` is set to `BucketOwnerEnforced` and ACLs are disabled. We recommend keeping ACLs disabled, except in uncommon use cases where you must control access for each object individually. For more information about S3 Object Ownership, see [Controlling ownership of objects and disabling ACLs for your bucket] in the *Amazon S3 User Guide*.

<note markdown=“1”> This functionality is not supported for directory buckets. Directory buckets use the bucket owner enforced setting for S3 Object Ownership.

</note>

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 2653

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