config

Documentation

Index

• type APNInfo
  • func (apn APNInfo) BuildUserAgentString() string
• type AssumeRole
• type AssumeRoleWithWebIdentity
  • func (c AssumeRoleWithWebIdentity) GetIdentityToken() ([]byte, error)
  • func (c AssumeRoleWithWebIdentity) HasValidTokenSource() bool
• type CannotAssumeRoleWithWebIdentityError
  • func (e CannotAssumeRoleWithWebIdentityError) Detail() string
  • func (e CannotAssumeRoleWithWebIdentityError) Equal(other diag.Diagnostic) bool
  • func (e CannotAssumeRoleWithWebIdentityError) Err() error
  • func (e CannotAssumeRoleWithWebIdentityError) Severity() diag.Severity
  • func (e CannotAssumeRoleWithWebIdentityError) Summary() string
• type Config
  • func (c Config) CustomCABundleReader() (*bytes.Reader, error)
  • func (c Config) HTTPTransportOptions() (func(*http.Transport), error)
  • func (c *Config) NewCannotAssumeRoleWithWebIdentityError(err error) CannotAssumeRoleWithWebIdentityError
  • func (c *Config) NewNoValidCredentialSourcesError(err error) NoValidCredentialSourcesError
  • func (c Config) ResolveSharedConfigFiles() ([]string, error)
  • func (c Config) ResolveSharedCredentialsFiles() ([]string, error)
  • func (c Config) ValidateProxySettings(diags *diag.Diagnostics)
  • func (c Config) VerifyAccountIDAllowed(accountID string) error
• type NoValidCredentialSourcesError
  • func (e NoValidCredentialSourcesError) Detail() string
  • func (e NoValidCredentialSourcesError) Equal(other diag.Diagnostic) bool
  • func (e NoValidCredentialSourcesError) Err() error
  • func (e NoValidCredentialSourcesError) Severity() diag.Severity
  • func (e NoValidCredentialSourcesError) Summary() string
• type ProxyMode
• type UserAgentProduct
• type UserAgentProducts
  • func (ua UserAgentProducts) BuildUserAgentString() string

Types

type APNInfo

type APNInfo struct {
	PartnerName string
	Products    []UserAgentProduct
}

func (APNInfo) BuildUserAgentString

func (apn APNInfo) BuildUserAgentString() string

Builds the user-agent string for APN

type AssumeRole

type AssumeRole struct {
	RoleARN           string
	Duration          time.Duration
	ExternalID        string
	Policy            string
	PolicyARNs        []string
	SessionName       string
	SourceIdentity    string
	Tags              map[string]string
	TransitiveTagKeys []string
}

type AssumeRoleWithWebIdentity

type AssumeRoleWithWebIdentity struct {
	RoleARN              string
	Duration             time.Duration
	Policy               string
	PolicyARNs           []string
	SessionName          string
	WebIdentityToken     string
	WebIdentityTokenFile string
}

func (AssumeRoleWithWebIdentity) GetIdentityToken

func (c AssumeRoleWithWebIdentity) GetIdentityToken() ([]byte, error)

Implements `stscreds.IdentityTokenRetriever`

func (AssumeRoleWithWebIdentity) HasValidTokenSource

func (c AssumeRoleWithWebIdentity) HasValidTokenSource() bool

type CannotAssumeRoleWithWebIdentityError

type CannotAssumeRoleWithWebIdentityError struct {
	Config *Config
	// contains filtered or unexported fields
}

CannotAssumeRoleWithWebIdentityError occurs when AssumeRoleWithWebIdentity cannot complete.

func (CannotAssumeRoleWithWebIdentityError) Detail

func (e CannotAssumeRoleWithWebIdentityError) Detail() string

func (CannotAssumeRoleWithWebIdentityError) Equal

func (e CannotAssumeRoleWithWebIdentityError) Equal(other diag.Diagnostic) bool

func (CannotAssumeRoleWithWebIdentityError) Err

func (e CannotAssumeRoleWithWebIdentityError) Err() error

func (CannotAssumeRoleWithWebIdentityError) Severity

func (e CannotAssumeRoleWithWebIdentityError) Severity() diag.Severity

func (CannotAssumeRoleWithWebIdentityError) Summary

func (e CannotAssumeRoleWithWebIdentityError) Summary() string

type Config

type Config struct {
	AccessKey                      string
	AllowedAccountIds              []string
	APNInfo                        *APNInfo
	AssumeRole                     []AssumeRole
	AssumeRoleWithWebIdentity      *AssumeRoleWithWebIdentity
	Backoff                        retry.BackoffDelayer
	CallerDocumentationURL         string
	CallerName                     string
	CustomCABundle                 string
	EC2MetadataServiceEnableState  imds.ClientEnableState
	EC2MetadataServiceEndpoint     string
	EC2MetadataServiceEndpointMode string
	ForbiddenAccountIds            []string
	HTTPClient                     *http.Client
	HTTPProxy                      *string
	HTTPSProxy                     *string
	IamEndpoint                    string
	Insecure                       bool
	Logger                         logging.Logger
	MaxBackoff                     time.Duration
	MaxRetries                     int
	NoProxy                        string
	Profile                        string
	HTTPProxyMode                  ProxyMode
	Region                         string
	RetryMode                      aws.RetryMode
	SecretKey                      string
	SharedCredentialsFiles         []string
	SharedConfigFiles              []string
	SkipCredsValidation            bool
	SkipRequestingAccountId        bool
	SsoEndpoint                    string
	StsEndpoint                    string
	StsRegion                      string
	SuppressDebugLog               bool
	Token                          string
	TokenBucketRateLimiterCapacity int
	UseDualStackEndpoint           bool
	UseFIPSEndpoint                bool
	UserAgent                      UserAgentProducts
}

func (Config) CustomCABundleReader

func (c Config) CustomCABundleReader() (*bytes.Reader, error)

func (Config) HTTPTransportOptions

func (c Config) HTTPTransportOptions() (func(*http.Transport), error)

HTTPTransportOptions returns functional options that configures an http.Transport. The returned options function is called on both AWS SDKv1 and v2 default HTTP clients.

func (*Config) NewCannotAssumeRoleWithWebIdentityError

func (c *Config) NewCannotAssumeRoleWithWebIdentityError(err error) CannotAssumeRoleWithWebIdentityError

func (*Config) NewNoValidCredentialSourcesError

func (c *Config) NewNoValidCredentialSourcesError(err error) NoValidCredentialSourcesError

func (Config) ResolveSharedConfigFiles

func (c Config) ResolveSharedConfigFiles() ([]string, error)

func (Config) ResolveSharedCredentialsFiles

func (c Config) ResolveSharedCredentialsFiles() ([]string, error)

func (Config) ValidateProxySettings

func (c Config) ValidateProxySettings(diags *diag.Diagnostics)

func (Config) VerifyAccountIDAllowed

func (c Config) VerifyAccountIDAllowed(accountID string) error

VerifyAccountIDAllowed verifies an account ID is not explicitly forbidden or omitted from an allow list, if configured.

If the AllowedAccountIds and ForbiddenAccountIds fields are both empty, this function will return nil.

type NoValidCredentialSourcesError

type NoValidCredentialSourcesError struct {
	Config *Config
	// contains filtered or unexported fields
}

NoValidCredentialSourcesError occurs when all credential lookup methods have been exhausted without results.

func (NoValidCredentialSourcesError) Detail

func (e NoValidCredentialSourcesError) Detail() string

func (NoValidCredentialSourcesError) Equal

func (e NoValidCredentialSourcesError) Equal(other diag.Diagnostic) bool

func (NoValidCredentialSourcesError) Err

func (e NoValidCredentialSourcesError) Err() error

func (NoValidCredentialSourcesError) Severity

func (e NoValidCredentialSourcesError) Severity() diag.Severity

func (NoValidCredentialSourcesError) Summary

func (e NoValidCredentialSourcesError) Summary() string

type ProxyMode

type ProxyMode int

const (
	HTTPProxyModeLegacy ProxyMode = iota
	HTTPProxyModeSeparate
)

type UserAgentProduct

type UserAgentProduct struct {
	Name    string
	Version string
	Comment string
}

type UserAgentProducts

type UserAgentProducts []UserAgentProduct

func (UserAgentProducts) BuildUserAgentString

func (ua UserAgentProducts) BuildUserAgentString() string