refactor: rename MetricCustomization => MetricOptions (#2360)

`MetricCustomization` has always been a silly, too verbose name.
We're setting on `Options` as a suffix for operations, and
`MetricOptions` just flows better.

BREAKING CHANGE: Rename `MetricCustomization` => `MetricOptions`.

design/aws-guidelines.md

@@ -340,9 +340,9 @@ export interface IFoo extends cdk.IConstruct, ISomething {
   addToPipeline(stage: pipelineapi.IStage, name: string, props?: FooActionProps): FooAction;
 
   // metrics
-  metric(metricName: string, props?: cloudwatch.MetricCustomization): cloudwatch.Metric;
-  metricFoo(props?: cloudwatch.MetricCustomization): cloudwatch.Metric;
-  metricBar(props?: cloudwatch.MetricCustomization): cloudwatch.Metric;
+  metric(metricName: string, props?: cloudwatch.MetricOptions): cloudwatch.Metric;
+  metricFoo(props?: cloudwatch.MetricOptions): cloudwatch.Metric;
+  metricBar(props?: cloudwatch.MetricOptions): cloudwatch.Metric;
 
   // export
   export(): FooImportProps;

packages/@aws-cdk/aws-cloudwatch/lib/metric.ts

@@ -129,7 +129,7 @@ export class Metric {
    *
    * @param props The set of properties to change.
    */
-  public with(props: MetricCustomization): Metric {
+  public with(props: MetricOptions): Metric {
     return new Metric({
       dimensions: ifUndefined(props.dimensions, this.dimensions),
       namespace: this.namespace,
@@ -244,7 +244,7 @@ export enum Unit {
 /**
  * Properties of a metric that can be changed
  */
-export interface MetricCustomization {
+export interface MetricOptions {
   /**
    * Dimensions of the metric
    *

packages/@aws-cdk/aws-codebuild/lib/project.ts

@@ -78,7 +78,7 @@ export interface IProject extends IResource, iam.IGrantable {
    * @param metricName The name of the metric
    * @param props Customization properties
    */
-  metric(metricName: string, props: cloudwatch.MetricCustomization): cloudwatch.Metric;
+  metric(metricName: string, props: cloudwatch.MetricOptions): cloudwatch.Metric;
 
   /**
    * Measures the number of builds triggered.
@@ -89,7 +89,7 @@ export interface IProject extends IResource, iam.IGrantable {
    *
    * @default sum over 5 minutes
    */
-  metricBuilds(props?: cloudwatch.MetricCustomization): cloudwatch.Metric;
+  metricBuilds(props?: cloudwatch.MetricOptions): cloudwatch.Metric;
 
   /**
    * Measures the duration of all builds over time.
@@ -100,7 +100,7 @@ export interface IProject extends IResource, iam.IGrantable {
    *
    * @default average over 5 minutes
    */
-  metricDuration(props?: cloudwatch.MetricCustomization): cloudwatch.Metric;
+  metricDuration(props?: cloudwatch.MetricOptions): cloudwatch.Metric;
 
   /**
    * Measures the number of successful builds.
@@ -111,7 +111,7 @@ export interface IProject extends IResource, iam.IGrantable {
    *
    * @default sum over 5 minutes
    */
-  metricSucceededBuilds(props?: cloudwatch.MetricCustomization): cloudwatch.Metric;
+  metricSucceededBuilds(props?: cloudwatch.MetricOptions): cloudwatch.Metric;
 
   /**
    * Measures the number of builds that failed because of client error or
@@ -123,7 +123,7 @@ export interface IProject extends IResource, iam.IGrantable {
    *
    * @default sum over 5 minutes
    */
-  metricFailedBuilds(props?: cloudwatch.MetricCustomization): cloudwatch.Metric;
+  metricFailedBuilds(props?: cloudwatch.MetricOptions): cloudwatch.Metric;
 
   /**
    * Export this Project. Allows referencing this Project in a different CDK Stack.
@@ -271,7 +271,7 @@ export abstract class ProjectBase extends Resource implements IProject {
    * @param metricName The name of the metric
    * @param props Customization properties
    */
-  public metric(metricName: string, props: cloudwatch.MetricCustomization) {
+  public metric(metricName: string, props: cloudwatch.MetricOptions) {
     return new cloudwatch.Metric({
       namespace: 'AWS/CodeBuild',
       metricName,
@@ -289,7 +289,7 @@ export abstract class ProjectBase extends Resource implements IProject {
    *
    * @default sum over 5 minutes
    */
-  public metricBuilds(props?: cloudwatch.MetricCustomization) {
+  public metricBuilds(props?: cloudwatch.MetricOptions) {
     return this.metric('Builds', {
       statistic: 'sum',
       ...props,
@@ -305,7 +305,7 @@ export abstract class ProjectBase extends Resource implements IProject {
    *
    * @default average over 5 minutes
    */
-  public metricDuration(props?: cloudwatch.MetricCustomization) {
+  public metricDuration(props?: cloudwatch.MetricOptions) {
     return this.metric('Duration', {
       statistic: 'avg',
       ...props
@@ -321,7 +321,7 @@ export abstract class ProjectBase extends Resource implements IProject {
    *
    * @default sum over 5 minutes
    */
-  public metricSucceededBuilds(props?: cloudwatch.MetricCustomization) {
+  public metricSucceededBuilds(props?: cloudwatch.MetricOptions) {
     return this.metric('SucceededBuilds', {
       statistic: 'sum',
       ...props,
@@ -338,7 +338,7 @@ export abstract class ProjectBase extends Resource implements IProject {
    *
    * @default sum over 5 minutes
    */
-  public metricFailedBuilds(props?: cloudwatch.MetricCustomization) {
+  public metricFailedBuilds(props?: cloudwatch.MetricOptions) {
     return this.metric('FailedBuilds', {
       statistic: 'sum',
       ...props,

packages/@aws-cdk/aws-ec2/lib/vpn.ts

@@ -102,7 +102,7 @@ export class VpnConnection extends cdk.Construct implements IVpnConnection {
   /**
    * Return the given named metric for all VPN connections in the account/region.
    */
-  public static metricAll(metricName: string, props?: cloudwatch.MetricCustomization): cloudwatch.Metric {
+  public static metricAll(metricName: string, props?: cloudwatch.MetricOptions): cloudwatch.Metric {
     return new cloudwatch.Metric({
       namespace: 'AWS/VPN',
       metricName,
@@ -115,7 +115,7 @@ export class VpnConnection extends cdk.Construct implements IVpnConnection {
    *
    * @default average over 5 minutes
    */
-  public static metricAllTunnelState(props?: cloudwatch.MetricCustomization): cloudwatch.Metric {
+  public static metricAllTunnelState(props?: cloudwatch.MetricOptions): cloudwatch.Metric {
     return this.metricAll('TunnelSate', { statistic: 'avg', ...props });
   }
 
@@ -124,7 +124,7 @@ export class VpnConnection extends cdk.Construct implements IVpnConnection {
    *
    * @default sum over 5 minutes
    */
-  public static metricAllTunnelDataIn(props?: cloudwatch.MetricCustomization): cloudwatch.Metric {
+  public static metricAllTunnelDataIn(props?: cloudwatch.MetricOptions): cloudwatch.Metric {
     return this.metricAll('TunnelDataIn', { statistic: 'sum', ...props });
   }
 
@@ -133,7 +133,7 @@ export class VpnConnection extends cdk.Construct implements IVpnConnection {
    *
    * @default sum over 5 minutes
    */
-  public static metricAllTunnelDataOut(props?: cloudwatch.MetricCustomization): cloudwatch.Metric {
+  public static metricAllTunnelDataOut(props?: cloudwatch.MetricOptions): cloudwatch.Metric {
     return this.metricAll('TunnelDataOut', { statistic: 'sum', ...props });
   }
 

packages/@aws-cdk/aws-ecs/lib/base/base-service.ts

@@ -209,7 +209,7 @@ export abstract class BaseService extends cdk.Construct
   /**
    * Return the given named metric for this Service
    */
-  public metric(metricName: string, props?: cloudwatch.MetricCustomization): cloudwatch.Metric {
+  public metric(metricName: string, props?: cloudwatch.MetricOptions): cloudwatch.Metric {
     return new cloudwatch.Metric({
       namespace: 'AWS/ECS',
       metricName,

packages/@aws-cdk/aws-ecs/lib/cluster.ts

@@ -199,7 +199,7 @@ export class Cluster extends Resource implements ICluster {
    *
    * @default average over 5 minutes
    */
-  public metricCpuReservation(props?: cloudwatch.MetricCustomization): cloudwatch.Metric {
+  public metricCpuReservation(props?: cloudwatch.MetricOptions): cloudwatch.Metric {
     return this.metric('CPUReservation', props);
   }
 
@@ -208,14 +208,14 @@ export class Cluster extends Resource implements ICluster {
    *
    * @default average over 5 minutes
    */
-  public metricMemoryReservation(props?: cloudwatch.MetricCustomization): cloudwatch.Metric {
+  public metricMemoryReservation(props?: cloudwatch.MetricOptions): cloudwatch.Metric {
     return this.metric('MemoryReservation', props );
   }
 
   /**
    * Return the given named metric for this Cluster
    */
-  public metric(metricName: string, props?: cloudwatch.MetricCustomization): cloudwatch.Metric {
+  public metric(metricName: string, props?: cloudwatch.MetricOptions): cloudwatch.Metric {
     return new cloudwatch.Metric({
       namespace: 'AWS/ECS',
       metricName,

packages/@aws-cdk/aws-ecs/lib/ec2/ec2-service.ts

@@ -203,7 +203,7 @@ export class Ec2Service extends BaseService implements elb.ILoadBalancerTarget {
   /**
    * Return the given named metric for this Service
    */
-  public metric(metricName: string, props?: cloudwatch.MetricCustomization): cloudwatch.Metric {
+  public metric(metricName: string, props?: cloudwatch.MetricOptions): cloudwatch.Metric {
     return new cloudwatch.Metric({
       namespace: 'AWS/ECS',
       metricName,
@@ -217,7 +217,7 @@ export class Ec2Service extends BaseService implements elb.ILoadBalancerTarget {
    *
    * @default average over 5 minutes
    */
-  public metricMemoryUtilization(props?: cloudwatch.MetricCustomization): cloudwatch.Metric {
+  public metricMemoryUtilization(props?: cloudwatch.MetricOptions): cloudwatch.Metric {
     return this.metric('MemoryUtilization', props );
   }
 
@@ -226,7 +226,7 @@ export class Ec2Service extends BaseService implements elb.ILoadBalancerTarget {
    *
    * @default average over 5 minutes
    */
-  public metricCpuUtilization(props?: cloudwatch.MetricCustomization): cloudwatch.Metric {
+  public metricCpuUtilization(props?: cloudwatch.MetricOptions): cloudwatch.Metric {
     return this.metric('CPUUtilization', props);
   }