Skip to content

API.md

Latest commit

 

History

History
358 lines (214 loc) · 12.3 KB

API.md

File metadata and controls

358 lines (214 loc) · 12.3 KB

API Reference

Constructs

BudgetNotifier

Initializers 

import { BudgetNotifier } from 'aws_budget_notifier'

new BudgetNotifier(scope: Construct, id: string, props: BudgetNotifierProps)
Name Type Description
scope constructs.Construct No description.
id string No description.
props BudgetNotifierProps No description.
scopeRequired
  • Type: constructs.Construct
idRequired
  • Type: string
propsRequired

Methods

Name Description
toString Returns a string representation of this construct.
with Applies one or more mixins to this construct.
toString 
public toString(): string

Returns a string representation of this construct.

with 
public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixinsRequired
  • Type: ...constructs.IMixin[]

The mixins to apply.

Static Functions

Name Description
isConstruct Checks if x is a construct.
isConstruct 
import { BudgetNotifier } from 'aws_budget_notifier'

BudgetNotifier.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

xRequired
  • Type: any

Any object.

Properties

Name Type Description
node constructs.Node The tree node.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

Structs

BudgetNotifierProps

Configuration options of the {@link BudgetNotifier BudgetNotifier}.

Initializer 

import { BudgetNotifierProps } from 'aws_budget_notifier'

const budgetNotifierProps: BudgetNotifierProps = { ... }

Properties

Name Type Description
limit number The cost associated with the budget threshold.
threshold number The threshold value in percent (0-100).
unit string The unit of measurement that is used for the budget threshold, such as dollars or GB.
application string If specified the application name will be added as tag filter.
availabilityZones string[] If specified the availability zones will be added as tag filter.
costCenter string If specified the cost center will be added as tag filter.
notificationType NotificationType Whether the notification is for how much you have spent (ACTUAL) or for how much you're forecasted to spend (FORECASTED).
recipients string[] Budget notifications will be sent to each of the recipients (e-mail addresses).
service string If specified the service will be added as tag filter.
timeUnit TimeUnit The length of time until a budget resets the actual and forecasted spend.
topicArn string No description.
limitRequired 
public readonly limit: number;
  • Type: number

The cost associated with the budget threshold.

thresholdRequired 
public readonly threshold: number;
  • Type: number

The threshold value in percent (0-100).

unitRequired 
public readonly unit: string;
  • Type: string

The unit of measurement that is used for the budget threshold, such as dollars or GB.

applicationOptional 
public readonly application: string;
  • Type: string

If specified the application name will be added as tag filter.

availabilityZonesOptional 
public readonly availabilityZones: string[];
  • Type: string[]

If specified the availability zones will be added as tag filter.

costCenterOptional 
public readonly costCenter: string;
  • Type: string

If specified the cost center will be added as tag filter.

notificationTypeOptional 
public readonly notificationType: NotificationType;

Whether the notification is for how much you have spent (ACTUAL) or for how much you're forecasted to spend (FORECASTED).

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-notification.html#cfn-budgets-budget-notification-notificationtype

recipientsOptional 
public readonly recipients: string[];
  • Type: string[]

Budget notifications will be sent to each of the recipients (e-mail addresses).

A maximum of 10 recipients is allowed.

serviceOptional 
public readonly service: string;
  • Type: string

If specified the service will be added as tag filter.

timeUnitOptional 
public readonly timeUnit: TimeUnit;

The length of time until a budget resets the actual and forecasted spend.

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-budgetdata.html#cfn-budgets-budget-budgetdata-timeunit

topicArnOptional 
public readonly topicArn: string;
  • Type: string

Enums

NotificationType

Members

Name Description
ACTUAL No description.
FORECASTED No description.
ACTUAL
FORECASTED

TimeUnit

Members

Name Description
MONTHLY No description.
QUARTERLY No description.
ANNUALLY No description.
MONTHLY
QUARTERLY
ANNUALLY