Gathering detailed insights and metrics for @aws-cdk/aws-s3
Gathering detailed insights and metrics for @aws-cdk/aws-s3
Gathering detailed insights and metrics for @aws-cdk/aws-s3
Gathering detailed insights and metrics for @aws-cdk/aws-s3
@aws-cdk/aws-s3-assets
Deploy local files and directories to S3
@aws-cdk/aws-autoscaling-common
Common implementation package for @aws-cdk/aws-autoscaling and @aws-cdk/aws-applicationautoscaling
@aws-cdk/aws-s3-notifications
Bucket Notifications API for AWS S3
@aws-cdk/aws-s3-deployment
Constructs for deploying contents to S3 buckets
The AWS Cloud Development Kit is a framework for defining cloud infrastructure in code
npm install @aws-cdk/aws-s3
Typescript
Module System
Min. Node Version
Node Version
NPM Version
76.9
Supply Chain
100
Quality
76.9
Maintenance
100
Vulnerability
84.7
License
TypeScript (97.74%)
JavaScript (1.25%)
Python (0.57%)
Shell (0.27%)
Dockerfile (0.04%)
Go (0.04%)
Java (0.02%)
C# (0.02%)
Alloy (0.02%)
Velocity Template Language (0.01%)
Total Downloads
144,275,692
Last Day
5,142
Last Week
65,210
Last Month
474,024
Last Year
9,227,048
11,753 Stars
14,761 Commits
3,959 Forks
228 Watching
191 Branches
1,541 Contributors
Latest Version
1.204.0
Package Id
@aws-cdk/aws-s3@1.204.0
Unpacked Size
3.09 MB
Size
403.02 kB
File Count
39
NPM Version
9.5.1
Node Version
18.16.0
Publised On
19 Jun 2023
Cumulative downloads
Total Downloads
Last day
-75.5%
5,142
Compared to previous day
Last week
-41.2%
65,210
Compared to previous week
Last month
-21.7%
474,024
Compared to previous month
Last year
-73.3%
9,227,048
Compared to previous year
6
6
AWS CDK v1 has reached End-of-Support on 2023-06-01. This package is no longer being updated, and users should migrate to AWS CDK v2.
For more information on how to migrate, see the Migrating to AWS CDK v2 guide.
Define an unencrypted S3 bucket.
1const bucket = new s3.Bucket(this, 'MyFirstBucket');
Bucket
constructs expose the following deploy-time attributes:
bucketArn
- the ARN of the bucket (i.e. arn:aws:s3:::bucket_name
)bucketName
- the name of the bucket (i.e. bucket_name
)bucketWebsiteUrl
- the Website URL of the bucket (i.e.
http://bucket_name.s3-website-us-west-1.amazonaws.com
)bucketDomainName
- the URL of the bucket (i.e. bucket_name.s3.amazonaws.com
)bucketDualStackDomainName
- the dual-stack URL of the bucket (i.e.
bucket_name.s3.dualstack.eu-west-1.amazonaws.com
)bucketRegionalDomainName
- the regional URL of the bucket (i.e.
bucket_name.s3.eu-west-1.amazonaws.com
)arnForObjects(pattern)
- the ARN of an object or objects within the bucket (i.e.
arn:aws:s3:::bucket_name/exampleobject.png
or
arn:aws:s3:::bucket_name/Development/*
)urlForObject(key)
- the HTTP URL of an object within the bucket (i.e.
https://s3.cn-north-1.amazonaws.com.cn/china-bucket/mykey
)virtualHostedUrlForObject(key)
- the virtual-hosted style HTTP URL of an object
within the bucket (i.e. https://china-bucket-s3.cn-north-1.amazonaws.com.cn/mykey
)s3UrlForObject(key)
- the S3 URL of an object within the bucket (i.e.
s3://bucket/mykey
)Define a KMS-encrypted bucket:
1const bucket = new s3.Bucket(this, 'MyEncryptedBucket', { 2 encryption: s3.BucketEncryption.KMS, 3}); 4 5// you can access the encryption key: 6assert(bucket.encryptionKey instanceof kms.Key);
You can also supply your own key:
1const myKmsKey = new kms.Key(this, 'MyKey'); 2 3const bucket = new s3.Bucket(this, 'MyEncryptedBucket', { 4 encryption: s3.BucketEncryption.KMS, 5 encryptionKey: myKmsKey, 6}); 7 8assert(bucket.encryptionKey === myKmsKey);
Enable KMS-SSE encryption via S3 Bucket Keys:
1const bucket = new s3.Bucket(this, 'MyEncryptedBucket', {
2 encryption: s3.BucketEncryption.KMS,
3 bucketKeyEnabled: true,
4});
Use BucketEncryption.ManagedKms
to use the S3 master KMS key:
1const bucket = new s3.Bucket(this, 'Buck', { 2 encryption: s3.BucketEncryption.KMS_MANAGED, 3}); 4 5assert(bucket.encryptionKey == null);
A bucket policy will be automatically created for the bucket upon the first call to
addToResourcePolicy(statement)
:
1const bucket = new s3.Bucket(this, 'MyBucket'); 2const result = bucket.addToResourcePolicy(new iam.PolicyStatement({ 3 actions: ['s3:GetObject'], 4 resources: [bucket.arnForObjects('file.txt')], 5 principals: [new iam.AccountRootPrincipal()], 6}));
If you try to add a policy statement to an existing bucket, this method will not do anything:
1const bucket = s3.Bucket.fromBucketName(this, 'existingBucket', 'bucket-name');
2
3// No policy statement will be added to the resource
4const result = bucket.addToResourcePolicy(new iam.PolicyStatement({
5 actions: ['s3:GetObject'],
6 resources: [bucket.arnForObjects('file.txt')],
7 principals: [new iam.AccountRootPrincipal()],
8}));
That's because 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. We recommend that you always check the result of the call:
1const bucket = new s3.Bucket(this, 'MyBucket');
2const result = bucket.addToResourcePolicy(new iam.PolicyStatement({
3 actions: ['s3:GetObject'],
4 resources: [bucket.arnForObjects('file.txt')],
5 principals: [new iam.AccountRootPrincipal()],
6}));
7
8if (!result.statementAdded) {
9 // Uh-oh! Someone probably made a mistake here.
10}
The bucket policy can be directly accessed after creation to add statements or adjust the removal policy.
1const bucket = new s3.Bucket(this, 'MyBucket'); 2bucket.policy?.applyRemovalPolicy(cdk.RemovalPolicy.RETAIN);
Most of the time, you won't have to manipulate the bucket policy directly. Instead, buckets have "grant" methods called to give prepackaged sets of permissions to other resources. For example:
1declare const myLambda: lambda.Function; 2 3const bucket = new s3.Bucket(this, 'MyBucket'); 4bucket.grantReadWrite(myLambda);
Will give the Lambda's execution role permissions to read and write from the bucket.
To require all requests use Secure Socket Layer (SSL):
1const bucket = new s3.Bucket(this, 'Bucket', { 2 enforceSSL: true, 3});
To use a bucket in a different stack in the same CDK application, pass the object to the other stack:
To import an existing bucket into your CDK application, use the Bucket.fromBucketAttributes
factory method. This method accepts BucketAttributes
which describes the properties of an already
existing bucket:
1declare const myLambda: lambda.Function;
2const bucket = s3.Bucket.fromBucketAttributes(this, 'ImportedBucket', {
3 bucketArn: 'arn:aws:s3:::my-bucket',
4});
5
6// now you can just call methods on the bucket
7bucket.addEventNotification(s3.EventType.OBJECT_CREATED, new s3n.LambdaDestination(myLambda), {prefix: 'home/myusername/*'});
Alternatively, short-hand factories are available as Bucket.fromBucketName
and
Bucket.fromBucketArn
, which will derive all bucket attributes from the bucket
name or ARN respectively:
1const byName = s3.Bucket.fromBucketName(this, 'BucketByName', 'my-bucket');
2const byArn = s3.Bucket.fromBucketArn(this, 'BucketByArn', 'arn:aws:s3:::my-bucket');
The bucket's region defaults to the current stack's region, but can also be explicitly set in cases where one of the bucket's regional properties needs to contain the correct values.
1const myCrossRegionBucket = s3.Bucket.fromBucketAttributes(this, 'CrossRegionImport', {
2 bucketArn: 'arn:aws:s3:::my-bucket',
3 region: 'us-east-1',
4});
5// myCrossRegionBucket.bucketRegionalDomainName === 'my-bucket.s3.us-east-1.amazonaws.com'
The Amazon S3 notification feature enables you to receive notifications when certain events happen in your bucket as described under S3 Bucket Notifications of the S3 Developer Guide.
To subscribe for bucket notifications, use the bucket.addEventNotification
method. The
bucket.addObjectCreatedNotification
and bucket.addObjectRemovedNotification
can also be used for
these common use cases.
The following example will subscribe an SNS topic to be notified of all s3:ObjectCreated:*
events:
1const bucket = new s3.Bucket(this, 'MyBucket');
2const topic = new sns.Topic(this, 'MyTopic');
3bucket.addEventNotification(s3.EventType.OBJECT_CREATED, new s3n.SnsDestination(topic));
This call will also ensure that the topic policy can accept notifications for this specific bucket.
Supported S3 notification targets are exposed by the @aws-cdk/aws-s3-notifications
package.
It is also possible to specify S3 object key filters when subscribing. The
following example will notify myQueue
when objects prefixed with foo/
and
have the .jpg
suffix are removed from the bucket.
1declare const myQueue: sqs.Queue; 2const bucket = new s3.Bucket(this, 'MyBucket'); 3bucket.addEventNotification(s3.EventType.OBJECT_REMOVED, 4 new s3n.SqsDestination(myQueue), 5 { prefix: 'foo/', suffix: '.jpg' });
Adding notifications on existing buckets:
1declare const topic: sns.Topic;
2const bucket = s3.Bucket.fromBucketAttributes(this, 'ImportedBucket', {
3 bucketArn: 'arn:aws:s3:::my-bucket',
4});
5bucket.addEventNotification(s3.EventType.OBJECT_CREATED, new s3n.SnsDestination(topic));
When you add an event notification to a bucket, a custom resource is created to
manage the notifications. By default, a new role is created for the Lambda
function that implements this feature. If you want to use your own role instead,
you should provide it in the Bucket
constructor:
1declare const myRole: iam.IRole; 2const bucket = new s3.Bucket(this, 'MyBucket', { 3 notificationsHandlerRole: myRole, 4});
Whatever role you provide, the CDK will try to modify it by adding the
permissions from AWSLambdaBasicExecutionRole
(an AWS managed policy) as well
as the permissions s3:PutBucketNotification
and s3:GetBucketNotification
.
If you’re passing an imported role, and you don’t want this to happen, configure
it to be immutable:
1const importedRole = iam.Role.fromRoleArn(this, 'role', 'arn:aws:iam::123456789012:role/RoleName', {
2 mutable: false,
3});
If you provide an imported immutable role, make sure that it has at least all the permissions mentioned above. Otherwise, the deployment will fail!
Amazon S3 can send events to Amazon EventBridge whenever certain events happen in your bucket. Unlike other destinations, you don't need to select which event types you want to deliver.
The following example will enable EventBridge notifications:
1const bucket = new s3.Bucket(this, 'MyEventBridgeBucket', { 2 eventBridgeEnabled: true, 3});
Use blockPublicAccess
to specify block public access settings on the bucket.
Enable all block public access settings:
1const bucket = new s3.Bucket(this, 'MyBlockedBucket', { 2 blockPublicAccess: s3.BlockPublicAccess.BLOCK_ALL, 3});
Block and ignore public ACLs:
1const bucket = new s3.Bucket(this, 'MyBlockedBucket', { 2 blockPublicAccess: s3.BlockPublicAccess.BLOCK_ACLS, 3});
Alternatively, specify the settings manually:
1const bucket = new s3.Bucket(this, 'MyBlockedBucket', {
2 blockPublicAccess: new s3.BlockPublicAccess({ blockPublicPolicy: true }),
3});
When blockPublicPolicy
is set to true
, grantPublicRead()
throws an error.
Use serverAccessLogsBucket
to describe where server access logs are to be stored.
1const accessLogsBucket = new s3.Bucket(this, 'AccessLogsBucket'); 2 3const bucket = new s3.Bucket(this, 'MyBucket', { 4 serverAccessLogsBucket: accessLogsBucket, 5});
It's also possible to specify a prefix for Amazon S3 to assign to all log object keys.
1const accessLogsBucket = new s3.Bucket(this, 'AccessLogsBucket');
2
3const bucket = new s3.Bucket(this, 'MyBucket', {
4 serverAccessLogsBucket: accessLogsBucket,
5 serverAccessLogsPrefix: 'logs',
6});
An inventory contains a list of the objects in the source bucket and metadata for each object. The inventory lists are stored in the destination bucket as a CSV file compressed with GZIP, as an Apache optimized row columnar (ORC) file compressed with ZLIB, or as an Apache Parquet (Parquet) file compressed with Snappy.
You can configure multiple inventory lists for a bucket. You can configure what object metadata to include in the inventory, whether to list all object versions or only current versions, where to store the inventory list file output, and whether to generate the inventory on a daily or weekly basis.
1const inventoryBucket = new s3.Bucket(this, 'InventoryBucket');
2
3const dataBucket = new s3.Bucket(this, 'DataBucket', {
4 inventories: [
5 {
6 frequency: s3.InventoryFrequency.DAILY,
7 includeObjectVersions: s3.InventoryObjectVersion.CURRENT,
8 destination: {
9 bucket: inventoryBucket,
10 },
11 },
12 {
13 frequency: s3.InventoryFrequency.WEEKLY,
14 includeObjectVersions: s3.InventoryObjectVersion.ALL,
15 destination: {
16 bucket: inventoryBucket,
17 prefix: 'with-all-versions',
18 },
19 },
20 ],
21});
If the destination bucket is created as part of the same CDK application, the necessary permissions will be automatically added to the bucket policy.
However, if you use an imported bucket (i.e Bucket.fromXXX()
), you'll have to make sure it contains the following policy document:
1{ 2 "Version": "2012-10-17", 3 "Statement": [ 4 { 5 "Sid": "InventoryAndAnalyticsExamplePolicy", 6 "Effect": "Allow", 7 "Principal": { "Service": "s3.amazonaws.com" }, 8 "Action": "s3:PutObject", 9 "Resource": ["arn:aws:s3:::destinationBucket/*"] 10 } 11 ] 12}
You can use the two following properties to specify the bucket redirection policy. Please note that these methods cannot both be applied to the same bucket.
You can statically redirect a to a given Bucket URL or any other host name with websiteRedirect
:
1const bucket = new s3.Bucket(this, 'MyRedirectedBucket', {
2 websiteRedirect: { hostName: 'www.example.com' },
3});
Alternatively, you can also define multiple websiteRoutingRules
, to define complex, conditional redirections:
1const bucket = new s3.Bucket(this, 'MyRedirectedBucket', {
2 websiteRoutingRules: [{
3 hostName: 'www.example.com',
4 httpRedirectCode: '302',
5 protocol: s3.RedirectProtocol.HTTPS,
6 replaceKey: s3.ReplaceKey.prefixWith('test/'),
7 condition: {
8 httpErrorCodeReturnedEquals: '200',
9 keyPrefixEquals: 'prefix',
10 },
11 }],
12});
To put files into a bucket as part of a deployment (for example, to host a
website), see the @aws-cdk/aws-s3-deployment
package, which provides a
resource that can do just that.
S3 provides two types of URLs for accessing objects via HTTP(S). Path-Style and Virtual Hosted-Style URL. Path-Style is a classic way and will be deprecated. We recommend to use Virtual Hosted-Style URL for newly made bucket.
You can generate both of them.
1const bucket = new s3.Bucket(this, 'MyBucket');
2bucket.urlForObject('objectname'); // Path-Style URL
3bucket.virtualHostedUrlForObject('objectname'); // Virtual Hosted-Style URL
4bucket.virtualHostedUrlForObject('objectname', { regional: false }); // Virtual Hosted-Style URL but non-regional
You can use one of following properties to specify the bucket object Ownership.
The Uploading account will own the object.
1new s3.Bucket(this, 'MyBucket', {
2 objectOwnership: s3.ObjectOwnership.OBJECT_WRITER,
3});
The bucket owner will own the object if the object is uploaded with the bucket-owner-full-control canned ACL. Without this setting and canned ACL, the object is uploaded and remains owned by the uploading account.
1new s3.Bucket(this, 'MyBucket', {
2 objectOwnership: s3.ObjectOwnership.BUCKET_OWNER_PREFERRED,
3});
ACLs are disabled, and the bucket owner automatically owns and has full control over every object in the bucket. ACLs no longer affect permissions to data in the S3 bucket. The bucket uses policies to define access control.
1new s3.Bucket(this, 'MyBucket', {
2 objectOwnership: s3.ObjectOwnership.BUCKET_OWNER_ENFORCED,
3});
When a bucket is removed from a stack (or the stack is deleted), the S3
bucket will be removed according to its removal policy (which by default will
simply orphan the bucket and leave it in your AWS account). If the removal
policy is set to RemovalPolicy.DESTROY
, the bucket will be deleted as long
as it does not contain any objects.
To override this and force all objects to get deleted during bucket deletion,
enable theautoDeleteObjects
option.
1const bucket = new s3.Bucket(this, 'MyTempFileBucket', { 2 removalPolicy: cdk.RemovalPolicy.DESTROY, 3 autoDeleteObjects: true, 4});
Warning if you have deployed a bucket with autoDeleteObjects: true
,
switching this to false
in a CDK version before 1.126.0
will lead to
all objects in the bucket being deleted. Be sure to update your bucket resources
by deploying with CDK version 1.126.0
or later before switching this value to false
.
Transfer Acceleration can be configured to enable fast, easy, and secure transfers of files over long distances:
1const bucket = new s3.Bucket(this, 'MyBucket', { 2 transferAcceleration: true, 3});
To access the bucket that is enabled for Transfer Acceleration, you must use a special endpoint. The URL can be generated using method transferAccelerationUrlForObject
:
1const bucket = new s3.Bucket(this, 'MyBucket', {
2 transferAcceleration: true,
3});
4bucket.transferAccelerationUrlForObject('objectname');
Intelligent Tiering can be configured to automatically move files to glacier:
1new s3.Bucket(this, 'MyBucket', { 2 intelligentTieringConfigurations: [{ 3 name: 'foo', 4 prefix: 'folder/name', 5 archiveAccessTierTime: cdk.Duration.days(90), 6 deepArchiveAccessTierTime: cdk.Duration.days(180), 7 tags: [{key: 'tagname', value: 'tagvalue'}] 8 }], 9}); 10
Managing lifecycle can be configured transition or expiration actions.
1const bucket = new s3.Bucket(this, 'MyBucket', { 2 lifecycleRules: [{ 3 abortIncompleteMultipartUploadAfter: cdk.Duration.minutes(30), 4 enabled: false, 5 expiration: cdk.Duration.days(30), 6 expirationDate: new Date(), 7 expiredObjectDeleteMarker: false, 8 id: 'id', 9 noncurrentVersionExpiration: cdk.Duration.days(30), 10 11 // the properties below are optional 12 noncurrentVersionsToRetain: 123, 13 noncurrentVersionTransitions: [{ 14 storageClass: s3.StorageClass.GLACIER, 15 transitionAfter: cdk.Duration.days(30), 16 17 // the properties below are optional 18 noncurrentVersionsToRetain: 123, 19 }], 20 objectSizeGreaterThan: 500, 21 prefix: 'prefix', 22 objectSizeLessThan: 10000, 23 transitions: [{ 24 storageClass: s3.StorageClass.GLACIER, 25 26 // the properties below are optional 27 transitionAfter: cdk.Duration.days(30), 28 transitionDate: new Date(), 29 }], 30 }] 31});
No vulnerabilities found.
Reason
30 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 10
Reason
all changesets reviewed
Reason
license file detected
Details
Reason
security policy file detected
Details
Reason
project is fuzzed
Details
Reason
SAST tool is run on all commits
Details
Reason
5 out of the last 5 releases have a total of 5 signed artifacts.
Details
Reason
8 existing vulnerabilities detected
Details
Reason
dangerous workflow patterns detected
Details
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
detected GitHub workflow tokens with excessive permissions
Details
Reason
binaries present in source code
Details
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
Score
Last Scanned on 2024-12-23
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More