Class: Aws::S3Control::Types::CreateBucketRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-s3control/lib/aws-sdk-s3control/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,
  outpost_id: "NonEmptyMaxLength64String",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#aclString

The canned ACL to apply to the bucket.

This is not supported by Amazon S3 on Outposts buckets.

Returns:

  • (String)


687
688
689
690
691
692
693
694
695
696
697
698
699
700
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 687

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

#bucketString

The name of the bucket.

Returns:

  • (String)


687
688
689
690
691
692
693
694
695
696
697
698
699
700
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 687

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

#create_bucket_configurationTypes::CreateBucketConfiguration

The configuration information for the bucket.

This is not supported by Amazon S3 on Outposts buckets.



687
688
689
690
691
692
693
694
695
696
697
698
699
700
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 687

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

#grant_full_controlString

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

This is not supported by Amazon S3 on Outposts buckets.

Returns:

  • (String)


687
688
689
690
691
692
693
694
695
696
697
698
699
700
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 687

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

#grant_readString

Allows grantee to list the objects in the bucket.

This is not supported by Amazon S3 on Outposts buckets.

Returns:

  • (String)


687
688
689
690
691
692
693
694
695
696
697
698
699
700
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 687

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

#grant_read_acpString

Allows grantee to read the bucket ACL.

This is not supported by Amazon S3 on Outposts buckets.

Returns:

  • (String)


687
688
689
690
691
692
693
694
695
696
697
698
699
700
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 687

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

#grant_writeString

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

This is not supported by Amazon S3 on Outposts buckets.

Returns:

  • (String)


687
688
689
690
691
692
693
694
695
696
697
698
699
700
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 687

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

#grant_write_acpString

Allows grantee to write the ACL for the applicable bucket.

This is not supported by Amazon S3 on Outposts buckets.

Returns:

  • (String)


687
688
689
690
691
692
693
694
695
696
697
698
699
700
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 687

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

#object_lock_enabled_for_bucketBoolean

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

This is not supported by Amazon S3 on Outposts buckets.

Returns:

  • (Boolean)


687
688
689
690
691
692
693
694
695
696
697
698
699
700
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 687

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

#outpost_idString

The ID of the Outposts where the bucket is being created.

This is required by Amazon S3 on Outposts buckets.

Returns:

  • (String)


687
688
689
690
691
692
693
694
695
696
697
698
699
700
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 687

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