class CfnDashboardPropsMixin (mixin)

Language	Type name
.NET	Amazon.CDK.CfnPropertyMixins.AWS.BCM.CfnDashboardPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkcfnpropertymixins/v2/awsbcm#CfnDashboardPropsMixin
Java	software.amazon.awscdk.cfnpropertymixins.services.bcm.CfnDashboardPropsMixin
Python	aws_cdk.cfn_property_mixins.aws_bcm.CfnDashboardPropsMixin
TypeScript	@aws-cdk/cfn-property-mixins » aws_bcm » CfnDashboardPropsMixin

Implements IMixin

Extends Mixin

Definition of AWS::BCM::Dashboard Resource Type.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bcm-dashboard.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_bcm as bcm } from '@aws-cdk/cfn-property-mixins';
import * as cdk from 'aws-cdk-lib';

declare const costAndUsageExpressionProperty_: bcm.CfnDashboardPropsMixin.CostAndUsageExpressionProperty;
declare const expressionProperty_: bcm.CfnDashboardPropsMixin.ExpressionProperty;
declare const mergeStrategy: cdk.IMergeStrategy;
declare const table: any;
const cfnDashboardPropsMixin = new bcm.CfnDashboardPropsMixin({
  description: 'description',
  name: 'name',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  widgets: [{
    configs: [{
      displayConfig: {
        graph: {
          graphKey: {
            visualType: 'visualType',
          },
        },
        table: table,
      },
      queryParameters: {
        costAndUsage: {
          filter: {
            and: [costAndUsageExpressionProperty_],
            costCategories: {
              key: 'key',
              matchOptions: ['matchOptions'],
              values: ['values'],
            },
            dimensions: {
              key: 'key',
              matchOptions: ['matchOptions'],
              values: ['values'],
            },
            not: costAndUsageExpressionProperty_,
            or: [costAndUsageExpressionProperty_],
            tags: {
              key: 'key',
              matchOptions: ['matchOptions'],
              values: ['values'],
            },
          },
          granularity: 'granularity',
          groupBy: [{
            key: 'key',
            type: 'type',
          }],
          metrics: ['metrics'],
          timeRange: {
            endTime: {
              type: 'type',
              value: 'value',
            },
            startTime: {
              type: 'type',
              value: 'value',
            },
          },
        },
        reservationCoverage: {
          filter: {
            and: [expressionProperty_],
            costCategories: {
              key: 'key',
              matchOptions: ['matchOptions'],
              values: ['values'],
            },
            dimensions: {
              key: 'key',
              matchOptions: ['matchOptions'],
              values: ['values'],
            },
            not: expressionProperty_,
            tags: {
              key: 'key',
              matchOptions: ['matchOptions'],
              values: ['values'],
            },
          },
          granularity: 'granularity',
          groupBy: [{
            key: 'key',
            type: 'type',
          }],
          metrics: ['metrics'],
          timeRange: {
            endTime: {
              type: 'type',
              value: 'value',
            },
            startTime: {
              type: 'type',
              value: 'value',
            },
          },
        },
        reservationUtilization: {
          filter: {
            and: [expressionProperty_],
            costCategories: {
              key: 'key',
              matchOptions: ['matchOptions'],
              values: ['values'],
            },
            dimensions: {
              key: 'key',
              matchOptions: ['matchOptions'],
              values: ['values'],
            },
            not: expressionProperty_,
            tags: {
              key: 'key',
              matchOptions: ['matchOptions'],
              values: ['values'],
            },
          },
          granularity: 'granularity',
          groupBy: [{
            key: 'key',
            type: 'type',
          }],
          timeRange: {
            endTime: {
              type: 'type',
              value: 'value',
            },
            startTime: {
              type: 'type',
              value: 'value',
            },
          },
        },
        savingsPlansCoverage: {
          filter: {
            and: [expressionProperty_],
            costCategories: {
              key: 'key',
              matchOptions: ['matchOptions'],
              values: ['values'],
            },
            dimensions: {
              key: 'key',
              matchOptions: ['matchOptions'],
              values: ['values'],
            },
            not: expressionProperty_,
            tags: {
              key: 'key',
              matchOptions: ['matchOptions'],
              values: ['values'],
            },
          },
          granularity: 'granularity',
          groupBy: [{
            key: 'key',
            type: 'type',
          }],
          metrics: ['metrics'],
          timeRange: {
            endTime: {
              type: 'type',
              value: 'value',
            },
            startTime: {
              type: 'type',
              value: 'value',
            },
          },
        },
        savingsPlansUtilization: {
          filter: {
            and: [expressionProperty_],
            costCategories: {
              key: 'key',
              matchOptions: ['matchOptions'],
              values: ['values'],
            },
            dimensions: {
              key: 'key',
              matchOptions: ['matchOptions'],
              values: ['values'],
            },
            not: expressionProperty_,
            tags: {
              key: 'key',
              matchOptions: ['matchOptions'],
              values: ['values'],
            },
          },
          granularity: 'granularity',
          timeRange: {
            endTime: {
              type: 'type',
              value: 'value',
            },
            startTime: {
              type: 'type',
              value: 'value',
            },
          },
        },
      },
    }],
    description: 'description',
    height: 123,
    horizontalOffset: 123,
    title: 'title',
    width: 123,
  }],
}, /* all optional props */ {
  strategy: mergeStrategy,
});

Initializer

new CfnDashboardPropsMixin(props: CfnDashboardMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnDashboardMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::BCM::Dashboard.

Properties

Name	Type	Description
props	CfnDashboardMixinProps
strategy	IMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnDashboardMixinProps

---

strategy

Type: IMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): void

Parameters

• construct IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.