providers

Documentation

Index

• type AWS
  • func (p *AWS) Initialize(ctx context.Context, serviceName string) error
• type Cleanable
  • func LoadProvider(ctx context.Context, provider string, service string) (Cleanable, error)
• type Config
• type Credentials
• type Profile

Types

type AWS

type AWS struct {
	Service Cleanable
	// contains filtered or unexported fields
}

func (*AWS) Initialize

func (p *AWS) Initialize(ctx context.Context, serviceName string) error

Call all the functions below in order to properly set the required configs for the cloud provider

type Cleanable

type Cleanable interface {
	List(context.Context) ([]string, error)
	Validate(context.Context, string) (bool, error)
	Delete(context.Context, string) error
}

func LoadProvider

func LoadProvider(ctx context.Context, provider string, service string) (Cleanable, error)

Initialize the cloud provider being used during the execution

type Config

type Config struct {
	// AWS Access and Secret Key credentials. DO NOT USE THIS FIELD FOR PRODUCTION PURPOSES.
	Credentials Credentials

	// AWS Configuration Profile to be used. DO NOT USE THIS FIELD FOR PRODUCTION PURPOSES.
	Profile Profile

	// AWS Region
	Region string
}

type Credentials

type Credentials struct {
	// AWS User's Access Key.
	AccessKey string

	// AWS User's Secret Key.
	SecretKey string
}

type Profile

type Profile struct {
	// AWS Configuration Profile name.
	Name string

	// AWS Configuration Profile file path.
	Path string
}