defaults

package
Version: v1.40.51 Latest Latest
Warning

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

Go to latest
Published: Sep 28, 2021 License: Apache-2.0 Imports: 16 Imported by: 732

Documentation

Overview

Package defaults is a collection of helpers to retrieve the SDK's default configuration and handlers.

Generally this package shouldn't be used directly, but session.Session instead. This package is useful when you need to reset the defaults of a session or service client to the SDK defaults before setting additional parameters.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Config added in v0.10.0

func Config() *aws.Config

Config returns the default configuration without credentials. To retrieve a config with credentials also included use `defaults.Get().Config` instead.

Generally you shouldn't need to use this method directly, but is available if you need to reset the configuration of an existing service client or session.

func CredChain added in v0.10.0

func CredChain(cfg *aws.Config, handlers request.Handlers) *credentials.Credentials

CredChain returns the default credential chain.

Generally you shouldn't need to use this method directly, but is available if you need to reset the credentials of an existing service client or session's Config.

func CredProviders added in v1.14.30

func CredProviders(cfg *aws.Config, handlers request.Handlers) []credentials.Provider

CredProviders returns the slice of providers used in the default credential chain.

For applications that need to use some other provider (for example use different environment variables for legacy reasons) but still fall back on the default chain of providers. This allows that default chaint to be automatically updated

func Handlers added in v0.10.0

func Handlers() request.Handlers

Handlers returns the default request handlers.

Generally you shouldn't need to use this method directly, but is available if you need to reset the request handlers of an existing service client or session.

func RemoteCredProvider added in v1.3.0

func RemoteCredProvider(cfg aws.Config, handlers request.Handlers) credentials.Provider

RemoteCredProvider returns a credentials provider for the default remote endpoints such as EC2 or ECS Roles.

func SharedConfigFilename added in v1.8.33

func SharedConfigFilename() string

SharedConfigFilename returns the SDK's default file path for the shared config file.

Builds the shared config file path based on the OS's platform.

- Linux/Unix: $HOME/.aws/config
- Windows: %USERPROFILE%\.aws\config

func SharedCredentialsFilename added in v1.8.33

func SharedCredentialsFilename() string

SharedCredentialsFilename returns the SDK's default file path for the shared credentials file.

Builds the shared config file path based on the OS's platform.

- Linux/Unix: $HOME/.aws/credentials
- Windows: %USERPROFILE%\.aws\credentials

Types

type Defaults added in v0.10.0

type Defaults struct {
	Config   *aws.Config
	Handlers request.Handlers
}

A Defaults provides a collection of default values for SDK clients.

func Get added in v0.10.0

func Get() Defaults

Get returns the SDK's default values with Config and handlers pre-configured.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto
y or Y : Canonical URL