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 MetricsConfiguration Property to S3 Bucket #2163

Merged
merged 3 commits into from
May 8, 2019

Conversation

workeitel
Copy link
Contributor

@workeitel workeitel commented Apr 2, 2019


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
  • Title and Description
    • Change type: title prefixed with fix, feat 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 April 2, 2019 16:39
packages/@aws-cdk/aws-s3/lib/bucket.ts Outdated Show resolved Hide resolved
*
* @see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-metricsconfiguration.html
*/
readonly metricsConfigurations?: Array<CfnBucket.MetricsConfigurationProperty | cdk.Token> | cdk.Token;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rename to metrics

@workeitel
Copy link
Contributor Author

workeitel commented Apr 11, 2019

Thanks for your feedback! I reworked my commit and made it very similar to S3 Lifecycle Rules. @eladb suggested to use metric and I tried to do it consistently but I'm not sure if that really fits the semantic of those metric configuration.

@workeitel
Copy link
Contributor Author

@rix0rrr @eladb any opinions on the change?

Copy link
Contributor

@rix0rrr rix0rrr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd like doc comments on everything, then it's good to merge.

packages/@aws-cdk/aws-s3/lib/bucket.ts Show resolved Hide resolved
packages/@aws-cdk/aws-s3/lib/bucket.ts Show resolved Hide resolved
…rics

You can either specify the metrics as properties:

    new Bucket(stack, 'Bucket', {
      metrics: [{
        id: "test",
        tagFilters: {tagname1: "tagvalue1", tagname2: "tagvalue2"}
      }]
    });

Or use the `addMetric` function:

    const bucket = new Bucket(stack, 'Bucket');
    bucket.addMetric({
      id: "test"
    });
@workeitel
Copy link
Contributor Author

updated docs and rebased on latest commit in master

@rix0rrr rix0rrr merged commit 1cc43b3 into aws:master May 8, 2019
@eladb
Copy link
Contributor

eladb commented May 8, 2019

@workeitel looks great. Thanks for the contribution!

@workeitel workeitel deleted the s3-metrics-configuration branch May 8, 2019 15:05
SanderKnape pushed a commit to SanderKnape/aws-cdk that referenced this pull request May 14, 2019
Add metric Property to S3 Bucket for configuring bucket metrics.

You can either specify the metrics as properties:

    new Bucket(stack, 'Bucket', {
      metrics: [{
        id: "test",
        tagFilters: {tagname1: "tagvalue1", tagname2: "tagvalue2"}
      }]
    });

Or use the `addMetric` function:

    const bucket = new Bucket(stack, 'Bucket');
    bucket.addMetric({
      id: "test"
    });
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.

3 participants