package
2.0.0-preview.4+incompatible
Repository: https://github.com/skarlso/aws-sdk-go-v2.git
Documentation: pkg.go.dev

# Functions

DefaultSharedConfigFilename returns the SDK's default file path for the shared config file.
DefaultSharedCredentialsFilename returns the SDK's default file path for the shared credentials file.
GetAssumeRoleConfig searchds the Configs for a AssumeRoleConfigProvider and returns the value if found.
GetContainerCredentialsEndpointPath searchds the Configs for a ContainerCredentialsEndpointPathProvider and returns the value if found.
GetCredentialsEndpoint searchds the Configs for a CredentialsEndpointProvider and returns the value if found.
GetCredentialsValue searchds the Configs for a CredentialsValueProvider and returns the value if found.
GetCustomCABundle searchds the Configs for a CustomCABundleProvider and returns the value if found.
GetMFATokenFunc searchds the Configs for a MFATokenFuncProvider and returns the value if found.
GetRegion searchds the Configs for a RegionProvider and returns the value if found.
GetSharedConfigFiles searchds the Configs for a SharedConfigFilesProvider and returns the value if found.
GetSharedConfigProfile searchds the Configs for a SharedConfigProfileProvider and returns the value if found.
LoadDefaultAWSConfig reads the SDK's default external configurations, and populates an AWS Config with the values from the external configurations.
LoadEnvConfig reads configuration values from the OS's environment variables.
LoadSharedConfig uses the Configs passed in to load the SharedConfig from file The file names and profile name are sourced from the Configs.
LoadSharedConfigIgnoreNotExist is an alias for LoadSharedConfig with the addition of ignoring when none of the files exist or when the profile is not found in any of the files.
NewEnvConfig retrieves the SDK's environment configuration.
NewSharedConfig retrieves the configuration from the list of files using the profile provided.
ResolveAssumeRoleCredentials extracts the assume role configuration from the external configurations.
ResolveContainerEndpointPathCredentials will extract the container credentials endpoint from the config slice.
ResolveCredentialsValue extracts the first instance of Credentials from the config slices.
ResolveCustomCABundle extracts the first instance of a custom CA bundle filename from the external configurations.
ResolveDefaultAWSConfig will write default configuration values into the cfg value.
ResolveEndpointCredentials will extract the credentials endpoint from the config slice.
ResolveFallbackEC2Credentials will configure the AWS config credentials to use EC2 Instance Role always.
ResolveRegion extracts the first instance of a Region from the Configs slice.

# Constants

Environment variables that will be read for configuration values.
Environment variables that will be read for configuration values.
Environment variables that will be read for configuration values.
TODO shorter name?.
Environment variables that will be read for configuration values.
Environment variables that will be read for configuration values.
Environment variables that will be read for configuration values.
Environment variables that will be read for configuration values.
Environment variables that will be read for configuration values.
Environment variables that will be read for configuration values.
Environment variables that will be read for configuration values.
Environment variables that will be read for configuration values.
Environment variables that will be read for configuration values.
Environment variables that will be read for configuration values.
CredentialsSourceName provides a name of the provider when config is loaded from environment.

# Variables

DefaultAWSConfigResolvers are a slice of functions that will resolve external configuration values into AWS configuration values.
DefaultConfigLoaders are a slice of functions that will read external configuration sources for configuration values.
DefaultSharedConfigFiles is a slice of the default shared config files that the will be used in order to load the SharedConfig.
DefaultSharedConfigProfile is the default profile to be used when loading configuration from the config files if another profile name is not provided.

# Structs

AssumeRoleConfig provides the values defining the configuration for an IAM assume role.
EnvConfig is a collection of environment values the SDK will read setup config from.
SharedConfig represents the configuration fields of the SDK config files.
SharedConfigAssumeRoleError is an error for the shared config when the profile contains assume role information, but that information is invalid or not complete.
SharedConfigFileNotExistError is an error for the shared config when the filename does not exist.
SharedConfigLoadError is an error for the shared config file failed to load.
SharedConfigProfileNotExistError is an error for the shared config when the profile was not find in the config file.
WithEC2MetadataRegion provides a RegionProvider that retrieves the region from the EC2 Metadata service.

# Interfaces

AssumeRoleConfigProvider provides access to the assume role config external configuration value.
A Config represents a generic configuration value or set of values.
ContainerCredentialsEndpointPathProvider provides access to the credentials endpoint path external configuration value.
CredentialsEndpointProvider provides access to the credentials endpoint external configuration value.
CredentialsValueProvider provides access to the credentials external configuration value.
CustomCABundleProvider provides access to the custom CA bundle PEM bytes.
MFATokenFuncProvider provides access to the MFA token function needed for Assume Role with MFA.
RegionProvider provides access to the region external configuration value.
SharedConfigFilesProvider provides access to the shared config filesnames external configuration value.
SharedConfigProfileProvider provides access to the shared config profile name external configuration value.

# Type aliases

An AWSConfigResolver will extract configuration data from the Configs slice using the provider interfaces to extract specific functionality.
A ConfigLoader is used to load external configuration data and returns it as a generic Config type.
Configs is a slice of Config values.
SharedConfigNotExistErrors provides an error type for failure to load shared config because resources do not exist.
WithAssumeRoleConfig provides wrapping of a string to satisfy the AssumeRoleConfigProvider interface.
WithContainerCredentialsEndpointPath provides wrapping of a string to satisfy the ContainerCredentialsEndpointPathProvider interface.
WithCredentialsEndpoint provides wrapping of a string to satisfy the CredentialsEndpointProvider interface.
WithCredentialsValue provides wrapping of a credentials Value to satisfy the CredentialsValueProvider interface.
WithCustomCABundle provides wrapping of a region string to satisfy the CustomCABundleProvider interface.
WithMFATokenFunc provides wrapping of a string to satisfy the MFATokenFuncProvider interface.
WithRegion provides wrapping of a region string to satisfy the RegionProvider interface.
WithSharedConfigFiles wraps a slice of strings to satisfy the SharedConfigFilesProvider interface so a slice of custom shared config files ared used when loading the SharedConfig.
WithSharedConfigProfile wraps a strings to satisfy the SharedConfigProfileProvider interface so a slice of custom shared config files ared used when loading the SharedConfig.