AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon S3 Control CreateBucket API operation.

Syntax

New-S3CBucket
-Bucket <String>
-ACL <BucketCannedACL>
-GrantFullControl <String>
-GrantRead <String>
-GrantReadACP <String>
-GrantWrite <String>
-GrantWriteACP <String>
-CreateBucketConfiguration_LocationConstraint <BucketLocationConstraint>
-ObjectLockEnabledForBucket <Boolean>
-OutpostId <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>

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 CreateBucket for Amazon S3 on Outposts:

Parameters

The canned ACL to apply to the bucket.This is not supported by Amazon S3 on Outposts buckets.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Bucket <String>
The name of the bucket.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-CreateBucketConfiguration_LocationConstraint <BucketLocationConstraint>
Specifies the Region where the bucket will be created. If you are creating a bucket on the US East (N. Virginia) Region (us-east-1), you do not need to specify the location.This is not supported by Amazon S3 on Outposts buckets.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-GrantFullControl <String>
Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.This is not supported by Amazon S3 on Outposts buckets.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-GrantRead <String>
Allows grantee to list the objects in the bucket.This is not supported by Amazon S3 on Outposts buckets.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-GrantReadACP <String>
Allows grantee to read the bucket ACL.This is not supported by Amazon S3 on Outposts buckets.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-GrantWrite <String>
Allows grantee to create, overwrite, and delete any object in the bucket.This is not supported by Amazon S3 on Outposts buckets.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-GrantWriteACP <String>
Allows grantee to write the ACL for the applicable bucket.This is not supported by Amazon S3 on Outposts buckets.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ObjectLockEnabledForBucket <Boolean>
Specifies whether you want S3 Object Lock to be enabled for the new bucket.This is not supported by Amazon S3 on Outposts buckets.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OutpostId <String>
The ID of the Outposts where the bucket is being created.This is required by Amazon S3 on Outposts buckets.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the Bucket parameter. The -PassThru parameter is deprecated, use -Select '^Bucket' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.S3Control.Model.CreateBucketResponse). Specifying the name of a property of type Amazon.S3Control.Model.CreateBucketResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

This cmdlet returns an Amazon.S3Control.Model.CreateBucketResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Supported Version

AWS Tools for PowerShell: 2.x.y.z