konnect.AiCostBudgetNotificationRule

Example coming soon!

name string

The unique name of the resource.

args AiCostBudgetNotificationRuleArgs

The arguments to resource properties.

opts CustomResourceOptions

Bag of options to control resource's behavior.

resource_name str

The unique name of the resource.

args AiCostBudgetNotificationRuleArgs

The arguments to resource properties.

opts ResourceOptions

Bag of options to control resource's behavior.

ctx Context

Context object for the current deployment.

name string

The unique name of the resource.

args AiCostBudgetNotificationRuleArgs

The arguments to resource properties.

opts ResourceOption

Bag of options to control resource's behavior.

name string

The unique name of the resource.

args AiCostBudgetNotificationRuleArgs

The arguments to resource properties.

opts CustomResourceOptions

Bag of options to control resource's behavior.

name String

The unique name of the resource.

args AiCostBudgetNotificationRuleArgs

The arguments to resource properties.

options CustomResourceOptions

Bag of options to control resource's behavior.

BudgetId string

The id of the budget. Requires replacement if changed.

Thresholds List<AiCostBudgetNotificationRuleThreshold>

The shares of the limit at which the rule fires. Each threshold fires at most once per budget window, derived budget, and limit, and changing the limit lets the thresholds fire again.

Channels List<AiCostBudgetNotificationRuleChannel>

The channels that receive the rule's alerts.

At most 10 channels, each listed once. Reads return them ordered by channel name. Defaults to [].

Message AiCostBudgetNotificationRuleMessage

The wording of the rule's alerts on every channel, or null for the built-in wording.

subject and body can contain placeholders, such as {{budget.name}}. A placeholder is {{, optional whitespace, a name from the list below, optional whitespace, and }}. There's no escaping, and a lone }} is text. Each alert fills the placeholders with its own values. Amounts appear in US dollars, such as $4,125.50.

• {{budget.name}}: the budget's name.
• {{budget.url}}: a link to the budget in Konnect.
• {{threshold}}: the threshold that was crossed, such as 80%.
• {{limit}}: the limit that spend is measured against. With each, the limit of one derived budget.
• {{spend}}: the spend so far in the budget window.
• {{percent}}: the spend as a share of the limit, such as 82.51%.
• {{remaining}}: what is left of the limit, never below $0.00.
• {{projected}}: where spend ends the budget window at the current pace, as an amount and a share of the limit.
• {{period}}: the budget window, in the time zone of its anchor.
• {{period.start}}: when the budget window started.
• {{period.end}}: when the budget window ends and the budget resets.
• {{period.remaining}}: how long is left in the budget window when the alert is sent, in its largest whole unit, such as 8 days or 12 minutes. Under a minute, it's less than a minute, and after the window ends, no time.
• {{entity.field}}: the each field as a noun, such as group, user for subject, or env tag for tags.env.
• {{entity.value}}: the value whose derived budget crossed the threshold. A Kong Identity principal or a consumer shows as its display name when the service can resolve it. Any other value, such as a Kong Identity group or team, shows as it is.

{{entity.field}} and {{entity.value}} work only on a budget with each. Defaults to null.

BudgetId string

The id of the budget. Requires replacement if changed.

Thresholds []AiCostBudgetNotificationRuleThresholdArgs

The shares of the limit at which the rule fires. Each threshold fires at most once per budget window, derived budget, and limit, and changing the limit lets the thresholds fire again.

Channels []AiCostBudgetNotificationRuleChannelArgs

The channels that receive the rule's alerts.

At most 10 channels, each listed once. Reads return them ordered by channel name. Defaults to [].

Message AiCostBudgetNotificationRuleMessageArgs

The wording of the rule's alerts on every channel, or null for the built-in wording.

subject and body can contain placeholders, such as {{budget.name}}. A placeholder is {{, optional whitespace, a name from the list below, optional whitespace, and }}. There's no escaping, and a lone }} is text. Each alert fills the placeholders with its own values. Amounts appear in US dollars, such as $4,125.50.

• {{budget.name}}: the budget's name.
• {{budget.url}}: a link to the budget in Konnect.
• {{threshold}}: the threshold that was crossed, such as 80%.
• {{limit}}: the limit that spend is measured against. With each, the limit of one derived budget.
• {{spend}}: the spend so far in the budget window.
• {{percent}}: the spend as a share of the limit, such as 82.51%.
• {{remaining}}: what is left of the limit, never below $0.00.
• {{projected}}: where spend ends the budget window at the current pace, as an amount and a share of the limit.
• {{period}}: the budget window, in the time zone of its anchor.
• {{period.start}}: when the budget window started.
• {{period.end}}: when the budget window ends and the budget resets.
• {{period.remaining}}: how long is left in the budget window when the alert is sent, in its largest whole unit, such as 8 days or 12 minutes. Under a minute, it's less than a minute, and after the window ends, no time.
• {{entity.field}}: the each field as a noun, such as group, user for subject, or env tag for tags.env.
• {{entity.value}}: the value whose derived budget crossed the threshold. A Kong Identity principal or a consumer shows as its display name when the service can resolve it. Any other value, such as a Kong Identity group or team, shows as it is.

{{entity.field}} and {{entity.value}} work only on a budget with each. Defaults to null.

budget_id string

The id of the budget. Requires replacement if changed.

thresholds list(object)

The shares of the limit at which the rule fires. Each threshold fires at most once per budget window, derived budget, and limit, and changing the limit lets the thresholds fire again.

channels list(object)

The channels that receive the rule's alerts.

At most 10 channels, each listed once. Reads return them ordered by channel name. Defaults to [].

message object

The wording of the rule's alerts on every channel, or null for the built-in wording.

subject and body can contain placeholders, such as {{budget.name}}. A placeholder is {{, optional whitespace, a name from the list below, optional whitespace, and }}. There's no escaping, and a lone }} is text. Each alert fills the placeholders with its own values. Amounts appear in US dollars, such as $4,125.50.

• {{budget.name}}: the budget's name.
• {{budget.url}}: a link to the budget in Konnect.
• {{threshold}}: the threshold that was crossed, such as 80%.
• {{limit}}: the limit that spend is measured against. With each, the limit of one derived budget.
• {{spend}}: the spend so far in the budget window.
• {{percent}}: the spend as a share of the limit, such as 82.51%.
• {{remaining}}: what is left of the limit, never below $0.00.
• {{projected}}: where spend ends the budget window at the current pace, as an amount and a share of the limit.
• {{period}}: the budget window, in the time zone of its anchor.
• {{period.start}}: when the budget window started.
• {{period.end}}: when the budget window ends and the budget resets.
• {{period.remaining}}: how long is left in the budget window when the alert is sent, in its largest whole unit, such as 8 days or 12 minutes. Under a minute, it's less than a minute, and after the window ends, no time.
• {{entity.field}}: the each field as a noun, such as group, user for subject, or env tag for tags.env.
• {{entity.value}}: the value whose derived budget crossed the threshold. A Kong Identity principal or a consumer shows as its display name when the service can resolve it. Any other value, such as a Kong Identity group or team, shows as it is.

{{entity.field}} and {{entity.value}} work only on a budget with each. Defaults to null.

budgetId String

The id of the budget. Requires replacement if changed.

thresholds List<AiCostBudgetNotificationRuleThreshold>

The shares of the limit at which the rule fires. Each threshold fires at most once per budget window, derived budget, and limit, and changing the limit lets the thresholds fire again.

channels List<AiCostBudgetNotificationRuleChannel>

The channels that receive the rule's alerts.

At most 10 channels, each listed once. Reads return them ordered by channel name. Defaults to [].

message AiCostBudgetNotificationRuleMessage

The wording of the rule's alerts on every channel, or null for the built-in wording.

subject and body can contain placeholders, such as {{budget.name}}. A placeholder is {{, optional whitespace, a name from the list below, optional whitespace, and }}. There's no escaping, and a lone }} is text. Each alert fills the placeholders with its own values. Amounts appear in US dollars, such as $4,125.50.

• {{budget.name}}: the budget's name.
• {{budget.url}}: a link to the budget in Konnect.
• {{threshold}}: the threshold that was crossed, such as 80%.
• {{limit}}: the limit that spend is measured against. With each, the limit of one derived budget.
• {{spend}}: the spend so far in the budget window.
• {{percent}}: the spend as a share of the limit, such as 82.51%.
• {{remaining}}: what is left of the limit, never below $0.00.
• {{projected}}: where spend ends the budget window at the current pace, as an amount and a share of the limit.
• {{period}}: the budget window, in the time zone of its anchor.
• {{period.start}}: when the budget window started.
• {{period.end}}: when the budget window ends and the budget resets.
• {{period.remaining}}: how long is left in the budget window when the alert is sent, in its largest whole unit, such as 8 days or 12 minutes. Under a minute, it's less than a minute, and after the window ends, no time.
• {{entity.field}}: the each field as a noun, such as group, user for subject, or env tag for tags.env.
• {{entity.value}}: the value whose derived budget crossed the threshold. A Kong Identity principal or a consumer shows as its display name when the service can resolve it. Any other value, such as a Kong Identity group or team, shows as it is.

{{entity.field}} and {{entity.value}} work only on a budget with each. Defaults to null.

budgetId string

The id of the budget. Requires replacement if changed.

thresholds AiCostBudgetNotificationRuleThreshold[]

The shares of the limit at which the rule fires. Each threshold fires at most once per budget window, derived budget, and limit, and changing the limit lets the thresholds fire again.

channels AiCostBudgetNotificationRuleChannel[]

The channels that receive the rule's alerts.

At most 10 channels, each listed once. Reads return them ordered by channel name. Defaults to [].

message AiCostBudgetNotificationRuleMessage

The wording of the rule's alerts on every channel, or null for the built-in wording.

subject and body can contain placeholders, such as {{budget.name}}. A placeholder is {{, optional whitespace, a name from the list below, optional whitespace, and }}. There's no escaping, and a lone }} is text. Each alert fills the placeholders with its own values. Amounts appear in US dollars, such as $4,125.50.

• {{budget.name}}: the budget's name.
• {{budget.url}}: a link to the budget in Konnect.
• {{threshold}}: the threshold that was crossed, such as 80%.
• {{limit}}: the limit that spend is measured against. With each, the limit of one derived budget.
• {{spend}}: the spend so far in the budget window.
• {{percent}}: the spend as a share of the limit, such as 82.51%.
• {{remaining}}: what is left of the limit, never below $0.00.
• {{projected}}: where spend ends the budget window at the current pace, as an amount and a share of the limit.
• {{period}}: the budget window, in the time zone of its anchor.
• {{period.start}}: when the budget window started.
• {{period.end}}: when the budget window ends and the budget resets.
• {{period.remaining}}: how long is left in the budget window when the alert is sent, in its largest whole unit, such as 8 days or 12 minutes. Under a minute, it's less than a minute, and after the window ends, no time.
• {{entity.field}}: the each field as a noun, such as group, user for subject, or env tag for tags.env.
• {{entity.value}}: the value whose derived budget crossed the threshold. A Kong Identity principal or a consumer shows as its display name when the service can resolve it. Any other value, such as a Kong Identity group or team, shows as it is.

{{entity.field}} and {{entity.value}} work only on a budget with each. Defaults to null.

budget_id str

The id of the budget. Requires replacement if changed.

thresholds Sequence[AiCostBudgetNotificationRuleThresholdArgs]

The shares of the limit at which the rule fires. Each threshold fires at most once per budget window, derived budget, and limit, and changing the limit lets the thresholds fire again.

channels Sequence[AiCostBudgetNotificationRuleChannelArgs]

The channels that receive the rule's alerts.

At most 10 channels, each listed once. Reads return them ordered by channel name. Defaults to [].

message AiCostBudgetNotificationRuleMessageArgs

The wording of the rule's alerts on every channel, or null for the built-in wording.

subject and body can contain placeholders, such as {{budget.name}}. A placeholder is {{, optional whitespace, a name from the list below, optional whitespace, and }}. There's no escaping, and a lone }} is text. Each alert fills the placeholders with its own values. Amounts appear in US dollars, such as $4,125.50.

• {{budget.name}}: the budget's name.
• {{budget.url}}: a link to the budget in Konnect.
• {{threshold}}: the threshold that was crossed, such as 80%.
• {{limit}}: the limit that spend is measured against. With each, the limit of one derived budget.
• {{spend}}: the spend so far in the budget window.
• {{percent}}: the spend as a share of the limit, such as 82.51%.
• {{remaining}}: what is left of the limit, never below $0.00.
• {{projected}}: where spend ends the budget window at the current pace, as an amount and a share of the limit.
• {{period}}: the budget window, in the time zone of its anchor.
• {{period.start}}: when the budget window started.
• {{period.end}}: when the budget window ends and the budget resets.
• {{period.remaining}}: how long is left in the budget window when the alert is sent, in its largest whole unit, such as 8 days or 12 minutes. Under a minute, it's less than a minute, and after the window ends, no time.
• {{entity.field}}: the each field as a noun, such as group, user for subject, or env tag for tags.env.
• {{entity.value}}: the value whose derived budget crossed the threshold. A Kong Identity principal or a consumer shows as its display name when the service can resolve it. Any other value, such as a Kong Identity group or team, shows as it is.

{{entity.field}} and {{entity.value}} work only on a budget with each. Defaults to null.

budgetId String

The id of the budget. Requires replacement if changed.

thresholds List<Property Map>

The shares of the limit at which the rule fires. Each threshold fires at most once per budget window, derived budget, and limit, and changing the limit lets the thresholds fire again.

channels List<Property Map>

The channels that receive the rule's alerts.

At most 10 channels, each listed once. Reads return them ordered by channel name. Defaults to [].

message Property Map

The wording of the rule's alerts on every channel, or null for the built-in wording.

subject and body can contain placeholders, such as {{budget.name}}. A placeholder is {{, optional whitespace, a name from the list below, optional whitespace, and }}. There's no escaping, and a lone }} is text. Each alert fills the placeholders with its own values. Amounts appear in US dollars, such as $4,125.50.

• {{budget.name}}: the budget's name.
• {{budget.url}}: a link to the budget in Konnect.
• {{threshold}}: the threshold that was crossed, such as 80%.
• {{limit}}: the limit that spend is measured against. With each, the limit of one derived budget.
• {{spend}}: the spend so far in the budget window.
• {{percent}}: the spend as a share of the limit, such as 82.51%.
• {{remaining}}: what is left of the limit, never below $0.00.
• {{projected}}: where spend ends the budget window at the current pace, as an amount and a share of the limit.
• {{period}}: the budget window, in the time zone of its anchor.
• {{period.start}}: when the budget window started.
• {{period.end}}: when the budget window ends and the budget resets.
• {{period.remaining}}: how long is left in the budget window when the alert is sent, in its largest whole unit, such as 8 days or 12 minutes. Under a minute, it's less than a minute, and after the window ends, no time.
• {{entity.field}}: the each field as a noun, such as group, user for subject, or env tag for tags.env.
• {{entity.value}}: the value whose derived budget crossed the threshold. A Kong Identity principal or a consumer shows as its display name when the service can resolve it. Any other value, such as a Kong Identity group or team, shows as it is.

{{entity.field}} and {{entity.value}} work only on a budget with each. Defaults to null.

Budget AiCostBudgetNotificationRuleBudget

The budget the rule belongs to.

CreatedAt string

An ISO-8601 timestamp representation of entity creation date.

Id string

The provider-assigned unique ID for this managed resource.

UpdatedAt string

An ISO-8601 timestamp representation of entity update date.

Budget AiCostBudgetNotificationRuleBudget

The budget the rule belongs to.

CreatedAt string

An ISO-8601 timestamp representation of entity creation date.

Id string

The provider-assigned unique ID for this managed resource.

UpdatedAt string

An ISO-8601 timestamp representation of entity update date.

budget object

The budget the rule belongs to.

created_at string

An ISO-8601 timestamp representation of entity creation date.

id string

The provider-assigned unique ID for this managed resource.

updated_at string

An ISO-8601 timestamp representation of entity update date.

budget AiCostBudgetNotificationRuleBudget

The budget the rule belongs to.

createdAt String

An ISO-8601 timestamp representation of entity creation date.

id String

The provider-assigned unique ID for this managed resource.

updatedAt String

An ISO-8601 timestamp representation of entity update date.

budget AiCostBudgetNotificationRuleBudget

The budget the rule belongs to.

createdAt string

An ISO-8601 timestamp representation of entity creation date.

id string

The provider-assigned unique ID for this managed resource.

updatedAt string

An ISO-8601 timestamp representation of entity update date.

budget AiCostBudgetNotificationRuleBudget

The budget the rule belongs to.

created_at str

An ISO-8601 timestamp representation of entity creation date.

id str

The provider-assigned unique ID for this managed resource.

updated_at str

An ISO-8601 timestamp representation of entity update date.

budget Property Map

The budget the rule belongs to.

createdAt String

An ISO-8601 timestamp representation of entity creation date.

id String

The provider-assigned unique ID for this managed resource.

updatedAt String

An ISO-8601 timestamp representation of entity update date.

name

The unique name of the resulting resource.

id

The unique provider ID of the resource to lookup.

state

Any extra arguments used during the lookup.

opts

A bag of options that control this resource's behavior.

resource_name

The unique name of the resulting resource.

id

The unique provider ID of the resource to lookup.

name

The unique name of the resulting resource.

id

The unique provider ID of the resource to lookup.

state

Any extra arguments used during the lookup.

opts

A bag of options that control this resource's behavior.

name

The unique name of the resulting resource.

id

The unique provider ID of the resource to lookup.

state

Any extra arguments used during the lookup.

opts

A bag of options that control this resource's behavior.

name

The unique name of the resulting resource.

id

The unique provider ID of the resource to lookup.

state

Any extra arguments used during the lookup.

opts

A bag of options that control this resource's behavior.

Id string

The id of the budget, which the budget operations take as budgetId.

Id string

The id of the budget, which the budget operations take as budgetId.

id string

The id of the budget, which the budget operations take as budgetId.

id String

The id of the budget, which the budget operations take as budgetId.

id string

The id of the budget, which the budget operations take as budgetId.

id str

The id of the budget, which the budget operations take as budgetId.

id String

The id of the budget, which the budget operations take as budgetId.

Id string

The identifier of one of the organization's notification channels. Not Null

Id string

The identifier of one of the organization's notification channels. Not Null

id string

The identifier of one of the organization's notification channels. Not Null

id String

The identifier of one of the organization's notification channels. Not Null

id string

The identifier of one of the organization's notification channels. Not Null

id str

The identifier of one of the organization's notification channels. Not Null

id String

The identifier of one of the organization's notification channels. Not Null

Body string

The text of the rule's alerts, as plain text that can contain placeholders such as {{budget.name}}. Blank lines separate paragraphs.

Subject string

The subject line of the rule's alerts, as plain text that can contain placeholders such as {{budget.name}}.

A single line of 1 to 200 characters after the server removes leading and trailing whitespace.

Body string

The text of the rule's alerts, as plain text that can contain placeholders such as {{budget.name}}. Blank lines separate paragraphs.

Subject string

The subject line of the rule's alerts, as plain text that can contain placeholders such as {{budget.name}}.

A single line of 1 to 200 characters after the server removes leading and trailing whitespace.

body string

The text of the rule's alerts, as plain text that can contain placeholders such as {{budget.name}}. Blank lines separate paragraphs.

subject string

The subject line of the rule's alerts, as plain text that can contain placeholders such as {{budget.name}}.

A single line of 1 to 200 characters after the server removes leading and trailing whitespace.

body String

The text of the rule's alerts, as plain text that can contain placeholders such as {{budget.name}}. Blank lines separate paragraphs.

subject String

The subject line of the rule's alerts, as plain text that can contain placeholders such as {{budget.name}}.

A single line of 1 to 200 characters after the server removes leading and trailing whitespace.

body string

The text of the rule's alerts, as plain text that can contain placeholders such as {{budget.name}}. Blank lines separate paragraphs.

subject string

The subject line of the rule's alerts, as plain text that can contain placeholders such as {{budget.name}}.

A single line of 1 to 200 characters after the server removes leading and trailing whitespace.

body str

The text of the rule's alerts, as plain text that can contain placeholders such as {{budget.name}}. Blank lines separate paragraphs.

subject str

The subject line of the rule's alerts, as plain text that can contain placeholders such as {{budget.name}}.

A single line of 1 to 200 characters after the server removes leading and trailing whitespace.

body String

The text of the rule's alerts, as plain text that can contain placeholders such as {{budget.name}}. Blank lines separate paragraphs.

subject String

The subject line of the rule's alerts, as plain text that can contain placeholders such as {{budget.name}}.

A single line of 1 to 200 characters after the server removes leading and trailing whitespace.

Percent double

The share of the limit, as a whole percent. A value above 100 fires on spend beyond the limit.

Percent float64

The share of the limit, as a whole percent. A value above 100 fires on spend beyond the limit.

percent number

The share of the limit, as a whole percent. A value above 100 fires on spend beyond the limit.

percent Double

The share of the limit, as a whole percent. A value above 100 fires on spend beyond the limit.

percent number

The share of the limit, as a whole percent. A value above 100 fires on spend beyond the limit.

percent float

The share of the limit, as a whole percent. A value above 100 fires on spend beyond the limit.

percent Number

The share of the limit, as a whole percent. A value above 100 fires on spend beyond the limit.