# All files / lib/schema augmentation.ts

100% Statements 4/4
100% Branches 2/2
100% Functions 1/1
100% Lines 4/4

Press n or j to go to the next uncovered block, b, p or k for the previous block.

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    87
    88
    89
    90
    91
    92
    93
    94
    95
    96
    97
    98

    8x

    8x

    8x

    8x

     /**
     * Augmentations for a CloudFormation resource type
     */
    export interface ResourceAugmentation {
      /**
       * Metric augmentations for this resource type
       */
      metrics?: ResourceMetricAugmentations;

      /**
       * Options for this resource augmentation
       *
       * @default no options
       */
      options?: AugmentationOptions;
    }

    export interface AugmentationOptions {
      /**
       * The name of the file containing the class to be "augmented".
       *
       * @default kebab cased CloudFormation resource name + '-base'
       */
      classFile?: string;

      /**
       * The name of the class to be "augmented".
       *
       * @default CloudFormation resource name + 'Base'
       */
      class?: string;

      /**
       * The name of the file containing the interface to be "augmented".
       *
       * @default - same as ``classFile``.
       */
      interfaceFile?: string;

      /**
       * The name of the interface to be "augmented".
       *
       * @default 'I' + CloudFormation resource name
       */
      interface?: string;
    }

    export interface ResourceMetricAugmentations {
      namespace: string;
      dimensions: {[key: string]: string};
      metrics: ResourceMetric[];
    }

    export interface ResourceMetric {
      /**
       * Uppercase-first metric name
       */
      name: string;

      /**
       * Documentation line
       */
      documentation: string;

      /**
       * Whether this is an even count (1 gets emitted every time something occurs)
       *
       * @default MetricType.Attrib
       */
      type?: MetricType;
    }

    export enum MetricType {
      /**
       * This metric measures an attribute of events
       *
       * It could be time, or request size, or similar. The default
       * aggregate for this type of event is "Avg".
       */
      Attrib = 'attrib',

      /**
       * This metric is counting events.
       *
       * This means the metric "1" is emitted every time an event occurs.
       * Only "Sum" is a meaningful aggregate of this type of metric.
       */
      Count = 'count',

      /**
       * This metric is emitting a size.
       *
       * The metric is not event-based, but measures some global ever-changing
       * property. The most useful aggregate of this type of metric is "Max".
       */
      Gauge = 'gauge'
    }