provider

README

provider

Refer to the Terraform Registry for docs: digitalocean.

Documentation

Index

• func DigitaloceanProvider_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, ...) cdktf.ImportableResource
• func DigitaloceanProvider_IsConstruct(x interface{}) *bool
• func DigitaloceanProvider_IsTerraformElement(x interface{}) *bool
• func DigitaloceanProvider_IsTerraformProvider(x interface{}) *bool
• func DigitaloceanProvider_TfResourceType() *string
• func NewDigitaloceanProvider_Override(d DigitaloceanProvider, scope constructs.Construct, id *string, ...)
• type DigitaloceanProvider
  • func NewDigitaloceanProvider(scope constructs.Construct, id *string, config *DigitaloceanProviderConfig) DigitaloceanProvider
• type DigitaloceanProviderConfig

Functions

func DigitaloceanProvider_GenerateConfigForImport

func DigitaloceanProvider_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, provider cdktf.TerraformProvider) cdktf.ImportableResource

Generates CDKTF code for importing a DigitaloceanProvider resource upon running "cdktf plan <stack-name>".

func DigitaloceanProvider_IsConstruct

func DigitaloceanProvider_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 DigitaloceanProvider_IsTerraformElement

func DigitaloceanProvider_IsTerraformElement(x interface{}) *bool

Experimental.

func DigitaloceanProvider_IsTerraformProvider

func DigitaloceanProvider_IsTerraformProvider(x interface{}) *bool

Experimental.

func DigitaloceanProvider_TfResourceType

func DigitaloceanProvider_TfResourceType() *string

func NewDigitaloceanProvider_Override

func NewDigitaloceanProvider_Override(d DigitaloceanProvider, scope constructs.Construct, id *string, config *DigitaloceanProviderConfig)

Create a new {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.37.0/docs digitalocean} Resource.

Types

type DigitaloceanProvider

type DigitaloceanProvider interface {
	cdktf.TerraformProvider
	Alias() *string
	SetAlias(val *string)
	AliasInput() *string
	ApiEndpoint() *string
	SetApiEndpoint(val *string)
	ApiEndpointInput() *string
	// Experimental.
	CdktfStack() cdktf.TerraformStack
	// Experimental.
	ConstructNodeMetadata() *map[string]interface{}
	// Experimental.
	Fqn() *string
	// Experimental.
	FriendlyUniqueId() *string
	HttpRetryMax() *float64
	SetHttpRetryMax(val *float64)
	HttpRetryMaxInput() *float64
	HttpRetryWaitMax() *float64
	SetHttpRetryWaitMax(val *float64)
	HttpRetryWaitMaxInput() *float64
	HttpRetryWaitMin() *float64
	SetHttpRetryWaitMin(val *float64)
	HttpRetryWaitMinInput() *float64
	// Experimental.
	MetaAttributes() *map[string]interface{}
	// The tree node.
	Node() constructs.Node
	// Experimental.
	RawOverrides() interface{}
	RequestsPerSecond() *float64
	SetRequestsPerSecond(val *float64)
	RequestsPerSecondInput() *float64
	SpacesAccessId() *string
	SetSpacesAccessId(val *string)
	SpacesAccessIdInput() *string
	SpacesEndpoint() *string
	SetSpacesEndpoint(val *string)
	SpacesEndpointInput() *string
	SpacesSecretKey() *string
	SetSpacesSecretKey(val *string)
	SpacesSecretKeyInput() *string
	// Experimental.
	TerraformGeneratorMetadata() *cdktf.TerraformProviderGeneratorMetadata
	// Experimental.
	TerraformProviderSource() *string
	// Experimental.
	TerraformResourceType() *string
	Token() *string
	SetToken(val *string)
	TokenInput() *string
	// Experimental.
	AddOverride(path *string, value interface{})
	// Overrides the auto-generated logical ID with a specific ID.
	// Experimental.
	OverrideLogicalId(newLogicalId *string)
	ResetAlias()
	ResetApiEndpoint()
	ResetHttpRetryMax()
	ResetHttpRetryWaitMax()
	ResetHttpRetryWaitMin()
	// Resets a previously passed logical Id to use the auto-generated logical id again.
	// Experimental.
	ResetOverrideLogicalId()
	ResetRequestsPerSecond()
	ResetSpacesAccessId()
	ResetSpacesEndpoint()
	ResetSpacesSecretKey()
	ResetToken()
	SynthesizeAttributes() *map[string]interface{}
	SynthesizeHclAttributes() *map[string]interface{}
	// Experimental.
	ToHclTerraform() 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://registry.terraform.io/providers/digitalocean/digitalocean/2.37.0/docs digitalocean}.

func NewDigitaloceanProvider

func NewDigitaloceanProvider(scope constructs.Construct, id *string, config *DigitaloceanProviderConfig) DigitaloceanProvider

Create a new {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.37.0/docs digitalocean} Resource.

type DigitaloceanProviderConfig

type DigitaloceanProviderConfig struct {
	// Alias name.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.37.0/docs#alias DigitaloceanProvider#alias}
	Alias *string `field:"optional" json:"alias" yaml:"alias"`
	// The URL to use for the DigitalOcean API.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.37.0/docs#api_endpoint DigitaloceanProvider#api_endpoint}
	ApiEndpoint *string `field:"optional" json:"apiEndpoint" yaml:"apiEndpoint"`
	// The maximum number of retries on a failed API request.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.37.0/docs#http_retry_max DigitaloceanProvider#http_retry_max}
	HttpRetryMax *float64 `field:"optional" json:"httpRetryMax" yaml:"httpRetryMax"`
	// The maximum wait time (in seconds) between failed API requests.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.37.0/docs#http_retry_wait_max DigitaloceanProvider#http_retry_wait_max}
	HttpRetryWaitMax *float64 `field:"optional" json:"httpRetryWaitMax" yaml:"httpRetryWaitMax"`
	// The minimum wait time (in seconds) between failed API requests.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.37.0/docs#http_retry_wait_min DigitaloceanProvider#http_retry_wait_min}
	HttpRetryWaitMin *float64 `field:"optional" json:"httpRetryWaitMin" yaml:"httpRetryWaitMin"`
	// The rate of requests per second to limit the HTTP client.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.37.0/docs#requests_per_second DigitaloceanProvider#requests_per_second}
	RequestsPerSecond *float64 `field:"optional" json:"requestsPerSecond" yaml:"requestsPerSecond"`
	// The access key ID for Spaces API operations.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.37.0/docs#spaces_access_id DigitaloceanProvider#spaces_access_id}
	SpacesAccessId *string `field:"optional" json:"spacesAccessId" yaml:"spacesAccessId"`
	// The URL to use for the DigitalOcean Spaces API.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.37.0/docs#spaces_endpoint DigitaloceanProvider#spaces_endpoint}
	SpacesEndpoint *string `field:"optional" json:"spacesEndpoint" yaml:"spacesEndpoint"`
	// The secret access key for Spaces API operations.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.37.0/docs#spaces_secret_key DigitaloceanProvider#spaces_secret_key}
	SpacesSecretKey *string `field:"optional" json:"spacesSecretKey" yaml:"spacesSecretKey"`
	// The token key for API operations.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.37.0/docs#token DigitaloceanProvider#token}
	Token *string `field:"optional" json:"token" yaml:"token"`
}