Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(s3): add CORS Property to S3 Bucket (#2101) #2843

Merged
merged 1 commit into from
Jun 17, 2019

Conversation

workeitel
Copy link
Contributor

Add CORS Property to S3 Bucket for configuring bucket cross-origin
access rules.

You can either specify the metrics as properties:

 new Bucket(stack, 'Bucket', {
   cors: [
     {
       allowedHeaders: [
         "*"
       ],
       allowedMethods: [
         "GET"
       ],
       allowedOrigins: [
         "*"
       ],
       exposedHeaders: [
         "Date"
       ],
       id: "myCORSRuleId1",
       maxAge: 3600
     }
   ]
 });

Or use the addCors function:

const bucket = new Bucket(stack, 'Bucket');
bucket.addCors({
  allowedMethods: ["GET", "HEAD"],
  allowedOrigins: ["https://example.com"]
});

Pull Request Checklist

  • Testing
    • Unit test added (prefer not to modify an existing test, otherwise, it's probably a breaking change)
    • CLI change?: coordinate update of integration tests with team
    • cdk-init template change?: coordinated update of integration tests with team
  • Docs
    • jsdocs: All public APIs documented
    • README: README and/or documentation topic updated
    • Design: For significant features, design document added to design folder
  • Title and Description
    • Change type: title prefixed with fix, feat and module name in parens, which will appear in changelog
    • Title: use lower-case and doesn't end with a period
    • Breaking?: last paragraph: "BREAKING CHANGE: <describe what changed + link for details>"
    • Issues: Indicate issues fixed via: "Fixes #xxx" or "Closes #xxx"
  • Sensitive Modules (requires 2 PR approvers)
    • IAM Policy Document (in @aws-cdk/aws-iam)
    • EC2 Security Groups and ACLs (in @aws-cdk/aws-ec2)
    • Grant APIs (only if not based on official documentation with a reference)

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license.

@workeitel workeitel requested a review from a team as a code owner June 12, 2019 15:50
packages/@aws-cdk/aws-s3/lib/bucket.ts Outdated Show resolved Hide resolved
packages/@aws-cdk/aws-s3/lib/bucket.ts Show resolved Hide resolved
packages/@aws-cdk/aws-s3/lib/bucket.ts Show resolved Hide resolved
packages/@aws-cdk/aws-s3/lib/bucket.ts Show resolved Hide resolved
packages/@aws-cdk/aws-s3/lib/bucket.ts Show resolved Hide resolved
packages/@aws-cdk/aws-s3/lib/bucket.ts Outdated Show resolved Hide resolved
Add CORS Property to S3 Bucket for configuring bucket cross-origin
access rules.

You can either specify the metrics as properties:

     new Bucket(stack, 'Bucket', {
       cors: [
         {
           allowedHeaders: [
             "*"
           ],
           allowedMethods: [
             "GET"
           ],
           allowedOrigins: [
             "*"
           ],
           exposedHeaders: [
             "Date"
           ],
           id: "myCORSRuleId1",
           maxAge: 3600
         }
       ]
     });

Or use the `addCors` function:

    const bucket = new Bucket(stack, 'Bucket');
    bucket.addCors({
      allowedMethods: ["GET", "HEAD"],
      allowedOrigins: ["https://example.com"]
    });
@rix0rrr rix0rrr merged commit 1a386d8 into aws:master Jun 17, 2019
@workeitel workeitel deleted the s3bucketcors branch June 17, 2019 09:50
This was referenced Dec 12, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants