Budgets

1 resource kind. Generated from the operator's CRD schemas.

API Group: aws.konfig.io/v1alpha1

Budget # GA

Budget is the Schema for managing AWS Budgets budgets.

kubectl get budgets · example on GitHub

Example

# Budget — Budgets
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/budgets.html#budget
apiVersion: aws.konfig.io/v1alpha1
kind: Budget
metadata:
  name: example-budget
  namespace: default
spec:
  accountId: '123456789012'
  budgetName: example-budget
  budgetType: COST
  costFilters: {}
  limitAmount: '100'
  limitUnit: example
  notifications:
  - comparisonOperator: GREATER_THAN
    notificationType: ACTUAL
    subscribers:
    - address: example
      subscriptionType: EMAIL
    threshold: '100'
    thresholdType: PERCENTAGE
  providerRef:
    name: example-budget
    region: us-east-1
  timeUnit: DAILY

Spec

Field	Type	Required	Description
`accountId`	string	yes	AccountID is the 12-digit AWS account ID that owns the budget.
`budgetName`	string	yes	BudgetName is the name of the budget, unique within the account.
`budgetType`	enum	yes	BudgetType is what the budget tracks. Allowed: `COST, USAGE, RI_UTILIZATION, RI_COVERAGE, SAVINGS_PLANS_UTILIZATION, SAVINGS_PLANS_COVERAGE`
`costFilters`	map<string>	—	CostFilters restrict the costs the budget tracks, e.g.
`limitAmount`	string	yes	LimitAmount is the budgeted amount, as a numeric string (e.g.
`limitUnit`	string	yes	LimitUnit is the unit of the limit, e.g.
`notifications`	array<object>	—	Notifications are alert thresholds with subscribers.
`notifications[].comparisonOperator`	enum	yes	ComparisonOperator compares spend against the threshold. Allowed: `GREATER_THAN, LESS_THAN, EQUAL_TO`
`notifications[].notificationType`	enum	yes	NotificationType is whether the alert is on actual or forecasted spend. Allowed: `ACTUAL, FORECASTED`
`notifications[].subscribers`	array<object>	yes	Subscribers to notify when the threshold is exceeded.
`notifications[].subscribers[].address`	string	yes	Address is the email address or SNS topic ARN to notify.
`notifications[].subscribers[].subscriptionType`	enum	yes	SubscriptionType is how notifications are delivered. Allowed: `EMAIL, SNS`
`notifications[].threshold`	string	yes	Threshold is the notification threshold value, as a numeric string (e.g.
`notifications[].thresholdType`	enum	—	ThresholdType is PERCENTAGE or ABSOLUTE_VALUE. Allowed: `PERCENTAGE, ABSOLUTE_VALUE`
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`timeUnit`	enum	yes	TimeUnit is the period after which the budget resets. Allowed: `DAILY, MONTHLY, QUARTERLY, ANNUALLY`

Status

Field	Type	Required	Description
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`budgetName`	string	—	BudgetName is the name of the budget in AWS (its primary identifier together with the account ID).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`lastSyncTime`	string	—	LastSyncTime is when the resource was last successfully reconciled.
`observedGeneration`	integer	—	ObservedGeneration is the most recent .metadata.generation reconciled.