BucketBase

java.lang.Object
- software.constructs.Construct
- - software.amazon.awscdk.core.Construct
  - - software.amazon.awscdk.core.Resource
    - - software.amazon.awscdk.services.s3.BucketBase

All Implemented Interfaces:

IConstruct, IDependable, IResource, IBucket

Direct Known Subclasses:

Bucket
```
@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)",
           date="2022-05-20T22:19:58.052Z")
public abstract class BucketBase
extends Resource
implements IBucket
```
Represents an S3 Bucket.
Buckets can be either defined within this stack:
new Bucket(this, 'MyBucket', { props });
Or imported from an existing bucket:
Bucket.import(this, 'MyImportedBucket', { bucketArn: ... });
You can also export a bucket and import it into another stack:
const ref = myBucket.export(); Bucket.import(this, 'MyImportedBucket', ref);

Nested Class Summary
- Nested classes/interfaces inherited from interface software.amazon.awscdk.services.s3.IBucket
  IBucket.Jsii$Default

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`BucketBase(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)`
`protected`	`BucketBase(software.amazon.jsii.JsiiObjectRef objRef)`
`protected`	`BucketBase(software.constructs.Construct scope, java.lang.String id)`
`protected`	`BucketBase(software.constructs.Construct scope, java.lang.String id, ResourceProps props)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addEventNotification(EventType event, IBucketNotificationDestination dest, NotificationKeyFilter... filters)` Adds a bucket notification event destination.
`void`	`addObjectCreatedNotification(IBucketNotificationDestination dest, NotificationKeyFilter... filters)` Subscribes a destination to receive notifications when an object is created in the bucket.
`void`	`addObjectRemovedNotification(IBucketNotificationDestination dest, NotificationKeyFilter... filters)` Subscribes a destination to receive notifications when an object is removed from the bucket.
`AddToResourcePolicyResult`	`addToResourcePolicy(PolicyStatement permission)` Adds a statement to the resource policy for a principal (i.e.
`java.lang.String`	`arnForObjects(java.lang.String keyPattern)` Returns an ARN that represents all objects within the bucket that match the key pattern specified.
`protected void`	`enableEventBridgeNotification()`
`protected abstract java.lang.Boolean`	`getAutoCreatePolicy()` Indicates if a bucket resource policy should automatically created upon the first call to `addToResourcePolicy`.
`abstract java.lang.String`	`getBucketArn()` The ARN of the bucket.
`abstract java.lang.String`	`getBucketDomainName()` The IPv4 DNS name of the specified bucket.
`abstract java.lang.String`	`getBucketDualStackDomainName()` The IPv6 DNS name of the specified bucket.
`abstract java.lang.String`	`getBucketName()` The name of the bucket.
`abstract java.lang.String`	`getBucketRegionalDomainName()` The regional domain name of the specified bucket.
`abstract java.lang.String`	`getBucketWebsiteDomainName()` The Domain name of the static website.
`abstract java.lang.String`	`getBucketWebsiteUrl()` The URL of the static website.
`protected abstract java.lang.Boolean`	`getDisallowPublicAccess()` Whether to disallow public access.
`abstract IKey`	`getEncryptionKey()` Optional KMS encryption key associated with this bucket.
`abstract java.lang.Boolean`	`getIsWebsite()` If this bucket has been configured for static website hosting.
`protected IRole`	`getNotificationsHandlerRole()`
`abstract BucketPolicy`	`getPolicy()` The resource policy associated with this bucket.
`Grant`	`grantDelete(IGrantable identity)` Grants s3:DeleteObject* permission to an IAM principal for objects in this bucket.
`Grant`	`grantDelete(IGrantable identity, java.lang.Object objectsKeyPattern)` Grants s3:DeleteObject* permission to an IAM principal for objects in this bucket.
`Grant`	`grantPublicAccess(java.lang.String keyPrefix, java.lang.String... allowedActions)` Allows unrestricted access to objects from this bucket.
`Grant`	`grantPut(IGrantable identity)` Grants s3:PutObject* and s3:Abort* permissions for this bucket to an IAM principal.
`Grant`	`grantPut(IGrantable identity, java.lang.Object objectsKeyPattern)` Grants s3:PutObject* and s3:Abort* permissions for this bucket to an IAM principal.
`Grant`	`grantPutAcl(IGrantable identity)` Grant the given IAM identity permissions to modify the ACLs of objects in the given Bucket.
`Grant`	`grantPutAcl(IGrantable identity, java.lang.String objectsKeyPattern)` Grant the given IAM identity permissions to modify the ACLs of objects in the given Bucket.
`Grant`	`grantRead(IGrantable identity)` Grant read permissions for this bucket and it's contents to an IAM principal (Role/Group/User).
`Grant`	`grantRead(IGrantable identity, java.lang.Object objectsKeyPattern)` Grant read permissions for this bucket and it's contents to an IAM principal (Role/Group/User).
`Grant`	`grantReadWrite(IGrantable identity)` Grants read/write permissions for this bucket and it's contents to an IAM principal (Role/Group/User).
`Grant`	`grantReadWrite(IGrantable identity, java.lang.Object objectsKeyPattern)` Grants read/write permissions for this bucket and it's contents to an IAM principal (Role/Group/User).
`Grant`	`grantWrite(IGrantable identity)` Grant write permissions to this bucket to an IAM principal.
`Grant`	`grantWrite(IGrantable identity, java.lang.Object objectsKeyPattern)` Grant write permissions to this bucket to an IAM principal.
`Rule`	`onCloudTrailEvent(java.lang.String id)` Define a CloudWatch event that triggers when something happens to this repository.
`Rule`	`onCloudTrailEvent(java.lang.String id, OnCloudTrailBucketEventOptions options)` Define a CloudWatch event that triggers when something happens to this repository.
`Rule`	`onCloudTrailPutObject(java.lang.String id)` Defines an AWS CloudWatch event that triggers when an object is uploaded to the specified paths (keys) in this bucket using the PutObject API call.
`Rule`	`onCloudTrailPutObject(java.lang.String id, OnCloudTrailBucketEventOptions options)` Defines an AWS CloudWatch event that triggers when an object is uploaded to the specified paths (keys) in this bucket using the PutObject API call.
`Rule`	`onCloudTrailWriteObject(java.lang.String id)` Defines an AWS CloudWatch event that triggers when an object at the specified paths (keys) in this bucket are written to.
`Rule`	`onCloudTrailWriteObject(java.lang.String id, OnCloudTrailBucketEventOptions options)` Defines an AWS CloudWatch event that triggers when an object at the specified paths (keys) in this bucket are written to.
`java.lang.String`	`s3UrlForObject()` The S3 URL of an S3 object.
`java.lang.String`	`s3UrlForObject(java.lang.String key)` The S3 URL of an S3 object.
`protected abstract void`	`setAutoCreatePolicy(java.lang.Boolean value)` Indicates if a bucket resource policy should automatically created upon the first call to `addToResourcePolicy`.
`protected abstract void`	`setDisallowPublicAccess(java.lang.Boolean value)` Whether to disallow public access.
`protected void`	`setNotificationsHandlerRole(IRole value)`
`abstract void`	`setPolicy(BucketPolicy value)` The resource policy associated with this bucket.
`java.lang.String`	`transferAccelerationUrlForObject()` The https Transfer Acceleration URL of an S3 object.
`java.lang.String`	`transferAccelerationUrlForObject(java.lang.String key)` The https Transfer Acceleration URL of an S3 object.
`java.lang.String`	`transferAccelerationUrlForObject(java.lang.String key, TransferAccelerationUrlOptions options)` The https Transfer Acceleration URL of an S3 object.
`java.lang.String`	`urlForObject()` The https URL of an S3 object.
`java.lang.String`	`urlForObject(java.lang.String key)` The https URL of an S3 object.
`protected java.util.List<java.lang.String>`	`validate()` Validate the current construct.
`java.lang.String`	`virtualHostedUrlForObject()` The virtual hosted-style URL of an S3 object.
`java.lang.String`	`virtualHostedUrlForObject(java.lang.String key)` The virtual hosted-style URL of an S3 object.
`java.lang.String`	`virtualHostedUrlForObject(java.lang.String key, VirtualHostedStyleUrlOptions options)` The virtual hosted-style URL of an S3 object.

Methods inherited from class software.amazon.awscdk.core.Resource
applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource

Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.core.IResource
applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct
getNode

- Constructor Detail
  - BucketBase
```
protected BucketBase(software.amazon.jsii.JsiiObjectRef objRef)
```
  - BucketBase
```
protected BucketBase(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - BucketBase
```
protected BucketBase(software.constructs.Construct scope,
                     java.lang.String id,
                     ResourceProps props)
```
    Parameters:
    
    scope - This parameter is required.
    
    id - This parameter is required.
    
    props -
  - BucketBase
```
protected BucketBase(software.constructs.Construct scope,
                     java.lang.String id)
```
    Parameters:
    
    scope - This parameter is required.
    
    id - This parameter is required.
- Method Detail
  - addEventNotification
```
public void addEventNotification(EventType event,
                                 IBucketNotificationDestination dest,
                                 NotificationKeyFilter... filters)
```
    Adds a bucket notification event destination.
    Example:
    Function myLambda; Bucket bucket = new Bucket(this, "MyBucket"); bucket.addEventNotification(EventType.OBJECT_CREATED, new LambdaDestination(myLambda), NotificationKeyFilter.builder().prefix("home/myusername/*").build());
    Specified by:
    
    addEventNotification in interface IBucket
    
    Parameters:
    
    event - The event to trigger the notification. This parameter is required.
    
    dest - The notification destination (Lambda, SNS Topic or SQS Queue). This parameter is required.
    
    filters - S3 object key filter rules to determine which objects trigger this event. This parameter is required.
    
    See Also:
    
    https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html
  - addObjectCreatedNotification
```
public void addObjectCreatedNotification(IBucketNotificationDestination dest,
                                         NotificationKeyFilter... filters)
```
    Subscribes a destination to receive notifications when an object is created in the bucket.
    This is identical to calling onEvent(EventType.OBJECT_CREATED).
    
    Specified by:
    
    addObjectCreatedNotification in interface IBucket
    
    Parameters:
    
    dest - The notification destination (see onEvent). This parameter is required.
    
    filters - Filters (see onEvent). This parameter is required.
  - addObjectRemovedNotification
```
public void addObjectRemovedNotification(IBucketNotificationDestination dest,
                                         NotificationKeyFilter... filters)
```
    Subscribes a destination to receive notifications when an object is removed from the bucket.
    This is identical to calling onEvent(EventType.OBJECT_REMOVED).
    
    Specified by:
    
    addObjectRemovedNotification in interface IBucket
    
    Parameters:
    
    dest - The notification destination (see onEvent). This parameter is required.
    
    filters - Filters (see onEvent). This parameter is required.
  - addToResourcePolicy
```
public AddToResourcePolicyResult addToResourcePolicy(PolicyStatement permission)
```
    Adds a statement to the resource policy for a principal (i.e. account/role/service) to perform actions on this bucket and/or its contents. Use `bucketArn` and `arnForObjects(keys)` to obtain ARNs for this bucket or objects.
    Note that the policy statement may or may not be added to the policy. For example, when an IBucket is created from an existing bucket, it's not possible to tell whether the bucket already has a policy attached, let alone to re-use that policy to add more statements to it. So it's safest to do nothing in these cases.
    
    Specified by:
    
    addToResourcePolicy in interface IBucket
    
    Parameters:
    
    permission - the policy statement to be added to the bucket's policy. This parameter is required.
    
    Returns:
    
    metadata about the execution of this method. If the policy was not added, the value of `statementAdded` will be `false`. You should always check this value to make sure that the operation was actually carried out. Otherwise, synthesis and deploy will terminate silently, which may be confusing.
  - arnForObjects
```
public java.lang.String arnForObjects(java.lang.String keyPattern)
```
    Returns an ARN that represents all objects within the bucket that match the key pattern specified.
    To represent all keys, specify "*".
    If you need to specify a keyPattern with multiple components, concatenate them into a single string, e.g.:
    arnForObjects(home/${team}/${user}/*)
    
    Specified by:
    
    arnForObjects in interface IBucket
    
    Parameters:
    
    keyPattern - This parameter is required.
  - enableEventBridgeNotification
```
protected void enableEventBridgeNotification()
```
  - grantDelete
```
public Grant grantDelete(IGrantable identity,
                         java.lang.Object objectsKeyPattern)
```
    Grants s3:DeleteObject* permission to an IAM principal for objects in this bucket.
    
    Specified by:
    
    grantDelete in interface IBucket
    
    Parameters:
    
    identity - The principal. This parameter is required.
    
    objectsKeyPattern - Restrict the permission to a certain key pattern (default '*').
  - grantDelete
```
public Grant grantDelete(IGrantable identity)
```
    Grants s3:DeleteObject* permission to an IAM principal for objects in this bucket.
    
    Specified by:
    
    grantDelete in interface IBucket
    
    Parameters:
    
    identity - The principal. This parameter is required.
  - grantPublicAccess
```
public Grant grantPublicAccess(java.lang.String keyPrefix,
                               java.lang.String... allowedActions)
```
    Allows unrestricted access to objects from this bucket.
    IMPORTANT: This permission allows anyone to perform actions on S3 objects in this bucket, which is useful for when you configure your bucket as a website and want everyone to be able to read objects in the bucket without needing to authenticate.
    Without arguments, this method will grant read ("s3:GetObject") access to all objects ("*") in the bucket.
    The method returns the iam.Grant object, which can then be modified as needed. For example, you can add a condition that will restrict access only to an IPv4 range like this:
    const grant = bucket.grantPublicAccess(); grant.resourceStatement!.addCondition(‘IpAddress’, { “aws:SourceIp”: “54.240.143.0/24” });
    Note that if this IBucket refers to an existing bucket, possibly not managed by CloudFormation, this method will have no effect, since it's impossible to modify the policy of an existing bucket.
    Specified by:
    
    grantPublicAccess in interface IBucket
    
    Parameters:
    
    keyPrefix - the prefix of S3 object keys (e.g. `home/*`). Default is "*".
    
    allowedActions - the set of S3 actions to allow. This parameter is required.
    
    Returns:
    
    The `iam.PolicyStatement` object, which can be used to apply e.g. conditions.
  - grantPut
```
public Grant grantPut(IGrantable identity,
                      java.lang.Object objectsKeyPattern)
```
    Grants s3:PutObject* and s3:Abort* permissions for this bucket to an IAM principal.
    If encryption is used, permission to use the key to encrypt the contents of written files will also be granted to the same principal.
    
    Specified by:
    
    grantPut in interface IBucket
    
    Parameters:
    
    identity - The principal. This parameter is required.
    
    objectsKeyPattern - Restrict the permission to a certain key pattern (default '*').
  - grantPut
```
public Grant grantPut(IGrantable identity)
```
    Grants s3:PutObject* and s3:Abort* permissions for this bucket to an IAM principal.
    If encryption is used, permission to use the key to encrypt the contents of written files will also be granted to the same principal.
    
    Specified by:
    
    grantPut in interface IBucket
    
    Parameters:
    
    identity - The principal. This parameter is required.
  - grantPutAcl
```
public Grant grantPutAcl(IGrantable identity,
                         java.lang.String objectsKeyPattern)
```
    Grant the given IAM identity permissions to modify the ACLs of objects in the given Bucket.
    If your application has the '@aws-cdk/aws-s3:grantWriteWithoutAcl' feature flag set, calling {@link grantWrite} or {@link grantReadWrite} no longer grants permissions to modify the ACLs of the objects; in this case, if you need to modify object ACLs, call this method explicitly.
    
    Specified by:
    
    grantPutAcl in interface IBucket
    
    Parameters:
    
    identity - This parameter is required.
    
    objectsKeyPattern -
  - grantPutAcl
```
public Grant grantPutAcl(IGrantable identity)
```
    Grant the given IAM identity permissions to modify the ACLs of objects in the given Bucket.
    If your application has the '@aws-cdk/aws-s3:grantWriteWithoutAcl' feature flag set, calling {@link grantWrite} or {@link grantReadWrite} no longer grants permissions to modify the ACLs of the objects; in this case, if you need to modify object ACLs, call this method explicitly.
    
    Specified by:
    
    grantPutAcl in interface IBucket
    
    Parameters:
    
    identity - This parameter is required.
  - grantRead
```
public Grant grantRead(IGrantable identity,
                       java.lang.Object objectsKeyPattern)
```
    Grant read permissions for this bucket and it's contents to an IAM principal (Role/Group/User).
    If encryption is used, permission to use the key to decrypt the contents of the bucket will also be granted to the same principal.
    
    Specified by:
    
    grantRead in interface IBucket
    
    Parameters:
    
    identity - The principal. This parameter is required.
    
    objectsKeyPattern - Restrict the permission to a certain key pattern (default '*').
  - grantRead
```
public Grant grantRead(IGrantable identity)
```
    Grant read permissions for this bucket and it's contents to an IAM principal (Role/Group/User).
    If encryption is used, permission to use the key to decrypt the contents of the bucket will also be granted to the same principal.
    
    Specified by:
    
    grantRead in interface IBucket
    
    Parameters:
    
    identity - The principal. This parameter is required.
  - grantReadWrite
```
public Grant grantReadWrite(IGrantable identity,
                            java.lang.Object objectsKeyPattern)
```
    Grants read/write permissions for this bucket and it's contents to an IAM principal (Role/Group/User).
    If an encryption key is used, permission to use the key for encrypt/decrypt will also be granted.
    Before CDK version 1.85.0, this method granted the s3:PutObject* permission that included s3:PutObjectAcl, which could be used to grant read/write object access to IAM principals in other accounts. If you want to get rid of that behavior, update your CDK version to 1.85.0 or later, and make sure the @aws-cdk/aws-s3:grantWriteWithoutAcl feature flag is set to true in the context key of your cdk.json file. If you've already updated, but still need the principal to have permissions to modify the ACLs, use the {@link grantPutAcl} method.
    
    Specified by:
    
    grantReadWrite in interface IBucket
    
    Parameters:
    
    identity - This parameter is required.
    
    objectsKeyPattern -
  - grantReadWrite
```
public Grant grantReadWrite(IGrantable identity)
```
    Grants read/write permissions for this bucket and it's contents to an IAM principal (Role/Group/User).
    If an encryption key is used, permission to use the key for encrypt/decrypt will also be granted.
    Before CDK version 1.85.0, this method granted the s3:PutObject* permission that included s3:PutObjectAcl, which could be used to grant read/write object access to IAM principals in other accounts. If you want to get rid of that behavior, update your CDK version to 1.85.0 or later, and make sure the @aws-cdk/aws-s3:grantWriteWithoutAcl feature flag is set to true in the context key of your cdk.json file. If you've already updated, but still need the principal to have permissions to modify the ACLs, use the {@link grantPutAcl} method.
    
    Specified by:
    
    grantReadWrite in interface IBucket
    
    Parameters:
    
    identity - This parameter is required.
  - grantWrite
```
public Grant grantWrite(IGrantable identity,
                        java.lang.Object objectsKeyPattern)
```
    Grant write permissions to this bucket to an IAM principal.
    If encryption is used, permission to use the key to encrypt the contents of written files will also be granted to the same principal.
    Before CDK version 1.85.0, this method granted the s3:PutObject* permission that included s3:PutObjectAcl, which could be used to grant read/write object access to IAM principals in other accounts. If you want to get rid of that behavior, update your CDK version to 1.85.0 or later, and make sure the @aws-cdk/aws-s3:grantWriteWithoutAcl feature flag is set to true in the context key of your cdk.json file. If you've already updated, but still need the principal to have permissions to modify the ACLs, use the {@link grantPutAcl} method.
    
    Specified by:
    
    grantWrite in interface IBucket
    
    Parameters:
    
    identity - This parameter is required.
    
    objectsKeyPattern -
  - grantWrite
```
public Grant grantWrite(IGrantable identity)
```
    Grant write permissions to this bucket to an IAM principal.
    If encryption is used, permission to use the key to encrypt the contents of written files will also be granted to the same principal.
    Before CDK version 1.85.0, this method granted the s3:PutObject* permission that included s3:PutObjectAcl, which could be used to grant read/write object access to IAM principals in other accounts. If you want to get rid of that behavior, update your CDK version to 1.85.0 or later, and make sure the @aws-cdk/aws-s3:grantWriteWithoutAcl feature flag is set to true in the context key of your cdk.json file. If you've already updated, but still need the principal to have permissions to modify the ACLs, use the {@link grantPutAcl} method.
    
    Specified by:
    
    grantWrite in interface IBucket
    
    Parameters:
    
    identity - This parameter is required.
  - onCloudTrailEvent
```
public Rule onCloudTrailEvent(java.lang.String id,
                              OnCloudTrailBucketEventOptions options)
```
    Define a CloudWatch event that triggers when something happens to this repository.
    Requires that there exists at least one CloudTrail Trail in your account that captures the event. This method will not create the Trail.
    
    Specified by:
    
    onCloudTrailEvent in interface IBucket
    
    Parameters:
    
    id - The id of the rule. This parameter is required.
    
    options - Options for adding the rule.
  - onCloudTrailEvent
```
public Rule onCloudTrailEvent(java.lang.String id)
```
    Define a CloudWatch event that triggers when something happens to this repository.
    Requires that there exists at least one CloudTrail Trail in your account that captures the event. This method will not create the Trail.
    
    Specified by:
    
    onCloudTrailEvent in interface IBucket
    
    Parameters:
    
    id - The id of the rule. This parameter is required.
  - onCloudTrailPutObject
```
public Rule onCloudTrailPutObject(java.lang.String id,
                                  OnCloudTrailBucketEventOptions options)
```
    Defines an AWS CloudWatch event that triggers when an object is uploaded to the specified paths (keys) in this bucket using the PutObject API call.
    Note that some tools like aws s3 cp will automatically use either PutObject or the multipart upload API depending on the file size, so using onCloudTrailWriteObject may be preferable.
    Requires that there exists at least one CloudTrail Trail in your account that captures the event. This method will not create the Trail.
    
    Specified by:
    
    onCloudTrailPutObject in interface IBucket
    
    Parameters:
    
    id - The id of the rule. This parameter is required.
    
    options - Options for adding the rule.
  - onCloudTrailPutObject
```
public Rule onCloudTrailPutObject(java.lang.String id)
```
    Defines an AWS CloudWatch event that triggers when an object is uploaded to the specified paths (keys) in this bucket using the PutObject API call.
    Note that some tools like aws s3 cp will automatically use either PutObject or the multipart upload API depending on the file size, so using onCloudTrailWriteObject may be preferable.
    Requires that there exists at least one CloudTrail Trail in your account that captures the event. This method will not create the Trail.
    
    Specified by:
    
    onCloudTrailPutObject in interface IBucket
    
    Parameters:
    
    id - The id of the rule. This parameter is required.
  - onCloudTrailWriteObject
```
public Rule onCloudTrailWriteObject(java.lang.String id,
                                    OnCloudTrailBucketEventOptions options)
```
    Defines an AWS CloudWatch event that triggers when an object at the specified paths (keys) in this bucket are written to.
    This includes the events PutObject, CopyObject, and CompleteMultipartUpload.
    Note that some tools like aws s3 cp will automatically use either PutObject or the multipart upload API depending on the file size, so using this method may be preferable to onCloudTrailPutObject.
    Requires that there exists at least one CloudTrail Trail in your account that captures the event. This method will not create the Trail.
    
    Specified by:
    
    onCloudTrailWriteObject in interface IBucket
    
    Parameters:
    
    id - The id of the rule. This parameter is required.
    
    options - Options for adding the rule.
  - onCloudTrailWriteObject
```
public Rule onCloudTrailWriteObject(java.lang.String id)
```
    Defines an AWS CloudWatch event that triggers when an object at the specified paths (keys) in this bucket are written to.
    This includes the events PutObject, CopyObject, and CompleteMultipartUpload.
    Note that some tools like aws s3 cp will automatically use either PutObject or the multipart upload API depending on the file size, so using this method may be preferable to onCloudTrailPutObject.
    Requires that there exists at least one CloudTrail Trail in your account that captures the event. This method will not create the Trail.
    
    Specified by:
    
    onCloudTrailWriteObject in interface IBucket
    
    Parameters:
    
    id - The id of the rule. This parameter is required.
  - s3UrlForObject
```
public java.lang.String s3UrlForObject(java.lang.String key)
```
    The S3 URL of an S3 object. For example:.
    - s3://onlybucket
    - s3://bucket/key
    Specified by:
    
    s3UrlForObject in interface IBucket
    
    Parameters:
    
    key - The S3 key of the object.
    
    Returns:
    
    an ObjectS3Url token
  - s3UrlForObject
```
public java.lang.String s3UrlForObject()
```
    The S3 URL of an S3 object. For example:.
    - s3://onlybucket
    - s3://bucket/key
    Specified by:
    
    s3UrlForObject in interface IBucket
    
    Returns:
    
    an ObjectS3Url token
  - transferAccelerationUrlForObject
```
public java.lang.String transferAccelerationUrlForObject(java.lang.String key,
                                                         TransferAccelerationUrlOptions options)
```
    The https Transfer Acceleration URL of an S3 object.
    Specify dualStack: true at the options for dual-stack endpoint (connect to the bucket over IPv6). For example:
    - https://bucket.s3-accelerate.amazonaws.com
    - https://bucket.s3-accelerate.amazonaws.com/key
    Specified by:
    
    transferAccelerationUrlForObject in interface IBucket
    
    Parameters:
    
    key - The S3 key of the object.
    
    options - Options for generating URL.
    
    Returns:
    
    an TransferAccelerationUrl token
  - transferAccelerationUrlForObject
```
public java.lang.String transferAccelerationUrlForObject(java.lang.String key)
```
    The https Transfer Acceleration URL of an S3 object.
    Specify dualStack: true at the options for dual-stack endpoint (connect to the bucket over IPv6). For example:
    - https://bucket.s3-accelerate.amazonaws.com
    - https://bucket.s3-accelerate.amazonaws.com/key
    Specified by:
    
    transferAccelerationUrlForObject in interface IBucket
    
    Parameters:
    
    key - The S3 key of the object.
    
    Returns:
    
    an TransferAccelerationUrl token
  - transferAccelerationUrlForObject
```
public java.lang.String transferAccelerationUrlForObject()
```
    The https Transfer Acceleration URL of an S3 object.
    Specify dualStack: true at the options for dual-stack endpoint (connect to the bucket over IPv6). For example:
    - https://bucket.s3-accelerate.amazonaws.com
    - https://bucket.s3-accelerate.amazonaws.com/key
    Specified by:
    
    transferAccelerationUrlForObject in interface IBucket
    
    Returns:
    
    an TransferAccelerationUrl token
  - urlForObject
```
public java.lang.String urlForObject(java.lang.String key)
```
    The https URL of an S3 object. Specify `regional: false` at the options for non-regional URLs. For example:.
    - https://s3.us-west-1.amazonaws.com/onlybucket
    - https://s3.us-west-1.amazonaws.com/bucket/key
    - https://s3.cn-north-1.amazonaws.com.cn/china-bucket/mykey
    Specified by:
    
    urlForObject in interface IBucket
    
    Parameters:
    
    key - The S3 key of the object.
    
    Returns:
    
    an ObjectS3Url token
  - urlForObject
```
public java.lang.String urlForObject()
```
    The https URL of an S3 object. Specify `regional: false` at the options for non-regional URLs. For example:.
    - https://s3.us-west-1.amazonaws.com/onlybucket
    - https://s3.us-west-1.amazonaws.com/bucket/key
    - https://s3.cn-north-1.amazonaws.com.cn/china-bucket/mykey
    Specified by:
    
    urlForObject in interface IBucket
    
    Returns:
    
    an ObjectS3Url token
  - validate
```
protected java.util.List<java.lang.String> validate()
```
    Validate the current construct.
    This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.
    
    Overrides:
    
    validate in class Construct
    
    Returns:
    
    An array of validation error messages, or an empty array if the construct is valid.
  - virtualHostedUrlForObject
```
public java.lang.String virtualHostedUrlForObject(java.lang.String key,
                                                  VirtualHostedStyleUrlOptions options)
```
    The virtual hosted-style URL of an S3 object. Specify `regional: false` at the options for non-regional URL. For example:.
    - https://only-bucket.s3.us-west-1.amazonaws.com
    - https://bucket.s3.us-west-1.amazonaws.com/key
    - https://bucket.s3.amazonaws.com/key
    - https://china-bucket.s3.cn-north-1.amazonaws.com.cn/mykey
    Specified by:
    
    virtualHostedUrlForObject in interface IBucket
    
    Parameters:
    
    key - The S3 key of the object.
    
    options - Options for generating URL.
    
    Returns:
    
    an ObjectS3Url token
  - virtualHostedUrlForObject
```
public java.lang.String virtualHostedUrlForObject(java.lang.String key)
```
    The virtual hosted-style URL of an S3 object. Specify `regional: false` at the options for non-regional URL. For example:.
    - https://only-bucket.s3.us-west-1.amazonaws.com
    - https://bucket.s3.us-west-1.amazonaws.com/key
    - https://bucket.s3.amazonaws.com/key
    - https://china-bucket.s3.cn-north-1.amazonaws.com.cn/mykey
    Specified by:
    
    virtualHostedUrlForObject in interface IBucket
    
    Parameters:
    
    key - The S3 key of the object.
    
    Returns:
    
    an ObjectS3Url token
  - virtualHostedUrlForObject
```
public java.lang.String virtualHostedUrlForObject()
```
    The virtual hosted-style URL of an S3 object. Specify `regional: false` at the options for non-regional URL. For example:.
    - https://only-bucket.s3.us-west-1.amazonaws.com
    - https://bucket.s3.us-west-1.amazonaws.com/key
    - https://bucket.s3.amazonaws.com/key
    - https://china-bucket.s3.cn-north-1.amazonaws.com.cn/mykey
    Specified by:
    
    virtualHostedUrlForObject in interface IBucket
    
    Returns:
    
    an ObjectS3Url token
  - getBucketArn
```
public abstract java.lang.String getBucketArn()
```
    The ARN of the bucket.
    
    Specified by:
    
    getBucketArn in interface IBucket
  - getBucketDomainName
```
public abstract java.lang.String getBucketDomainName()
```
    The IPv4 DNS name of the specified bucket.
    
    Specified by:
    
    getBucketDomainName in interface IBucket
  - getBucketDualStackDomainName
```
public abstract java.lang.String getBucketDualStackDomainName()
```
    The IPv6 DNS name of the specified bucket.
    
    Specified by:
    
    getBucketDualStackDomainName in interface IBucket
  - getBucketName
```
public abstract java.lang.String getBucketName()
```
    The name of the bucket.
    
    Specified by:
    
    getBucketName in interface IBucket
  - getBucketRegionalDomainName
```
public abstract java.lang.String getBucketRegionalDomainName()
```
    The regional domain name of the specified bucket.
    
    Specified by:
    
    getBucketRegionalDomainName in interface IBucket
  - getBucketWebsiteDomainName
```
public abstract java.lang.String getBucketWebsiteDomainName()
```
    The Domain name of the static website.
    
    Specified by:
    
    getBucketWebsiteDomainName in interface IBucket
  - getBucketWebsiteUrl
```
public abstract java.lang.String getBucketWebsiteUrl()
```
    The URL of the static website.
    
    Specified by:
    
    getBucketWebsiteUrl in interface IBucket
  - getEncryptionKey
```
public abstract IKey getEncryptionKey()
```
    Optional KMS encryption key associated with this bucket.
    
    Specified by:
    
    getEncryptionKey in interface IBucket
  - getIsWebsite
```
public abstract java.lang.Boolean getIsWebsite()
```
    If this bucket has been configured for static website hosting.
    
    Specified by:
    
    getIsWebsite in interface IBucket
  - getAutoCreatePolicy
```
protected abstract java.lang.Boolean getAutoCreatePolicy()
```
    Indicates if a bucket resource policy should automatically created upon the first call to `addToResourcePolicy`.
  - setAutoCreatePolicy
```
protected abstract void setAutoCreatePolicy(java.lang.Boolean value)
```
    Indicates if a bucket resource policy should automatically created upon the first call to `addToResourcePolicy`.
  - getDisallowPublicAccess
```
protected abstract java.lang.Boolean getDisallowPublicAccess()
```
    Whether to disallow public access.
  - setDisallowPublicAccess
```
protected abstract void setDisallowPublicAccess(java.lang.Boolean value)
```
    Whether to disallow public access.
  - getNotificationsHandlerRole
```
protected IRole getNotificationsHandlerRole()
```
  - setNotificationsHandlerRole
```
protected void setNotificationsHandlerRole(IRole value)
```
  - getPolicy
```
public abstract BucketPolicy getPolicy()
```
    The resource policy associated with this bucket.
    If autoCreatePolicy is true, a BucketPolicy will be created upon the first call to addToResourcePolicy(s).
    
    Specified by:
    
    getPolicy in interface IBucket
  - setPolicy
```
public abstract void setPolicy(BucketPolicy value)
```
    The resource policy associated with this bucket.
    If autoCreatePolicy is true, a BucketPolicy will be created upon the first call to addToResourcePolicy(s).
    
    Specified by:
    
    setPolicy in interface IBucket

Class BucketBase

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.s3.IBucket

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.core.Resource

Methods inherited from class software.amazon.awscdk.core.Construct

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awscdk.core.IResource

Methods inherited from interface software.amazon.awscdk.core.IConstruct

Constructor Detail

BucketBase

BucketBase

BucketBase

BucketBase

Method Detail

addEventNotification

addObjectCreatedNotification

addObjectRemovedNotification

addToResourcePolicy

arnForObjects

enableEventBridgeNotification

grantDelete

grantDelete

grantPublicAccess

grantPut

grantPut

grantPutAcl

grantPutAcl

grantRead

grantRead

grantReadWrite

grantReadWrite

grantWrite

grantWrite

onCloudTrailEvent

onCloudTrailEvent

onCloudTrailPutObject

onCloudTrailPutObject

onCloudTrailWriteObject

onCloudTrailWriteObject

s3UrlForObject

s3UrlForObject

transferAccelerationUrlForObject

transferAccelerationUrlForObject

transferAccelerationUrlForObject

urlForObject

urlForObject

validate

virtualHostedUrlForObject

virtualHostedUrlForObject

virtualHostedUrlForObject

getBucketArn

getBucketDomainName

getBucketDualStackDomainName

getBucketName

getBucketRegionalDomainName

getBucketWebsiteDomainName

getBucketWebsiteUrl

getEncryptionKey

getIsWebsite

getAutoCreatePolicy

setAutoCreatePolicy

getDisallowPublicAccess

setDisallowPublicAccess

getNotificationsHandlerRole

setNotificationsHandlerRole

getPolicy

setPolicy