software.amazon.awscdk.services.s3

Interface BucketAttributes

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

BucketAttributes.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-02T14:17:18.504Z")
 @Stability(value=Stable)
public interface BucketAttributes
extends software.amazon.jsii.JsiiSerializable

A reference to a bucket outside this stack.

Example:

 Function myLambda;
 IBucket bucket = Bucket.fromBucketAttributes(this, "ImportedBucket", BucketAttributes.builder()
         .bucketArn("arn:aws:s3:::my-bucket")
         .build());
 // now you can just call methods on the bucket
 bucket.addEventNotification(EventType.OBJECT_CREATED, new LambdaDestination(myLambda), NotificationKeyFilter.builder().prefix("home/myusername/*").build());
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static BucketAttributes.Builder	builder()
default String	getAccount() The account this existing bucket belongs to.
default String	getBucketArn() The ARN of the bucket.
default String	getBucketDomainName() The domain name of the bucket.
default String	getBucketDualStackDomainName() The IPv6 DNS name of the specified bucket.
default String	getBucketName() The name of the bucket.
default String	getBucketRegionalDomainName() The regional domain name of the specified bucket.
default Boolean	getBucketWebsiteNewUrlFormat() The format of the website URL of the bucket.
default String	getBucketWebsiteUrl() The website URL of the bucket (if static web hosting is enabled).
default IKey	getEncryptionKey()
default Boolean	getIsWebsite() If this bucket has been configured for static website hosting.
default IRole	getNotificationsHandlerRole() The role to be used by the notifications handler.
default String	getRegion() The region this existing bucket is in.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAccount

@Stability(value=Stable)
 @Nullable
default String getAccount()

The account this existing bucket belongs to.

Default: - it's assumed the bucket belongs to the same account as the scope it's being imported into

getBucketArn

@Stability(value=Stable)
 @Nullable
default String getBucketArn()

The ARN of the bucket.

At least one of bucketArn or bucketName must be defined in order to initialize a bucket ref.

getBucketDomainName

@Stability(value=Stable)
 @Nullable
default String getBucketDomainName()

The domain name of the bucket.

Default: Inferred from bucket name

getBucketDualStackDomainName

@Stability(value=Stable)
 @Nullable
default String getBucketDualStackDomainName()

The IPv6 DNS name of the specified bucket.

getBucketName

@Stability(value=Stable)
 @Nullable
default String getBucketName()

The name of the bucket.

If the underlying value of ARN is a string, the name will be parsed from the ARN. Otherwise, the name is optional, but some features that require the bucket name such as auto-creating a bucket policy, won't work.

getBucketRegionalDomainName

@Stability(value=Stable)
 @Nullable
default String getBucketRegionalDomainName()

The regional domain name of the specified bucket.

getBucketWebsiteNewUrlFormat

@Stability(value=Stable)
 @Nullable
default Boolean getBucketWebsiteNewUrlFormat()

The format of the website URL of the bucket.

This should be true for regions launched since 2014.

Default: false

getBucketWebsiteUrl

@Stability(value=Stable)
 @Nullable
default String getBucketWebsiteUrl()

The website URL of the bucket (if static web hosting is enabled).

Default: Inferred from bucket name

getEncryptionKey

@Stability(value=Stable)
 @Nullable
default IKey getEncryptionKey()

getIsWebsite

@Stability(value=Stable)
 @Nullable
default Boolean getIsWebsite()

If this bucket has been configured for static website hosting.

Default: false

getNotificationsHandlerRole

@Stability(value=Stable)
 @Nullable
default IRole getNotificationsHandlerRole()

The role to be used by the notifications handler.

Default: - a new role will be created.

getRegion

@Stability(value=Stable)
 @Nullable
default String getRegion()

The region this existing bucket is in.

Default: - it's assumed the bucket is in the same region as the scope it's being imported into

builder

@Stability(value=Stable)
static BucketAttributes.Builder builder()

Returns:

a BucketAttributes.Builder of BucketAttributes