config

Documentation

Index

• func GetAccessKey(ctx *pulumi.Context) string
• func GetAssumeRole(ctx *pulumi.Context) string
• func GetMaxRetries(ctx *pulumi.Context) int
• func GetProfile(ctx *pulumi.Context) string
• func GetRegion(ctx *pulumi.Context) string
• func GetSecretKey(ctx *pulumi.Context) string
• func GetSharedCredentialsFile(ctx *pulumi.Context) string
• func GetSkipCredentialsValidation(ctx *pulumi.Context) bool
• func GetSkipMetadataApiCheck(ctx *pulumi.Context) bool
• func GetSkipRequestingAccountId(ctx *pulumi.Context) bool
• func GetToken(ctx *pulumi.Context) string
• type AssumeRole
• type AssumeRoleArgs
  • func (AssumeRoleArgs) ElementType() reflect.Type
  • func (i AssumeRoleArgs) ToAssumeRoleOutput() AssumeRoleOutput
  • func (i AssumeRoleArgs) ToAssumeRoleOutputWithContext(ctx context.Context) AssumeRoleOutput
  • func (i AssumeRoleArgs) ToOutput(ctx context.Context) pulumix.Output[AssumeRole]
• type AssumeRoleInput
• type AssumeRoleOutput
  • func (o AssumeRoleOutput) DurationSeconds() pulumi.IntPtrOutput
  • func (AssumeRoleOutput) ElementType() reflect.Type
  • func (o AssumeRoleOutput) ExternalId() pulumi.StringPtrOutput
  • func (o AssumeRoleOutput) Policy() pulumi.StringPtrOutput
  • func (o AssumeRoleOutput) PolicyArns() pulumi.StringArrayOutput
  • func (o AssumeRoleOutput) RoleArn() pulumi.StringPtrOutput
  • func (o AssumeRoleOutput) SessionName() pulumi.StringPtrOutput
  • func (o AssumeRoleOutput) Tags() pulumi.StringMapOutput
  • func (o AssumeRoleOutput) ToAssumeRoleOutput() AssumeRoleOutput
  • func (o AssumeRoleOutput) ToAssumeRoleOutputWithContext(ctx context.Context) AssumeRoleOutput
  • func (o AssumeRoleOutput) ToOutput(ctx context.Context) pulumix.Output[AssumeRole]
  • func (o AssumeRoleOutput) TransitiveTagKeys() pulumi.StringArrayOutput

Functions

func GetAccessKey

func GetAccessKey(ctx *pulumi.Context) string

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 GetAssumeRole

func GetAssumeRole(ctx *pulumi.Context) string

Settings for making use of the AWS Assume Role functionality.

func GetMaxRetries

func GetMaxRetries(ctx *pulumi.Context) int

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`.

func GetProfile

func GetProfile(ctx *pulumi.Context) string

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

func GetRegion

func GetRegion(ctx *pulumi.Context) string

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 GetSecretKey

func GetSecretKey(ctx *pulumi.Context) string

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 GetSharedCredentialsFile

func GetSharedCredentialsFile(ctx *pulumi.Context) string

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 GetSkipCredentialsValidation

func GetSkipCredentialsValidation(ctx *pulumi.Context) bool

Skip the credentials validation via the STS API. Useful for AWS API implementations that do not have STS available or implemented.

func GetSkipMetadataApiCheck

func GetSkipMetadataApiCheck(ctx *pulumi.Context) bool

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.

func GetSkipRequestingAccountId

func GetSkipRequestingAccountId(ctx *pulumi.Context) bool

Skip requesting the account ID. Useful for AWS API implementations that do not have the IAM, STS API, or metadata API.

func GetToken

func GetToken(ctx *pulumi.Context) string

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.

Types

type AssumeRole

type AssumeRole 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 AssumeRoleArgs

type AssumeRoleArgs 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 (AssumeRoleArgs) ElementType

func (AssumeRoleArgs) ElementType() reflect.Type

func (AssumeRoleArgs) ToAssumeRoleOutput

func (i AssumeRoleArgs) ToAssumeRoleOutput() AssumeRoleOutput

func (AssumeRoleArgs) ToAssumeRoleOutputWithContext

func (i AssumeRoleArgs) ToAssumeRoleOutputWithContext(ctx context.Context) AssumeRoleOutput

func (AssumeRoleArgs) ToOutput

func (i AssumeRoleArgs) ToOutput(ctx context.Context) pulumix.Output[AssumeRole]

type AssumeRoleInput

type AssumeRoleInput interface {
	pulumi.Input

	ToAssumeRoleOutput() AssumeRoleOutput
	ToAssumeRoleOutputWithContext(context.Context) AssumeRoleOutput
}

AssumeRoleInput is an input type that accepts AssumeRoleArgs and AssumeRoleOutput values. You can construct a concrete instance of `AssumeRoleInput` via:

AssumeRoleArgs{...}

type AssumeRoleOutput

type AssumeRoleOutput struct{ *pulumi.OutputState }

func (AssumeRoleOutput) DurationSeconds

func (o AssumeRoleOutput) DurationSeconds() pulumi.IntPtrOutput

func (AssumeRoleOutput) ElementType

func (AssumeRoleOutput) ElementType() reflect.Type

func (AssumeRoleOutput) ExternalId

func (o AssumeRoleOutput) ExternalId() pulumi.StringPtrOutput

func (AssumeRoleOutput) Policy

func (o AssumeRoleOutput) Policy() pulumi.StringPtrOutput

func (AssumeRoleOutput) PolicyArns

func (o AssumeRoleOutput) PolicyArns() pulumi.StringArrayOutput

func (AssumeRoleOutput) RoleArn

func (o AssumeRoleOutput) RoleArn() pulumi.StringPtrOutput

func (AssumeRoleOutput) SessionName

func (o AssumeRoleOutput) SessionName() pulumi.StringPtrOutput

func (AssumeRoleOutput) Tags

func (o AssumeRoleOutput) Tags() pulumi.StringMapOutput

func (AssumeRoleOutput) ToAssumeRoleOutput

func (o AssumeRoleOutput) ToAssumeRoleOutput() AssumeRoleOutput

func (AssumeRoleOutput) ToAssumeRoleOutputWithContext

func (o AssumeRoleOutput) ToAssumeRoleOutputWithContext(ctx context.Context) AssumeRoleOutput

func (AssumeRoleOutput) ToOutput

func (o AssumeRoleOutput) ToOutput(ctx context.Context) pulumix.Output[AssumeRole]

func (AssumeRoleOutput) TransitiveTagKeys

func (o AssumeRoleOutput) TransitiveTagKeys() pulumi.StringArrayOutput