Skip to content

Latest commit

 

History

History
1164 lines (699 loc) · 44.2 KB

API.md

File metadata and controls

1164 lines (699 loc) · 44.2 KB

API Reference

Constructs

SecureVpcBucket

Initializers 

import { SecureVpcBucket } from '@gammarers/aws-secure-vpc-bucket'

new SecureVpcBucket(scope: Construct, id: string, props: SecureVpcBucketProps)
Name Type Description
scope constructs.Construct No description.
id string No description.
props SecureVpcBucketProps No description.
scopeRequired
  • Type: constructs.Construct
idRequired
  • Type: string
propsRequired

Methods

Name Description
toString Returns a string representation of this construct.
applyRemovalPolicy Apply the given removal policy to this resource.
addEventNotification Adds a bucket notification event destination.
addObjectCreatedNotification Subscribes a destination to receive notifications when an object is created in the bucket.
addObjectRemovedNotification Subscribes a destination to receive notifications when an object is removed from the bucket.
addToResourcePolicy 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.
arnForObjects Returns an ARN that represents all objects within the bucket that match the key pattern specified.
enableEventBridgeNotification Enables event bridge notification, causing all events below to be sent to EventBridge:.
grantDelete Grants s3:DeleteObject* permission to an IAM principal for objects in this bucket.
grantPublicAccess Allows unrestricted access to objects from this bucket.
grantPut Grants s3:PutObject* and s3:Abort* permissions for this bucket to an IAM principal.
grantPutAcl Grant the given IAM identity permissions to modify the ACLs of objects in the given Bucket.
grantRead Grant read permissions for this bucket and it's contents to an IAM principal (Role/Group/User).
grantReadWrite Grants read/write permissions for this bucket and it's contents to an IAM principal (Role/Group/User).
grantWrite Grant write permissions to this bucket to an IAM principal.
onCloudTrailEvent Define a CloudWatch event that triggers when something happens to this repository.
onCloudTrailPutObject 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.
onCloudTrailWriteObject Defines an AWS CloudWatch event that triggers when an object at the specified paths (keys) in this bucket are written to.
s3UrlForObject The S3 URL of an S3 object. For example:.
transferAccelerationUrlForObject The https Transfer Acceleration URL of an S3 object.
urlForObject The https URL of an S3 object. Specify regional: false at the options for non-regional URLs. For example:.
virtualHostedUrlForObject The virtual hosted-style URL of an S3 object. Specify regional: false at the options for non-regional URL. For example:.
addCorsRule Adds a cross-origin access configuration for objects in an Amazon S3 bucket.
addInventory Add an inventory configuration.
addLifecycleRule Add a lifecycle rule to the bucket.
addMetric Adds a metrics configuration for the CloudWatch request metrics from the bucket.
toString 
public toString(): string

Returns a string representation of this construct.

applyRemovalPolicy 
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).

policyRequired
  • Type: aws-cdk-lib.RemovalPolicy
addEventNotification 
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

Example

   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/*'});
eventRequired
  • Type: aws-cdk-lib.aws_s3.EventType

The event to trigger the notification.

destRequired
  • Type: aws-cdk-lib.aws_s3.IBucketNotificationDestination

The notification destination (Lambda, SNS Topic or SQS Queue).

filtersRequired
  • 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 
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).

destRequired
  • Type: aws-cdk-lib.aws_s3.IBucketNotificationDestination

The notification destination (see onEvent).

filtersRequired
  • Type: ...aws-cdk-lib.aws_s3.NotificationKeyFilter[]

Filters (see onEvent).

addObjectRemovedNotification 
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).

destRequired
  • Type: aws-cdk-lib.aws_s3.IBucketNotificationDestination

The notification destination (see onEvent).

filtersRequired
  • Type: ...aws-cdk-lib.aws_s3.NotificationKeyFilter[]

Filters (see onEvent).

addToResourcePolicy 
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.

permissionRequired
  • Type: aws-cdk-lib.aws_iam.PolicyStatement

the policy statement to be added to the bucket's policy.

arnForObjects 
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}/*)

keyPatternRequired
  • Type: string
enableEventBridgeNotification 
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 
public grantDelete(identity: IGrantable, objectsKeyPattern?: any): Grant

Grants s3:DeleteObject* permission to an IAM principal for objects in this bucket.

identityRequired
  • Type: aws-cdk-lib.aws_iam.IGrantable

The principal.

objectsKeyPatternOptional
  • Type: any

Restrict the permission to a certain key pattern (default '*').

grantPublicAccess 
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.

allowedActionsRequired
  • Type: ...string[]

the set of S3 actions to allow.

Default is "s3:GetObject".

keyPrefixOptional
  • Type: string

the prefix of S3 object keys (e.g. home/*). Default is "*".

grantPut 
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.

identityRequired
  • Type: aws-cdk-lib.aws_iam.IGrantable

The principal.

objectsKeyPatternOptional
  • Type: any

Restrict the permission to a certain key pattern (default '*').

grantPutAcl 
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.

identityRequired
  • Type: aws-cdk-lib.aws_iam.IGrantable
objectsKeyPatternOptional
  • Type: string
grantRead 
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.

identityRequired
  • Type: aws-cdk-lib.aws_iam.IGrantable

The principal.

objectsKeyPatternOptional
  • Type: any

Restrict the permission to a certain key pattern (default '*').

grantReadWrite 
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.

identityRequired
  • Type: aws-cdk-lib.aws_iam.IGrantable
objectsKeyPatternOptional
  • Type: any
grantWrite 
public grantWrite(identity: IGrantable, objectsKeyPattern?: any, allowedActionPatterns?: string[]): 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.

identityRequired
  • Type: aws-cdk-lib.aws_iam.IGrantable
objectsKeyPatternOptional
  • Type: any
allowedActionPatternsOptional
  • Type: string[]
onCloudTrailEvent 
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.

idRequired
  • Type: string

The id of the rule.

optionsOptional
  • Type: aws-cdk-lib.aws_s3.OnCloudTrailBucketEventOptions

Options for adding the rule.

onCloudTrailPutObject 
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.

idRequired
  • Type: string

The id of the rule.

optionsOptional
  • Type: aws-cdk-lib.aws_s3.OnCloudTrailBucketEventOptions

Options for adding the rule.

onCloudTrailWriteObject 
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.

idRequired
  • Type: string

The id of the rule.

optionsOptional
  • Type: aws-cdk-lib.aws_s3.OnCloudTrailBucketEventOptions

Options for adding the rule.

s3UrlForObject 
public s3UrlForObject(key?: string): string

The S3 URL of an S3 object. For example:.

s3://onlybucket

  • s3://bucket/key
keyOptional
  • Type: string

The S3 key of the object.

If not specified, the S3 URL of the bucket is returned.

transferAccelerationUrlForObject 
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
keyOptional
  • Type: string

The S3 key of the object.

If not specified, the URL of the bucket is returned.

optionsOptional
  • Type: aws-cdk-lib.aws_s3.TransferAccelerationUrlOptions

Options for generating URL.

urlForObject 
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
keyOptional
  • Type: string

The S3 key of the object.

If not specified, the URL of the bucket is returned.

virtualHostedUrlForObject 
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
keyOptional
  • Type: string

The S3 key of the object.

If not specified, the URL of the bucket is returned.

optionsOptional
  • Type: aws-cdk-lib.aws_s3.VirtualHostedStyleUrlOptions

Options for generating URL.

addCorsRule 
public addCorsRule(rule: CorsRule): void

Adds a cross-origin access configuration for objects in an Amazon S3 bucket.

ruleRequired
  • Type: aws-cdk-lib.aws_s3.CorsRule

The CORS configuration rule to add.

addInventory 
public addInventory(inventory: Inventory): void

Add an inventory configuration.

inventoryRequired
  • Type: aws-cdk-lib.aws_s3.Inventory

configuration to add.

addLifecycleRule 
public addLifecycleRule(rule: LifecycleRule): void

Add a lifecycle rule to the bucket.

ruleRequired
  • Type: aws-cdk-lib.aws_s3.LifecycleRule

The rule to add.

addMetric 
public addMetric(metric: BucketMetrics): void

Adds a metrics configuration for the CloudWatch request metrics from the bucket.

metricRequired
  • Type: aws-cdk-lib.aws_s3.BucketMetrics

The metric configuration to add.

Static Functions

Name Description
isConstruct Checks if x is a construct.
isOwnedResource Returns true if the construct was created by CDK, and false otherwise.
isResource Check whether the given construct is a Resource.
fromBucketArn No description.
fromBucketAttributes Creates a Bucket construct that represents an external bucket.
fromBucketName No description.
fromCfnBucket Create a mutable IBucket based on a low-level CfnBucket.
validateBucketName Thrown an exception if the given bucket name is not valid.
isConstruct 
import { SecureVpcBucket } from '@gammarers/aws-secure-vpc-bucket'

SecureVpcBucket.isConstruct(x: any)

Checks if x is a construct.

xRequired
  • Type: any

Any object.

isOwnedResource 
import { SecureVpcBucket } from '@gammarers/aws-secure-vpc-bucket'

SecureVpcBucket.isOwnedResource(construct: IConstruct)

Returns true if the construct was created by CDK, and false otherwise.

constructRequired
  • Type: constructs.IConstruct
isResource 
import { SecureVpcBucket } from '@gammarers/aws-secure-vpc-bucket'

SecureVpcBucket.isResource(construct: IConstruct)

Check whether the given construct is a Resource.

constructRequired
  • Type: constructs.IConstruct
fromBucketArn 
import { SecureVpcBucket } from '@gammarers/aws-secure-vpc-bucket'

SecureVpcBucket.fromBucketArn(scope: Construct, id: string, bucketArn: string)
scopeRequired
  • Type: constructs.Construct
idRequired
  • Type: string
bucketArnRequired
  • Type: string
fromBucketAttributes 
import { SecureVpcBucket } from '@gammarers/aws-secure-vpc-bucket'

SecureVpcBucket.fromBucketAttributes(scope: Construct, id: string, attrs: BucketAttributes)

Creates a Bucket construct that represents an external bucket.

scopeRequired
  • Type: constructs.Construct

The parent creating construct (usually this).

idRequired
  • Type: string

The construct's name.

attrsRequired
  • Type: aws-cdk-lib.aws_s3.BucketAttributes

A BucketAttributes object.

Can be obtained from a call to bucket.export() or manually created.

fromBucketName 
import { SecureVpcBucket } from '@gammarers/aws-secure-vpc-bucket'

SecureVpcBucket.fromBucketName(scope: Construct, id: string, bucketName: string)
scopeRequired
  • Type: constructs.Construct
idRequired
  • Type: string
bucketNameRequired
  • Type: string
fromCfnBucket 
import { SecureVpcBucket } from '@gammarers/aws-secure-vpc-bucket'

SecureVpcBucket.fromCfnBucket(cfnBucket: CfnBucket)

Create a mutable IBucket based on a low-level CfnBucket.

cfnBucketRequired
  • Type: aws-cdk-lib.aws_s3.CfnBucket
validateBucketName 
import { SecureVpcBucket } from '@gammarers/aws-secure-vpc-bucket'

SecureVpcBucket.validateBucketName(physicalName: string)

Thrown an exception if the given bucket name is not valid.

physicalNameRequired
  • Type: string

name of the bucket.

Properties

Name Type Description
node constructs.Node The tree node.
env aws-cdk-lib.ResourceEnvironment The environment this resource belongs to.
stack aws-cdk-lib.Stack The stack in which this resource is defined.
bucketArn string The ARN of the bucket.
bucketDomainName string The IPv4 DNS name of the specified bucket.
bucketDualStackDomainName string The IPv6 DNS name of the specified bucket.
bucketName string The name of the bucket.
bucketRegionalDomainName string The regional domain name of the specified bucket.
bucketWebsiteDomainName string The Domain name of the static website.
bucketWebsiteUrl string The URL of the static website.
encryptionKey aws-cdk-lib.aws_kms.IKey Optional KMS encryption key associated with this bucket.
isWebsite boolean If this bucket has been configured for static website hosting.
policy aws-cdk-lib.aws_s3.BucketPolicy The resource policy associated with this bucket.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

envRequired 
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.

stackRequired 
public readonly stack: Stack;
  • Type: aws-cdk-lib.Stack

The stack in which this resource is defined.

bucketArnRequired 
public readonly bucketArn: string;
  • Type: string

The ARN of the bucket.

bucketDomainNameRequired 
public readonly bucketDomainName: string;
  • Type: string

The IPv4 DNS name of the specified bucket.

bucketDualStackDomainNameRequired 
public readonly bucketDualStackDomainName: string;
  • Type: string

The IPv6 DNS name of the specified bucket.

bucketNameRequired 
public readonly bucketName: string;
  • Type: string

The name of the bucket.

bucketRegionalDomainNameRequired 
public readonly bucketRegionalDomainName: string;
  • Type: string

The regional domain name of the specified bucket.

bucketWebsiteDomainNameRequired 
public readonly bucketWebsiteDomainName: string;
  • Type: string

The Domain name of the static website.

bucketWebsiteUrlRequired 
public readonly bucketWebsiteUrl: string;
  • Type: string

The URL of the static website.

encryptionKeyOptional 
public readonly encryptionKey: IKey;
  • Type: aws-cdk-lib.aws_kms.IKey

Optional KMS encryption key associated with this bucket.

isWebsiteOptional 
public readonly isWebsite: boolean;
  • Type: boolean

If this bucket has been configured for static website hosting.

policyOptional 
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

SecureVpcBucketProps

Initializer 

import { SecureVpcBucketProps } from '@gammarers/aws-secure-vpc-bucket'

const secureVpcBucketProps: SecureVpcBucketProps = { ... }

Properties

Name Type Description
vpcEndpointId string No description.
bucketName string No description.
vpcEndpointIdRequired 
public readonly vpcEndpointId: string;
  • Type: string
bucketNameOptional 
public readonly bucketName: string;
  • Type: string