awscontroltower

package
v0.0.0-...-1ae1486 Latest Latest
Warning

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

 Go to latest Published: Oct 20, 2023 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Overview

A Pulumi package for creating and managing control tower accounts.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ControlTowerAwsAccount 

type ControlTowerAwsAccount struct {
	pulumi.CustomResourceState

	// ID of the AWS account.
	AccountId pulumi.StringOutput `pulumi:"accountId"`
	// If enabled, this will close the AWS account on resource deletion, beginning the 90-day suspension period. Otherwise, the
	// account will just be unenrolled from Control Tower.
	CloseAccountOnDelete pulumi.BoolPtrOutput `pulumi:"closeAccountOnDelete"`
	// Root email of the account.
	Email pulumi.StringOutput `pulumi:"email"`
	// Name of the account.
	Name pulumi.StringOutput `pulumi:"name"`
	// Name of the Organizational Unit under which the account resides.
	OrganizationalUnit pulumi.StringOutput `pulumi:"organizationalUnit"`
	// ID of the Organizational Unit to which the account should be moved when the resource is deleted. If no value is
	// provided, the account will not be moved.
	OrganizationalUnitIdOnDelete pulumi.StringPtrOutput `pulumi:"organizationalUnitIdOnDelete"`
	// Name of the path identifier of the product. This value is optional if the product has a default path, and required if
	// the product has more than one path. To list the paths for a product, use ListLaunchPaths.
	PathId pulumi.StringOutput `pulumi:"pathId"`
	// Name of the service catalog product that is provisioned. Defaults to a slugified version of the account name.
	ProvisionedProductName pulumi.StringOutput `pulumi:"provisionedProductName"`
	// Assigned SSO user settings.
	Sso ControlTowerAwsAccountSsoOutput `pulumi:"sso"`
	// Key-value map of resource tags for the account.
	Tags pulumi.StringMapOutput `pulumi:"tags"`
}

func GetControlTowerAwsAccount 

func GetControlTowerAwsAccount(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ControlTowerAwsAccountState, opts ...pulumi.ResourceOption) (*ControlTowerAwsAccount, error)

GetControlTowerAwsAccount gets an existing ControlTowerAwsAccount 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 NewControlTowerAwsAccount 

func NewControlTowerAwsAccount(ctx *pulumi.Context,
	name string, args *ControlTowerAwsAccountArgs, opts ...pulumi.ResourceOption) (*ControlTowerAwsAccount, error)

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

func (*ControlTowerAwsAccount) ElementType 

func (*ControlTowerAwsAccount) ElementType() reflect.Type

func (*ControlTowerAwsAccount) ToControlTowerAwsAccountOutput 

func (i *ControlTowerAwsAccount) ToControlTowerAwsAccountOutput() ControlTowerAwsAccountOutput

func (*ControlTowerAwsAccount) ToControlTowerAwsAccountOutputWithContext 

func (i *ControlTowerAwsAccount) ToControlTowerAwsAccountOutputWithContext(ctx context.Context) ControlTowerAwsAccountOutput

func (*ControlTowerAwsAccount) ToOutput 

func (i *ControlTowerAwsAccount) ToOutput(ctx context.Context) pulumix.Output[*ControlTowerAwsAccount]

type ControlTowerAwsAccountArgs 

type ControlTowerAwsAccountArgs struct {
	// If enabled, this will close the AWS account on resource deletion, beginning the 90-day suspension period. Otherwise, the
	// account will just be unenrolled from Control Tower.
	CloseAccountOnDelete pulumi.BoolPtrInput
	// Root email of the account.
	Email pulumi.StringInput
	// Name of the account.
	Name pulumi.StringPtrInput
	// Name of the Organizational Unit under which the account resides.
	OrganizationalUnit pulumi.StringInput
	// ID of the Organizational Unit to which the account should be moved when the resource is deleted. If no value is
	// provided, the account will not be moved.
	OrganizationalUnitIdOnDelete pulumi.StringPtrInput
	// Name of the path identifier of the product. This value is optional if the product has a default path, and required if
	// the product has more than one path. To list the paths for a product, use ListLaunchPaths.
	PathId pulumi.StringPtrInput
	// Name of the service catalog product that is provisioned. Defaults to a slugified version of the account name.
	ProvisionedProductName pulumi.StringPtrInput
	// Assigned SSO user settings.
	Sso ControlTowerAwsAccountSsoInput
	// Key-value map of resource tags for the account.
	Tags pulumi.StringMapInput
}

The set of arguments for constructing a ControlTowerAwsAccount resource.

func (ControlTowerAwsAccountArgs) ElementType 

func (ControlTowerAwsAccountArgs) ElementType() reflect.Type

type ControlTowerAwsAccountArray 

type ControlTowerAwsAccountArray []ControlTowerAwsAccountInput

func (ControlTowerAwsAccountArray) ElementType 

func (ControlTowerAwsAccountArray) ElementType() reflect.Type

func (ControlTowerAwsAccountArray) ToControlTowerAwsAccountArrayOutput 

func (i ControlTowerAwsAccountArray) ToControlTowerAwsAccountArrayOutput() ControlTowerAwsAccountArrayOutput

func (ControlTowerAwsAccountArray) ToControlTowerAwsAccountArrayOutputWithContext 

func (i ControlTowerAwsAccountArray) ToControlTowerAwsAccountArrayOutputWithContext(ctx context.Context) ControlTowerAwsAccountArrayOutput

func (ControlTowerAwsAccountArray) ToOutput 

func (i ControlTowerAwsAccountArray) ToOutput(ctx context.Context) pulumix.Output[[]*ControlTowerAwsAccount]

type ControlTowerAwsAccountArrayInput 

type ControlTowerAwsAccountArrayInput interface {
	pulumi.Input

	ToControlTowerAwsAccountArrayOutput() ControlTowerAwsAccountArrayOutput
	ToControlTowerAwsAccountArrayOutputWithContext(context.Context) ControlTowerAwsAccountArrayOutput
}

ControlTowerAwsAccountArrayInput is an input type that accepts ControlTowerAwsAccountArray and ControlTowerAwsAccountArrayOutput values. You can construct a concrete instance of `ControlTowerAwsAccountArrayInput` via: 

ControlTowerAwsAccountArray{ ControlTowerAwsAccountArgs{...} }

type ControlTowerAwsAccountArrayOutput 

type ControlTowerAwsAccountArrayOutput struct{ *pulumi.OutputState }

func (ControlTowerAwsAccountArrayOutput) ElementType 

func (ControlTowerAwsAccountArrayOutput) ElementType() reflect.Type

func (ControlTowerAwsAccountArrayOutput) Index 

func (o ControlTowerAwsAccountArrayOutput) Index(i pulumi.IntInput) ControlTowerAwsAccountOutput

func (ControlTowerAwsAccountArrayOutput) ToControlTowerAwsAccountArrayOutput 

func (o ControlTowerAwsAccountArrayOutput) ToControlTowerAwsAccountArrayOutput() ControlTowerAwsAccountArrayOutput

func (ControlTowerAwsAccountArrayOutput) ToControlTowerAwsAccountArrayOutputWithContext 

func (o ControlTowerAwsAccountArrayOutput) ToControlTowerAwsAccountArrayOutputWithContext(ctx context.Context) ControlTowerAwsAccountArrayOutput

func (ControlTowerAwsAccountArrayOutput) ToOutput 

func (o ControlTowerAwsAccountArrayOutput) ToOutput(ctx context.Context) pulumix.Output[[]*ControlTowerAwsAccount]

type ControlTowerAwsAccountInput 

type ControlTowerAwsAccountInput interface {
	pulumi.Input

	ToControlTowerAwsAccountOutput() ControlTowerAwsAccountOutput
	ToControlTowerAwsAccountOutputWithContext(ctx context.Context) ControlTowerAwsAccountOutput
}

type ControlTowerAwsAccountMap 

type ControlTowerAwsAccountMap map[string]ControlTowerAwsAccountInput

func (ControlTowerAwsAccountMap) ElementType 

func (ControlTowerAwsAccountMap) ElementType() reflect.Type

func (ControlTowerAwsAccountMap) ToControlTowerAwsAccountMapOutput 

func (i ControlTowerAwsAccountMap) ToControlTowerAwsAccountMapOutput() ControlTowerAwsAccountMapOutput

func (ControlTowerAwsAccountMap) ToControlTowerAwsAccountMapOutputWithContext 

func (i ControlTowerAwsAccountMap) ToControlTowerAwsAccountMapOutputWithContext(ctx context.Context) ControlTowerAwsAccountMapOutput

func (ControlTowerAwsAccountMap) ToOutput 

func (i ControlTowerAwsAccountMap) ToOutput(ctx context.Context) pulumix.Output[map[string]*ControlTowerAwsAccount]

type ControlTowerAwsAccountMapInput 

type ControlTowerAwsAccountMapInput interface {
	pulumi.Input

	ToControlTowerAwsAccountMapOutput() ControlTowerAwsAccountMapOutput
	ToControlTowerAwsAccountMapOutputWithContext(context.Context) ControlTowerAwsAccountMapOutput
}

ControlTowerAwsAccountMapInput is an input type that accepts ControlTowerAwsAccountMap and ControlTowerAwsAccountMapOutput values. You can construct a concrete instance of `ControlTowerAwsAccountMapInput` via: 

ControlTowerAwsAccountMap{ "key": ControlTowerAwsAccountArgs{...} }

type ControlTowerAwsAccountMapOutput 

type ControlTowerAwsAccountMapOutput struct{ *pulumi.OutputState }

func (ControlTowerAwsAccountMapOutput) ElementType 

func (ControlTowerAwsAccountMapOutput) ElementType() reflect.Type

func (ControlTowerAwsAccountMapOutput) MapIndex 

func (o ControlTowerAwsAccountMapOutput) MapIndex(k pulumi.StringInput) ControlTowerAwsAccountOutput

func (ControlTowerAwsAccountMapOutput) ToControlTowerAwsAccountMapOutput 

func (o ControlTowerAwsAccountMapOutput) ToControlTowerAwsAccountMapOutput() ControlTowerAwsAccountMapOutput

func (ControlTowerAwsAccountMapOutput) ToControlTowerAwsAccountMapOutputWithContext 

func (o ControlTowerAwsAccountMapOutput) ToControlTowerAwsAccountMapOutputWithContext(ctx context.Context) ControlTowerAwsAccountMapOutput

func (ControlTowerAwsAccountMapOutput) ToOutput 

func (o ControlTowerAwsAccountMapOutput) ToOutput(ctx context.Context) pulumix.Output[map[string]*ControlTowerAwsAccount]

type ControlTowerAwsAccountOutput 

type ControlTowerAwsAccountOutput struct{ *pulumi.OutputState }

func (ControlTowerAwsAccountOutput) AccountId 

func (o ControlTowerAwsAccountOutput) AccountId() pulumi.StringOutput

ID of the AWS account.

func (ControlTowerAwsAccountOutput) CloseAccountOnDelete 

func (o ControlTowerAwsAccountOutput) CloseAccountOnDelete() pulumi.BoolPtrOutput

If enabled, this will close the AWS account on resource deletion, beginning the 90-day suspension period. Otherwise, the account will just be unenrolled from Control Tower.

func (ControlTowerAwsAccountOutput) ElementType 

func (ControlTowerAwsAccountOutput) ElementType() reflect.Type

func (ControlTowerAwsAccountOutput) Email 

func (o ControlTowerAwsAccountOutput) Email() pulumi.StringOutput

Root email of the account.

func (ControlTowerAwsAccountOutput) Name 

func (o ControlTowerAwsAccountOutput) Name() pulumi.StringOutput

Name of the account.

func (ControlTowerAwsAccountOutput) OrganizationalUnit 

func (o ControlTowerAwsAccountOutput) OrganizationalUnit() pulumi.StringOutput

Name of the Organizational Unit under which the account resides.

func (ControlTowerAwsAccountOutput) OrganizationalUnitIdOnDelete 

func (o ControlTowerAwsAccountOutput) OrganizationalUnitIdOnDelete() pulumi.StringPtrOutput

ID of the Organizational Unit to which the account should be moved when the resource is deleted. If no value is provided, the account will not be moved.

func (ControlTowerAwsAccountOutput) PathId 

func (o ControlTowerAwsAccountOutput) PathId() pulumi.StringOutput

Name of the path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths.

func (ControlTowerAwsAccountOutput) ProvisionedProductName 

func (o ControlTowerAwsAccountOutput) ProvisionedProductName() pulumi.StringOutput

Name of the service catalog product that is provisioned. Defaults to a slugified version of the account name.

func (ControlTowerAwsAccountOutput) Sso 

func (o ControlTowerAwsAccountOutput) Sso() ControlTowerAwsAccountSsoOutput

Assigned SSO user settings.

func (ControlTowerAwsAccountOutput) Tags 

func (o ControlTowerAwsAccountOutput) Tags() pulumi.StringMapOutput

Key-value map of resource tags for the account.

func (ControlTowerAwsAccountOutput) ToControlTowerAwsAccountOutput 

func (o ControlTowerAwsAccountOutput) ToControlTowerAwsAccountOutput() ControlTowerAwsAccountOutput

func (ControlTowerAwsAccountOutput) ToControlTowerAwsAccountOutputWithContext 

func (o ControlTowerAwsAccountOutput) ToControlTowerAwsAccountOutputWithContext(ctx context.Context) ControlTowerAwsAccountOutput

func (ControlTowerAwsAccountOutput) ToOutput 

func (o ControlTowerAwsAccountOutput) ToOutput(ctx context.Context) pulumix.Output[*ControlTowerAwsAccount]

type ControlTowerAwsAccountSso 

type ControlTowerAwsAccountSso struct {
	Email     string `pulumi:"email"`
	FirstName string `pulumi:"firstName"`
	LastName  string `pulumi:"lastName"`
}

type ControlTowerAwsAccountSsoArgs 

type ControlTowerAwsAccountSsoArgs struct {
	Email     pulumi.StringInput `pulumi:"email"`
	FirstName pulumi.StringInput `pulumi:"firstName"`
	LastName  pulumi.StringInput `pulumi:"lastName"`
}

func (ControlTowerAwsAccountSsoArgs) ElementType 

func (ControlTowerAwsAccountSsoArgs) ElementType() reflect.Type

func (ControlTowerAwsAccountSsoArgs) ToControlTowerAwsAccountSsoOutput 

func (i ControlTowerAwsAccountSsoArgs) ToControlTowerAwsAccountSsoOutput() ControlTowerAwsAccountSsoOutput

func (ControlTowerAwsAccountSsoArgs) ToControlTowerAwsAccountSsoOutputWithContext 

func (i ControlTowerAwsAccountSsoArgs) ToControlTowerAwsAccountSsoOutputWithContext(ctx context.Context) ControlTowerAwsAccountSsoOutput

func (ControlTowerAwsAccountSsoArgs) ToControlTowerAwsAccountSsoPtrOutput 

func (i ControlTowerAwsAccountSsoArgs) ToControlTowerAwsAccountSsoPtrOutput() ControlTowerAwsAccountSsoPtrOutput

func (ControlTowerAwsAccountSsoArgs) ToControlTowerAwsAccountSsoPtrOutputWithContext 

func (i ControlTowerAwsAccountSsoArgs) ToControlTowerAwsAccountSsoPtrOutputWithContext(ctx context.Context) ControlTowerAwsAccountSsoPtrOutput

func (ControlTowerAwsAccountSsoArgs) ToOutput 

func (i ControlTowerAwsAccountSsoArgs) ToOutput(ctx context.Context) pulumix.Output[ControlTowerAwsAccountSso]

type ControlTowerAwsAccountSsoInput 

type ControlTowerAwsAccountSsoInput interface {
	pulumi.Input

	ToControlTowerAwsAccountSsoOutput() ControlTowerAwsAccountSsoOutput
	ToControlTowerAwsAccountSsoOutputWithContext(context.Context) ControlTowerAwsAccountSsoOutput
}

ControlTowerAwsAccountSsoInput is an input type that accepts ControlTowerAwsAccountSsoArgs and ControlTowerAwsAccountSsoOutput values. You can construct a concrete instance of `ControlTowerAwsAccountSsoInput` via: 

ControlTowerAwsAccountSsoArgs{...}

type ControlTowerAwsAccountSsoOutput 

type ControlTowerAwsAccountSsoOutput struct{ *pulumi.OutputState }

func (ControlTowerAwsAccountSsoOutput) ElementType 

func (ControlTowerAwsAccountSsoOutput) ElementType() reflect.Type

func (ControlTowerAwsAccountSsoOutput) Email 

func (o ControlTowerAwsAccountSsoOutput) Email() pulumi.StringOutput

func (ControlTowerAwsAccountSsoOutput) FirstName 

func (o ControlTowerAwsAccountSsoOutput) FirstName() pulumi.StringOutput

func (ControlTowerAwsAccountSsoOutput) LastName 

func (o ControlTowerAwsAccountSsoOutput) LastName() pulumi.StringOutput

func (ControlTowerAwsAccountSsoOutput) ToControlTowerAwsAccountSsoOutput 

func (o ControlTowerAwsAccountSsoOutput) ToControlTowerAwsAccountSsoOutput() ControlTowerAwsAccountSsoOutput

func (ControlTowerAwsAccountSsoOutput) ToControlTowerAwsAccountSsoOutputWithContext 

func (o ControlTowerAwsAccountSsoOutput) ToControlTowerAwsAccountSsoOutputWithContext(ctx context.Context) ControlTowerAwsAccountSsoOutput

func (ControlTowerAwsAccountSsoOutput) ToControlTowerAwsAccountSsoPtrOutput 

func (o ControlTowerAwsAccountSsoOutput) ToControlTowerAwsAccountSsoPtrOutput() ControlTowerAwsAccountSsoPtrOutput

func (ControlTowerAwsAccountSsoOutput) ToControlTowerAwsAccountSsoPtrOutputWithContext 

func (o ControlTowerAwsAccountSsoOutput) ToControlTowerAwsAccountSsoPtrOutputWithContext(ctx context.Context) ControlTowerAwsAccountSsoPtrOutput

func (ControlTowerAwsAccountSsoOutput) ToOutput 

func (o ControlTowerAwsAccountSsoOutput) ToOutput(ctx context.Context) pulumix.Output[ControlTowerAwsAccountSso]

type ControlTowerAwsAccountSsoPtrInput 

type ControlTowerAwsAccountSsoPtrInput interface {
	pulumi.Input

	ToControlTowerAwsAccountSsoPtrOutput() ControlTowerAwsAccountSsoPtrOutput
	ToControlTowerAwsAccountSsoPtrOutputWithContext(context.Context) ControlTowerAwsAccountSsoPtrOutput
}

ControlTowerAwsAccountSsoPtrInput is an input type that accepts ControlTowerAwsAccountSsoArgs, ControlTowerAwsAccountSsoPtr and ControlTowerAwsAccountSsoPtrOutput values. You can construct a concrete instance of `ControlTowerAwsAccountSsoPtrInput` via: 

        ControlTowerAwsAccountSsoArgs{...}

or:

        nil

func ControlTowerAwsAccountSsoPtr 

func ControlTowerAwsAccountSsoPtr(v *ControlTowerAwsAccountSsoArgs) ControlTowerAwsAccountSsoPtrInput

type ControlTowerAwsAccountSsoPtrOutput 

type ControlTowerAwsAccountSsoPtrOutput struct{ *pulumi.OutputState }

func (ControlTowerAwsAccountSsoPtrOutput) Elem 

func (o ControlTowerAwsAccountSsoPtrOutput) Elem() ControlTowerAwsAccountSsoOutput

func (ControlTowerAwsAccountSsoPtrOutput) ElementType 

func (ControlTowerAwsAccountSsoPtrOutput) ElementType() reflect.Type

func (ControlTowerAwsAccountSsoPtrOutput) Email 

func (o ControlTowerAwsAccountSsoPtrOutput) Email() pulumi.StringPtrOutput

func (ControlTowerAwsAccountSsoPtrOutput) FirstName 

func (o ControlTowerAwsAccountSsoPtrOutput) FirstName() pulumi.StringPtrOutput

func (ControlTowerAwsAccountSsoPtrOutput) LastName 

func (o ControlTowerAwsAccountSsoPtrOutput) LastName() pulumi.StringPtrOutput

func (ControlTowerAwsAccountSsoPtrOutput) ToControlTowerAwsAccountSsoPtrOutput 

func (o ControlTowerAwsAccountSsoPtrOutput) ToControlTowerAwsAccountSsoPtrOutput() ControlTowerAwsAccountSsoPtrOutput

func (ControlTowerAwsAccountSsoPtrOutput) ToControlTowerAwsAccountSsoPtrOutputWithContext 

func (o ControlTowerAwsAccountSsoPtrOutput) ToControlTowerAwsAccountSsoPtrOutputWithContext(ctx context.Context) ControlTowerAwsAccountSsoPtrOutput

func (ControlTowerAwsAccountSsoPtrOutput) ToOutput 

func (o ControlTowerAwsAccountSsoPtrOutput) ToOutput(ctx context.Context) pulumix.Output[*ControlTowerAwsAccountSso]

type ControlTowerAwsAccountState 

type ControlTowerAwsAccountState struct {
	// ID of the AWS account.
	AccountId pulumi.StringPtrInput
	// If enabled, this will close the AWS account on resource deletion, beginning the 90-day suspension period. Otherwise, the
	// account will just be unenrolled from Control Tower.
	CloseAccountOnDelete pulumi.BoolPtrInput
	// Root email of the account.
	Email pulumi.StringPtrInput
	// Name of the account.
	Name pulumi.StringPtrInput
	// Name of the Organizational Unit under which the account resides.
	OrganizationalUnit pulumi.StringPtrInput
	// ID of the Organizational Unit to which the account should be moved when the resource is deleted. If no value is
	// provided, the account will not be moved.
	OrganizationalUnitIdOnDelete pulumi.StringPtrInput
	// Name of the path identifier of the product. This value is optional if the product has a default path, and required if
	// the product has more than one path. To list the paths for a product, use ListLaunchPaths.
	PathId pulumi.StringPtrInput
	// Name of the service catalog product that is provisioned. Defaults to a slugified version of the account name.
	ProvisionedProductName pulumi.StringPtrInput
	// Assigned SSO user settings.
	Sso ControlTowerAwsAccountSsoPtrInput
	// Key-value map of resource tags for the account.
	Tags pulumi.StringMapInput
}

func (ControlTowerAwsAccountState) ElementType 

func (ControlTowerAwsAccountState) ElementType() reflect.Type

type Provider 

type Provider struct {
	pulumi.ProviderResourceState

	// This is the AWS access key. It must be provided, but it can also be sourced from the `AWS_ACCESS_KEY_ID` environment
	// variable, or via a shared credentials file if `profile` is specified.
	AccessKey pulumi.StringPtrOutput `pulumi:"accessKey"`
	// This is the AWS profile name as set in the shared credentials file.
	Profile pulumi.StringPtrOutput `pulumi:"profile"`
	// This is the AWS region. It must be provided, but it can also be sourced from the `AWS_DEFAULT_REGION` environment
	// variables, or via a shared credentials file if `profile` is specified.
	Region pulumi.StringOutput `pulumi:"region"`
	// This is the AWS secret key. It must be provided, but it can also be sourced from the `AWS_SECRET_ACCESS_KEY` environment
	// variable, or via a shared credentials file if `profile` is specified.
	SecretKey pulumi.StringPtrOutput `pulumi:"secretKey"`
	// This is the path to the shared credentials file. If this is not set and a profile is specified, `~/.aws/credentials`
	// will be used.
	SharedCredentialsFile pulumi.StringPtrOutput `pulumi:"sharedCredentialsFile"`
	// Session token for validating temporary credentials. Typically provided after successful identity federation or
	// Multi-Factor Authentication (MFA) login. With MFA login, this is the session token provided afterward, not the 6 digit
	// MFA code used to get temporary credentials. It can also be sourced from the `AWS_SESSION_TOKEN` environment variable.
	Token pulumi.StringPtrOutput `pulumi:"token"`
}

The provider type for the awscontroltower package. By default, resources use package-wide configuration settings, however an explicit `Provider` instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the [documentation](https://www.pulumi.com/docs/reference/programming-model/#providers) for more information.

func NewProvider 

func NewProvider(ctx *pulumi.Context,
	name string, args *ProviderArgs, opts ...pulumi.ResourceOption) (*Provider, error)

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

func (*Provider) ElementType 

func (*Provider) ElementType() reflect.Type

func (*Provider) ToOutput 

func (i *Provider) ToOutput(ctx context.Context) pulumix.Output[*Provider]

func (*Provider) ToProviderOutput 

func (i *Provider) ToProviderOutput() ProviderOutput

func (*Provider) ToProviderOutputWithContext 

func (i *Provider) ToProviderOutputWithContext(ctx context.Context) ProviderOutput

type ProviderArgs 

type ProviderArgs struct {
	// This is the AWS access key. It must be provided, but it can also be sourced from the `AWS_ACCESS_KEY_ID` environment
	// variable, or via a shared credentials file if `profile` is specified.
	AccessKey pulumi.StringPtrInput
	// Settings for making use of the AWS Assume Role functionality.
	AssumeRole ProviderAssumeRolePtrInput
	// This is the maximum number of times an API call is retried, in the case where requests are being throttled or
	// experiencing transient failures. The delay between the subsequent API calls increases exponentially. If omitted, the
	// default value is `25`.
	MaxRetries pulumi.IntPtrInput
	// This is the AWS profile name as set in the shared credentials file.
	Profile pulumi.StringPtrInput
	// This is the AWS region. It must be provided, but it can also be sourced from the `AWS_DEFAULT_REGION` environment
	// variables, or via a shared credentials file if `profile` is specified.
	Region pulumi.StringInput
	// This is the AWS secret key. It must be provided, but it can also be sourced from the `AWS_SECRET_ACCESS_KEY` environment
	// variable, or via a shared credentials file if `profile` is specified.
	SecretKey pulumi.StringPtrInput
	// This is the path to the shared credentials file. If this is not set and a profile is specified, `~/.aws/credentials`
	// will be used.
	SharedCredentialsFile pulumi.StringPtrInput
	// Skip the credentials validation via the STS API. Useful for AWS API implementations that do not have STS available or
	// implemented.
	SkipCredentialsValidation pulumi.BoolPtrInput
	// Skip the AWS Metadata API check. Useful for AWS API implementations that do not have a metadata API endpoint. Setting to
	// `true` prevents Terraform from authenticating via the Metadata API. You may need to use other authentication methods
	// like static credentials, configuration variables, or environment variables.
	SkipMetadataApiCheck pulumi.BoolPtrInput
	// Skip requesting the account ID. Useful for AWS API implementations that do not have the IAM, STS API, or metadata API.
	SkipRequestingAccountId pulumi.BoolPtrInput
	// Session token for validating temporary credentials. Typically provided after successful identity federation or
	// Multi-Factor Authentication (MFA) login. With MFA login, this is the session token provided afterward, not the 6 digit
	// MFA code used to get temporary credentials. It can also be sourced from the `AWS_SESSION_TOKEN` environment variable.
	Token pulumi.StringPtrInput
}

The set of arguments for constructing a Provider resource.

func (ProviderArgs) ElementType 

func (ProviderArgs) ElementType() reflect.Type

type ProviderAssumeRole 

type ProviderAssumeRole struct {
	DurationSeconds   *int              `pulumi:"durationSeconds"`
	ExternalId        *string           `pulumi:"externalId"`
	Policy            *string           `pulumi:"policy"`
	PolicyArns        []string          `pulumi:"policyArns"`
	RoleArn           *string           `pulumi:"roleArn"`
	SessionName       *string           `pulumi:"sessionName"`
	Tags              map[string]string `pulumi:"tags"`
	TransitiveTagKeys []string          `pulumi:"transitiveTagKeys"`
}

type ProviderAssumeRoleArgs 

type ProviderAssumeRoleArgs struct {
	DurationSeconds   pulumi.IntPtrInput      `pulumi:"durationSeconds"`
	ExternalId        pulumi.StringPtrInput   `pulumi:"externalId"`
	Policy            pulumi.StringPtrInput   `pulumi:"policy"`
	PolicyArns        pulumi.StringArrayInput `pulumi:"policyArns"`
	RoleArn           pulumi.StringPtrInput   `pulumi:"roleArn"`
	SessionName       pulumi.StringPtrInput   `pulumi:"sessionName"`
	Tags              pulumi.StringMapInput   `pulumi:"tags"`
	TransitiveTagKeys pulumi.StringArrayInput `pulumi:"transitiveTagKeys"`
}

func (ProviderAssumeRoleArgs) ElementType 

func (ProviderAssumeRoleArgs) ElementType() reflect.Type

func (ProviderAssumeRoleArgs) ToOutput 

func (i ProviderAssumeRoleArgs) ToOutput(ctx context.Context) pulumix.Output[ProviderAssumeRole]

func (ProviderAssumeRoleArgs) ToProviderAssumeRoleOutput 

func (i ProviderAssumeRoleArgs) ToProviderAssumeRoleOutput() ProviderAssumeRoleOutput

func (ProviderAssumeRoleArgs) ToProviderAssumeRoleOutputWithContext 

func (i ProviderAssumeRoleArgs) ToProviderAssumeRoleOutputWithContext(ctx context.Context) ProviderAssumeRoleOutput

func (ProviderAssumeRoleArgs) ToProviderAssumeRolePtrOutput 

func (i ProviderAssumeRoleArgs) ToProviderAssumeRolePtrOutput() ProviderAssumeRolePtrOutput

func (ProviderAssumeRoleArgs) ToProviderAssumeRolePtrOutputWithContext 

func (i ProviderAssumeRoleArgs) ToProviderAssumeRolePtrOutputWithContext(ctx context.Context) ProviderAssumeRolePtrOutput

type ProviderAssumeRoleInput 

type ProviderAssumeRoleInput interface {
	pulumi.Input

	ToProviderAssumeRoleOutput() ProviderAssumeRoleOutput
	ToProviderAssumeRoleOutputWithContext(context.Context) ProviderAssumeRoleOutput
}

ProviderAssumeRoleInput is an input type that accepts ProviderAssumeRoleArgs and ProviderAssumeRoleOutput values. You can construct a concrete instance of `ProviderAssumeRoleInput` via: 

ProviderAssumeRoleArgs{...}

type ProviderAssumeRoleOutput 

type ProviderAssumeRoleOutput struct{ *pulumi.OutputState }

func (ProviderAssumeRoleOutput) DurationSeconds 

func (o ProviderAssumeRoleOutput) DurationSeconds() pulumi.IntPtrOutput

func (ProviderAssumeRoleOutput) ElementType 

func (ProviderAssumeRoleOutput) ElementType() reflect.Type

func (ProviderAssumeRoleOutput) ExternalId 

func (o ProviderAssumeRoleOutput) ExternalId() pulumi.StringPtrOutput

func (ProviderAssumeRoleOutput) Policy 

func (o ProviderAssumeRoleOutput) Policy() pulumi.StringPtrOutput

func (ProviderAssumeRoleOutput) PolicyArns 

func (o ProviderAssumeRoleOutput) PolicyArns() pulumi.StringArrayOutput

func (ProviderAssumeRoleOutput) RoleArn 

func (o ProviderAssumeRoleOutput) RoleArn() pulumi.StringPtrOutput

func (ProviderAssumeRoleOutput) SessionName 

func (o ProviderAssumeRoleOutput) SessionName() pulumi.StringPtrOutput

func (ProviderAssumeRoleOutput) Tags 

func (o ProviderAssumeRoleOutput) Tags() pulumi.StringMapOutput

func (ProviderAssumeRoleOutput) ToOutput 

func (o ProviderAssumeRoleOutput) ToOutput(ctx context.Context) pulumix.Output[ProviderAssumeRole]

func (ProviderAssumeRoleOutput) ToProviderAssumeRoleOutput 

func (o ProviderAssumeRoleOutput) ToProviderAssumeRoleOutput() ProviderAssumeRoleOutput

func (ProviderAssumeRoleOutput) ToProviderAssumeRoleOutputWithContext 

func (o ProviderAssumeRoleOutput) ToProviderAssumeRoleOutputWithContext(ctx context.Context) ProviderAssumeRoleOutput

func (ProviderAssumeRoleOutput) ToProviderAssumeRolePtrOutput 

func (o ProviderAssumeRoleOutput) ToProviderAssumeRolePtrOutput() ProviderAssumeRolePtrOutput

func (ProviderAssumeRoleOutput) ToProviderAssumeRolePtrOutputWithContext 

func (o ProviderAssumeRoleOutput) ToProviderAssumeRolePtrOutputWithContext(ctx context.Context) ProviderAssumeRolePtrOutput

func (ProviderAssumeRoleOutput) TransitiveTagKeys 

func (o ProviderAssumeRoleOutput) TransitiveTagKeys() pulumi.StringArrayOutput

type ProviderAssumeRolePtrInput 

type ProviderAssumeRolePtrInput interface {
	pulumi.Input

	ToProviderAssumeRolePtrOutput() ProviderAssumeRolePtrOutput
	ToProviderAssumeRolePtrOutputWithContext(context.Context) ProviderAssumeRolePtrOutput
}

ProviderAssumeRolePtrInput is an input type that accepts ProviderAssumeRoleArgs, ProviderAssumeRolePtr and ProviderAssumeRolePtrOutput values. You can construct a concrete instance of `ProviderAssumeRolePtrInput` via: 

        ProviderAssumeRoleArgs{...}

or:

        nil

func ProviderAssumeRolePtr 

func ProviderAssumeRolePtr(v *ProviderAssumeRoleArgs) ProviderAssumeRolePtrInput

type ProviderAssumeRolePtrOutput 

type ProviderAssumeRolePtrOutput struct{ *pulumi.OutputState }

func (ProviderAssumeRolePtrOutput) DurationSeconds 

func (o ProviderAssumeRolePtrOutput) DurationSeconds() pulumi.IntPtrOutput

func (ProviderAssumeRolePtrOutput) Elem 

func (o ProviderAssumeRolePtrOutput) Elem() ProviderAssumeRoleOutput

func (ProviderAssumeRolePtrOutput) ElementType 

func (ProviderAssumeRolePtrOutput) ElementType() reflect.Type

func (ProviderAssumeRolePtrOutput) ExternalId 

func (o ProviderAssumeRolePtrOutput) ExternalId() pulumi.StringPtrOutput

func (ProviderAssumeRolePtrOutput) Policy 

func (o ProviderAssumeRolePtrOutput) Policy() pulumi.StringPtrOutput

func (ProviderAssumeRolePtrOutput) PolicyArns 

func (o ProviderAssumeRolePtrOutput) PolicyArns() pulumi.StringArrayOutput

func (ProviderAssumeRolePtrOutput) RoleArn 

func (o ProviderAssumeRolePtrOutput) RoleArn() pulumi.StringPtrOutput

func (ProviderAssumeRolePtrOutput) SessionName 

func (o ProviderAssumeRolePtrOutput) SessionName() pulumi.StringPtrOutput

func (ProviderAssumeRolePtrOutput) Tags 

func (o ProviderAssumeRolePtrOutput) Tags() pulumi.StringMapOutput

func (ProviderAssumeRolePtrOutput) ToOutput 

func (o ProviderAssumeRolePtrOutput) ToOutput(ctx context.Context) pulumix.Output[*ProviderAssumeRole]

func (ProviderAssumeRolePtrOutput) ToProviderAssumeRolePtrOutput 

func (o ProviderAssumeRolePtrOutput) ToProviderAssumeRolePtrOutput() ProviderAssumeRolePtrOutput

func (ProviderAssumeRolePtrOutput) ToProviderAssumeRolePtrOutputWithContext 

func (o ProviderAssumeRolePtrOutput) ToProviderAssumeRolePtrOutputWithContext(ctx context.Context) ProviderAssumeRolePtrOutput

func (ProviderAssumeRolePtrOutput) TransitiveTagKeys 

func (o ProviderAssumeRolePtrOutput) TransitiveTagKeys() pulumi.StringArrayOutput

type ProviderInput 

type ProviderInput interface {
	pulumi.Input

	ToProviderOutput() ProviderOutput
	ToProviderOutputWithContext(ctx context.Context) ProviderOutput
}

type ProviderOutput 

type ProviderOutput struct{ *pulumi.OutputState }

func (ProviderOutput) AccessKey 

func (o ProviderOutput) AccessKey() pulumi.StringPtrOutput

This is the AWS access key. It must be provided, but it can also be sourced from the `AWS_ACCESS_KEY_ID` environment variable, or via a shared credentials file if `profile` is specified.

func (ProviderOutput) ElementType 

func (ProviderOutput) ElementType() reflect.Type

func (ProviderOutput) Profile 

func (o ProviderOutput) Profile() pulumi.StringPtrOutput

This is the AWS profile name as set in the shared credentials file.

func (ProviderOutput) Region 

func (o ProviderOutput) Region() pulumi.StringOutput

This is the AWS region. It must be provided, but it can also be sourced from the `AWS_DEFAULT_REGION` environment variables, or via a shared credentials file if `profile` is specified.

func (ProviderOutput) SecretKey 

func (o ProviderOutput) SecretKey() pulumi.StringPtrOutput

This is the AWS secret key. It must be provided, but it can also be sourced from the `AWS_SECRET_ACCESS_KEY` environment variable, or via a shared credentials file if `profile` is specified.

func (ProviderOutput) SharedCredentialsFile 

func (o ProviderOutput) SharedCredentialsFile() pulumi.StringPtrOutput

This is the path to the shared credentials file. If this is not set and a profile is specified, `~/.aws/credentials` will be used.

func (ProviderOutput) ToOutput 

func (o ProviderOutput) ToOutput(ctx context.Context) pulumix.Output[*Provider]

func (ProviderOutput) ToProviderOutput 

func (o ProviderOutput) ToProviderOutput() ProviderOutput

func (ProviderOutput) ToProviderOutputWithContext 

func (o ProviderOutput) ToProviderOutputWithContext(ctx context.Context) ProviderOutput

func (ProviderOutput) Token 

func (o ProviderOutput) Token() pulumi.StringPtrOutput

Session token for validating temporary credentials. Typically provided after successful identity federation or Multi-Factor Authentication (MFA) login. With MFA login, this is the session token provided afterward, not the 6 digit MFA code used to get temporary credentials. It can also be sourced from the `AWS_SESSION_TOKEN` environment variable.

Source Files

View all Source files

Directories

Path Synopsis

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.