meta

Documentation

Index

• Constants
• Variables
• func ExtractHTTPClient(m interface{}) *http.Client
• func ExtractProjectID(d terraformResourceData, m interface{}) (projectID string, isDefault bool, err error)
• func ExtractRegion(d terraformResourceData, m interface{}) (scw.Region, error)
• func ExtractRegionWithDefault(d terraformResourceData, m interface{}, defaultRegion scw.Region) (scw.Region, error)
• func ExtractScwClient(m interface{}) *scw.Client
• func ExtractZone(d terraformResourceData, m interface{}) (scw.Zone, error)
• func GetRawConfigForKey(d *schema.ResourceData, key string, ty cty.Type) (interface{}, bool)
• type Config
• type CredentialsSource
  • func GetCredentialsSource(defaultZoneProfile, activeProfile, providerProfile, envProfile *scw.Profile) *CredentialsSource
• type Meta
  • func NewMeta(ctx context.Context, config *Config) (*Meta, error)
  • func (m Meta) AccessKeySource() string
  • func (m Meta) HTTPClient() *http.Client
  • func (m Meta) ProjectIDSource() string
  • func (m Meta) RegionSource() string
  • func (m Meta) ScwClient() *scw.Client
  • func (m Meta) SecretKeySource() string
  • func (m Meta) ZoneSource() string

Constants

const (
	CredentialsSourceEnvironment     = "Environment variable"
	CredentialsSourceDefault         = "Default"
	CredentialsSourceActiveProfile   = "Active Profile in config.yaml"
	CredentialsSourceProviderProfile = "Profile defined in provider{} block"
	CredentialsSourceInferred        = "CredentialsSourceInferred from default zone"
)

Variables

var ErrProjectIDNotFound = errors.New("could not detect project id")

ErrProjectIDNotFound is returned when no region can be detected

Functions

func ExtractHTTPClient

func ExtractHTTPClient(m interface{}) *http.Client

func ExtractProjectID

func ExtractProjectID(d terraformResourceData, m interface{}) (projectID string, isDefault bool, err error)

ExtractProjectID will try to guess the project id from the following:

• project_id field of the resource data
• default project id from config

func ExtractRegion

func ExtractRegion(d terraformResourceData, m interface{}) (scw.Region, error)

ExtractRegion will try to guess the region from the following:

• region field of the resource data
• default region from config

func ExtractRegionWithDefault

func ExtractRegionWithDefault(d terraformResourceData, m interface{}, defaultRegion scw.Region) (scw.Region, error)

ExtractRegionWithDefault will try to guess the region from the following:

• region field of the resource data
• default region given in argument
• default region from config

func ExtractScwClient

func ExtractScwClient(m interface{}) *scw.Client

func ExtractZone

func ExtractZone(d terraformResourceData, m interface{}) (scw.Zone, error)

ExtractZone will try to guess the zone from the following:

• zone field of the resource data
• default zone from config

func GetRawConfigForKey

func GetRawConfigForKey(d *schema.ResourceData, key string, ty cty.Type) (interface{}, bool)

GetRawConfigForKey returns the value for a specific key in the user's raw configuration, which can be useful on resources' update The value for the key to look for must be a primitive type (bool, string, number) and the expected type of the value should be passed as the ty parameter

Types

type Config

type Config struct {
	ProviderSchema      *schema.ResourceData
	TerraformVersion    string
	ForceZone           scw.Zone
	ForceProjectID      string
	ForceOrganizationID string
	ForceAccessKey      string
	ForceSecretKey      string
	HTTPClient          *http.Client
}

type CredentialsSource

type CredentialsSource struct {
	AccessKey     string
	SecretKey     string
	ProjectID     string
	DefaultZone   string
	DefaultRegion string
}

func GetCredentialsSource

func GetCredentialsSource(defaultZoneProfile, activeProfile, providerProfile, envProfile *scw.Profile) *CredentialsSource

GetCredentialsSource infers the source of the credentials based on the priority order of the different profiles

type Meta

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

Meta contains config and SDK clients used by resources.

This meta value is passed into all resources.

func NewMeta

func NewMeta(ctx context.Context, config *Config) (*Meta, error)

NewMeta creates the Meta object containing the SDK client.

func (Meta) AccessKeySource

func (m Meta) AccessKeySource() string

func (Meta) HTTPClient

func (m Meta) HTTPClient() *http.Client

func (Meta) ProjectIDSource

func (m Meta) ProjectIDSource() string

func (Meta) RegionSource

func (m Meta) RegionSource() string

func (Meta) ScwClient

func (m Meta) ScwClient() *scw.Client

func (Meta) SecretKeySource

func (m Meta) SecretKeySource() string

func (Meta) ZoneSource

func (m Meta) ZoneSource() string