IBucket

All Superinterfaces:

IConstruct, IDependable, IResource

All Known Subinterfaces:

IBucket.Jsii$Default

All Known Implementing Classes:

Bucket, BucketBase, IBucket.Jsii$Proxy
```
@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:41.675Z")
public interface IBucket
extends IResource
```

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`IBucket.Jsii$Default` Internal default implementation for `IBucket`.
`static class`	`IBucket.Jsii$Proxy` A proxy class which represents a concrete javascript instance of this type.

Method Summary

All Methods Instance Methods Abstract Methods Default 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.
`java.lang.String`	`getBucketArn()` The ARN of the bucket.
`java.lang.String`	`getBucketDomainName()` The IPv4 DNS name of the specified bucket.
`java.lang.String`	`getBucketDualStackDomainName()` The IPv6 DNS name of the specified bucket.
`java.lang.String`	`getBucketName()` The name of the bucket.
`java.lang.String`	`getBucketRegionalDomainName()` The regional domain name of the specified bucket.
`java.lang.String`	`getBucketWebsiteDomainName()` The Domain name of the static website.
`java.lang.String`	`getBucketWebsiteUrl()` The URL of the static website.
`default IKey`	`getEncryptionKey()` Optional KMS encryption key associated with this bucket.
`default java.lang.Boolean`	`getIsWebsite()` If this bucket has been configured for static website hosting.
`default 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)` Defines a CloudWatch event that triggers when something happens to this bucket.
`Rule`	`onCloudTrailEvent(java.lang.String id, OnCloudTrailBucketEventOptions options)` Defines a CloudWatch event that triggers when something happens to this bucket.
`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.
`default 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.
`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 interface software.amazon.awscdk.core.IResource
applyRemovalPolicy, getEnv, getStack

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

- Method Detail
  - getBucketArn
```
java.lang.String getBucketArn()
```
    The ARN of the bucket.
  - getBucketDomainName
```
java.lang.String getBucketDomainName()
```
    The IPv4 DNS name of the specified bucket.
  - getBucketDualStackDomainName
```
java.lang.String getBucketDualStackDomainName()
```
    The IPv6 DNS name of the specified bucket.
  - getBucketName
```
java.lang.String getBucketName()
```
    The name of the bucket.
  - getBucketRegionalDomainName
```
java.lang.String getBucketRegionalDomainName()
```
    The regional domain name of the specified bucket.
  - getBucketWebsiteDomainName
```
java.lang.String getBucketWebsiteDomainName()
```
    The Domain name of the static website.
  - getBucketWebsiteUrl
```
java.lang.String getBucketWebsiteUrl()
```
    The URL of the static website.
  - getEncryptionKey
```
default IKey getEncryptionKey()
```
    Optional KMS encryption key associated with this bucket.
  - getIsWebsite
```
default java.lang.Boolean getIsWebsite()
```
    If this bucket has been configured for static website hosting.
  - getPolicy
```
default 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).
  - setPolicy
```
default 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).
  - addEventNotification
```
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());
    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
```
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(s3.EventType.OBJECT_CREATED).
    
    Parameters:
    
    dest - The notification destination (see onEvent). This parameter is required.
    
    filters - Filters (see onEvent). This parameter is required.
  - addObjectRemovedNotification
```
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).
    
    Parameters:
    
    dest - The notification destination (see onEvent). This parameter is required.
    
    filters - Filters (see onEvent). This parameter is required.
  - addToResourcePolicy
```
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.
    
    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
```
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 "*".
    
    Parameters:
    
    keyPattern - This parameter is required.
  - grantDelete
```
Grant grantDelete(IGrantable identity,
                  java.lang.Object objectsKeyPattern)
```
    Grants s3:DeleteObject* permission to an IAM principal for objects in this bucket.
    
    Parameters:
    
    identity - The principal. This parameter is required.
    
    objectsKeyPattern - Restrict the permission to a certain key pattern (default '*').
  - grantDelete
```
Grant grantDelete(IGrantable identity)
```
    Grants s3:DeleteObject* permission to an IAM principal for objects in this bucket.
    
    Parameters:
    
    identity - The principal. This parameter is required.
  - grantPublicAccess
```
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” });
    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
```
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.
    
    Parameters:
    
    identity - The principal. This parameter is required.
    
    objectsKeyPattern - Restrict the permission to a certain key pattern (default '*').
  - grantPut
```
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.
    
    Parameters:
    
    identity - The principal. This parameter is required.
  - grantPutAcl
```
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.
    
    Parameters:
    
    identity - The principal. This parameter is required.
    
    objectsKeyPattern - Restrict the permission to a certain key pattern (default '*').
  - grantPutAcl
```
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.
    
    Parameters:
    
    identity - The principal. This parameter is required.
  - grantRead
```
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.
    
    Parameters:
    
    identity - The principal. This parameter is required.
    
    objectsKeyPattern - Restrict the permission to a certain key pattern (default '*').
  - grantRead
```
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.
    
    Parameters:
    
    identity - The principal. This parameter is required.
  - grantReadWrite
```
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.
    
    Parameters:
    
    identity - The principal. This parameter is required.
    
    objectsKeyPattern - Restrict the permission to a certain key pattern (default '*').
  - grantReadWrite
```
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.
    
    Parameters:
    
    identity - The principal. This parameter is required.
  - grantWrite
```
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.
    
    Parameters:
    
    identity - The principal. This parameter is required.
    
    objectsKeyPattern - Restrict the permission to a certain key pattern (default '*').
  - grantWrite
```
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.
    
    Parameters:
    
    identity - The principal. This parameter is required.
  - onCloudTrailEvent
```
Rule onCloudTrailEvent(java.lang.String id,
                       OnCloudTrailBucketEventOptions options)
```
    Defines a CloudWatch event that triggers when something happens to this bucket.
    Requires that there exists at least one CloudTrail Trail in your account that captures the event. This method will not create the Trail.
    
    Parameters:
    
    id - The id of the rule. This parameter is required.
    
    options - Options for adding the rule.
  - onCloudTrailEvent
```
Rule onCloudTrailEvent(java.lang.String id)
```
    Defines a CloudWatch event that triggers when something happens to this bucket.
    Requires that there exists at least one CloudTrail Trail in your account that captures the event. This method will not create the Trail.
    
    Parameters:
    
    id - The id of the rule. This parameter is required.
  - onCloudTrailPutObject
```
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.
    
    Parameters:
    
    id - The id of the rule. This parameter is required.
    
    options - Options for adding the rule.
  - onCloudTrailPutObject
```
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.
    
    Parameters:
    
    id - The id of the rule. This parameter is required.
  - onCloudTrailWriteObject
```
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.
    
    Parameters:
    
    id - The id of the rule. This parameter is required.
    
    options - Options for adding the rule.
  - onCloudTrailWriteObject
```
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.
    
    Parameters:
    
    id - The id of the rule. This parameter is required.
  - s3UrlForObject
```
java.lang.String s3UrlForObject(java.lang.String key)
```
    The S3 URL of an S3 object.
    For example:
    - s3://onlybucket
    - s3://bucket/key
    Parameters:
    
    key - The S3 key of the object.
    
    Returns:
    
    an ObjectS3Url token
  - s3UrlForObject
```
java.lang.String s3UrlForObject()
```
    The S3 URL of an S3 object.
    For example:
    - s3://onlybucket
    - s3://bucket/key
    Returns:
    
    an ObjectS3Url token
  - transferAccelerationUrlForObject
```
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
    Parameters:
    
    key - The S3 key of the object.
    
    options - Options for generating URL.
    
    Returns:
    
    an TransferAccelerationUrl token
  - transferAccelerationUrlForObject
```
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
    Parameters:
    
    key - The S3 key of the object.
    
    Returns:
    
    an TransferAccelerationUrl token
  - transferAccelerationUrlForObject
```
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
    Returns:
    
    an TransferAccelerationUrl token
  - urlForObject
```
java.lang.String urlForObject(java.lang.String key)
```
    The https URL of an S3 object. 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
    Parameters:
    
    key - The S3 key of the object.
    
    Returns:
    
    an ObjectS3Url token
  - urlForObject
```
java.lang.String urlForObject()
```
    The https URL of an S3 object. 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
    Returns:
    
    an ObjectS3Url token
  - virtualHostedUrlForObject
```
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
    Parameters:
    
    key - The S3 key of the object.
    
    options - Options for generating URL.
    
    Returns:
    
    an ObjectS3Url token
  - virtualHostedUrlForObject
```
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
    Parameters:
    
    key - The S3 key of the object.
    
    Returns:
    
    an ObjectS3Url token
  - virtualHostedUrlForObject
```
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
    Returns:
    
    an ObjectS3Url token

Interface IBucket

Nested Class Summary

Method Summary

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

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

Method Detail

getBucketArn

getBucketDomainName

getBucketDualStackDomainName

getBucketName

getBucketRegionalDomainName

getBucketWebsiteDomainName

getBucketWebsiteUrl

getEncryptionKey

getIsWebsite

getPolicy

setPolicy

addEventNotification

addObjectCreatedNotification

addObjectRemovedNotification

addToResourcePolicy

arnForObjects

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

virtualHostedUrlForObject

virtualHostedUrlForObject

virtualHostedUrlForObject