ProviderName is the name of the credentials provider.
const ProviderName = `CredentialsEndpointProvider`
AuthTokenProvider defines an interface to dynamically load a value to be passed for the Authorization header of a credentials request.
type AuthTokenProvider interface {
GetToken() (string, error)
}
HTTPClient is a client for sending HTTP requests
type HTTPClient interface {
Do(*http.Request) (*http.Response, error)
}
Options is structure of configurable options for Provider
type Options struct {
// Endpoint to retrieve credentials from. Required
Endpoint string
// HTTPClient to handle sending HTTP requests to the target endpoint.
HTTPClient HTTPClient
// Set of options to modify how the credentials operation is invoked.
APIOptions []func(*middleware.Stack) error
// The Retryer to be used for determining whether a failed requested should be retried
Retryer aws.Retryer
// Optional authorization token value if set will be used as the value of
// the Authorization header of the endpoint credential request.
//
// When constructed from environment, the provider will use the value of
// AWS_CONTAINER_AUTHORIZATION_TOKEN environment variable as the token
//
// Will be overridden if AuthorizationTokenProvider is configured
AuthorizationToken string
// Optional auth provider func to dynamically load the auth token from a file
// everytime a credential is retrieved
//
// When constructed from environment, the provider will read and use the content
// of the file pointed to by AWS_CONTAINER_AUTHORIZATION_TOKEN_FILE environment variable
// as the auth token everytime credentials are retrieved
//
// Will override AuthorizationToken if configured
AuthorizationTokenProvider AuthTokenProvider
}
Provider satisfies the aws.CredentialsProvider interface, and is a client to retrieve credentials from an arbitrary endpoint.
type Provider struct {
// contains filtered or unexported fields
}
func New(endpoint string, optFns ...func(*Options)) *Provider
New returns a credentials Provider for retrieving AWS credentials from arbitrary endpoint.
func (p *Provider) Retrieve(ctx context.Context) (aws.Credentials, error)
Retrieve will attempt to request the credentials from the endpoint the Provider was configured for. And error will be returned if the retrieval fails.
TokenProviderFunc is a func type implementing AuthTokenProvider interface and enables customizing token provider behavior
type TokenProviderFunc func() (string, error)
func (p TokenProviderFunc) GetToken() (string, error)
GetToken func retrieves auth token according to TokenProviderFunc implementation
| Name | Synopsis |
|---|---|
| .. | |