Package software.amazon.awscdk.services.s3outposts

Interface CfnBucketProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnBucketProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:13.315Z")
@Stability(Stable)
public interface CfnBucketProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnBucket.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.s3outposts.*;
 Object filter;
 CfnBucketProps cfnBucketProps = CfnBucketProps.builder()
         .bucketName("bucketName")
         .outpostId("outpostId")
         // the properties below are optional
         .lifecycleConfiguration(LifecycleConfigurationProperty.builder()
                 .rules(List.of(RuleProperty.builder()
                         .status("status")
                         // the properties below are optional
                         .abortIncompleteMultipartUpload(AbortIncompleteMultipartUploadProperty.builder()
                                 .daysAfterInitiation(123)
                                 .build())
                         .expirationDate("expirationDate")
                         .expirationInDays(123)
                         .filter(filter)
                         .id("id")
                         .build()))
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnBucketProps.Builder	A builder for CfnBucketProps
static final class	CfnBucketProps.Jsii$Proxy	An implementation for CfnBucketProps

Method Summary

Modifier and Type	Method	Description
static CfnBucketProps.Builder	builder()
String	getBucketName()	A name for the S3 on Outposts bucket.
default Object	getLifecycleConfiguration()	Creates a new lifecycle configuration for the S3 on Outposts bucket or replaces an existing lifecycle configuration.
String	getOutpostId()	The ID of the Outpost of the specified bucket.
default List<CfnTag>	getTags()	Sets the tags for an S3 on Outposts bucket.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBucketName

@Stability(Stable)
@NotNull
String getBucketName()

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.

See Also:

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

getOutpostId

@Stability(Stable)
@NotNull
String getOutpostId()

The ID of the Outpost of the specified bucket.

See Also:

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

getLifecycleConfiguration

@Stability(Stable)
@Nullable
default Object getLifecycleConfiguration()

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.

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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 .

See Also:

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

builder

@Stability(Stable)
static CfnBucketProps.Builder builder()

Returns:

a CfnBucketProps.Builder of CfnBucketProps