_transfer

Documentation

Overview

Package _transfer provides AWS client management functions for the transfer AWS service.

The Client() is a wrapper on transfer.NewFromConfig(), which creates & caches the client.

The Delete() clears the cached client.

Index

• func Client(provider providers.CredsProvider, optFns ...func(*transfer.Options)) (*transfer.Client, error)
• func Delete(provider providers.CredsProvider) error
• func Must(provider providers.CredsProvider, optFns ...func(*transfer.Options)) *transfer.Client
• func Refresh(provider providers.CredsProvider, optFns ...func(*transfer.Options)) (*transfer.Client, error)

Functions

func Client

func Client(provider providers.CredsProvider, optFns ...func(*transfer.Options)) (*transfer.Client, error)

Client builds or returns the singleton transfer client for the supplied provider If functional options are supplied, they are passed as-is to the underlying NewFromConfig(...) for the corresponding client

func Delete

func Delete(provider providers.CredsProvider) error

Delete removes the cached transfer client for the supplied provider; This foreces the subsequent calls to Client() for the same provider to recreate & return a new instnce.

func Must

func Must(provider providers.CredsProvider, optFns ...func(*transfer.Options)) *transfer.Client

Must wraps the _transfer.Client( ) function & panics if a non-nil error is returned.

func Refresh

func Refresh(provider providers.CredsProvider, optFns ...func(*transfer.Options)) (*transfer.Client, error)

Refresh discards the cached transfer client if it exists, builds & returns a new singleton instance