account

package
v6.32.0 Latest Latest
Warning

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

 Go to latest Published: Apr 19, 2024 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 AlternativeContact 

type AlternativeContact struct {
	pulumi.CustomResourceState

	// ID of the target account when managing member accounts. Will manage current user's account by default if omitted.
	AccountId pulumi.StringPtrOutput `pulumi:"accountId"`
	// Type of the alternate contact. Allowed values are: `BILLING`, `OPERATIONS`, `SECURITY`.
	AlternateContactType pulumi.StringOutput `pulumi:"alternateContactType"`
	// An email address for the alternate contact.
	EmailAddress pulumi.StringOutput `pulumi:"emailAddress"`
	// Name of the alternate contact.
	Name pulumi.StringOutput `pulumi:"name"`
	// Phone number for the alternate contact.
	PhoneNumber pulumi.StringOutput `pulumi:"phoneNumber"`
	// Title for the alternate contact.
	Title pulumi.StringOutput `pulumi:"title"`
}

Manages the specified alternate contact attached to an AWS Account.

## Example Usage

<!--Start PulumiCodeChooser --> ```go package main

import ( 

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

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := account.NewAlternativeContact(ctx, "operations", &account.AlternativeContactArgs{
			AlternateContactType: pulumi.String("OPERATIONS"),
			Name:                 pulumi.String("Example"),
			Title:                pulumi.String("Example"),
			EmailAddress:         pulumi.String("test@example.com"),
			PhoneNumber:          pulumi.String("+1234567890"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

## Import

Import the Alternate Contact for another account using the `account_id` and `alternate_contact_type` separated by a forward slash (`/`):

__Using `pulumi import` to import__ the Alternate Contact for the current or another account using the `alternate_contact_type`. For example:

Import the Alternate Contact for the current account:

```sh $ pulumi import aws:account/alternativeContact:AlternativeContact operations OPERATIONS ``` Import the Alternate Contact for another account using the `account_id` and `alternate_contact_type` separated by a forward slash (`/`):

```sh $ pulumi import aws:account/alternativeContact:AlternativeContact operations 1234567890/OPERATIONS ```

func GetAlternativeContact 

func GetAlternativeContact(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *AlternativeContactState, opts ...pulumi.ResourceOption) (*AlternativeContact, error)

GetAlternativeContact gets an existing AlternativeContact 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 NewAlternativeContact 

func NewAlternativeContact(ctx *pulumi.Context,
	name string, args *AlternativeContactArgs, opts ...pulumi.ResourceOption) (*AlternativeContact, error)

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

func (*AlternativeContact) ElementType 

func (*AlternativeContact) ElementType() reflect.Type

func (*AlternativeContact) ToAlternativeContactOutput 

func (i *AlternativeContact) ToAlternativeContactOutput() AlternativeContactOutput

func (*AlternativeContact) ToAlternativeContactOutputWithContext 

func (i *AlternativeContact) ToAlternativeContactOutputWithContext(ctx context.Context) AlternativeContactOutput

type AlternativeContactArgs 

type AlternativeContactArgs struct {
	// ID of the target account when managing member accounts. Will manage current user's account by default if omitted.
	AccountId pulumi.StringPtrInput
	// Type of the alternate contact. Allowed values are: `BILLING`, `OPERATIONS`, `SECURITY`.
	AlternateContactType pulumi.StringInput
	// An email address for the alternate contact.
	EmailAddress pulumi.StringInput
	// Name of the alternate contact.
	Name pulumi.StringPtrInput
	// Phone number for the alternate contact.
	PhoneNumber pulumi.StringInput
	// Title for the alternate contact.
	Title pulumi.StringInput
}

The set of arguments for constructing a AlternativeContact resource.

func (AlternativeContactArgs) ElementType 

func (AlternativeContactArgs) ElementType() reflect.Type

type AlternativeContactArray 

type AlternativeContactArray []AlternativeContactInput

func (AlternativeContactArray) ElementType 

func (AlternativeContactArray) ElementType() reflect.Type

func (AlternativeContactArray) ToAlternativeContactArrayOutput 

func (i AlternativeContactArray) ToAlternativeContactArrayOutput() AlternativeContactArrayOutput

func (AlternativeContactArray) ToAlternativeContactArrayOutputWithContext 

func (i AlternativeContactArray) ToAlternativeContactArrayOutputWithContext(ctx context.Context) AlternativeContactArrayOutput

type AlternativeContactArrayInput 

type AlternativeContactArrayInput interface {
	pulumi.Input

	ToAlternativeContactArrayOutput() AlternativeContactArrayOutput
	ToAlternativeContactArrayOutputWithContext(context.Context) AlternativeContactArrayOutput
}

AlternativeContactArrayInput is an input type that accepts AlternativeContactArray and AlternativeContactArrayOutput values. You can construct a concrete instance of `AlternativeContactArrayInput` via: 

AlternativeContactArray{ AlternativeContactArgs{...} }

type AlternativeContactArrayOutput 

type AlternativeContactArrayOutput struct{ *pulumi.OutputState }

func (AlternativeContactArrayOutput) ElementType 

func (AlternativeContactArrayOutput) ElementType() reflect.Type

func (AlternativeContactArrayOutput) Index 

func (o AlternativeContactArrayOutput) Index(i pulumi.IntInput) AlternativeContactOutput

func (AlternativeContactArrayOutput) ToAlternativeContactArrayOutput 

func (o AlternativeContactArrayOutput) ToAlternativeContactArrayOutput() AlternativeContactArrayOutput

func (AlternativeContactArrayOutput) ToAlternativeContactArrayOutputWithContext 

func (o AlternativeContactArrayOutput) ToAlternativeContactArrayOutputWithContext(ctx context.Context) AlternativeContactArrayOutput

type AlternativeContactInput 

type AlternativeContactInput interface {
	pulumi.Input

	ToAlternativeContactOutput() AlternativeContactOutput
	ToAlternativeContactOutputWithContext(ctx context.Context) AlternativeContactOutput
}

type AlternativeContactMap 

type AlternativeContactMap map[string]AlternativeContactInput

func (AlternativeContactMap) ElementType 

func (AlternativeContactMap) ElementType() reflect.Type

func (AlternativeContactMap) ToAlternativeContactMapOutput 

func (i AlternativeContactMap) ToAlternativeContactMapOutput() AlternativeContactMapOutput

func (AlternativeContactMap) ToAlternativeContactMapOutputWithContext 

func (i AlternativeContactMap) ToAlternativeContactMapOutputWithContext(ctx context.Context) AlternativeContactMapOutput

type AlternativeContactMapInput 

type AlternativeContactMapInput interface {
	pulumi.Input

	ToAlternativeContactMapOutput() AlternativeContactMapOutput
	ToAlternativeContactMapOutputWithContext(context.Context) AlternativeContactMapOutput
}

AlternativeContactMapInput is an input type that accepts AlternativeContactMap and AlternativeContactMapOutput values. You can construct a concrete instance of `AlternativeContactMapInput` via: 

AlternativeContactMap{ "key": AlternativeContactArgs{...} }

type AlternativeContactMapOutput 

type AlternativeContactMapOutput struct{ *pulumi.OutputState }

func (AlternativeContactMapOutput) ElementType 

func (AlternativeContactMapOutput) ElementType() reflect.Type

func (AlternativeContactMapOutput) MapIndex 

func (o AlternativeContactMapOutput) MapIndex(k pulumi.StringInput) AlternativeContactOutput

func (AlternativeContactMapOutput) ToAlternativeContactMapOutput 

func (o AlternativeContactMapOutput) ToAlternativeContactMapOutput() AlternativeContactMapOutput

func (AlternativeContactMapOutput) ToAlternativeContactMapOutputWithContext 

func (o AlternativeContactMapOutput) ToAlternativeContactMapOutputWithContext(ctx context.Context) AlternativeContactMapOutput

type AlternativeContactOutput 

type AlternativeContactOutput struct{ *pulumi.OutputState }

func (AlternativeContactOutput) AccountId 

func (o AlternativeContactOutput) AccountId() pulumi.StringPtrOutput

ID of the target account when managing member accounts. Will manage current user's account by default if omitted.

func (AlternativeContactOutput) AlternateContactType 

func (o AlternativeContactOutput) AlternateContactType() pulumi.StringOutput

Type of the alternate contact. Allowed values are: `BILLING`, `OPERATIONS`, `SECURITY`.

func (AlternativeContactOutput) ElementType 

func (AlternativeContactOutput) ElementType() reflect.Type

func (AlternativeContactOutput) EmailAddress 

func (o AlternativeContactOutput) EmailAddress() pulumi.StringOutput

An email address for the alternate contact.

func (AlternativeContactOutput) Name 

func (o AlternativeContactOutput) Name() pulumi.StringOutput

Name of the alternate contact.

func (AlternativeContactOutput) PhoneNumber 

func (o AlternativeContactOutput) PhoneNumber() pulumi.StringOutput

Phone number for the alternate contact.

func (AlternativeContactOutput) Title 

func (o AlternativeContactOutput) Title() pulumi.StringOutput

Title for the alternate contact.

func (AlternativeContactOutput) ToAlternativeContactOutput 

func (o AlternativeContactOutput) ToAlternativeContactOutput() AlternativeContactOutput

func (AlternativeContactOutput) ToAlternativeContactOutputWithContext 

func (o AlternativeContactOutput) ToAlternativeContactOutputWithContext(ctx context.Context) AlternativeContactOutput

type AlternativeContactState 

type AlternativeContactState struct {
	// ID of the target account when managing member accounts. Will manage current user's account by default if omitted.
	AccountId pulumi.StringPtrInput
	// Type of the alternate contact. Allowed values are: `BILLING`, `OPERATIONS`, `SECURITY`.
	AlternateContactType pulumi.StringPtrInput
	// An email address for the alternate contact.
	EmailAddress pulumi.StringPtrInput
	// Name of the alternate contact.
	Name pulumi.StringPtrInput
	// Phone number for the alternate contact.
	PhoneNumber pulumi.StringPtrInput
	// Title for the alternate contact.
	Title pulumi.StringPtrInput
}

func (AlternativeContactState) ElementType 

func (AlternativeContactState) ElementType() reflect.Type

type PrimaryContact 

type PrimaryContact struct {
	pulumi.CustomResourceState

	// The ID of the target account when managing member accounts. Will manage current user's account by default if omitted.
	AccountId pulumi.StringPtrOutput `pulumi:"accountId"`
	// The first line of the primary contact address.
	AddressLine1 pulumi.StringOutput `pulumi:"addressLine1"`
	// The second line of the primary contact address, if any.
	AddressLine2 pulumi.StringPtrOutput `pulumi:"addressLine2"`
	// The third line of the primary contact address, if any.
	AddressLine3 pulumi.StringPtrOutput `pulumi:"addressLine3"`
	// The city of the primary contact address.
	City pulumi.StringOutput `pulumi:"city"`
	// The name of the company associated with the primary contact information, if any.
	CompanyName pulumi.StringPtrOutput `pulumi:"companyName"`
	// The ISO-3166 two-letter country code for the primary contact address.
	CountryCode pulumi.StringOutput `pulumi:"countryCode"`
	// The district or county of the primary contact address, if any.
	DistrictOrCounty pulumi.StringPtrOutput `pulumi:"districtOrCounty"`
	// The full name of the primary contact address.
	FullName pulumi.StringOutput `pulumi:"fullName"`
	// The phone number of the primary contact information. The number will be validated and, in some countries, checked for activation.
	PhoneNumber pulumi.StringOutput `pulumi:"phoneNumber"`
	// The postal code of the primary contact address.
	PostalCode pulumi.StringOutput `pulumi:"postalCode"`
	// The state or region of the primary contact address. This field is required in selected countries.
	StateOrRegion pulumi.StringPtrOutput `pulumi:"stateOrRegion"`
	// The URL of the website associated with the primary contact information, if any.
	WebsiteUrl pulumi.StringPtrOutput `pulumi:"websiteUrl"`
}

Manages the specified primary contact information associated with an AWS Account.

## Example Usage

<!--Start PulumiCodeChooser --> ```go package main

import ( 

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

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := account.NewPrimaryContact(ctx, "test", &account.PrimaryContactArgs{
			AddressLine1:     pulumi.String("123 Any Street"),
			City:             pulumi.String("Seattle"),
			CompanyName:      pulumi.String("Example Corp, Inc."),
			CountryCode:      pulumi.String("US"),
			DistrictOrCounty: pulumi.String("King"),
			FullName:         pulumi.String("My Name"),
			PhoneNumber:      pulumi.String("+64211111111"),
			PostalCode:       pulumi.String("98101"),
			StateOrRegion:    pulumi.String("WA"),
			WebsiteUrl:       pulumi.String("https://www.examplecorp.com"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

## Import

Using `pulumi import`, import the Primary Contact using the `account_id`. For example:

```sh $ pulumi import aws:account/primaryContact:PrimaryContact test 1234567890 ```

func GetPrimaryContact 

func GetPrimaryContact(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *PrimaryContactState, opts ...pulumi.ResourceOption) (*PrimaryContact, error)

GetPrimaryContact gets an existing PrimaryContact 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 NewPrimaryContact 

func NewPrimaryContact(ctx *pulumi.Context,
	name string, args *PrimaryContactArgs, opts ...pulumi.ResourceOption) (*PrimaryContact, error)

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

func (*PrimaryContact) ElementType 

func (*PrimaryContact) ElementType() reflect.Type

func (*PrimaryContact) ToPrimaryContactOutput 

func (i *PrimaryContact) ToPrimaryContactOutput() PrimaryContactOutput

func (*PrimaryContact) ToPrimaryContactOutputWithContext 

func (i *PrimaryContact) ToPrimaryContactOutputWithContext(ctx context.Context) PrimaryContactOutput

type PrimaryContactArgs 

type PrimaryContactArgs struct {
	// The ID of the target account when managing member accounts. Will manage current user's account by default if omitted.
	AccountId pulumi.StringPtrInput
	// The first line of the primary contact address.
	AddressLine1 pulumi.StringInput
	// The second line of the primary contact address, if any.
	AddressLine2 pulumi.StringPtrInput
	// The third line of the primary contact address, if any.
	AddressLine3 pulumi.StringPtrInput
	// The city of the primary contact address.
	City pulumi.StringInput
	// The name of the company associated with the primary contact information, if any.
	CompanyName pulumi.StringPtrInput
	// The ISO-3166 two-letter country code for the primary contact address.
	CountryCode pulumi.StringInput
	// The district or county of the primary contact address, if any.
	DistrictOrCounty pulumi.StringPtrInput
	// The full name of the primary contact address.
	FullName pulumi.StringInput
	// The phone number of the primary contact information. The number will be validated and, in some countries, checked for activation.
	PhoneNumber pulumi.StringInput
	// The postal code of the primary contact address.
	PostalCode pulumi.StringInput
	// The state or region of the primary contact address. This field is required in selected countries.
	StateOrRegion pulumi.StringPtrInput
	// The URL of the website associated with the primary contact information, if any.
	WebsiteUrl pulumi.StringPtrInput
}

The set of arguments for constructing a PrimaryContact resource.

func (PrimaryContactArgs) ElementType 

func (PrimaryContactArgs) ElementType() reflect.Type

type PrimaryContactArray 

type PrimaryContactArray []PrimaryContactInput

func (PrimaryContactArray) ElementType 

func (PrimaryContactArray) ElementType() reflect.Type

func (PrimaryContactArray) ToPrimaryContactArrayOutput 

func (i PrimaryContactArray) ToPrimaryContactArrayOutput() PrimaryContactArrayOutput

func (PrimaryContactArray) ToPrimaryContactArrayOutputWithContext 

func (i PrimaryContactArray) ToPrimaryContactArrayOutputWithContext(ctx context.Context) PrimaryContactArrayOutput

type PrimaryContactArrayInput 

type PrimaryContactArrayInput interface {
	pulumi.Input

	ToPrimaryContactArrayOutput() PrimaryContactArrayOutput
	ToPrimaryContactArrayOutputWithContext(context.Context) PrimaryContactArrayOutput
}

PrimaryContactArrayInput is an input type that accepts PrimaryContactArray and PrimaryContactArrayOutput values. You can construct a concrete instance of `PrimaryContactArrayInput` via: 

PrimaryContactArray{ PrimaryContactArgs{...} }

type PrimaryContactArrayOutput 

type PrimaryContactArrayOutput struct{ *pulumi.OutputState }

func (PrimaryContactArrayOutput) ElementType 

func (PrimaryContactArrayOutput) ElementType() reflect.Type

func (PrimaryContactArrayOutput) Index 

func (o PrimaryContactArrayOutput) Index(i pulumi.IntInput) PrimaryContactOutput

func (PrimaryContactArrayOutput) ToPrimaryContactArrayOutput 

func (o PrimaryContactArrayOutput) ToPrimaryContactArrayOutput() PrimaryContactArrayOutput

func (PrimaryContactArrayOutput) ToPrimaryContactArrayOutputWithContext 

func (o PrimaryContactArrayOutput) ToPrimaryContactArrayOutputWithContext(ctx context.Context) PrimaryContactArrayOutput

type PrimaryContactInput 

type PrimaryContactInput interface {
	pulumi.Input

	ToPrimaryContactOutput() PrimaryContactOutput
	ToPrimaryContactOutputWithContext(ctx context.Context) PrimaryContactOutput
}

type PrimaryContactMap 

type PrimaryContactMap map[string]PrimaryContactInput

func (PrimaryContactMap) ElementType 

func (PrimaryContactMap) ElementType() reflect.Type

func (PrimaryContactMap) ToPrimaryContactMapOutput 

func (i PrimaryContactMap) ToPrimaryContactMapOutput() PrimaryContactMapOutput

func (PrimaryContactMap) ToPrimaryContactMapOutputWithContext 

func (i PrimaryContactMap) ToPrimaryContactMapOutputWithContext(ctx context.Context) PrimaryContactMapOutput

type PrimaryContactMapInput 

type PrimaryContactMapInput interface {
	pulumi.Input

	ToPrimaryContactMapOutput() PrimaryContactMapOutput
	ToPrimaryContactMapOutputWithContext(context.Context) PrimaryContactMapOutput
}

PrimaryContactMapInput is an input type that accepts PrimaryContactMap and PrimaryContactMapOutput values. You can construct a concrete instance of `PrimaryContactMapInput` via: 

PrimaryContactMap{ "key": PrimaryContactArgs{...} }

type PrimaryContactMapOutput 

type PrimaryContactMapOutput struct{ *pulumi.OutputState }

func (PrimaryContactMapOutput) ElementType 

func (PrimaryContactMapOutput) ElementType() reflect.Type

func (PrimaryContactMapOutput) MapIndex 

func (o PrimaryContactMapOutput) MapIndex(k pulumi.StringInput) PrimaryContactOutput

func (PrimaryContactMapOutput) ToPrimaryContactMapOutput 

func (o PrimaryContactMapOutput) ToPrimaryContactMapOutput() PrimaryContactMapOutput

func (PrimaryContactMapOutput) ToPrimaryContactMapOutputWithContext 

func (o PrimaryContactMapOutput) ToPrimaryContactMapOutputWithContext(ctx context.Context) PrimaryContactMapOutput

type PrimaryContactOutput 

type PrimaryContactOutput struct{ *pulumi.OutputState }

func (PrimaryContactOutput) AccountId 

func (o PrimaryContactOutput) AccountId() pulumi.StringPtrOutput

The ID of the target account when managing member accounts. Will manage current user's account by default if omitted.

func (PrimaryContactOutput) AddressLine1 

func (o PrimaryContactOutput) AddressLine1() pulumi.StringOutput

The first line of the primary contact address.

func (PrimaryContactOutput) AddressLine2 

func (o PrimaryContactOutput) AddressLine2() pulumi.StringPtrOutput

The second line of the primary contact address, if any.

func (PrimaryContactOutput) AddressLine3 

func (o PrimaryContactOutput) AddressLine3() pulumi.StringPtrOutput

The third line of the primary contact address, if any.

func (PrimaryContactOutput) City 

func (o PrimaryContactOutput) City() pulumi.StringOutput

The city of the primary contact address.

func (PrimaryContactOutput) CompanyName 

func (o PrimaryContactOutput) CompanyName() pulumi.StringPtrOutput

The name of the company associated with the primary contact information, if any.

func (PrimaryContactOutput) CountryCode 

func (o PrimaryContactOutput) CountryCode() pulumi.StringOutput

The ISO-3166 two-letter country code for the primary contact address.

func (PrimaryContactOutput) DistrictOrCounty 

func (o PrimaryContactOutput) DistrictOrCounty() pulumi.StringPtrOutput

The district or county of the primary contact address, if any.

func (PrimaryContactOutput) ElementType 

func (PrimaryContactOutput) ElementType() reflect.Type

func (PrimaryContactOutput) FullName 

func (o PrimaryContactOutput) FullName() pulumi.StringOutput

The full name of the primary contact address.

func (PrimaryContactOutput) PhoneNumber 

func (o PrimaryContactOutput) PhoneNumber() pulumi.StringOutput

The phone number of the primary contact information. The number will be validated and, in some countries, checked for activation.

func (PrimaryContactOutput) PostalCode 

func (o PrimaryContactOutput) PostalCode() pulumi.StringOutput

The postal code of the primary contact address.

func (PrimaryContactOutput) StateOrRegion 

func (o PrimaryContactOutput) StateOrRegion() pulumi.StringPtrOutput

The state or region of the primary contact address. This field is required in selected countries.

func (PrimaryContactOutput) ToPrimaryContactOutput 

func (o PrimaryContactOutput) ToPrimaryContactOutput() PrimaryContactOutput

func (PrimaryContactOutput) ToPrimaryContactOutputWithContext 

func (o PrimaryContactOutput) ToPrimaryContactOutputWithContext(ctx context.Context) PrimaryContactOutput

func (PrimaryContactOutput) WebsiteUrl 

func (o PrimaryContactOutput) WebsiteUrl() pulumi.StringPtrOutput

The URL of the website associated with the primary contact information, if any.

type PrimaryContactState 

type PrimaryContactState struct {
	// The ID of the target account when managing member accounts. Will manage current user's account by default if omitted.
	AccountId pulumi.StringPtrInput
	// The first line of the primary contact address.
	AddressLine1 pulumi.StringPtrInput
	// The second line of the primary contact address, if any.
	AddressLine2 pulumi.StringPtrInput
	// The third line of the primary contact address, if any.
	AddressLine3 pulumi.StringPtrInput
	// The city of the primary contact address.
	City pulumi.StringPtrInput
	// The name of the company associated with the primary contact information, if any.
	CompanyName pulumi.StringPtrInput
	// The ISO-3166 two-letter country code for the primary contact address.
	CountryCode pulumi.StringPtrInput
	// The district or county of the primary contact address, if any.
	DistrictOrCounty pulumi.StringPtrInput
	// The full name of the primary contact address.
	FullName pulumi.StringPtrInput
	// The phone number of the primary contact information. The number will be validated and, in some countries, checked for activation.
	PhoneNumber pulumi.StringPtrInput
	// The postal code of the primary contact address.
	PostalCode pulumi.StringPtrInput
	// The state or region of the primary contact address. This field is required in selected countries.
	StateOrRegion pulumi.StringPtrInput
	// The URL of the website associated with the primary contact information, if any.
	WebsiteUrl pulumi.StringPtrInput
}

func (PrimaryContactState) ElementType 

func (PrimaryContactState) ElementType() reflect.Type

type Region added in v6.27.0 

type Region struct {
	pulumi.CustomResourceState

	// The ID of the target account when managing member accounts. Will manage current user's account by default if omitted. To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account. The specified account ID must also be a member account in the same organization. The organization must have all features enabled, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin account assigned.
	AccountId pulumi.StringPtrOutput `pulumi:"accountId"`
	// Whether the region is enabled.
	Enabled pulumi.BoolOutput `pulumi:"enabled"`
	// The region opt status.
	OptStatus pulumi.StringOutput `pulumi:"optStatus"`
	// The region name to manage.
	RegionName pulumi.StringOutput `pulumi:"regionName"`
}

Enable (Opt-In) or Disable (Opt-Out) a particular Region for an AWS account.

## Example Usage

<!--Start PulumiCodeChooser --> ```go package main

import ( 

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

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := account.NewRegion(ctx, "example", &account.RegionArgs{
			RegionName: pulumi.String("ap-southeast-3"),
			Enabled:    pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

## Import

Using `pulumi import`. For example:

```sh $ pulumi import aws:account/region:Region example ap-southeast-3 ```

func GetRegion added in v6.27.0 

func GetRegion(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *RegionState, opts ...pulumi.ResourceOption) (*Region, error)

GetRegion gets an existing Region 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 NewRegion added in v6.27.0 

func NewRegion(ctx *pulumi.Context,
	name string, args *RegionArgs, opts ...pulumi.ResourceOption) (*Region, error)

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

func (*Region) ElementType added in v6.27.0 

func (*Region) ElementType() reflect.Type

func (*Region) ToRegionOutput added in v6.27.0 

func (i *Region) ToRegionOutput() RegionOutput

func (*Region) ToRegionOutputWithContext added in v6.27.0 

func (i *Region) ToRegionOutputWithContext(ctx context.Context) RegionOutput

type RegionArgs added in v6.27.0 

type RegionArgs struct {
	// The ID of the target account when managing member accounts. Will manage current user's account by default if omitted. To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account. The specified account ID must also be a member account in the same organization. The organization must have all features enabled, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin account assigned.
	AccountId pulumi.StringPtrInput
	// Whether the region is enabled.
	Enabled pulumi.BoolInput
	// The region name to manage.
	RegionName pulumi.StringInput
}

The set of arguments for constructing a Region resource.

func (RegionArgs) ElementType added in v6.27.0 

func (RegionArgs) ElementType() reflect.Type

type RegionArray added in v6.27.0 

type RegionArray []RegionInput

func (RegionArray) ElementType added in v6.27.0 

func (RegionArray) ElementType() reflect.Type

func (RegionArray) ToRegionArrayOutput added in v6.27.0 

func (i RegionArray) ToRegionArrayOutput() RegionArrayOutput

func (RegionArray) ToRegionArrayOutputWithContext added in v6.27.0 

func (i RegionArray) ToRegionArrayOutputWithContext(ctx context.Context) RegionArrayOutput

type RegionArrayInput added in v6.27.0 

type RegionArrayInput interface {
	pulumi.Input

	ToRegionArrayOutput() RegionArrayOutput
	ToRegionArrayOutputWithContext(context.Context) RegionArrayOutput
}

RegionArrayInput is an input type that accepts RegionArray and RegionArrayOutput values. You can construct a concrete instance of `RegionArrayInput` via: 

RegionArray{ RegionArgs{...} }

type RegionArrayOutput added in v6.27.0 

type RegionArrayOutput struct{ *pulumi.OutputState }

func (RegionArrayOutput) ElementType added in v6.27.0 

func (RegionArrayOutput) ElementType() reflect.Type

func (RegionArrayOutput) Index added in v6.27.0 

func (o RegionArrayOutput) Index(i pulumi.IntInput) RegionOutput

func (RegionArrayOutput) ToRegionArrayOutput added in v6.27.0 

func (o RegionArrayOutput) ToRegionArrayOutput() RegionArrayOutput

func (RegionArrayOutput) ToRegionArrayOutputWithContext added in v6.27.0 

func (o RegionArrayOutput) ToRegionArrayOutputWithContext(ctx context.Context) RegionArrayOutput

type RegionInput added in v6.27.0 

type RegionInput interface {
	pulumi.Input

	ToRegionOutput() RegionOutput
	ToRegionOutputWithContext(ctx context.Context) RegionOutput
}

type RegionMap added in v6.27.0 

type RegionMap map[string]RegionInput

func (RegionMap) ElementType added in v6.27.0 

func (RegionMap) ElementType() reflect.Type

func (RegionMap) ToRegionMapOutput added in v6.27.0 

func (i RegionMap) ToRegionMapOutput() RegionMapOutput

func (RegionMap) ToRegionMapOutputWithContext added in v6.27.0 

func (i RegionMap) ToRegionMapOutputWithContext(ctx context.Context) RegionMapOutput

type RegionMapInput added in v6.27.0 

type RegionMapInput interface {
	pulumi.Input

	ToRegionMapOutput() RegionMapOutput
	ToRegionMapOutputWithContext(context.Context) RegionMapOutput
}

RegionMapInput is an input type that accepts RegionMap and RegionMapOutput values. You can construct a concrete instance of `RegionMapInput` via: 

RegionMap{ "key": RegionArgs{...} }

type RegionMapOutput added in v6.27.0 

type RegionMapOutput struct{ *pulumi.OutputState }

func (RegionMapOutput) ElementType added in v6.27.0 

func (RegionMapOutput) ElementType() reflect.Type

func (RegionMapOutput) MapIndex added in v6.27.0 

func (o RegionMapOutput) MapIndex(k pulumi.StringInput) RegionOutput

func (RegionMapOutput) ToRegionMapOutput added in v6.27.0 

func (o RegionMapOutput) ToRegionMapOutput() RegionMapOutput

func (RegionMapOutput) ToRegionMapOutputWithContext added in v6.27.0 

func (o RegionMapOutput) ToRegionMapOutputWithContext(ctx context.Context) RegionMapOutput

type RegionOutput added in v6.27.0 

type RegionOutput struct{ *pulumi.OutputState }

func (RegionOutput) AccountId added in v6.27.0 

func (o RegionOutput) AccountId() pulumi.StringPtrOutput

The ID of the target account when managing member accounts. Will manage current user's account by default if omitted. To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account. The specified account ID must also be a member account in the same organization. The organization must have all features enabled, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin account assigned.

func (RegionOutput) ElementType added in v6.27.0 

func (RegionOutput) ElementType() reflect.Type

func (RegionOutput) Enabled added in v6.27.0 

func (o RegionOutput) Enabled() pulumi.BoolOutput

Whether the region is enabled.

func (RegionOutput) OptStatus added in v6.27.0 

func (o RegionOutput) OptStatus() pulumi.StringOutput

The region opt status.

func (RegionOutput) RegionName added in v6.27.0 

func (o RegionOutput) RegionName() pulumi.StringOutput

The region name to manage.

func (RegionOutput) ToRegionOutput added in v6.27.0 

func (o RegionOutput) ToRegionOutput() RegionOutput

func (RegionOutput) ToRegionOutputWithContext added in v6.27.0 

func (o RegionOutput) ToRegionOutputWithContext(ctx context.Context) RegionOutput

type RegionState added in v6.27.0 

type RegionState struct {
	// The ID of the target account when managing member accounts. Will manage current user's account by default if omitted. To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account. The specified account ID must also be a member account in the same organization. The organization must have all features enabled, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin account assigned.
	AccountId pulumi.StringPtrInput
	// Whether the region is enabled.
	Enabled pulumi.BoolPtrInput
	// The region opt status.
	OptStatus pulumi.StringPtrInput
	// The region name to manage.
	RegionName pulumi.StringPtrInput
}

func (RegionState) ElementType added in v6.27.0 

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