Package software.amazon.awscdk.services.s3outposts

Class CfnBucket.Builder

java.lang.Object

software.amazon.awscdk.services.s3outposts.CfnBucket.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnBucket>

Enclosing class:

CfnBucket

@Stability(Stable)
public static final class CfnBucket.Builder
extends Object
implements software.amazon.jsii.Builder<CfnBucket>

A fluent builder for CfnBucket.

Method Summary

Modifier and Type	Method	Description
CfnBucket.Builder	bucketName(String bucketName)	A name for the S3 on Outposts bucket.
CfnBucket	build()
static CfnBucket.Builder	create(software.constructs.Construct scope, String id)
CfnBucket.Builder	lifecycleConfiguration(IResolvable lifecycleConfiguration)	Creates a new lifecycle configuration for the S3 on Outposts bucket or replaces an existing lifecycle configuration.
CfnBucket.Builder	lifecycleConfiguration(CfnBucket.LifecycleConfigurationProperty lifecycleConfiguration)	Creates a new lifecycle configuration for the S3 on Outposts bucket or replaces an existing lifecycle configuration.
CfnBucket.Builder	outpostId(String outpostId)	The ID of the Outpost of the specified bucket.
CfnBucket.Builder	tags(List<? extends CfnTag> tags)	Sets the tags for an S3 on Outposts bucket.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnBucket.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnBucket.Builder.

bucketName

@Stability(Stable)
public CfnBucket.Builder bucketName(String bucketName)

A name for the S3 on Outposts bucket.

If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the bucket name. The bucket name must contain only lowercase letters, numbers, periods (.), and dashes (-) and must follow Amazon S3 bucket restrictions and limitations . For more information, see Bucket naming rules .

If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you need to replace the resource, specify a new name.

Parameters:

bucketName - A name for the S3 on Outposts bucket. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3outposts-bucket.html#cfn-s3outposts-bucket-bucketname

outpostId

@Stability(Stable)
public CfnBucket.Builder outpostId(String outpostId)

The ID of the Outpost of the specified bucket.

Parameters:

outpostId - The ID of the Outpost of the specified bucket. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3outposts-bucket.html#cfn-s3outposts-bucket-outpostid

lifecycleConfiguration

@Stability(Stable)
public CfnBucket.Builder lifecycleConfiguration(IResolvable lifecycleConfiguration)

Creates a new lifecycle configuration for the S3 on Outposts bucket or replaces an existing lifecycle configuration.

Outposts buckets only support lifecycle configurations that delete/expire objects after a certain period of time and abort incomplete multipart uploads.

Parameters:

lifecycleConfiguration - Creates a new lifecycle configuration for the S3 on Outposts bucket or replaces an existing lifecycle configuration. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3outposts-bucket.html#cfn-s3outposts-bucket-lifecycleconfiguration

lifecycleConfiguration

@Stability(Stable)
public CfnBucket.Builder lifecycleConfiguration(CfnBucket.LifecycleConfigurationProperty lifecycleConfiguration)

Creates a new lifecycle configuration for the S3 on Outposts bucket or replaces an existing lifecycle configuration.

Outposts buckets only support lifecycle configurations that delete/expire objects after a certain period of time and abort incomplete multipart uploads.

Parameters:

lifecycleConfiguration - Creates a new lifecycle configuration for the S3 on Outposts bucket or replaces an existing lifecycle configuration. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3outposts-bucket.html#cfn-s3outposts-bucket-lifecycleconfiguration

tags

@Stability(Stable)
public CfnBucket.Builder tags(List<? extends CfnTag> tags)

Sets the tags for an S3 on Outposts bucket. For more information, see Using Amazon S3 on Outposts .

Use tags to organize your AWS bill to reflect your own cost structure. To do this, sign up to get your AWS account bill with tag key values included. Then, to see the cost of combined resources, organize your billing information according to resources with the same tag key values. For example, you can tag several resources with a specific application name, and then organize your billing information to see the total cost of that application across several services. For more information, see Cost allocation and tags .

Within a bucket, if you add a tag that has the same key as an existing tag, the new value overwrites the old value. For more information, see Using cost allocation and bucket tags .

To use this resource, you must have permissions to perform the s3-outposts:PutBucketTagging . The S3 on Outposts bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing access permissions to your Amazon S3 resources .

Parameters:

tags - Sets the tags for an S3 on Outposts bucket. For more information, see Using Amazon S3 on Outposts . This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3outposts-bucket.html#cfn-s3outposts-bucket-tags

build

@Stability(Stable)
public CfnBucket build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnBucket>

Returns:

a newly built instance of CfnBucket.