aws

Documentation

Index

• func ParseRegistry(registry string) (accountId, awsEcrRegion string, ok bool)
• type Client
  • func NewClient(opts ...Option) *Client
  • func (c *Client) Login(ctx context.Context, autoLogin bool, image string) (authn.Authenticator, error)
  • func (c *Client) LoginWithExpiry(ctx context.Context, autoLogin bool, image string) (authn.Authenticator, time.Time, error)
  • func (c *Client) OIDCLogin(ctx context.Context, registryURL string) (authn.Authenticator, error)
  • func (c *Client) WithConfig(cfg *aws.Config)
• type Option
  • func WithProxyURL(proxyURL *url.URL) Option

Functions

func ParseRegistry

func ParseRegistry(registry string) (accountId, awsEcrRegion string, ok bool)

ParseRegistry returns the AWS account ID and region and `true` if the image registry/repository is hosted in AWS's Elastic Container Registry, otherwise empty strings and `false`.

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client is a AWS ECR client which can log into the registry and return authorization information.

func NewClient

func NewClient(opts ...Option) *Client

NewClient creates a new empty ECR client. NOTE: In order to avoid breaking the auth API with aws-sdk-go-v2's default config, return an empty Client. Client.getLoginAuth() loads the default config if Client.config is nil. This also enables tests to configure the Client with stub before calling the login method using Client.WithConfig().

func (*Client) Login

func (c *Client) Login(ctx context.Context, autoLogin bool, image string) (authn.Authenticator, error)

Login attempts to get the authentication material for ECR.

func (*Client) LoginWithExpiry

func (c *Client) LoginWithExpiry(ctx context.Context, autoLogin bool, image string) (authn.Authenticator, time.Time, error)

LoginWithExpiry attempts to get the authentication material for ECR. It returns the authentication material and the expiry time of the token.

func (*Client) OIDCLogin

func (c *Client) OIDCLogin(ctx context.Context, registryURL string) (authn.Authenticator, error)

OIDCLogin attempts to get the authentication material for ECR.

Deprecated: Use LoginWithExpiry instead.

func (*Client) WithConfig

func (c *Client) WithConfig(cfg *aws.Config)

WithConfig allows setting the client config if it's uninitialized.

type Option

type Option func(*Client)

Option is a functional option for configuring the client.

func WithProxyURL

func WithProxyURL(proxyURL *url.URL) Option

WithProxyURL sets the proxy URL for the client.