API.md

API Reference

Constructs

BudgetsNotification

Initializers

import { BudgetsNotification } from '@gammarers/aws-budgets-notification'

new BudgetsNotification(scope: Construct, id: string, props: BudgetsNotificationProps)

Name	Type	Description
scope	constructs.Construct	No description.
id	string	No description.
props	BudgetsNotificationProps	No description.

---

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

props^Required

• Type: BudgetsNotificationProps

---

Methods

Name	Description
toString	Returns a string representation of this construct.

---

toString

public toString(): string

Returns a string representation of this construct.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.

---

isConstruct

import { BudgetsNotification } from '@gammarers/aws-budgets-notification'

BudgetsNotification.isConstruct(x: any)

Checks if x is a construct.

x^Required

• Type: any

Any object.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

Structs

BudgetsNotificationProps

Initializer

import { BudgetsNotificationProps } from '@gammarers/aws-budgets-notification'

const budgetsNotificationProps: BudgetsNotificationProps = { ... }

Properties

Name	Type	Description
budgetLimitAmount	number	No description.
slackChannelId	string	No description.
slackWorkspaceId	string	No description.
linkedAccounts	string[]	No description.

---

budgetLimitAmount^Required

public readonly budgetLimitAmount: number;

• Type: number

---

slackChannelId^Required

public readonly slackChannelId: string;

• Type: string

---

slackWorkspaceId^Required

public readonly slackWorkspaceId: string;

• Type: string

---

linkedAccounts^Optional

public readonly linkedAccounts: string[];

• Type: string[]

---