budgets

package
v3.29.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 15, 2021 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Budget 

type Budget struct {
	pulumi.CustomResourceState

	// The ID of the target account for budget. Will use current user's accountId by default if omitted.
	AccountId pulumi.StringOutput `pulumi:"accountId"`
	// The ARN of the budget.
	Arn pulumi.StringOutput `pulumi:"arn"`
	// Whether this budget tracks monetary cost or usage.
	BudgetType pulumi.StringOutput `pulumi:"budgetType"`
	// Map of Cost Filters key/value pairs to apply to the budget.
	CostFilters pulumi.StringMapOutput `pulumi:"costFilters"`
	// Object containing Cost Types The types of cost included in a budget, such as tax and subscriptions..
	CostTypes BudgetCostTypesOutput `pulumi:"costTypes"`
	// The amount of cost or usage being measured for a budget.
	LimitAmount pulumi.StringOutput `pulumi:"limitAmount"`
	// The unit of measurement used for the budget forecast, actual spend, or budget threshold, such as dollars or GB. See [Spend](http://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/data-type-spend.html) documentation.
	LimitUnit pulumi.StringOutput `pulumi:"limitUnit"`
	// The name of a budget. Unique within accounts.
	Name pulumi.StringOutput `pulumi:"name"`
	// The prefix of the name of a budget. Unique within accounts.
	NamePrefix pulumi.StringOutput `pulumi:"namePrefix"`
	// Object containing Budget Notifications. Can be used multiple times to define more than one budget notification
	Notifications BudgetNotificationArrayOutput `pulumi:"notifications"`
	// The end of the time period covered by the budget. There are no restrictions on the end date. Format: `2017-01-01_12:00`.
	TimePeriodEnd pulumi.StringPtrOutput `pulumi:"timePeriodEnd"`
	// The start of the time period covered by the budget. The start date must come before the end date. Format: `2017-01-01_12:00`.
	TimePeriodStart pulumi.StringOutput `pulumi:"timePeriodStart"`
	// The length of time until a budget resets the actual and forecasted spend. Valid values: `MONTHLY`, `QUARTERLY`, `ANNUALLY`, and `DAILY`.
	TimeUnit pulumi.StringOutput `pulumi:"timeUnit"`
}

Provides a budgets budget resource. Budgets use the cost visualisation provided by Cost Explorer to show you the status of your budgets, to provide forecasts of your estimated costs, and to track your AWS usage, including your free tier usage.

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi-aws/sdk/v3/go/aws/budgets"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := budgets.NewBudget(ctx, "ec2", &budgets.BudgetArgs{
			BudgetType: pulumi.String("COST"),
			CostFilters: pulumi.StringMap{
				"Service": pulumi.String("Amazon Elastic Compute Cloud - Compute"),
			},
			LimitAmount: pulumi.String("1200"),
			LimitUnit:   pulumi.String("USD"),
			Notifications: budgets.BudgetNotificationArray{
				&budgets.BudgetNotificationArgs{
					ComparisonOperator: pulumi.String("GREATER_THAN"),
					NotificationType:   pulumi.String("FORECASTED"),
					SubscriberEmailAddresses: pulumi.StringArray{
						pulumi.String("test@example.com"),
					},
					Threshold:     pulumi.Float64(100),
					ThresholdType: pulumi.String("PERCENTAGE"),
				},
			},
			TimePeriodEnd:   pulumi.String("2087-06-15_00:00"),
			TimePeriodStart: pulumi.String("2017-07-01_00:00"),
			TimeUnit:        pulumi.String("MONTHLY"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

Create a budget for *$100*.

```go package main

import ( 

"github.com/pulumi/pulumi-aws/sdk/v3/go/aws/budgets"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := budgets.NewBudget(ctx, "cost", &budgets.BudgetArgs{
			BudgetType:  pulumi.String("COST"),
			LimitAmount: pulumi.String("100"),
			LimitUnit:   pulumi.String("USD"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

Create a budget for s3 with a limit of *3 GB* of storage.

```go package main

import ( 

"github.com/pulumi/pulumi-aws/sdk/v3/go/aws/budgets"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := budgets.NewBudget(ctx, "s3", &budgets.BudgetArgs{
			BudgetType:  pulumi.String("USAGE"),
			LimitAmount: pulumi.String("3"),
			LimitUnit:   pulumi.String("GB"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

Create a Savings Plan Utilization Budget

```go package main

import ( 

"github.com/pulumi/pulumi-aws/sdk/v3/go/aws/budgets"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := budgets.NewBudget(ctx, "savingsPlanUtilization", &budgets.BudgetArgs{
			BudgetType: pulumi.String("SAVINGS_PLANS_UTILIZATION"),
			CostTypes: &budgets.BudgetCostTypesArgs{
				IncludeCredit:            pulumi.Bool(false),
				IncludeDiscount:          pulumi.Bool(false),
				IncludeOtherSubscription: pulumi.Bool(false),
				IncludeRecurring:         pulumi.Bool(false),
				IncludeRefund:            pulumi.Bool(false),
				IncludeSubscription:      pulumi.Bool(true),
				IncludeSupport:           pulumi.Bool(false),
				IncludeTax:               pulumi.Bool(false),
				IncludeUpfront:           pulumi.Bool(false),
				UseBlended:               pulumi.Bool(false),
			},
			LimitAmount: pulumi.String("100.0"),
			LimitUnit:   pulumi.String("PERCENTAGE"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

Create a RI Utilization Budget

```go package main

import ( 

"github.com/pulumi/pulumi-aws/sdk/v3/go/aws/budgets"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := budgets.NewBudget(ctx, "riUtilization", &budgets.BudgetArgs{
			BudgetType: pulumi.String("RI_UTILIZATION"),
			CostFilters: pulumi.StringMap{
				"Service": pulumi.String("Amazon Relational Database Service"),
			},
			CostTypes: &budgets.BudgetCostTypesArgs{
				IncludeCredit:            pulumi.Bool(false),
				IncludeDiscount:          pulumi.Bool(false),
				IncludeOtherSubscription: pulumi.Bool(false),
				IncludeRecurring:         pulumi.Bool(false),
				IncludeRefund:            pulumi.Bool(false),
				IncludeSubscription:      pulumi.Bool(true),
				IncludeSupport:           pulumi.Bool(false),
				IncludeTax:               pulumi.Bool(false),
				IncludeUpfront:           pulumi.Bool(false),
				UseBlended:               pulumi.Bool(false),
			},
			LimitAmount: pulumi.String("100.0"),
			LimitUnit:   pulumi.String("PERCENTAGE"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

Budgets can be imported using `AccountID:BudgetName`, e.g.

```sh 

$ pulumi import aws:budgets/budget:Budget myBudget 123456789012:myBudget`

```

func GetBudget 

func GetBudget(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *BudgetState, opts ...pulumi.ResourceOption) (*Budget, error)

GetBudget gets an existing Budget resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewBudget 

func NewBudget(ctx *pulumi.Context,
	name string, args *BudgetArgs, opts ...pulumi.ResourceOption) (*Budget, error)

NewBudget registers a new resource with the given unique name, arguments, and options.

func (*Budget) ElementType added in v3.13.0 

func (*Budget) ElementType() reflect.Type

func (*Budget) ToBudgetOutput added in v3.13.0 

func (i *Budget) ToBudgetOutput() BudgetOutput

func (*Budget) ToBudgetOutputWithContext added in v3.13.0 

func (i *Budget) ToBudgetOutputWithContext(ctx context.Context) BudgetOutput

func (*Budget) ToBudgetPtrOutput added in v3.25.0 

func (i *Budget) ToBudgetPtrOutput() BudgetPtrOutput

func (*Budget) ToBudgetPtrOutputWithContext added in v3.25.0 

func (i *Budget) ToBudgetPtrOutputWithContext(ctx context.Context) BudgetPtrOutput

type BudgetArgs 

type BudgetArgs struct {
	// The ID of the target account for budget. Will use current user's accountId by default if omitted.
	AccountId pulumi.StringPtrInput
	// Whether this budget tracks monetary cost or usage.
	BudgetType pulumi.StringInput
	// Map of Cost Filters key/value pairs to apply to the budget.
	CostFilters pulumi.StringMapInput
	// Object containing Cost Types The types of cost included in a budget, such as tax and subscriptions..
	CostTypes BudgetCostTypesPtrInput
	// The amount of cost or usage being measured for a budget.
	LimitAmount pulumi.StringInput
	// The unit of measurement used for the budget forecast, actual spend, or budget threshold, such as dollars or GB. See [Spend](http://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/data-type-spend.html) documentation.
	LimitUnit pulumi.StringInput
	// The name of a budget. Unique within accounts.
	Name pulumi.StringPtrInput
	// The prefix of the name of a budget. Unique within accounts.
	NamePrefix pulumi.StringPtrInput
	// Object containing Budget Notifications. Can be used multiple times to define more than one budget notification
	Notifications BudgetNotificationArrayInput
	// The end of the time period covered by the budget. There are no restrictions on the end date. Format: `2017-01-01_12:00`.
	TimePeriodEnd pulumi.StringPtrInput
	// The start of the time period covered by the budget. The start date must come before the end date. Format: `2017-01-01_12:00`.
	TimePeriodStart pulumi.StringInput
	// The length of time until a budget resets the actual and forecasted spend. Valid values: `MONTHLY`, `QUARTERLY`, `ANNUALLY`, and `DAILY`.
	TimeUnit pulumi.StringInput
}

The set of arguments for constructing a Budget resource.

func (BudgetArgs) ElementType 

func (BudgetArgs) ElementType() reflect.Type

type BudgetArray added in v3.25.0 

type BudgetArray []BudgetInput

func (BudgetArray) ElementType added in v3.25.0 

func (BudgetArray) ElementType() reflect.Type

func (BudgetArray) ToBudgetArrayOutput added in v3.25.0 

func (i BudgetArray) ToBudgetArrayOutput() BudgetArrayOutput

func (BudgetArray) ToBudgetArrayOutputWithContext added in v3.25.0 

func (i BudgetArray) ToBudgetArrayOutputWithContext(ctx context.Context) BudgetArrayOutput

type BudgetArrayInput added in v3.25.0 

type BudgetArrayInput interface {
	pulumi.Input

	ToBudgetArrayOutput() BudgetArrayOutput
	ToBudgetArrayOutputWithContext(context.Context) BudgetArrayOutput
}

BudgetArrayInput is an input type that accepts BudgetArray and BudgetArrayOutput values. You can construct a concrete instance of `BudgetArrayInput` via: 

BudgetArray{ BudgetArgs{...} }

type BudgetArrayOutput added in v3.25.0 

type BudgetArrayOutput struct{ *pulumi.OutputState }

func (BudgetArrayOutput) ElementType added in v3.25.0 

func (BudgetArrayOutput) ElementType() reflect.Type

func (BudgetArrayOutput) Index added in v3.25.0 

func (o BudgetArrayOutput) Index(i pulumi.IntInput) BudgetOutput

func (BudgetArrayOutput) ToBudgetArrayOutput added in v3.25.0 

func (o BudgetArrayOutput) ToBudgetArrayOutput() BudgetArrayOutput

func (BudgetArrayOutput) ToBudgetArrayOutputWithContext added in v3.25.0 

func (o BudgetArrayOutput) ToBudgetArrayOutputWithContext(ctx context.Context) BudgetArrayOutput

type BudgetCostTypes 

type BudgetCostTypes struct {
	// A boolean value whether to include credits in the cost budget. Defaults to `true`
	IncludeCredit *bool `pulumi:"includeCredit"`
	// Specifies whether a budget includes discounts. Defaults to `true`
	IncludeDiscount *bool `pulumi:"includeDiscount"`
	// A boolean value whether to include other subscription costs in the cost budget. Defaults to `true`
	IncludeOtherSubscription *bool `pulumi:"includeOtherSubscription"`
	// A boolean value whether to include recurring costs in the cost budget. Defaults to `true`
	IncludeRecurring *bool `pulumi:"includeRecurring"`
	// A boolean value whether to include refunds in the cost budget. Defaults to `true`
	IncludeRefund *bool `pulumi:"includeRefund"`
	// A boolean value whether to include subscriptions in the cost budget. Defaults to `true`
	IncludeSubscription *bool `pulumi:"includeSubscription"`
	// A boolean value whether to include support costs in the cost budget. Defaults to `true`
	IncludeSupport *bool `pulumi:"includeSupport"`
	// A boolean value whether to include tax in the cost budget. Defaults to `true`
	IncludeTax *bool `pulumi:"includeTax"`
	// A boolean value whether to include upfront costs in the cost budget. Defaults to `true`
	IncludeUpfront *bool `pulumi:"includeUpfront"`
	// Specifies whether a budget uses the amortized rate. Defaults to `false`
	UseAmortized *bool `pulumi:"useAmortized"`
	// A boolean value whether to use blended costs in the cost budget. Defaults to `false`
	UseBlended *bool `pulumi:"useBlended"`
}

type BudgetCostTypesArgs 

type BudgetCostTypesArgs struct {
	// A boolean value whether to include credits in the cost budget. Defaults to `true`
	IncludeCredit pulumi.BoolPtrInput `pulumi:"includeCredit"`
	// Specifies whether a budget includes discounts. Defaults to `true`
	IncludeDiscount pulumi.BoolPtrInput `pulumi:"includeDiscount"`
	// A boolean value whether to include other subscription costs in the cost budget. Defaults to `true`
	IncludeOtherSubscription pulumi.BoolPtrInput `pulumi:"includeOtherSubscription"`
	// A boolean value whether to include recurring costs in the cost budget. Defaults to `true`
	IncludeRecurring pulumi.BoolPtrInput `pulumi:"includeRecurring"`
	// A boolean value whether to include refunds in the cost budget. Defaults to `true`
	IncludeRefund pulumi.BoolPtrInput `pulumi:"includeRefund"`
	// A boolean value whether to include subscriptions in the cost budget. Defaults to `true`
	IncludeSubscription pulumi.BoolPtrInput `pulumi:"includeSubscription"`
	// A boolean value whether to include support costs in the cost budget. Defaults to `true`
	IncludeSupport pulumi.BoolPtrInput `pulumi:"includeSupport"`
	// A boolean value whether to include tax in the cost budget. Defaults to `true`
	IncludeTax pulumi.BoolPtrInput `pulumi:"includeTax"`
	// A boolean value whether to include upfront costs in the cost budget. Defaults to `true`
	IncludeUpfront pulumi.BoolPtrInput `pulumi:"includeUpfront"`
	// Specifies whether a budget uses the amortized rate. Defaults to `false`
	UseAmortized pulumi.BoolPtrInput `pulumi:"useAmortized"`
	// A boolean value whether to use blended costs in the cost budget. Defaults to `false`
	UseBlended pulumi.BoolPtrInput `pulumi:"useBlended"`
}

func (BudgetCostTypesArgs) ElementType 

func (BudgetCostTypesArgs) ElementType() reflect.Type

func (BudgetCostTypesArgs) ToBudgetCostTypesOutput 

func (i BudgetCostTypesArgs) ToBudgetCostTypesOutput() BudgetCostTypesOutput

func (BudgetCostTypesArgs) ToBudgetCostTypesOutputWithContext 

func (i BudgetCostTypesArgs) ToBudgetCostTypesOutputWithContext(ctx context.Context) BudgetCostTypesOutput

func (BudgetCostTypesArgs) ToBudgetCostTypesPtrOutput 

func (i BudgetCostTypesArgs) ToBudgetCostTypesPtrOutput() BudgetCostTypesPtrOutput

func (BudgetCostTypesArgs) ToBudgetCostTypesPtrOutputWithContext 

func (i BudgetCostTypesArgs) ToBudgetCostTypesPtrOutputWithContext(ctx context.Context) BudgetCostTypesPtrOutput

type BudgetCostTypesInput 

type BudgetCostTypesInput interface {
	pulumi.Input

	ToBudgetCostTypesOutput() BudgetCostTypesOutput
	ToBudgetCostTypesOutputWithContext(context.Context) BudgetCostTypesOutput
}

BudgetCostTypesInput is an input type that accepts BudgetCostTypesArgs and BudgetCostTypesOutput values. You can construct a concrete instance of `BudgetCostTypesInput` via: 

BudgetCostTypesArgs{...}

type BudgetCostTypesOutput 

type BudgetCostTypesOutput struct{ *pulumi.OutputState }

func (BudgetCostTypesOutput) ElementType 

func (BudgetCostTypesOutput) ElementType() reflect.Type

func (BudgetCostTypesOutput) IncludeCredit 

func (o BudgetCostTypesOutput) IncludeCredit() pulumi.BoolPtrOutput

A boolean value whether to include credits in the cost budget. Defaults to `true`

func (BudgetCostTypesOutput) IncludeDiscount 

func (o BudgetCostTypesOutput) IncludeDiscount() pulumi.BoolPtrOutput

Specifies whether a budget includes discounts. Defaults to `true`

func (BudgetCostTypesOutput) IncludeOtherSubscription 

func (o BudgetCostTypesOutput) IncludeOtherSubscription() pulumi.BoolPtrOutput

A boolean value whether to include other subscription costs in the cost budget. Defaults to `true`

func (BudgetCostTypesOutput) IncludeRecurring 

func (o BudgetCostTypesOutput) IncludeRecurring() pulumi.BoolPtrOutput

A boolean value whether to include recurring costs in the cost budget. Defaults to `true`

func (BudgetCostTypesOutput) IncludeRefund 

func (o BudgetCostTypesOutput) IncludeRefund() pulumi.BoolPtrOutput

A boolean value whether to include refunds in the cost budget. Defaults to `true`

func (BudgetCostTypesOutput) IncludeSubscription 

func (o BudgetCostTypesOutput) IncludeSubscription() pulumi.BoolPtrOutput

A boolean value whether to include subscriptions in the cost budget. Defaults to `true`

func (BudgetCostTypesOutput) IncludeSupport 

func (o BudgetCostTypesOutput) IncludeSupport() pulumi.BoolPtrOutput

A boolean value whether to include support costs in the cost budget. Defaults to `true`

func (BudgetCostTypesOutput) IncludeTax 

func (o BudgetCostTypesOutput) IncludeTax() pulumi.BoolPtrOutput

A boolean value whether to include tax in the cost budget. Defaults to `true`

func (BudgetCostTypesOutput) IncludeUpfront 

func (o BudgetCostTypesOutput) IncludeUpfront() pulumi.BoolPtrOutput

A boolean value whether to include upfront costs in the cost budget. Defaults to `true`

func (BudgetCostTypesOutput) ToBudgetCostTypesOutput 

func (o BudgetCostTypesOutput) ToBudgetCostTypesOutput() BudgetCostTypesOutput

func (BudgetCostTypesOutput) ToBudgetCostTypesOutputWithContext 

func (o BudgetCostTypesOutput) ToBudgetCostTypesOutputWithContext(ctx context.Context) BudgetCostTypesOutput

func (BudgetCostTypesOutput) ToBudgetCostTypesPtrOutput 

func (o BudgetCostTypesOutput) ToBudgetCostTypesPtrOutput() BudgetCostTypesPtrOutput

func (BudgetCostTypesOutput) ToBudgetCostTypesPtrOutputWithContext 

func (o BudgetCostTypesOutput) ToBudgetCostTypesPtrOutputWithContext(ctx context.Context) BudgetCostTypesPtrOutput

func (BudgetCostTypesOutput) UseAmortized 

func (o BudgetCostTypesOutput) UseAmortized() pulumi.BoolPtrOutput

Specifies whether a budget uses the amortized rate. Defaults to `false`

func (BudgetCostTypesOutput) UseBlended 

func (o BudgetCostTypesOutput) UseBlended() pulumi.BoolPtrOutput

A boolean value whether to use blended costs in the cost budget. Defaults to `false`

type BudgetCostTypesPtrInput 

type BudgetCostTypesPtrInput interface {
	pulumi.Input

	ToBudgetCostTypesPtrOutput() BudgetCostTypesPtrOutput
	ToBudgetCostTypesPtrOutputWithContext(context.Context) BudgetCostTypesPtrOutput
}

BudgetCostTypesPtrInput is an input type that accepts BudgetCostTypesArgs, BudgetCostTypesPtr and BudgetCostTypesPtrOutput values. You can construct a concrete instance of `BudgetCostTypesPtrInput` via: 

        BudgetCostTypesArgs{...}

or:

        nil

func BudgetCostTypesPtr 

func BudgetCostTypesPtr(v *BudgetCostTypesArgs) BudgetCostTypesPtrInput

type BudgetCostTypesPtrOutput 

type BudgetCostTypesPtrOutput struct{ *pulumi.OutputState }

func (BudgetCostTypesPtrOutput) Elem 

func (o BudgetCostTypesPtrOutput) Elem() BudgetCostTypesOutput

func (BudgetCostTypesPtrOutput) ElementType 

func (BudgetCostTypesPtrOutput) ElementType() reflect.Type

func (BudgetCostTypesPtrOutput) IncludeCredit 

func (o BudgetCostTypesPtrOutput) IncludeCredit() pulumi.BoolPtrOutput

A boolean value whether to include credits in the cost budget. Defaults to `true`

func (BudgetCostTypesPtrOutput) IncludeDiscount 

func (o BudgetCostTypesPtrOutput) IncludeDiscount() pulumi.BoolPtrOutput

Specifies whether a budget includes discounts. Defaults to `true`

func (BudgetCostTypesPtrOutput) IncludeOtherSubscription 

func (o BudgetCostTypesPtrOutput) IncludeOtherSubscription() pulumi.BoolPtrOutput

A boolean value whether to include other subscription costs in the cost budget. Defaults to `true`

func (BudgetCostTypesPtrOutput) IncludeRecurring 

func (o BudgetCostTypesPtrOutput) IncludeRecurring() pulumi.BoolPtrOutput

A boolean value whether to include recurring costs in the cost budget. Defaults to `true`

func (BudgetCostTypesPtrOutput) IncludeRefund 

func (o BudgetCostTypesPtrOutput) IncludeRefund() pulumi.BoolPtrOutput

A boolean value whether to include refunds in the cost budget. Defaults to `true`

func (BudgetCostTypesPtrOutput) IncludeSubscription 

func (o BudgetCostTypesPtrOutput) IncludeSubscription() pulumi.BoolPtrOutput

A boolean value whether to include subscriptions in the cost budget. Defaults to `true`

func (BudgetCostTypesPtrOutput) IncludeSupport 

func (o BudgetCostTypesPtrOutput) IncludeSupport() pulumi.BoolPtrOutput

A boolean value whether to include support costs in the cost budget. Defaults to `true`

func (BudgetCostTypesPtrOutput) IncludeTax 

func (o BudgetCostTypesPtrOutput) IncludeTax() pulumi.BoolPtrOutput

A boolean value whether to include tax in the cost budget. Defaults to `true`

func (BudgetCostTypesPtrOutput) IncludeUpfront 

func (o BudgetCostTypesPtrOutput) IncludeUpfront() pulumi.BoolPtrOutput

A boolean value whether to include upfront costs in the cost budget. Defaults to `true`

func (BudgetCostTypesPtrOutput) ToBudgetCostTypesPtrOutput 

func (o BudgetCostTypesPtrOutput) ToBudgetCostTypesPtrOutput() BudgetCostTypesPtrOutput

func (BudgetCostTypesPtrOutput) ToBudgetCostTypesPtrOutputWithContext 

func (o BudgetCostTypesPtrOutput) ToBudgetCostTypesPtrOutputWithContext(ctx context.Context) BudgetCostTypesPtrOutput

func (BudgetCostTypesPtrOutput) UseAmortized 

func (o BudgetCostTypesPtrOutput) UseAmortized() pulumi.BoolPtrOutput

Specifies whether a budget uses the amortized rate. Defaults to `false`

func (BudgetCostTypesPtrOutput) UseBlended 

func (o BudgetCostTypesPtrOutput) UseBlended() pulumi.BoolPtrOutput

A boolean value whether to use blended costs in the cost budget. Defaults to `false`

type BudgetInput added in v3.13.0 

type BudgetInput interface {
	pulumi.Input

	ToBudgetOutput() BudgetOutput
	ToBudgetOutputWithContext(ctx context.Context) BudgetOutput
}

type BudgetMap added in v3.25.0 

type BudgetMap map[string]BudgetInput

func (BudgetMap) ElementType added in v3.25.0 

func (BudgetMap) ElementType() reflect.Type

func (BudgetMap) ToBudgetMapOutput added in v3.25.0 

func (i BudgetMap) ToBudgetMapOutput() BudgetMapOutput

func (BudgetMap) ToBudgetMapOutputWithContext added in v3.25.0 

func (i BudgetMap) ToBudgetMapOutputWithContext(ctx context.Context) BudgetMapOutput

type BudgetMapInput added in v3.25.0 

type BudgetMapInput interface {
	pulumi.Input

	ToBudgetMapOutput() BudgetMapOutput
	ToBudgetMapOutputWithContext(context.Context) BudgetMapOutput
}

BudgetMapInput is an input type that accepts BudgetMap and BudgetMapOutput values. You can construct a concrete instance of `BudgetMapInput` via: 

BudgetMap{ "key": BudgetArgs{...} }

type BudgetMapOutput added in v3.25.0 

type BudgetMapOutput struct{ *pulumi.OutputState }

func (BudgetMapOutput) ElementType added in v3.25.0 

func (BudgetMapOutput) ElementType() reflect.Type

func (BudgetMapOutput) MapIndex added in v3.25.0 

func (o BudgetMapOutput) MapIndex(k pulumi.StringInput) BudgetOutput

func (BudgetMapOutput) ToBudgetMapOutput added in v3.25.0 

func (o BudgetMapOutput) ToBudgetMapOutput() BudgetMapOutput

func (BudgetMapOutput) ToBudgetMapOutputWithContext added in v3.25.0 

func (o BudgetMapOutput) ToBudgetMapOutputWithContext(ctx context.Context) BudgetMapOutput

type BudgetNotification 

type BudgetNotification struct {
	// (Required) Comparison operator to use to evaluate the condition. Can be `LESS_THAN`, `EQUAL_TO` or `GREATER_THAN`.
	ComparisonOperator string `pulumi:"comparisonOperator"`
	// (Required) What kind of budget value to notify on. Can be `ACTUAL` or `FORECASTED`
	NotificationType string `pulumi:"notificationType"`
	// (Optional) E-Mail addresses to notify. Either this or `subscriberSnsTopicArns` is required.
	SubscriberEmailAddresses []string `pulumi:"subscriberEmailAddresses"`
	// (Optional) SNS topics to notify. Either this or `subscriberEmailAddresses` is required.
	SubscriberSnsTopicArns []string `pulumi:"subscriberSnsTopicArns"`
	// (Required) Threshold when the notification should be sent.
	Threshold float64 `pulumi:"threshold"`
	// (Required) What kind of threshold is defined. Can be `PERCENTAGE` OR `ABSOLUTE_VALUE`.
	ThresholdType string `pulumi:"thresholdType"`
}

type BudgetNotificationArgs 

type BudgetNotificationArgs struct {
	// (Required) Comparison operator to use to evaluate the condition. Can be `LESS_THAN`, `EQUAL_TO` or `GREATER_THAN`.
	ComparisonOperator pulumi.StringInput `pulumi:"comparisonOperator"`
	// (Required) What kind of budget value to notify on. Can be `ACTUAL` or `FORECASTED`
	NotificationType pulumi.StringInput `pulumi:"notificationType"`
	// (Optional) E-Mail addresses to notify. Either this or `subscriberSnsTopicArns` is required.
	SubscriberEmailAddresses pulumi.StringArrayInput `pulumi:"subscriberEmailAddresses"`
	// (Optional) SNS topics to notify. Either this or `subscriberEmailAddresses` is required.
	SubscriberSnsTopicArns pulumi.StringArrayInput `pulumi:"subscriberSnsTopicArns"`
	// (Required) Threshold when the notification should be sent.
	Threshold pulumi.Float64Input `pulumi:"threshold"`
	// (Required) What kind of threshold is defined. Can be `PERCENTAGE` OR `ABSOLUTE_VALUE`.
	ThresholdType pulumi.StringInput `pulumi:"thresholdType"`
}

func (BudgetNotificationArgs) ElementType 

func (BudgetNotificationArgs) ElementType() reflect.Type

func (BudgetNotificationArgs) ToBudgetNotificationOutput 

func (i BudgetNotificationArgs) ToBudgetNotificationOutput() BudgetNotificationOutput

func (BudgetNotificationArgs) ToBudgetNotificationOutputWithContext 

func (i BudgetNotificationArgs) ToBudgetNotificationOutputWithContext(ctx context.Context) BudgetNotificationOutput

type BudgetNotificationArray 

type BudgetNotificationArray []BudgetNotificationInput

func (BudgetNotificationArray) ElementType 

func (BudgetNotificationArray) ElementType() reflect.Type

func (BudgetNotificationArray) ToBudgetNotificationArrayOutput 

func (i BudgetNotificationArray) ToBudgetNotificationArrayOutput() BudgetNotificationArrayOutput

func (BudgetNotificationArray) ToBudgetNotificationArrayOutputWithContext 

func (i BudgetNotificationArray) ToBudgetNotificationArrayOutputWithContext(ctx context.Context) BudgetNotificationArrayOutput

type BudgetNotificationArrayInput 

type BudgetNotificationArrayInput interface {
	pulumi.Input

	ToBudgetNotificationArrayOutput() BudgetNotificationArrayOutput
	ToBudgetNotificationArrayOutputWithContext(context.Context) BudgetNotificationArrayOutput
}

BudgetNotificationArrayInput is an input type that accepts BudgetNotificationArray and BudgetNotificationArrayOutput values. You can construct a concrete instance of `BudgetNotificationArrayInput` via: 

BudgetNotificationArray{ BudgetNotificationArgs{...} }

type BudgetNotificationArrayOutput 

type BudgetNotificationArrayOutput struct{ *pulumi.OutputState }

func (BudgetNotificationArrayOutput) ElementType 

func (BudgetNotificationArrayOutput) ElementType() reflect.Type

func (BudgetNotificationArrayOutput) Index 

func (o BudgetNotificationArrayOutput) Index(i pulumi.IntInput) BudgetNotificationOutput

func (BudgetNotificationArrayOutput) ToBudgetNotificationArrayOutput 

func (o BudgetNotificationArrayOutput) ToBudgetNotificationArrayOutput() BudgetNotificationArrayOutput

func (BudgetNotificationArrayOutput) ToBudgetNotificationArrayOutputWithContext 

func (o BudgetNotificationArrayOutput) ToBudgetNotificationArrayOutputWithContext(ctx context.Context) BudgetNotificationArrayOutput

type BudgetNotificationInput 

type BudgetNotificationInput interface {
	pulumi.Input

	ToBudgetNotificationOutput() BudgetNotificationOutput
	ToBudgetNotificationOutputWithContext(context.Context) BudgetNotificationOutput
}

BudgetNotificationInput is an input type that accepts BudgetNotificationArgs and BudgetNotificationOutput values. You can construct a concrete instance of `BudgetNotificationInput` via: 

BudgetNotificationArgs{...}

type BudgetNotificationOutput 

type BudgetNotificationOutput struct{ *pulumi.OutputState }

func (BudgetNotificationOutput) ComparisonOperator 

func (o BudgetNotificationOutput) ComparisonOperator() pulumi.StringOutput

(Required) Comparison operator to use to evaluate the condition. Can be `LESS_THAN`, `EQUAL_TO` or `GREATER_THAN`.

func (BudgetNotificationOutput) ElementType 

func (BudgetNotificationOutput) ElementType() reflect.Type

func (BudgetNotificationOutput) NotificationType 

func (o BudgetNotificationOutput) NotificationType() pulumi.StringOutput

(Required) What kind of budget value to notify on. Can be `ACTUAL` or `FORECASTED`

func (BudgetNotificationOutput) SubscriberEmailAddresses 

func (o BudgetNotificationOutput) SubscriberEmailAddresses() pulumi.StringArrayOutput

(Optional) E-Mail addresses to notify. Either this or `subscriberSnsTopicArns` is required.

func (BudgetNotificationOutput) SubscriberSnsTopicArns 

func (o BudgetNotificationOutput) SubscriberSnsTopicArns() pulumi.StringArrayOutput

(Optional) SNS topics to notify. Either this or `subscriberEmailAddresses` is required.

func (BudgetNotificationOutput) Threshold 

func (o BudgetNotificationOutput) Threshold() pulumi.Float64Output

(Required) Threshold when the notification should be sent.

func (BudgetNotificationOutput) ThresholdType 

func (o BudgetNotificationOutput) ThresholdType() pulumi.StringOutput

(Required) What kind of threshold is defined. Can be `PERCENTAGE` OR `ABSOLUTE_VALUE`.

func (BudgetNotificationOutput) ToBudgetNotificationOutput 

func (o BudgetNotificationOutput) ToBudgetNotificationOutput() BudgetNotificationOutput

func (BudgetNotificationOutput) ToBudgetNotificationOutputWithContext 

func (o BudgetNotificationOutput) ToBudgetNotificationOutputWithContext(ctx context.Context) BudgetNotificationOutput

type BudgetOutput added in v3.13.0 

type BudgetOutput struct {
	*pulumi.OutputState
}

func (BudgetOutput) ElementType added in v3.13.0 

func (BudgetOutput) ElementType() reflect.Type

func (BudgetOutput) ToBudgetOutput added in v3.13.0 

func (o BudgetOutput) ToBudgetOutput() BudgetOutput

func (BudgetOutput) ToBudgetOutputWithContext added in v3.13.0 

func (o BudgetOutput) ToBudgetOutputWithContext(ctx context.Context) BudgetOutput

func (BudgetOutput) ToBudgetPtrOutput added in v3.25.0 

func (o BudgetOutput) ToBudgetPtrOutput() BudgetPtrOutput

func (BudgetOutput) ToBudgetPtrOutputWithContext added in v3.25.0 

func (o BudgetOutput) ToBudgetPtrOutputWithContext(ctx context.Context) BudgetPtrOutput

type BudgetPtrInput added in v3.25.0 

type BudgetPtrInput interface {
	pulumi.Input

	ToBudgetPtrOutput() BudgetPtrOutput
	ToBudgetPtrOutputWithContext(ctx context.Context) BudgetPtrOutput
}

type BudgetPtrOutput added in v3.25.0 

type BudgetPtrOutput struct {
	*pulumi.OutputState
}

func (BudgetPtrOutput) ElementType added in v3.25.0 

func (BudgetPtrOutput) ElementType() reflect.Type

func (BudgetPtrOutput) ToBudgetPtrOutput added in v3.25.0 

func (o BudgetPtrOutput) ToBudgetPtrOutput() BudgetPtrOutput

func (BudgetPtrOutput) ToBudgetPtrOutputWithContext added in v3.25.0 

func (o BudgetPtrOutput) ToBudgetPtrOutputWithContext(ctx context.Context) BudgetPtrOutput

type BudgetState 

type BudgetState struct {
	// The ID of the target account for budget. Will use current user's accountId by default if omitted.
	AccountId pulumi.StringPtrInput
	// The ARN of the budget.
	Arn pulumi.StringPtrInput
	// Whether this budget tracks monetary cost or usage.
	BudgetType pulumi.StringPtrInput
	// Map of Cost Filters key/value pairs to apply to the budget.
	CostFilters pulumi.StringMapInput
	// Object containing Cost Types The types of cost included in a budget, such as tax and subscriptions..
	CostTypes BudgetCostTypesPtrInput
	// The amount of cost or usage being measured for a budget.
	LimitAmount pulumi.StringPtrInput
	// The unit of measurement used for the budget forecast, actual spend, or budget threshold, such as dollars or GB. See [Spend](http://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/data-type-spend.html) documentation.
	LimitUnit pulumi.StringPtrInput
	// The name of a budget. Unique within accounts.
	Name pulumi.StringPtrInput
	// The prefix of the name of a budget. Unique within accounts.
	NamePrefix pulumi.StringPtrInput
	// Object containing Budget Notifications. Can be used multiple times to define more than one budget notification
	Notifications BudgetNotificationArrayInput
	// The end of the time period covered by the budget. There are no restrictions on the end date. Format: `2017-01-01_12:00`.
	TimePeriodEnd pulumi.StringPtrInput
	// The start of the time period covered by the budget. The start date must come before the end date. Format: `2017-01-01_12:00`.
	TimePeriodStart pulumi.StringPtrInput
	// The length of time until a budget resets the actual and forecasted spend. Valid values: `MONTHLY`, `QUARTERLY`, `ANNUALLY`, and `DAILY`.
	TimeUnit pulumi.StringPtrInput
}

func (BudgetState) ElementType 

func (BudgetState) ElementType() reflect.Type

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.