costoptimizationhub

package
v6.59.0 Latest Latest
Warning

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

 Go to latest Published: Nov 11, 2024 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type EnrollmentStatus 

type EnrollmentStatus struct {
	pulumi.CustomResourceState

	// Flag to enroll member accounts of the organization if the account is the management account. No drift detection is currently supported for this argument. Default value is `false`.
	IncludeMemberAccounts pulumi.BoolOutput   `pulumi:"includeMemberAccounts"`
	Status                pulumi.StringOutput `pulumi:"status"`
}

Resource for managing AWS Cost Optimization Hub Enrollment Status.

> **TIP:** The Cost Optimization Hub only has a `us-east-1` endpoint. However, you can access the service globally with the AWS Provider from other regions. Other tools, such as the [AWS CLI](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cost-optimization-hub/index.html), may require you to specify the `us-east-1` region when using the service.

## Example Usage

### Basic Usage

```go package main

import ( 

"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/costoptimizationhub"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := costoptimizationhub.NewEnrollmentStatus(ctx, "example", nil)
		if err != nil {
			return err
		}
		return nil
	})
}

```

### Usage with all the arguments

```go package main

import ( 

"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/costoptimizationhub"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := costoptimizationhub.NewEnrollmentStatus(ctx, "example", &costoptimizationhub.EnrollmentStatusArgs{
			IncludeMemberAccounts: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

Using `pulumi import`, import Cost Optimization Hub Enrollment Status using your AWS account ID. For example:

```sh $ pulumi import aws:costoptimizationhub/enrollmentStatus:EnrollmentStatus example 111222333444 ```

func GetEnrollmentStatus 

func GetEnrollmentStatus(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *EnrollmentStatusState, opts ...pulumi.ResourceOption) (*EnrollmentStatus, error)

GetEnrollmentStatus gets an existing EnrollmentStatus 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 NewEnrollmentStatus 

func NewEnrollmentStatus(ctx *pulumi.Context,
	name string, args *EnrollmentStatusArgs, opts ...pulumi.ResourceOption) (*EnrollmentStatus, error)

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

func (*EnrollmentStatus) ElementType 

func (*EnrollmentStatus) ElementType() reflect.Type

func (*EnrollmentStatus) ToEnrollmentStatusOutput 

func (i *EnrollmentStatus) ToEnrollmentStatusOutput() EnrollmentStatusOutput

func (*EnrollmentStatus) ToEnrollmentStatusOutputWithContext 

func (i *EnrollmentStatus) ToEnrollmentStatusOutputWithContext(ctx context.Context) EnrollmentStatusOutput

type EnrollmentStatusArgs 

type EnrollmentStatusArgs struct {
	// Flag to enroll member accounts of the organization if the account is the management account. No drift detection is currently supported for this argument. Default value is `false`.
	IncludeMemberAccounts pulumi.BoolPtrInput
}

The set of arguments for constructing a EnrollmentStatus resource.

func (EnrollmentStatusArgs) ElementType 

func (EnrollmentStatusArgs) ElementType() reflect.Type

type EnrollmentStatusArray 

type EnrollmentStatusArray []EnrollmentStatusInput

func (EnrollmentStatusArray) ElementType 

func (EnrollmentStatusArray) ElementType() reflect.Type

func (EnrollmentStatusArray) ToEnrollmentStatusArrayOutput 

func (i EnrollmentStatusArray) ToEnrollmentStatusArrayOutput() EnrollmentStatusArrayOutput

func (EnrollmentStatusArray) ToEnrollmentStatusArrayOutputWithContext 

func (i EnrollmentStatusArray) ToEnrollmentStatusArrayOutputWithContext(ctx context.Context) EnrollmentStatusArrayOutput

type EnrollmentStatusArrayInput 

type EnrollmentStatusArrayInput interface {
	pulumi.Input

	ToEnrollmentStatusArrayOutput() EnrollmentStatusArrayOutput
	ToEnrollmentStatusArrayOutputWithContext(context.Context) EnrollmentStatusArrayOutput
}

EnrollmentStatusArrayInput is an input type that accepts EnrollmentStatusArray and EnrollmentStatusArrayOutput values. You can construct a concrete instance of `EnrollmentStatusArrayInput` via: 

EnrollmentStatusArray{ EnrollmentStatusArgs{...} }

type EnrollmentStatusArrayOutput 

type EnrollmentStatusArrayOutput struct{ *pulumi.OutputState }

func (EnrollmentStatusArrayOutput) ElementType 

func (EnrollmentStatusArrayOutput) ElementType() reflect.Type

func (EnrollmentStatusArrayOutput) Index 

func (o EnrollmentStatusArrayOutput) Index(i pulumi.IntInput) EnrollmentStatusOutput

func (EnrollmentStatusArrayOutput) ToEnrollmentStatusArrayOutput 

func (o EnrollmentStatusArrayOutput) ToEnrollmentStatusArrayOutput() EnrollmentStatusArrayOutput

func (EnrollmentStatusArrayOutput) ToEnrollmentStatusArrayOutputWithContext 

func (o EnrollmentStatusArrayOutput) ToEnrollmentStatusArrayOutputWithContext(ctx context.Context) EnrollmentStatusArrayOutput

type EnrollmentStatusInput 

type EnrollmentStatusInput interface {
	pulumi.Input

	ToEnrollmentStatusOutput() EnrollmentStatusOutput
	ToEnrollmentStatusOutputWithContext(ctx context.Context) EnrollmentStatusOutput
}

type EnrollmentStatusMap 

type EnrollmentStatusMap map[string]EnrollmentStatusInput

func (EnrollmentStatusMap) ElementType 

func (EnrollmentStatusMap) ElementType() reflect.Type

func (EnrollmentStatusMap) ToEnrollmentStatusMapOutput 

func (i EnrollmentStatusMap) ToEnrollmentStatusMapOutput() EnrollmentStatusMapOutput

func (EnrollmentStatusMap) ToEnrollmentStatusMapOutputWithContext 

func (i EnrollmentStatusMap) ToEnrollmentStatusMapOutputWithContext(ctx context.Context) EnrollmentStatusMapOutput

type EnrollmentStatusMapInput 

type EnrollmentStatusMapInput interface {
	pulumi.Input

	ToEnrollmentStatusMapOutput() EnrollmentStatusMapOutput
	ToEnrollmentStatusMapOutputWithContext(context.Context) EnrollmentStatusMapOutput
}

EnrollmentStatusMapInput is an input type that accepts EnrollmentStatusMap and EnrollmentStatusMapOutput values. You can construct a concrete instance of `EnrollmentStatusMapInput` via: 

EnrollmentStatusMap{ "key": EnrollmentStatusArgs{...} }

type EnrollmentStatusMapOutput 

type EnrollmentStatusMapOutput struct{ *pulumi.OutputState }

func (EnrollmentStatusMapOutput) ElementType 

func (EnrollmentStatusMapOutput) ElementType() reflect.Type

func (EnrollmentStatusMapOutput) MapIndex 

func (o EnrollmentStatusMapOutput) MapIndex(k pulumi.StringInput) EnrollmentStatusOutput

func (EnrollmentStatusMapOutput) ToEnrollmentStatusMapOutput 

func (o EnrollmentStatusMapOutput) ToEnrollmentStatusMapOutput() EnrollmentStatusMapOutput

func (EnrollmentStatusMapOutput) ToEnrollmentStatusMapOutputWithContext 

func (o EnrollmentStatusMapOutput) ToEnrollmentStatusMapOutputWithContext(ctx context.Context) EnrollmentStatusMapOutput

type EnrollmentStatusOutput 

type EnrollmentStatusOutput struct{ *pulumi.OutputState }

func (EnrollmentStatusOutput) ElementType 

func (EnrollmentStatusOutput) ElementType() reflect.Type

func (EnrollmentStatusOutput) IncludeMemberAccounts 

func (o EnrollmentStatusOutput) IncludeMemberAccounts() pulumi.BoolOutput

Flag to enroll member accounts of the organization if the account is the management account. No drift detection is currently supported for this argument. Default value is `false`.

func (EnrollmentStatusOutput) Status 

func (o EnrollmentStatusOutput) Status() pulumi.StringOutput

func (EnrollmentStatusOutput) ToEnrollmentStatusOutput 

func (o EnrollmentStatusOutput) ToEnrollmentStatusOutput() EnrollmentStatusOutput

func (EnrollmentStatusOutput) ToEnrollmentStatusOutputWithContext 

func (o EnrollmentStatusOutput) ToEnrollmentStatusOutputWithContext(ctx context.Context) EnrollmentStatusOutput

type EnrollmentStatusState 

type EnrollmentStatusState struct {
	// Flag to enroll member accounts of the organization if the account is the management account. No drift detection is currently supported for this argument. Default value is `false`.
	IncludeMemberAccounts pulumi.BoolPtrInput
	Status                pulumi.StringPtrInput
}

func (EnrollmentStatusState) ElementType 

func (EnrollmentStatusState) ElementType() reflect.Type

type Preferences 

type Preferences struct {
	pulumi.CustomResourceState

	// Customize whether the member accounts can see the "After Discounts" savings estimates. Valid values are `All` and `None`. Default value is `All`.
	MemberAccountDiscountVisibility pulumi.StringOutput `pulumi:"memberAccountDiscountVisibility"`
	// Customize how estimated monthly savings are calculated. Valid values are `BeforeDiscounts` and `AfterDiscounts`. Default value is `BeforeDiscounts`.
	SavingsEstimationMode pulumi.StringOutput `pulumi:"savingsEstimationMode"`
}

Resource for managing AWS Cost Optimization Hub Preferences.

## Example Usage

### Basic Usage

```go package main

import ( 

"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/costoptimizationhub"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := costoptimizationhub.NewPreferences(ctx, "example", nil)
		if err != nil {
			return err
		}
		return nil
	})
}

```

### Usage with all the arguments

```go package main

import ( 

"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/costoptimizationhub"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := costoptimizationhub.NewPreferences(ctx, "example", &costoptimizationhub.PreferencesArgs{
			MemberAccountDiscountVisibility: pulumi.String("None"),
			SavingsEstimationMode:           pulumi.String("AfterDiscounts"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

Using `pulumi import`, import Cost Optimization Hub Preferences using the `id`. For example:

```sh $ pulumi import aws:costoptimizationhub/preferences:Preferences example 111222333444 ```

func GetPreferences 

func GetPreferences(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *PreferencesState, opts ...pulumi.ResourceOption) (*Preferences, error)

GetPreferences gets an existing Preferences 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 NewPreferences 

func NewPreferences(ctx *pulumi.Context,
	name string, args *PreferencesArgs, opts ...pulumi.ResourceOption) (*Preferences, error)

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

func (*Preferences) ElementType 

func (*Preferences) ElementType() reflect.Type

func (*Preferences) ToPreferencesOutput 

func (i *Preferences) ToPreferencesOutput() PreferencesOutput

func (*Preferences) ToPreferencesOutputWithContext 

func (i *Preferences) ToPreferencesOutputWithContext(ctx context.Context) PreferencesOutput

type PreferencesArgs 

type PreferencesArgs struct {
	// Customize whether the member accounts can see the "After Discounts" savings estimates. Valid values are `All` and `None`. Default value is `All`.
	MemberAccountDiscountVisibility pulumi.StringPtrInput
	// Customize how estimated monthly savings are calculated. Valid values are `BeforeDiscounts` and `AfterDiscounts`. Default value is `BeforeDiscounts`.
	SavingsEstimationMode pulumi.StringPtrInput
}

The set of arguments for constructing a Preferences resource.

func (PreferencesArgs) ElementType 

func (PreferencesArgs) ElementType() reflect.Type

type PreferencesArray 

type PreferencesArray []PreferencesInput

func (PreferencesArray) ElementType 

func (PreferencesArray) ElementType() reflect.Type

func (PreferencesArray) ToPreferencesArrayOutput 

func (i PreferencesArray) ToPreferencesArrayOutput() PreferencesArrayOutput

func (PreferencesArray) ToPreferencesArrayOutputWithContext 

func (i PreferencesArray) ToPreferencesArrayOutputWithContext(ctx context.Context) PreferencesArrayOutput

type PreferencesArrayInput 

type PreferencesArrayInput interface {
	pulumi.Input

	ToPreferencesArrayOutput() PreferencesArrayOutput
	ToPreferencesArrayOutputWithContext(context.Context) PreferencesArrayOutput
}

PreferencesArrayInput is an input type that accepts PreferencesArray and PreferencesArrayOutput values. You can construct a concrete instance of `PreferencesArrayInput` via: 

PreferencesArray{ PreferencesArgs{...} }

type PreferencesArrayOutput 

type PreferencesArrayOutput struct{ *pulumi.OutputState }

func (PreferencesArrayOutput) ElementType 

func (PreferencesArrayOutput) ElementType() reflect.Type

func (PreferencesArrayOutput) Index 

func (o PreferencesArrayOutput) Index(i pulumi.IntInput) PreferencesOutput

func (PreferencesArrayOutput) ToPreferencesArrayOutput 

func (o PreferencesArrayOutput) ToPreferencesArrayOutput() PreferencesArrayOutput

func (PreferencesArrayOutput) ToPreferencesArrayOutputWithContext 

func (o PreferencesArrayOutput) ToPreferencesArrayOutputWithContext(ctx context.Context) PreferencesArrayOutput

type PreferencesInput 

type PreferencesInput interface {
	pulumi.Input

	ToPreferencesOutput() PreferencesOutput
	ToPreferencesOutputWithContext(ctx context.Context) PreferencesOutput
}

type PreferencesMap 

type PreferencesMap map[string]PreferencesInput

func (PreferencesMap) ElementType 

func (PreferencesMap) ElementType() reflect.Type

func (PreferencesMap) ToPreferencesMapOutput 

func (i PreferencesMap) ToPreferencesMapOutput() PreferencesMapOutput

func (PreferencesMap) ToPreferencesMapOutputWithContext 

func (i PreferencesMap) ToPreferencesMapOutputWithContext(ctx context.Context) PreferencesMapOutput

type PreferencesMapInput 

type PreferencesMapInput interface {
	pulumi.Input

	ToPreferencesMapOutput() PreferencesMapOutput
	ToPreferencesMapOutputWithContext(context.Context) PreferencesMapOutput
}

PreferencesMapInput is an input type that accepts PreferencesMap and PreferencesMapOutput values. You can construct a concrete instance of `PreferencesMapInput` via: 

PreferencesMap{ "key": PreferencesArgs{...} }

type PreferencesMapOutput 

type PreferencesMapOutput struct{ *pulumi.OutputState }

func (PreferencesMapOutput) ElementType 

func (PreferencesMapOutput) ElementType() reflect.Type

func (PreferencesMapOutput) MapIndex 

func (o PreferencesMapOutput) MapIndex(k pulumi.StringInput) PreferencesOutput

func (PreferencesMapOutput) ToPreferencesMapOutput 

func (o PreferencesMapOutput) ToPreferencesMapOutput() PreferencesMapOutput

func (PreferencesMapOutput) ToPreferencesMapOutputWithContext 

func (o PreferencesMapOutput) ToPreferencesMapOutputWithContext(ctx context.Context) PreferencesMapOutput

type PreferencesOutput 

type PreferencesOutput struct{ *pulumi.OutputState }

func (PreferencesOutput) ElementType 

func (PreferencesOutput) ElementType() reflect.Type

func (PreferencesOutput) MemberAccountDiscountVisibility 

func (o PreferencesOutput) MemberAccountDiscountVisibility() pulumi.StringOutput

Customize whether the member accounts can see the "After Discounts" savings estimates. Valid values are `All` and `None`. Default value is `All`.

func (PreferencesOutput) SavingsEstimationMode 

func (o PreferencesOutput) SavingsEstimationMode() pulumi.StringOutput

Customize how estimated monthly savings are calculated. Valid values are `BeforeDiscounts` and `AfterDiscounts`. Default value is `BeforeDiscounts`.

func (PreferencesOutput) ToPreferencesOutput 

func (o PreferencesOutput) ToPreferencesOutput() PreferencesOutput

func (PreferencesOutput) ToPreferencesOutputWithContext 

func (o PreferencesOutput) ToPreferencesOutputWithContext(ctx context.Context) PreferencesOutput

type PreferencesState 

type PreferencesState struct {
	// Customize whether the member accounts can see the "After Discounts" savings estimates. Valid values are `All` and `None`. Default value is `All`.
	MemberAccountDiscountVisibility pulumi.StringPtrInput
	// Customize how estimated monthly savings are calculated. Valid values are `BeforeDiscounts` and `AfterDiscounts`. Default value is `BeforeDiscounts`.
	SavingsEstimationMode pulumi.StringPtrInput
}

func (PreferencesState) ElementType 

func (PreferencesState) 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.