aws

README

---

title: AWS description: AWS Provider for Carbon weight: 20

The AWS provider uses AWS profiles as Platforms, VPCs as Environments, and EC2 instances as VMs. It will read your AWS config and return all of your profiles as platforms. Carbon does not use the AWS CLI directly, it is recommended to have it setup and configured especially if using SSO. Carbon will treat VPCs as environments.

Documentation

Index

• func New() types.Provider
• type Environment
  • func (e *Environment) CreateVM(options types.MachineLaunchOptions) error
  • func (e *Environment) DestroyImage(imageID string) error
  • func (e *Environment) DestroyVM(id string) error
  • func (e *Environment) ImageBuilds() ([]types.ImageBuild, error)
  • func (e *Environment) Images() ([]types.Image, error)
  • func (e *Environment) Name() string
  • func (e *Environment) Profile() types.Profile
  • func (e *Environment) RestartVM(id string) error
  • func (e *Environment) StartVM(id string) error
  • func (e *Environment) StopVM(id string) error
  • func (e *Environment) VMs() []types.VM
• type Profile
  • func NewProfile(name string, providerInstance *Provider, config common.ProfileConfig) *Profile
  • func (p *Profile) Environments() []types.Environment
• type Provider
  • func (p *Provider) AWSProfiles() []string
  • func (p *Provider) IsAvailable() bool
  • func (p *Provider) Profiles() []types.Profile

Functions

func New

func New() types.Provider

Types

type Environment

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

func (*Environment) CreateVM

func (e *Environment) CreateVM(options types.MachineLaunchOptions) error

func (*Environment) DestroyImage

func (e *Environment) DestroyImage(imageID string) error

func (*Environment) DestroyVM

func (e *Environment) DestroyVM(id string) error

func (*Environment) ImageBuilds

func (e *Environment) ImageBuilds() ([]types.ImageBuild, error)

func (*Environment) Images

func (e *Environment) Images() ([]types.Image, error)

func (*Environment) Name

func (e *Environment) Name() string

func (*Environment) Profile

func (e *Environment) Profile() types.Profile

func (*Environment) RestartVM

func (e *Environment) RestartVM(id string) error

func (*Environment) StartVM

func (e *Environment) StartVM(id string) error

func (*Environment) StopVM

func (e *Environment) StopVM(id string) error

func (*Environment) VMs

func (e *Environment) VMs() []types.VM

type Profile

type Profile struct {
	types.Profile
}

func NewProfile

func NewProfile(name string, providerInstance *Provider, config common.ProfileConfig) *Profile

func (*Profile) Environments

func (p *Profile) Environments() []types.Environment

type Provider

type Provider struct {
	types.Provider
	// contains filtered or unexported fields
}

func (*Provider) AWSProfiles

func (p *Provider) AWSProfiles() []string

func (*Provider) IsAvailable

func (p *Provider) IsAvailable() bool

func (*Provider) Profiles

func (p *Provider) Profiles() []types.Profile