provider

README

provider

Refer to the Terraform Registory for docs: upcloud.

Documentation

Index

• func NewUpcloudProvider_Override(u UpcloudProvider, scope constructs.Construct, id *string, ...)
• func UpcloudProvider_IsConstruct(x interface{}) *bool
• func UpcloudProvider_IsTerraformElement(x interface{}) *bool
• func UpcloudProvider_IsTerraformProvider(x interface{}) *bool
• func UpcloudProvider_TfResourceType() *string
• type UpcloudProvider
  • func NewUpcloudProvider(scope constructs.Construct, id *string, config *UpcloudProviderConfig) UpcloudProvider
• type UpcloudProviderConfig

Functions

func NewUpcloudProvider_Override

func NewUpcloudProvider_Override(u UpcloudProvider, scope constructs.Construct, id *string, config *UpcloudProviderConfig)

Create a new {@link https://www.terraform.io/docs/providers/upcloud upcloud} Resource.

func UpcloudProvider_IsConstruct

func UpcloudProvider_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.

Returns: true if `x` is an object created from a class which extends `Construct`.

func UpcloudProvider_IsTerraformElement

func UpcloudProvider_IsTerraformElement(x interface{}) *bool

Experimental.

func UpcloudProvider_IsTerraformProvider

func UpcloudProvider_IsTerraformProvider(x interface{}) *bool

Experimental.

func UpcloudProvider_TfResourceType

func UpcloudProvider_TfResourceType() *string

Types

type UpcloudProvider

type UpcloudProvider interface {
	cdktf.TerraformProvider
	Alias() *string
	SetAlias(val *string)
	AliasInput() *string
	// Experimental.
	CdktfStack() cdktf.TerraformStack
	// Experimental.
	ConstructNodeMetadata() *map[string]interface{}
	// Experimental.
	Fqn() *string
	// Experimental.
	FriendlyUniqueId() *string
	// Experimental.
	MetaAttributes() *map[string]interface{}
	// The tree node.
	Node() constructs.Node
	Password() *string
	SetPassword(val *string)
	PasswordInput() *string
	// Experimental.
	RawOverrides() interface{}
	RetryMax() *float64
	SetRetryMax(val *float64)
	RetryMaxInput() *float64
	RetryWaitMaxSec() *float64
	SetRetryWaitMaxSec(val *float64)
	RetryWaitMaxSecInput() *float64
	RetryWaitMinSec() *float64
	SetRetryWaitMinSec(val *float64)
	RetryWaitMinSecInput() *float64
	// Experimental.
	TerraformGeneratorMetadata() *cdktf.TerraformProviderGeneratorMetadata
	// Experimental.
	TerraformProviderSource() *string
	// Experimental.
	TerraformResourceType() *string
	Username() *string
	SetUsername(val *string)
	UsernameInput() *string
	// Experimental.
	AddOverride(path *string, value interface{})
	// Overrides the auto-generated logical ID with a specific ID.
	// Experimental.
	OverrideLogicalId(newLogicalId *string)
	ResetAlias()
	// Resets a previously passed logical Id to use the auto-generated logical id again.
	// Experimental.
	ResetOverrideLogicalId()
	ResetPassword()
	ResetRetryMax()
	ResetRetryWaitMaxSec()
	ResetRetryWaitMinSec()
	ResetUsername()
	SynthesizeAttributes() *map[string]interface{}
	// Experimental.
	ToMetadata() interface{}
	// Returns a string representation of this construct.
	ToString() *string
	// Adds this resource to the terraform JSON output.
	// Experimental.
	ToTerraform() interface{}
}

Represents a {@link https://www.terraform.io/docs/providers/upcloud upcloud}.

func NewUpcloudProvider

func NewUpcloudProvider(scope constructs.Construct, id *string, config *UpcloudProviderConfig) UpcloudProvider

Create a new {@link https://www.terraform.io/docs/providers/upcloud upcloud} Resource.

type UpcloudProviderConfig

type UpcloudProviderConfig struct {
	// Alias name.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/upcloud#alias UpcloudProvider#alias}
	Alias *string `field:"optional" json:"alias" yaml:"alias"`
	// Password for UpCloud API user. Can also be configured using the `UPCLOUD_PASSWORD` environment variable.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/upcloud#password UpcloudProvider#password}
	Password *string `field:"optional" json:"password" yaml:"password"`
	// Maximum number of retries.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/upcloud#retry_max UpcloudProvider#retry_max}
	RetryMax *float64 `field:"optional" json:"retryMax" yaml:"retryMax"`
	// Maximum time to wait between retries.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/upcloud#retry_wait_max_sec UpcloudProvider#retry_wait_max_sec}
	RetryWaitMaxSec *float64 `field:"optional" json:"retryWaitMaxSec" yaml:"retryWaitMaxSec"`
	// Minimum time to wait between retries.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/upcloud#retry_wait_min_sec UpcloudProvider#retry_wait_min_sec}
	RetryWaitMinSec *float64 `field:"optional" json:"retryWaitMinSec" yaml:"retryWaitMinSec"`
	// UpCloud username with API access. Can also be configured using the `UPCLOUD_USERNAME` environment variable.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/upcloud#username UpcloudProvider#username}
	Username *string `field:"optional" json:"username" yaml:"username"`
}