catalog

Documentation

Index

• func DefaultProviderConfig(name string) (map[string]string, bool)
• func OptionDescription(name string) string
• func OptionNames() []string
• func PayloadCapability(name string) string
• func PayloadSensitivity(name string) string
• func ProviderCapabilities(name string) []string
• func ProviderSupportsCapability(provider, capability string) bool
• func SensitiveOption(name string) bool
• type PayloadHelp
  • func PayloadHelpFor(name string) (PayloadHelp, bool)
• type PayloadSpec
  • func PayloadSpecFor(name string) (PayloadSpec, bool)
• type ProviderOption
  • func ProviderOptions(name string) []ProviderOption
• type ProviderSpec
  • func ProviderSpecFor(name string) (ProviderSpec, bool)
• type Suggestion
  • func PayloadMetadataSuggestions(name string) []Suggestion
  • func ProviderRegions(name string) []Suggestion

Functions

func DefaultProviderConfig

func DefaultProviderConfig(name string) (map[string]string, bool)

func OptionDescription

func OptionDescription(name string) string

func OptionNames

func OptionNames() []string

func PayloadCapability

func PayloadCapability(name string) string

func PayloadSensitivity

func PayloadSensitivity(name string) string

func ProviderCapabilities

func ProviderCapabilities(name string) []string

func ProviderSupportsCapability

func ProviderSupportsCapability(provider, capability string) bool

func SensitiveOption

func SensitiveOption(name string) bool

Types

type PayloadHelp

type PayloadHelp struct {
	MetadataSyntax   []string
	MetadataExamples []string
	SafetyNotes      []string
}

func PayloadHelpFor

func PayloadHelpFor(name string) (PayloadHelp, bool)

type PayloadSpec

type PayloadSpec struct {
	Capability        string
	Sensitivity       string
	MetadataTemplates []Suggestion
	Help              PayloadHelp
}

func PayloadSpecFor

func PayloadSpecFor(name string) (PayloadSpec, bool)

type ProviderOption

type ProviderOption struct {
	Name        string
	Description string
	Default     string
	Required    bool
	Sensitive   bool
}

func ProviderOptions

func ProviderOptions(name string) []ProviderOption

type ProviderSpec

type ProviderSpec struct {
	Options      []ProviderOption
	Regions      []Suggestion
	Capabilities []string
}

func ProviderSpecFor

func ProviderSpecFor(name string) (ProviderSpec, bool)

type Suggestion

type Suggestion struct {
	Text        string
	Description string
}

func PayloadMetadataSuggestions

func PayloadMetadataSuggestions(name string) []Suggestion

func ProviderRegions

func ProviderRegions(name string) []Suggestion