Skip to content

Create Bucket

s3control_create_bucket R Documentation

This action creates an Amazon S3 on Outposts bucket

Description

This action creates an Amazon S3 on Outposts bucket. To create an S3 bucket, see Create Bucket in the Amazon S3 API Reference.

Creates a new Outposts bucket. By creating the bucket, you become the bucket owner. To create an Outposts bucket, you must have S3 on Outposts. For more information, see Using Amazon S3 on Outposts in Amazon S3 User Guide.

Not every string is an acceptable bucket name. For information on bucket naming restrictions, see Working with Amazon S3 Buckets.

S3 on Outposts buckets support:

  • Tags

  • LifecycleConfigurations for deleting expired objects

For a complete list of restrictions and Amazon S3 feature limitations on S3 on Outposts, see Amazon S3 on Outposts Restrictions and Limitations.

For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and x-amz-outpost-id in your API request, see the Examples section.

The following actions are related to create_bucket for Amazon S3 on Outposts:

  • PutObject

  • get_bucket

  • delete_bucket

  • create_access_point

  • put_access_point_policy

Usage

s3control_create_bucket(ACL, Bucket, CreateBucketConfiguration,
  GrantFullControl, GrantRead, GrantReadACP, GrantWrite, GrantWriteACP,
  ObjectLockEnabledForBucket, OutpostId)

Arguments

ACL

The canned ACL to apply to the bucket.

This is not supported by Amazon S3 on Outposts buckets.

Bucket

[required] The name of the bucket.

CreateBucketConfiguration

The configuration information for the bucket.

This is not supported by Amazon S3 on Outposts buckets.

GrantFullControl

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

This is not supported by Amazon S3 on Outposts buckets.

GrantRead

Allows grantee to list the objects in the bucket.

This is not supported by Amazon S3 on Outposts buckets.

GrantReadACP

Allows grantee to read the bucket ACL.

This is not supported by Amazon S3 on Outposts buckets.

GrantWrite

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

This is not supported by Amazon S3 on Outposts buckets.

GrantWriteACP

Allows grantee to write the ACL for the applicable bucket.

This is not supported by Amazon S3 on Outposts buckets.

ObjectLockEnabledForBucket

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

This is not supported by Amazon S3 on Outposts buckets.

OutpostId

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

This ID is required by Amazon S3 on Outposts buckets.

Value

A list with the following syntax: 

list(
  Location = "string",
  BucketArn = "string"
)

Request syntax

svc$create_bucket(
  ACL = "private"|"public-read"|"public-read-write"|"authenticated-read",
  Bucket = "string",
  CreateBucketConfiguration = list(
    LocationConstraint = "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"
  ),
  GrantFullControl = "string",
  GrantRead = "string",
  GrantReadACP = "string",
  GrantWrite = "string",
  GrantWriteACP = "string",
  ObjectLockEnabledForBucket = TRUE|FALSE,
  OutpostId = "string"
)