@gammarers/aws-secure-bucket

# API Reference <a name="API Reference" id="api-reference"></a> ## Constructs <a name="Constructs" id="Constructs"></a> ### SecureBucket <a name="SecureBucket" id="@yicr/secure-bucket.SecureBucket"></a> #### Initializers <a name="Initializers" id="@yicr/secure-bucket.SecureBucket.Initializer"></a> ```typescript import { SecureBucket } from '@yicr/secure-bucket' new SecureBucket(scope: Construct, id: string, props?: SecureBucketProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | <code><a href="#@yicr/secure-bucket.SecureBucket.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* | | <code><a href="#@yicr/secure-bucket.SecureBucket.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* | | <code><a href="#@yicr/secure-bucket.SecureBucket.Initializer.parameter.props">props</a></code> | <code><a href="#@yicr/secure-bucket.SecureBucketProps">SecureBucketProps</a></code> | *No description.* | --- ##### `scope`Required <a name="scope" id="@yicr/secure-bucket.SecureBucket.Initializer.parameter.scope"></a> - *Type:* constructs.Construct --- ##### `id`Required <a name="id" id="@yicr/secure-bucket.SecureBucket.Initializer.parameter.id"></a> - *Type:* string --- ##### `props`Optional <a name="props" id="@yicr/secure-bucket.SecureBucket.Initializer.parameter.props"></a> - *Type:* <a href="#@yicr/secure-bucket.SecureBucketProps">SecureBucketProps</a> --- #### Methods <a name="Methods" id="Methods"></a> | **Name** | **Description** | | --- | --- | | <code><a href="#@yicr/secure-bucket.SecureBucket.toString">toString</a></code> | Returns a string representation of this construct. | | <code><a href="#@yicr/secure-bucket.SecureBucket.applyRemovalPolicy">applyRemovalPolicy</a></code> | Apply the given removal policy to this resource. | | <code><a href="#@yicr/secure-bucket.SecureBucket.addEventNotification">addEventNotification</a></code> | Adds a bucket notification event destination. | | <code><a href="#@yicr/secure-bucket.SecureBucket.addObjectCreatedNotification">addObjectCreatedNotification</a></code> | Subscribes a destination to receive notifications when an object is created in the bucket. | | <code><a href="#@yicr/secure-bucket.SecureBucket.addObjectRemovedNotification">addObjectRemovedNotification</a></code> | Subscribes a destination to receive notifications when an object is removed from the bucket. | | <code><a href="#@yicr/secure-bucket.SecureBucket.addToResourcePolicy">addToResourcePolicy</a></code> | 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. | | <code><a href="#@yicr/secure-bucket.SecureBucket.arnForObjects">arnForObjects</a></code> | Returns an ARN that represents all objects within the bucket that match the key pattern specified. | | <code><a href="#@yicr/secure-bucket.SecureBucket.enableEventBridgeNotification">enableEventBridgeNotification</a></code> | Enables event bridge notification, causing all events below to be sent to EventBridge:. | | <code><a href="#@yicr/secure-bucket.SecureBucket.grantDelete">grantDelete</a></code> | Grants s3:DeleteObject* permission to an IAM principal for objects in this bucket. | | <code><a href="#@yicr/secure-bucket.SecureBucket.grantPublicAccess">grantPublicAccess</a></code> | Allows unrestricted access to objects from this bucket. | | <code><a href="#@yicr/secure-bucket.SecureBucket.grantPut">grantPut</a></code> | Grants s3:PutObject* and s3:Abort* permissions for this bucket to an IAM principal. | | <code><a href="#@yicr/secure-bucket.SecureBucket.grantPutAcl">grantPutAcl</a></code> | Grant the given IAM identity permissions to modify the ACLs of objects in the given Bucket. | | <code><a href="#@yicr/secure-bucket.SecureBucket.grantRead">grantRead</a></code> | Grant read permissions for this bucket and it's contents to an IAM principal (Role/Group/User). | | <code><a href="#@yicr/secure-bucket.SecureBucket.grantReadWrite">grantReadWrite</a></code> | Grants read/write permissions for this bucket and it's contents to an IAM principal (Role/Group/User). | | <code><a href="#@yicr/secure-bucket.SecureBucket.grantWrite">grantWrite</a></code> | Grant write permissions to this bucket to an IAM principal. | | <code><a href="#@yicr/secure-bucket.SecureBucket.onCloudTrailEvent">onCloudTrailEvent</a></code> | Define a CloudWatch event that triggers when something happens to this repository. | | <code><a href="#@yicr/secure-bucket.SecureBucket.onCloudTrailPutObject">onCloudTrailPutObject</a></code> | 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. | | <code><a href="#@yicr/secure-bucket.SecureBucket.onCloudTrailWriteObject">onCloudTrailWriteObject</a></code> | Defines an AWS CloudWatch event that triggers when an object at the specified paths (keys) in this bucket are written to. | | <code><a href="#@yicr/secure-bucket.SecureBucket.s3UrlForObject">s3UrlForObject</a></code> | The S3 URL of an S3 object. For example:. | | <code><a href="#@yicr/secure-bucket.SecureBucket.transferAccelerationUrlForObject">transferAccelerationUrlForObject</a></code> | The https Transfer Acceleration URL of an S3 object. | | <code><a href="#@yicr/secure-bucket.SecureBucket.urlForObject">urlForObject</a></code> | The https URL of an S3 object. Specify `regional: false` at the options for non-regional URLs. For example:. | | <code><a href="#@yicr/secure-bucket.SecureBucket.virtualHostedUrlForObject">virtualHostedUrlForObject</a></code> | The virtual hosted-style URL of an S3 object. Specify `regional: false` at the options for non-regional URL. For example:. | | <code><a href="#@yicr/secure-bucket.SecureBucket.addCorsRule">addCorsRule</a></code> | Adds a cross-origin access configuration for objects in an Amazon S3 bucket. | | <code><a href="#@yicr/secure-bucket.SecureBucket.addInventory">addInventory</a></code> | Add an inventory configuration. | | <code><a href="#@yicr/secure-bucket.SecureBucket.addLifecycleRule">addLifecycleRule</a></code> | Add a lifecycle rule to the bucket. | | <code><a href="#@yicr/secure-bucket.SecureBucket.addMetric">addMetric</a></code> | Adds a metrics configuration for the CloudWatch request metrics from the bucket. | --- ##### `toString` <a name="toString" id="@yicr/secure-bucket.SecureBucket.toString"></a> ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `applyRemovalPolicy` <a name="applyRemovalPolicy" id="@yicr/secure-bucket.SecureBucket.applyRemovalPolicy"></a> ```typescript public applyRemovalPolicy(policy: RemovalPolicy): void ``` Apply the given removal policy to this resource. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). ###### `policy`Required <a name="policy" id="@yicr/secure-bucket.SecureBucket.applyRemovalPolicy.parameter.policy"></a> - *Type:* aws-cdk-lib.RemovalPolicy --- ##### `addEventNotification` <a name="addEventNotification" id="@yicr/secure-bucket.SecureBucket.addEventNotification"></a> ```typescript public addEventNotification(event: EventType, dest: IBucketNotificationDestination, filters: NotificationKeyFilter): void ``` Adds a bucket notification event destination. > [https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) *Example* ```typescript declare const myLambda: lambda.Function; const bucket = new s3.Bucket(this, 'MyBucket'); bucket.addEventNotification(s3.EventType.OBJECT_CREATED, new s3n.LambdaDestination(myLambda), {prefix: 'home/myusername/*'}); ``` ###### `event`Required <a name="event" id="@yicr/secure-bucket.SecureBucket.addEventNotification.parameter.event"></a> - *Type:* aws-cdk-lib.aws_s3.EventType The event to trigger the notification. --- ###### `dest`Required <a name="dest" id="@yicr/secure-bucket.SecureBucket.addEventNotification.parameter.dest"></a> - *Type:* aws-cdk-lib.aws_s3.IBucketNotificationDestination The notification destination (Lambda, SNS Topic or SQS Queue). --- ###### `filters`Required <a name="filters" id="@yicr/secure-bucket.SecureBucket.addEventNotification.parameter.filters"></a> - *Type:* aws-cdk-lib.aws_s3.NotificationKeyFilter S3 object key filter rules to determine which objects trigger this event. Each filter must include a `prefix` and/or `suffix` that will be matched against the s3 object key. Refer to the S3 Developer Guide for details about allowed filter rules. --- ##### `addObjectCreatedNotification` <a name="addObjectCreatedNotification" id="@yicr/secure-bucket.SecureBucket.addObjectCreatedNotification"></a> ```typescript public addObjectCreatedNotification(dest: IBucketNotificationDestination, filters: NotificationKeyFilter): void ``` Subscribes a destination to receive notifications when an object is created in the bucket. This is identical to calling `onEvent(EventType.OBJECT_CREATED)`. ###### `dest`Required <a name="dest" id="@yicr/secure-bucket.SecureBucket.addObjectCreatedNotification.parameter.dest"></a> - *Type:* aws-cdk-lib.aws_s3.IBucketNotificationDestination The notification destination (see onEvent). --- ###### `filters`Required <a name="filters" id="@yicr/secure-bucket.SecureBucket.addObjectCreatedNotification.parameter.filters"></a> - *Type:* aws-cdk-lib.aws_s3.NotificationKeyFilter Filters (see onEvent). --- ##### `addObjectRemovedNotification` <a name="addObjectRemovedNotification" id="@yicr/secure-bucket.SecureBucket.addObjectRemovedNotification"></a> ```typescript public addObjectRemovedNotification(dest: IBucketNotificationDestination, filters: NotificationKeyFilter): void ``` Subscribes a destination to receive notifications when an object is removed from the bucket. This is identical to calling `onEvent(EventType.OBJECT_REMOVED)`. ###### `dest`Required <a name="dest" id="@yicr/secure-bucket.SecureBucket.addObjectRemovedNotification.parameter.dest"></a> - *Type:* aws-cdk-lib.aws_s3.IBucketNotificationDestination The notification destination (see onEvent). --- ###### `filters`Required <a name="filters" id="@yicr/secure-bucket.SecureBucket.addObjectRemovedNotification.parameter.filters"></a> - *Type:* aws-cdk-lib.aws_s3.NotificationKeyFilter Filters (see onEvent). --- ##### `addToResourcePolicy` <a name="addToResourcePolicy" id="@yicr/secure-bucket.SecureBucket.addToResourcePolicy"></a> ```typescript public addToResourcePolicy(permission: PolicyStatement): AddToResourcePolicyResult ``` 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. ###### `permission`Required <a name="permission" id="@yicr/secure-bucket.SecureBucket.addToResourcePolicy.parameter.permission"></a> - *Type:* aws-cdk-lib.aws_iam.PolicyStatement the policy statement to be added to the bucket's policy. --- ##### `arnForObjects` <a name="arnForObjects" id="@yicr/secure-bucket.SecureBucket.arnForObjects"></a> ```typescript public arnForObjects(keyPattern: string): string ``` 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}/*`) ###### `keyPattern`Required <a name="keyPattern" id="@yicr/secure-bucket.SecureBucket.arnForObjects.parameter.keyPattern"></a> - *Type:* string --- ##### `enableEventBridgeNotification` <a name="enableEventBridgeNotification" id="@yicr/secure-bucket.SecureBucket.enableEventBridgeNotification"></a> ```typescript public enableEventBridgeNotification(): void ``` Enables event bridge notification, causing all events below to be sent to EventBridge:. Object Deleted (DeleteObject) - Object Deleted (Lifecycle expiration) - Object Restore Initiated - Object Restore Completed - Object Restore Expired - Object Storage Class Changed - Object Access Tier Changed - Object ACL Updated - Object Tags Added - Object Tags Deleted ##### `grantDelete` <a name="grantDelete" id="@yicr/secure-bucket.SecureBucket.grantDelete"></a> ```typescript public grantDelete(identity: IGrantable, objectsKeyPattern?: any): Grant ``` Grants s3:DeleteObject* permission to an IAM principal for objects in this bucket. ###### `identity`Required <a name="identity" id="@yicr/secure-bucket.SecureBucket.grantDelete.parameter.identity"></a> - *Type:* aws-cdk-lib.aws_iam.IGrantable The principal. --- ###### `objectsKeyPattern`Optional <a name="objectsKeyPattern" id="@yicr/secure-bucket.SecureBucket.grantDelete.parameter.objectsKeyPattern"></a> - *Type:* any Restrict the permission to a certain key pattern (default '*'). --- ##### `grantPublicAccess` <a name="grantPublicAccess" id="@yicr/secure-bucket.SecureBucket.grantPublicAccess"></a> ```typescript public grantPublicAccess(allowedActions: string, keyPrefix?: string): Grant ``` 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. ###### `allowedActions`Required <a name="allowedActions" id="@yicr/secure-bucket.SecureBucket.grantPublicAccess.parameter.allowedActions"></a> - *Type:* string the set of S3 actions to allow. Default is "s3:GetObject". --- ###### `keyPrefix`Optional <a name="keyPrefix" id="@yicr/secure-bucket.SecureBucket.grantPublicAccess.parameter.keyPrefix"></a> - *Type:* string the prefix of S3 object keys (e.g. `home/*`). Default is "*". --- ##### `grantPut` <a name="grantPut" id="@yicr/secure-bucket.SecureBucket.grantPut"></a> ```typescript public grantPut(identity: IGrantable, objectsKeyPattern?: any): Grant ``` 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. ###### `identity`Required <a name="identity" id="@yicr/secure-bucket.SecureBucket.grantPut.parameter.identity"></a> - *Type:* aws-cdk-lib.aws_iam.IGrantable The principal. --- ###### `objectsKeyPattern`Optional <a name="objectsKeyPattern" id="@yicr/secure-bucket.SecureBucket.grantPut.parameter.objectsKeyPattern"></a> - *Type:* any Restrict the permission to a certain key pattern (default '*'). --- ##### `grantPutAcl` <a name="grantPutAcl" id="@yicr/secure-bucket.SecureBucket.grantPutAcl"></a> ```typescript public grantPutAcl(identity: IGrantable, objectsKeyPattern?: string): Grant ``` 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 `grantWrite` or `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. ###### `identity`Required <a name="identity" id="@yicr/secure-bucket.SecureBucket.grantPutAcl.parameter.identity"></a> - *Type:* aws-cdk-lib.aws_iam.IGrantable --- ###### `objectsKeyPattern`Optional <a name="objectsKeyPattern" id="@yicr/secure-bucket.SecureBucket.grantPutAcl.parameter.objectsKeyPattern"></a> - *Type:* string --- ##### `grantRead` <a name="grantRead" id="@yicr/secure-bucket.SecureBucket.grantRead"></a> ```typescript public grantRead(identity: IGrantable, objectsKeyPattern?: any): Grant ``` 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. ###### `identity`Required <a name="identity" id="@yicr/secure-bucket.SecureBucket.grantRead.parameter.identity"></a> - *Type:* aws-cdk-lib.aws_iam.IGrantable The principal. --- ###### `objectsKeyPattern`Optional <a name="objectsKeyPattern" id="@yicr/secure-bucket.SecureBucket.grantRead.parameter.objectsKeyPattern"></a> - *Type:* any Restrict the permission to a certain key pattern (default '*'). --- ##### `grantReadWrite` <a name="grantReadWrite" id="@yicr/secure-bucket.SecureBucket.grantReadWrite"></a> ```typescript public grantReadWrite(identity: IGrantable, objectsKeyPattern?: any): Grant ``` 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 `grantPutAcl` method. ###### `identity`Required <a name="identity" id="@yicr/secure-bucket.SecureBucket.grantReadWrite.parameter.identity"></a> - *Type:* aws-cdk-lib.aws_iam.IGrantable --- ###### `objectsKeyPattern`Optional <a name="objectsKeyPattern" id="@yicr/secure-bucket.SecureBucket.grantReadWrite.parameter.objectsKeyPattern"></a> - *Type:* any --- ##### `grantWrite` <a name="grantWrite" id="@yicr/secure-bucket.SecureBucket.grantWrite"></a> ```typescript public grantWrite(identity: IGrantable, objectsKeyPattern?: any): Grant ``` 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 `grantPutAcl` method. ###### `identity`Required <a name="identity" id="@yicr/secure-bucket.SecureBucket.grantWrite.parameter.identity"></a> - *Type:* aws-cdk-lib.aws_iam.IGrantable --- ###### `objectsKeyPattern`Optional <a name="objectsKeyPattern" id="@yicr/secure-bucket.SecureBucket.grantWrite.parameter.objectsKeyPattern"></a> - *Type:* any --- ##### `onCloudTrailEvent` <a name="onCloudTrailEvent" id="@yicr/secure-bucket.SecureBucket.onCloudTrailEvent"></a> ```typescript public onCloudTrailEvent(id: string, options?: OnCloudTrailBucketEventOptions): Rule ``` 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. ###### `id`Required <a name="id" id="@yicr/secure-bucket.SecureBucket.onCloudTrailEvent.parameter.id"></a> - *Type:* string The id of the rule. --- ###### `options`Optional <a name="options" id="@yicr/secure-bucket.SecureBucket.onCloudTrailEvent.parameter.options"></a> - *Type:* aws-cdk-lib.aws_s3.OnCloudTrailBucketEventOptions Options for adding the rule. --- ##### `onCloudTrailPutObject` <a name="onCloudTrailPutObject" id="@yicr/secure-bucket.SecureBucket.onCloudTrailPutObject"></a> ```typescript public onCloudTrailPutObject(id: string, options?: OnCloudTrailBucketEventOptions): Rule ``` 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. ###### `id`Required <a name="id" id="@yicr/secure-bucket.SecureBucket.onCloudTrailPutObject.parameter.id"></a> - *Type:* string The id of the rule. --- ###### `options`Optional <a name="options" id="@yicr/secure-bucket.SecureBucket.onCloudTrailPutObject.parameter.options"></a> - *Type:* aws-cdk-lib.aws_s3.OnCloudTrailBucketEventOptions Options for adding the rule. --- ##### `onCloudTrailWriteObject` <a name="onCloudTrailWriteObject" id="@yicr/secure-bucket.SecureBucket.onCloudTrailWriteObject"></a> ```typescript public onCloudTrailWriteObject(id: string, options?: OnCloudTrailBucketEventOptions): Rule ``` 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. ###### `id`Required <a name="id" id="@yicr/secure-bucket.SecureBucket.onCloudTrailWriteObject.parameter.id"></a> - *Type:* string The id of the rule. --- ###### `options`Optional <a name="options" id="@yicr/secure-bucket.SecureBucket.onCloudTrailWriteObject.parameter.options"></a> - *Type:* aws-cdk-lib.aws_s3.OnCloudTrailBucketEventOptions Options for adding the rule. --- ##### `s3UrlForObject` <a name="s3UrlForObject" id="@yicr/secure-bucket.SecureBucket.s3UrlForObject"></a> ```typescript public s3UrlForObject(key?: string): string ``` The S3 URL of an S3 object. For example:. `s3://onlybucket` - `s3://bucket/key` ###### `key`Optional <a name="key" id="@yicr/secure-bucket.SecureBucket.s3UrlForObject.parameter.key"></a> - *Type:* string The S3 key of the object. If not specified, the S3 URL of the bucket is returned. --- ##### `transferAccelerationUrlForObject` <a name="transferAccelerationUrlForObject" id="@yicr/secure-bucket.SecureBucket.transferAccelerationUrlForObject"></a> ```typescript public transferAccelerationUrlForObject(key?: string, options?: TransferAccelerationUrlOptions): string ``` 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` ###### `key`Optional <a name="key" id="@yicr/secure-bucket.SecureBucket.transferAccelerationUrlForObject.parameter.key"></a> - *Type:* string The S3 key of the object. If not specified, the URL of the bucket is returned. --- ###### `options`Optional <a name="options" id="@yicr/secure-bucket.SecureBucket.transferAccelerationUrlForObject.parameter.options"></a> - *Type:* aws-cdk-lib.aws_s3.TransferAccelerationUrlOptions Options for generating URL. --- ##### `urlForObject` <a name="urlForObject" id="@yicr/secure-bucket.SecureBucket.urlForObject"></a> ```typescript public urlForObject(key?: string): string ``` 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` ###### `key`Optional <a name="key" id="@yicr/secure-bucket.SecureBucket.urlForObject.parameter.key"></a> - *Type:* string The S3 key of the object. If not specified, the URL of the bucket is returned. --- ##### `virtualHostedUrlForObject` <a name="virtualHostedUrlForObject" id="@yicr/secure-bucket.SecureBucket.virtualHostedUrlForObject"></a> ```typescript public virtualHostedUrlForObject(key?: string, options?: VirtualHostedStyleUrlOptions): string ``` 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` ###### `key`Optional <a name="key" id="@yicr/secure-bucket.SecureBucket.virtualHostedUrlForObject.parameter.key"></a> - *Type:* string The S3 key of the object. If not specified, the URL of the bucket is returned. --- ###### `options`Optional <a name="options" id="@yicr/secure-bucket.SecureBucket.virtualHostedUrlForObject.parameter.options"></a> - *Type:* aws-cdk-lib.aws_s3.VirtualHostedStyleUrlOptions Options for generating URL. --- ##### `addCorsRule` <a name="addCorsRule" id="@yicr/secure-bucket.SecureBucket.addCorsRule"></a> ```typescript public addCorsRule(rule: CorsRule): void ``` Adds a cross-origin access configuration for objects in an Amazon S3 bucket. ###### `rule`Required <a name="rule" id="@yicr/secure-bucket.SecureBucket.addCorsRule.parameter.rule"></a> - *Type:* aws-cdk-lib.aws_s3.CorsRule The CORS configuration rule to add. --- ##### `addInventory` <a name="addInventory" id="@yicr/secure-bucket.SecureBucket.addInventory"></a> ```typescript public addInventory(inventory: Inventory): void ``` Add an inventory configuration. ###### `inventory`Required <a name="inventory" id="@yicr/secure-bucket.SecureBucket.addInventory.parameter.inventory"></a> - *Type:* aws-cdk-lib.aws_s3.Inventory configuration to add. --- ##### `addLifecycleRule` <a name="addLifecycleRule" id="@yicr/secure-bucket.SecureBucket.addLifecycleRule"></a> ```typescript public addLifecycleRule(rule: LifecycleRule): void ``` Add a lifecycle rule to the bucket. ###### `rule`Required <a name="rule" id="@yicr/secure-bucket.SecureBucket.addLifecycleRule.parameter.rule"></a> - *Type:* aws-cdk-lib.aws_s3.LifecycleRule The rule to add. --- ##### `addMetric` <a name="addMetric" id="@yicr/secure-bucket.SecureBucket.addMetric"></a> ```typescript public addMetric(metric: BucketMetrics): void ``` Adds a metrics configuration for the CloudWatch request metrics from the bucket. ###### `metric`Required <a name="metric" id="@yicr/secure-bucket.SecureBucket.addMetric.parameter.metric"></a> - *Type:* aws-cdk-lib.aws_s3.BucketMetrics The metric configuration to add. --- #### Static Functions <a name="Static Functions" id="Static Functions"></a> | **Name** | **Description** | | --- | --- | | <code><a href="#@yicr/secure-bucket.SecureBucket.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. | | <code><a href="#@yicr/secure-bucket.SecureBucket.isOwnedResource">isOwnedResource</a></code> | Returns true if the construct was created by CDK, and false otherwise. | | <code><a href="#@yicr/secure-bucket.SecureBucket.isResource">isResource</a></code> | Check whether the given construct is a Resource. | | <code><a href="#@yicr/secure-bucket.SecureBucket.fromBucketArn">fromBucketArn</a></code> | *No description.* | | <code><a href="#@yicr/secure-bucket.SecureBucket.fromBucketAttributes">fromBucketAttributes</a></code> | Creates a Bucket construct that represents an external bucket. | | <code><a href="#@yicr/secure-bucket.SecureBucket.fromBucketName">fromBucketName</a></code> | *No description.* | | <code><a href="#@yicr/secure-bucket.SecureBucket.fromCfnBucket">fromCfnBucket</a></code> | Create a mutable `IBucket` based on a low-level `CfnBucket`. | | <code><a href="#@yicr/secure-bucket.SecureBucket.validateBucketName">validateBucketName</a></code> | Thrown an exception if the given bucket name is not valid. | --- ##### ~~`isConstruct`~~ <a name="isConstruct" id="@yicr/secure-bucket.SecureBucket.isConstruct"></a> ```typescript import { SecureBucket } from '@yicr/secure-bucket' SecureBucket.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`Required <a name="x" id="@yicr/secure-bucket.SecureBucket.isConstruct.parameter.x"></a> - *Type:* any Any object. --- ##### `isOwnedResource` <a name="isOwnedResource" id="@yicr/secure-bucket.SecureBucket.isOwnedResource"></a> ```typescript import { SecureBucket } from '@yicr/secure-bucket' SecureBucket.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`Required <a name="construct" id="@yicr/secure-bucket.SecureBucket.isOwnedResource.parameter.construct"></a> - *Type:* constructs.IConstruct --- ##### `isResource` <a name="isResource" id="@yicr/secure-bucket.SecureBucket.isResource"></a> ```typescript import { SecureBucket } from '@yicr/secure-bucket' SecureBucket.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`Required <a name="construct" id="@yicr/secure-bucket.SecureBucket.isResource.parameter.construct"></a> - *Type:* constructs.IConstruct --- ##### `fromBucketArn` <a name="fromBucketArn" id="@yicr/secure-bucket.SecureBucket.fromBucketArn"></a> ```typescript import { SecureBucket } from '@yicr/secure-bucket' SecureBucket.fromBucketArn(scope: Construct, id: string, bucketArn: string) ``` ###### `scope`Required <a name="scope" id="@yicr/secure-bucket.SecureBucket.fromBucketArn.parameter.scope"></a> - *Type:* constructs.Construct --- ###### `id`Required <a name="id" id="@yicr/secure-bucket.SecureBucket.fromBucketArn.parameter.id"></a> - *Type:* string --- ###### `bucketArn`Required <a name="bucketArn" id="@yicr/secure-bucket.SecureBucket.fromBucketArn.parameter.bucketArn"></a> - *Type:* string --- ##### `fromBucketAttributes` <a name="fromBucketAttributes" id="@yicr/secure-bucket.SecureBucket.fromBucketAttributes"></a> ```typescript import { SecureBucket } from '@yicr/secure-bucket' SecureBucket.fromBucketAttributes(scope: Construct, id: string, attrs: BucketAttributes) ``` Creates a Bucket construct that represents an external bucket. ###### `scope`Required <a name="scope" id="@yicr/secure-bucket.SecureBucket.fromBucketAttributes.parameter.scope"></a> - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`Required <a name="id" id="@yicr/secure-bucket.SecureBucket.fromBucketAttributes.parameter.id"></a> - *Type:* string The construct's name. --- ###### `attrs`Required <a name="attrs" id="@yicr/secure-bucket.SecureBucket.fromBucketAttributes.parameter.attrs"></a> - *Type:* aws-cdk-lib.aws_s3.BucketAttributes A `BucketAttributes` object. Can be obtained from a call to `bucket.export()` or manually created. --- ##### `fromBucketName` <a name="fromBucketName" id="@yicr/secure-bucket.SecureBucket.fromBucketName"></a> ```typescript import { SecureBucket } from '@yicr/secure-bucket' SecureBucket.fromBucketName(scope: Construct, id: string, bucketName: string) ``` ###### `scope`Required <a name="scope" id="@yicr/secure-bucket.SecureBucket.fromBucketName.parameter.scope"></a> - *Type:* constructs.Construct --- ###### `id`Required <a name="id" id="@yicr/secure-bucket.SecureBucket.fromBucketName.parameter.id"></a> - *Type:* string --- ###### `bucketName`Required <a name="bucketName" id="@yicr/secure-bucket.SecureBucket.fromBucketName.parameter.bucketName"></a> - *Type:* string --- ##### `fromCfnBucket` <a name="fromCfnBucket" id="@yicr/secure-bucket.SecureBucket.fromCfnBucket"></a> ```typescript import { SecureBucket } from '@yicr/secure-bucket' SecureBucket.fromCfnBucket(cfnBucket: CfnBucket) ``` Create a mutable `IBucket` based on a low-level `CfnBucket`. ###### `cfnBucket`Required <a name="cfnBucket" id="@yicr/secure-bucket.SecureBucket.fromCfnBucket.parameter.cfnBucket"></a> - *Type:* aws-cdk-lib.aws_s3.CfnBucket --- ##### `validateBucketName` <a name="validateBucketName" id="@yicr/secure-bucket.SecureBucket.validateBucketName"></a> ```typescript import { SecureBucket } from '@yicr/secure-bucket' SecureBucket.validateBucketName(physicalName: string) ``` Thrown an exception if the given bucket name is not valid. ###### `physicalName`Required <a name="physicalName" id="@yicr/secure-bucket.SecureBucket.validateBucketName.parameter.physicalName"></a> - *Type:* string name of the bucket. --- #### Properties <a name="Properties" id="Properties"></a> | **Name** | **Type** | **Description** | | --- | --- | --- | | <code><a href="#@yicr/secure-bucket.SecureBucket.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. | | <code><a href="#@yicr/secure-bucket.SecureBucket.property.env">env</a></code> | <code>aws-cdk-lib.ResourceEnvironment</code> | The environment this resource belongs to. | | <code><a href="#@yicr/secure-bucket.SecureBucket.property.stack">stack</a></code> | <code>aws-cdk-lib.Stack</code> | The stack in which this resource is defined. | | <code><a href="#@yicr/secure-bucket.SecureBucket.property.bucketArn">bucketArn</a></code> | <code>string</code> | The ARN of the bucket. | | <code><a href="#@yicr/secure-bucket.SecureBucket.property.bucketDomainName">bucketDomainName</a></code> | <code>string</code> | The IPv4 DNS name of the specified bucket. | | <code><a href="#@yicr/secure-bucket.SecureBucket.property.bucketDualStackDomainName">bucketDualStackDomainName</a></code> | <code>string</code> | The IPv6 DNS name of the specified bucket. | | <code><a href="#@yicr/secure-bucket.SecureBucket.property.bucketName">bucketName</a></code> | <code>string</code> | The name of the bucket. | | <code><a href="#@yicr/secure-bucket.SecureBucket.property.bucketRegionalDomainName">bucketRegionalDomainName</a></code> | <code>string</code> | The regional domain name of the specified bucket. | | <code><a href="#@yicr/secure-bucket.SecureBucket.property.bucketWebsiteDomainName">bucketWebsiteDomainName</a></code> | <code>string</code> | The Domain name of the static website. | | <code><a href="#@yicr/secure-bucket.SecureBucket.property.bucketWebsiteUrl">bucketWebsiteUrl</a></code> | <code>string</code> | The URL of the static website. | | <code><a href="#@yicr/secure-bucket.SecureBucket.property.encryptionKey">encryptionKey</a></code> | <code>aws-cdk-lib.aws_kms.IKey</code> | Optional KMS encryption key associated with this bucket. | | <code><a href="#@yicr/secure-bucket.SecureBucket.property.isWebsite">isWebsite</a></code> | <code>boolean</code> | If this bucket has been configured for static website hosting. | | <code><a href="#@yicr/secure-bucket.SecureBucket.property.policy">policy</a></code> | <code>aws-cdk-lib.aws_s3.BucketPolicy</code> | The resource policy associated with this bucket. | --- ##### `node`Required <a name="node" id="@yicr/secure-bucket.SecureBucket.property.node"></a> ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`Required <a name="env" id="@yicr/secure-bucket.SecureBucket.property.env"></a> ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`Required <a name="stack" id="@yicr/secure-bucket.SecureBucket.property.stack"></a> ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `bucketArn`Required <a name="bucketArn" id="@yicr/secure-bucket.SecureBucket.property.bucketArn"></a> ```typescript public readonly bucketArn: string; ``` - *Type:* string The ARN of the bucket. --- ##### `bucketDomainName`Required <a name="bucketDomainName" id="@yicr/secure-bucket.SecureBucket.property.bucketDomainName"></a> ```typescript public readonly bucketDomainName: string; ``` - *Type:* string The IPv4 DNS name of the specified bucket. --- ##### `bucketDualStackDomainName`Required <a name="bucketDualStackDomainName" id="@yicr/secure-bucket.SecureBucket.property.bucketDualStackDomainName"></a> ```typescript public readonly bucketDualStackDomainName: string; ``` - *Type:* string The IPv6 DNS name of the specified bucket. --- ##### `bucketName`Required <a name="bucketName" id="@yicr/secure-bucket.SecureBucket.property.bucketName"></a> ```typescript public readonly bucketName: string; ``` - *Type:* string The name of the bucket. --- ##### `bucketRegionalDomainName`Required <a name="bucketRegionalDomainName" id="@yicr/secure-bucket.SecureBucket.property.bucketRegionalDomainName"></a> ```typescript public readonly bucketRegionalDomainName: string; ``` - *Type:* string The regional domain name of the specified bucket. --- ##### `bucketWebsiteDomainName`Required <a name="bucketWebsiteDomainName" id="@yicr/secure-bucket.SecureBucket.property.bucketWebsiteDomainName"></a> ```typescript public readonly bucketWebsiteDomainName: string; ``` - *Type:* string The Domain name of the static website. --- ##### `bucketWebsiteUrl`Required <a name="bucketWebsiteUrl" id="@yicr/secure-bucket.SecureBucket.property.bucketWebsiteUrl"></a> ```typescript public readonly bucketWebsiteUrl: string; ``` - *Type:* string The URL of the static website. --- ##### `encryptionKey`Optional <a name="encryptionKey" id="@yicr/secure-bucket.SecureBucket.property.encryptionKey"></a> ```typescript public readonly encryptionKey: IKey; ``` - *Type:* aws-cdk-lib.aws_kms.IKey Optional KMS encryption key associated with this bucket. --- ##### `isWebsite`Optional <a name="isWebsite" id="@yicr/secure-bucket.SecureBucket.property.isWebsite"></a> ```typescript public readonly isWebsite: boolean; ``` - *Type:* boolean If this bucket has been configured for static website hosting. --- ##### `policy`Optional <a name="policy" id="@yicr/secure-bucket.SecureBucket.property.policy"></a> ```typescript public readonly policy: BucketPolicy; ``` - *Type:* aws-cdk-lib.aws_s3.BucketPolicy The resource policy associated with this bucket. If `autoCreatePolicy` is true, a `BucketPolicy` will be created upon the first call to addToResourcePolicy(s). --- ## Structs <a name="Structs" id="Structs"></a> ### SecureBucketProps <a name="SecureBucketProps" id="@yicr/secure-bucket.SecureBucketProps"></a> #### Initializer <a name="Initializer" id="@yicr/secure-bucket.SecureBucketProps.Initializer"></a> ```typescript import { SecureBucketProps } from '@yicr/secure-bucket' const secureBucketProps: SecureBucketProps = { ... } ``` #### Properties <a name="Properties" id="Properties"></a> | **Name** | **Type** | **Description** | | --- | --- | --- | | <code><a href="#@yicr/secure-bucket.SecureBucketProps.property.bucketName">bucketName</a></code> | <code>string</code> | *No description.* | | <code><a href="#@yicr/secure-bucket.SecureBucketProps.property.encryption">encryption</a></code> | <code><a href="#@yicr/secure-bucket.SecureBucketEncryption">SecureBucketEncryption</a></code> | *No description.* | | <code><a href="#@yicr/secure-bucket.SecureBucketProps.property.versioned">versioned</a></code> | <code>boolean</code> | *No description.* | --- ##### `bucketName`Optional <a name="bucketName" id="@yicr/secure-bucket.SecureBucketProps.property.bucketName"></a> ```typescript public readonly bucketName: string; ``` - *Type:* string --- ##### `encryption`Optional <a name="encryption" id="@yicr/secure-bucket.SecureBucketProps.property.encryption"></a> ```typescript public readonly encryption: SecureBucketEncryption; ``` - *Type:* <a href="#@yicr/secure-bucket.SecureBucketEncryption">SecureBucketEncryption</a> --- ##### `versioned`Optional <a name="versioned" id="@yicr/secure-bucket.SecureBucketProps.property.versioned"></a> ```typescript public readonly versioned: boolean; ``` - *Type:* boolean --- ## Enums <a name="Enums" id="Enums"></a> ### SecureBucketEncryption <a name="SecureBucketEncryption" id="@yicr/secure-bucket.SecureBucketEncryption"></a> #### Members <a name="Members" id="Members"></a> | **Name** | **Description** | | --- | --- | | <code><a href="#@yicr/secure-bucket.SecureBucketEncryption.KMS_MANAGED">KMS_MANAGED</a></code> | Server-side KMS encryption with a master key managed by KMS. | | <code><a href="#@yicr/secure-bucket.SecureBucketEncryption.S3_MANAGED">S3_MANAGED</a></code> | Server-side encryption with a master key managed by S3. | --- ##### `KMS_MANAGED` <a name="KMS_MANAGED" id="@yicr/secure-bucket.SecureBucketEncryption.KMS_MANAGED"></a> Server-side KMS encryption with a master key managed by KMS. --- ##### `S3_MANAGED` <a name="S3_MANAGED" id="@yicr/secure-bucket.SecureBucketEncryption.S3_MANAGED"></a> Server-side encryption with a master key managed by S3. ---