BucketAttributes

All Known Implementing Classes:: BucketAttributes.Jsii$Proxy

@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)",
           date="2022-05-20T22:19:58.052Z")
public interface BucketAttributes

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

All Methods Static Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`static BucketAttributes.Builder`	`builder()`
`default java.lang.String`	`getAccount()` The account this existing bucket belongs to.
`default java.lang.String`	`getBucketArn()` The ARN of the bucket.
`default java.lang.String`	`getBucketDomainName()` The domain name of the bucket.
`default java.lang.String`	`getBucketDualStackDomainName()` The IPv6 DNS name of the specified bucket.
`default java.lang.String`	`getBucketName()` The name of the bucket.
`default java.lang.String`	`getBucketRegionalDomainName()` The regional domain name of the specified bucket.
`default java.lang.Boolean`	`getBucketWebsiteNewUrlFormat()` The format of the website URL of the bucket.
`default java.lang.String`	`getBucketWebsiteUrl()` The website URL of the bucket (if static web hosting is enabled).
`default IKey`	`getEncryptionKey()`
`default java.lang.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 java.lang.String`	`getRegion()` The region this existing bucket is in.

- Method Detail
  - getAccount
```
default java.lang.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
```
default java.lang.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
```
default java.lang.String getBucketDomainName()
```
    The domain name of the bucket.
    Default: Inferred from bucket name
  - getBucketDualStackDomainName
```
default java.lang.String getBucketDualStackDomainName()
```
    The IPv6 DNS name of the specified bucket.
  - getBucketName
```
default java.lang.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
```
default java.lang.String getBucketRegionalDomainName()
```
    The regional domain name of the specified bucket.
  - getBucketWebsiteNewUrlFormat
```
default java.lang.Boolean getBucketWebsiteNewUrlFormat()
```
    The format of the website URL of the bucket.
    This should be true for regions launched since 2014.
    Default: false
  - getBucketWebsiteUrl
```
default java.lang.String getBucketWebsiteUrl()
```
    The website URL of the bucket (if static web hosting is enabled).
    Default: Inferred from bucket name
  - getEncryptionKey
```
default IKey getEncryptionKey()
```
  - getIsWebsite
```
default java.lang.Boolean getIsWebsite()
```
    If this bucket has been configured for static website hosting.
    Default: false
  - getNotificationsHandlerRole
```
default IRole getNotificationsHandlerRole()
```
    The role to be used by the notifications handler.
    Default: - a new role will be created.
  - getRegion
```
default java.lang.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
```
static BucketAttributes.Builder builder()
```
    Returns:
    
    a BucketAttributes.Builder of BucketAttributes

Interface BucketAttributes

Nested Class Summary

Method Summary

Method Detail

getAccount

getBucketArn

getBucketDomainName

getBucketDualStackDomainName

getBucketName

getBucketRegionalDomainName

getBucketWebsiteNewUrlFormat

getBucketWebsiteUrl

getEncryptionKey

getIsWebsite

getNotificationsHandlerRole

getRegion

builder