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 ¶
- func Config() *volcengine.Config
- func CredChain(cfg *volcengine.Config, handlers request.Handlers) *credentials.Credentials
- func CredProviders(cfg *volcengine.Config, handlers request.Handlers) []credentials.Provider
- func Handlers() request.Handlers
- func NewDefaultCredentialProvider(optFns ...func(*credentials.DefaultCredentialProviderOptions)) *credentials.Credentials
- func SharedConfigFilename() string
- func SharedCredentialsFilename() string
- func SharedEndpointConfigFilename() string
- type Defaults
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Config ¶
func Config() *volcengine.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 ¶
func CredChain(cfg *volcengine.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.
The chain honors cfg.CredentialsChainVerboseErrors: when true the failure error includes per-provider details; otherwise (default) the stable credentials.ErrNoValidProvidersFoundInChain is returned.
func CredProviders ¶
func CredProviders(cfg *volcengine.Config, handlers request.Handlers) []credentials.Provider
CredProviders returns the slice of providers used in the default credential chain.
The default chain:
- EnvProvider (AK/SK/STS from environment variables)
- OIDCCredentialsProvider (from environment variables)
- CliProvider (from ~/.volcengine/config.json)
- EcsRoleProvider (from IMDS)
func 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 NewDefaultCredentialProvider ¶ added in v1.2.27
func NewDefaultCredentialProvider(optFns ...func(*credentials.DefaultCredentialProviderOptions)) *credentials.Credentials
NewDefaultCredentialProvider creates a default credential chain with the given options. This is the primary entry point for users who want to customize the default chain (e.g., specify an ECS role name).
Example:
creds := defaults.NewDefaultCredentialProvider(
func(o *credentials.DefaultCredentialProviderOptions) {
o.RoleName = "my-ecs-role"
},
)
func SharedConfigFilename ¶
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/.volcengine/config
- Windows: %USERPROFILE%\.volcengine\config
func SharedCredentialsFilename ¶
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/.volcengine/credentials
- Windows: %USERPROFILE%\.volcengine\credentials
func SharedEndpointConfigFilename ¶ added in v1.0.168
func SharedEndpointConfigFilename() string
SharedEndpointConfigFilename returns the SDK's default file path for the endpoint config file.
Builds the shared config file path based on the OS's platform.
- Linux/Unix: $HOME/.volcengine/endpoint
- Windows: %USERPROFILE%\.volcengine\endpoint
Source Files