provider

package
v0.1.21 Latest Latest
Warning

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

Go to latest
Published: Jan 12, 2026 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var ErrNoRoleARN = errors.New("no IAM Role ARN specified")

ErrNoRoleARN is an error, which is returned when creating a new credentials provider without specifying a IAM Role ARN to be assumed.

View Source
var ErrNoSTSClient = errors.New("no STS client specified")

ErrNoSTSClient is an error, which is returned when creating a new credentials provider without the required AWS STS client.

View Source
var ErrNoTokenRetriever = errors.New("no token retriever specified")

ErrNoTokenRetriever is an error, which is returned when creating a new web identity credentials provider, without specifying a stscreds.IdentityTokenRetriever implementation.

Functions

func New

func New(spec *Spec) (aws.CredentialsProvider, error)

New creates a new Web Identity implementation of aws.CredentialsProvider based on the provided spec.

Types

type Spec

type Spec struct {
	// Client is the API client used to make API calls to the AWS STS.
	Client *sts.Client

	// RoleARN is the IAM Role ARN to assume.
	RoleARN string

	// RoleSessionName is the name of the session, which uniquely identifies it
	RoleSessionName string

	// Duration specifies the expiry duration of the STS credentials.
	Duration time.Duration

	// TokenRetriever is the identity token retriever implementation to use.
	TokenRetriever stscreds.IdentityTokenRetriever
}

Spec provides the configuration settings for the Web Identity Credentials Provider.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL