`provider` Submodule

Constructs

DigitaloceanProvider

Represents a {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs digitalocean}.

Initializers

import "github.com/cdktf/cdktf-provider-digitalocean-go/digitalocean/v11/provider"

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

Name	Type	Description
`scope`	`github.com/aws/constructs-go/constructs/v10.Construct`	The scope in which to define this construct.
`id`	`*string`	The scoped construct ID.
`config`	`DigitaloceanProviderConfig`	No description.

`scope`^Required

Type: github.com/aws/constructs-go/constructs/v10.Construct

The scope in which to define this construct.

`id`^Required

Type: *string

The scoped construct ID.

Must be unique amongst siblings in the same scope

`config`^Optional

Type: DigitaloceanProviderConfig

Methods

Name	Description
`ToString`	Returns a string representation of this construct.
`AddOverride`	No description.
`OverrideLogicalId`	Overrides the auto-generated logical ID with a specific ID.
`ResetOverrideLogicalId`	Resets a previously passed logical Id to use the auto-generated logical id again.
`ToHclTerraform`	No description.
`ToMetadata`	No description.
`ToTerraform`	Adds this resource to the terraform JSON output.
`ResetAlias`	No description.
`ResetApiEndpoint`	No description.
`ResetHttpRetryMax`	No description.
`ResetHttpRetryWaitMax`	No description.
`ResetHttpRetryWaitMin`	No description.
`ResetRequestsPerSecond`	No description.
`ResetSpacesAccessId`	No description.
`ResetSpacesEndpoint`	No description.
`ResetSpacesSecretKey`	No description.
`ResetToken`	No description.

`ToString`

func ToString() *string

Returns a string representation of this construct.

`AddOverride`

func AddOverride(path *string, value interface{})

`path`^Required

Type: *string

`value`^Required

Type: interface{}

`OverrideLogicalId`

func OverrideLogicalId(newLogicalId *string)

Overrides the auto-generated logical ID with a specific ID.

`newLogicalId`^Required

Type: *string

The new logical ID to use for this stack element.

`ResetOverrideLogicalId`

func ResetOverrideLogicalId()

Resets a previously passed logical Id to use the auto-generated logical id again.

`ToHclTerraform`

func ToHclTerraform() interface{}

`ToMetadata`

func ToMetadata() interface{}

`ToTerraform`

func ToTerraform() interface{}

Adds this resource to the terraform JSON output.

`ResetAlias`

func ResetAlias()

`ResetApiEndpoint`

func ResetApiEndpoint()

`ResetHttpRetryMax`

func ResetHttpRetryMax()

`ResetHttpRetryWaitMax`

func ResetHttpRetryWaitMax()

`ResetHttpRetryWaitMin`

func ResetHttpRetryWaitMin()

`ResetRequestsPerSecond`

func ResetRequestsPerSecond()

`ResetSpacesAccessId`

func ResetSpacesAccessId()

`ResetSpacesEndpoint`

func ResetSpacesEndpoint()

`ResetSpacesSecretKey`

func ResetSpacesSecretKey()

`ResetToken`

func ResetToken()

Static Functions

Name	Description
`IsConstruct`	Checks if `x` is a construct.
`IsTerraformElement`	No description.
`IsTerraformProvider`	No description.
`GenerateConfigForImport`	Generates CDKTF code for importing a DigitaloceanProvider resource upon running "cdktf plan ".

`IsConstruct`

import "github.com/cdktf/cdktf-provider-digitalocean-go/digitalocean/v11/provider"

provider.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.

`x`^Required

Type: interface{}

Any object.

`IsTerraformElement`

import "github.com/cdktf/cdktf-provider-digitalocean-go/digitalocean/v11/provider"

provider.DigitaloceanProvider_IsTerraformElement(x interface{}) *bool

`x`^Required

Type: interface{}

`IsTerraformProvider`

import "github.com/cdktf/cdktf-provider-digitalocean-go/digitalocean/v11/provider"

provider.DigitaloceanProvider_IsTerraformProvider(x interface{}) *bool

`x`^Required

Type: interface{}

`GenerateConfigForImport`

import "github.com/cdktf/cdktf-provider-digitalocean-go/digitalocean/v11/provider"

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

Generates CDKTF code for importing a DigitaloceanProvider resource upon running "cdktf plan ".

`scope`^Required

Type: github.com/aws/constructs-go/constructs/v10.Construct

The scope in which to define this construct.

`importToId`^Required

Type: *string

The construct id used in the generated config for the DigitaloceanProvider to import.

`importFromId`^Required

Type: *string

The id of the existing DigitaloceanProvider that should be imported.

Refer to the {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs#import import section} in the documentation of this resource for the id to use

`provider`^Optional

Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

? Optional instance of the provider where the DigitaloceanProvider to import is found.

Properties

Name	Type	Description
`Node`	`github.com/aws/constructs-go/constructs/v10.Node`	The tree node.
`CdktfStack`	`github.com/hashicorp/terraform-cdk-go/cdktf.TerraformStack`	No description.
`Fqn`	`*string`	No description.
`FriendlyUniqueId`	`*string`	No description.
`MetaAttributes`	`*map[string]interface{}`	No description.
`TerraformResourceType`	`*string`	No description.
`TerraformGeneratorMetadata`	`github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProviderGeneratorMetadata`	No description.
`TerraformProviderSource`	`*string`	No description.
`Alias`	`*string`	No description.
`AliasInput`	`*string`	No description.
`ApiEndpointInput`	`*string`	No description.
`HttpRetryMaxInput`	`*f64`	No description.
`HttpRetryWaitMaxInput`	`*f64`	No description.
`HttpRetryWaitMinInput`	`*f64`	No description.
`RequestsPerSecondInput`	`*f64`	No description.
`SpacesAccessIdInput`	`*string`	No description.
`SpacesEndpointInput`	`*string`	No description.
`SpacesSecretKeyInput`	`*string`	No description.
`TokenInput`	`*string`	No description.
`ApiEndpoint`	`*string`	No description.
`HttpRetryMax`	`*f64`	No description.
`HttpRetryWaitMax`	`*f64`	No description.
`HttpRetryWaitMin`	`*f64`	No description.
`RequestsPerSecond`	`*f64`	No description.
`SpacesAccessId`	`*string`	No description.
`SpacesEndpoint`	`*string`	No description.
`SpacesSecretKey`	`*string`	No description.
`Token`	`*string`	No description.

`Node`^Required

func Node() Node

Type: github.com/aws/constructs-go/constructs/v10.Node

The tree node.

`CdktfStack`^Required

func CdktfStack() TerraformStack

Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformStack

`Fqn`^Required

func Fqn() *string

Type: *string

`FriendlyUniqueId`^Required

func FriendlyUniqueId() *string

Type: *string

`MetaAttributes`^Required

func MetaAttributes() *map[string]interface{}

Type: *map[string]interface{}

`TerraformResourceType`^Required

func TerraformResourceType() *string

Type: *string

`TerraformGeneratorMetadata`^Optional

func TerraformGeneratorMetadata() TerraformProviderGeneratorMetadata

Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProviderGeneratorMetadata

`TerraformProviderSource`^Optional

func TerraformProviderSource() *string

Type: *string

`Alias`^Optional

func Alias() *string

Type: *string

`AliasInput`^Optional

func AliasInput() *string

Type: *string

`ApiEndpointInput`^Optional

func ApiEndpointInput() *string

Type: *string

`HttpRetryMaxInput`^Optional

func HttpRetryMaxInput() *f64

Type: *f64

`HttpRetryWaitMaxInput`^Optional

func HttpRetryWaitMaxInput() *f64

Type: *f64

`HttpRetryWaitMinInput`^Optional

func HttpRetryWaitMinInput() *f64

Type: *f64

`RequestsPerSecondInput`^Optional

func RequestsPerSecondInput() *f64

Type: *f64

`SpacesAccessIdInput`^Optional

func SpacesAccessIdInput() *string

Type: *string

`SpacesEndpointInput`^Optional

func SpacesEndpointInput() *string

Type: *string

`SpacesSecretKeyInput`^Optional

func SpacesSecretKeyInput() *string

Type: *string

`TokenInput`^Optional

func TokenInput() *string

Type: *string

`ApiEndpoint`^Optional

func ApiEndpoint() *string

Type: *string

`HttpRetryMax`^Optional

func HttpRetryMax() *f64

Type: *f64

`HttpRetryWaitMax`^Optional

func HttpRetryWaitMax() *f64

Type: *f64

`HttpRetryWaitMin`^Optional

func HttpRetryWaitMin() *f64

Type: *f64

`RequestsPerSecond`^Optional

func RequestsPerSecond() *f64

Type: *f64

`SpacesAccessId`^Optional

func SpacesAccessId() *string

Type: *string

`SpacesEndpoint`^Optional

func SpacesEndpoint() *string

Type: *string

`SpacesSecretKey`^Optional

func SpacesSecretKey() *string

Type: *string

`Token`^Optional

func Token() *string

Type: *string

Constants

Name	Type	Description
`TfResourceType`	`*string`	No description.

`TfResourceType`^Required

func TfResourceType() *string

Type: *string

Structs

DigitaloceanProviderConfig

Initializer

import "github.com/cdktf/cdktf-provider-digitalocean-go/digitalocean/v11/provider"

&provider.DigitaloceanProviderConfig {
	Alias: *string,
	ApiEndpoint: *string,
	HttpRetryMax: *f64,
	HttpRetryWaitMax: *f64,
	HttpRetryWaitMin: *f64,
	RequestsPerSecond: *f64,
	SpacesAccessId: *string,
	SpacesEndpoint: *string,
	SpacesSecretKey: *string,
	Token: *string,
}

Properties

Name	Type	Description
`Alias`	`*string`	Alias name.
`ApiEndpoint`	`*string`	The URL to use for the DigitalOcean API.
`HttpRetryMax`	`*f64`	The maximum number of retries on a failed API request.
`HttpRetryWaitMax`	`*f64`	The maximum wait time (in seconds) between failed API requests.
`HttpRetryWaitMin`	`*f64`	The minimum wait time (in seconds) between failed API requests.
`RequestsPerSecond`	`*f64`	The rate of requests per second to limit the HTTP client.
`SpacesAccessId`	`*string`	The access key ID for Spaces API operations.
`SpacesEndpoint`	`*string`	The URL to use for the DigitalOcean Spaces API.
`SpacesSecretKey`	`*string`	The secret access key for Spaces API operations.
`Token`	`*string`	The token key for API operations.

`Alias`^Optional

Alias *string

Type: *string

Alias name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs#alias DigitaloceanProvider#alias}

`ApiEndpoint`^Optional

ApiEndpoint *string

Type: *string

The URL to use for the DigitalOcean API.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs#api_endpoint DigitaloceanProvider#api_endpoint}

`HttpRetryMax`^Optional

HttpRetryMax *f64

Type: *f64

The maximum number of retries on a failed API request.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs#http_retry_max DigitaloceanProvider#http_retry_max}

`HttpRetryWaitMax`^Optional

HttpRetryWaitMax *f64

Type: *f64

The maximum wait time (in seconds) between failed API requests.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs#http_retry_wait_max DigitaloceanProvider#http_retry_wait_max}

`HttpRetryWaitMin`^Optional

HttpRetryWaitMin *f64

Type: *f64

The minimum wait time (in seconds) between failed API requests.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs#http_retry_wait_min DigitaloceanProvider#http_retry_wait_min}

`RequestsPerSecond`^Optional

RequestsPerSecond *f64

Type: *f64

The rate of requests per second to limit the HTTP client.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs#requests_per_second DigitaloceanProvider#requests_per_second}

`SpacesAccessId`^Optional

SpacesAccessId *string

Type: *string

The access key ID for Spaces API operations.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs#spaces_access_id DigitaloceanProvider#spaces_access_id}

`SpacesEndpoint`^Optional

SpacesEndpoint *string

Type: *string

The URL to use for the DigitalOcean Spaces API.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs#spaces_endpoint DigitaloceanProvider#spaces_endpoint}

`SpacesSecretKey`^Optional

SpacesSecretKey *string

Type: *string

The secret access key for Spaces API operations.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs#spaces_secret_key DigitaloceanProvider#spaces_secret_key}

`Token`^Optional

Token *string

Type: *string

The token key for API operations.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs#token DigitaloceanProvider#token}

Files

provider.go.md

Latest commit

History

provider.go.md

File metadata and controls

provider Submodule

Constructs

DigitaloceanProvider

Initializers

scopeRequired

idRequired

configOptional

Methods

ToString

AddOverride

pathRequired

valueRequired

OverrideLogicalId

newLogicalIdRequired

ResetOverrideLogicalId

ToHclTerraform

ToMetadata

ToTerraform

ResetAlias

ResetApiEndpoint

ResetHttpRetryMax

ResetHttpRetryWaitMax

ResetHttpRetryWaitMin

ResetRequestsPerSecond

ResetSpacesAccessId

ResetSpacesEndpoint

ResetSpacesSecretKey

ResetToken

Static Functions

IsConstruct

xRequired

IsTerraformElement

xRequired

IsTerraformProvider

xRequired

GenerateConfigForImport

scopeRequired

importToIdRequired

importFromIdRequired

providerOptional

Properties

NodeRequired

CdktfStackRequired

FqnRequired

FriendlyUniqueIdRequired

MetaAttributesRequired

TerraformResourceTypeRequired

TerraformGeneratorMetadataOptional

TerraformProviderSourceOptional

AliasOptional

AliasInputOptional

ApiEndpointInputOptional

HttpRetryMaxInputOptional

HttpRetryWaitMaxInputOptional

HttpRetryWaitMinInputOptional

RequestsPerSecondInputOptional

SpacesAccessIdInputOptional

SpacesEndpointInputOptional

SpacesSecretKeyInputOptional

TokenInputOptional

ApiEndpointOptional

HttpRetryMaxOptional

HttpRetryWaitMaxOptional

HttpRetryWaitMinOptional

RequestsPerSecondOptional

SpacesAccessIdOptional

SpacesEndpointOptional

SpacesSecretKeyOptional

TokenOptional

Constants

TfResourceTypeRequired

Structs

DigitaloceanProviderConfig

Initializer

`provider` Submodule

`scope`^Required

`id`^Required

`config`^Optional

`ToString`

`AddOverride`

`path`^Required

`value`^Required

`OverrideLogicalId`

`newLogicalId`^Required

`ResetOverrideLogicalId`

`ToHclTerraform`

`ToMetadata`

`ToTerraform`

`ResetAlias`

`ResetApiEndpoint`

`ResetHttpRetryMax`

`ResetHttpRetryWaitMax`

`ResetHttpRetryWaitMin`

`ResetRequestsPerSecond`

`ResetSpacesAccessId`

`ResetSpacesEndpoint`

`ResetSpacesSecretKey`

`ResetToken`

`IsConstruct`

`x`^Required

`IsTerraformElement`

`x`^Required

`IsTerraformProvider`

`x`^Required

`GenerateConfigForImport`

`scope`^Required

`importToId`^Required

`importFromId`^Required

`provider`^Optional

`Node`^Required

`CdktfStack`^Required

`Fqn`^Required

`FriendlyUniqueId`^Required

`MetaAttributes`^Required

`TerraformResourceType`^Required

`TerraformGeneratorMetadata`^Optional

`TerraformProviderSource`^Optional

`Alias`^Optional

`AliasInput`^Optional

`ApiEndpointInput`^Optional

`HttpRetryMaxInput`^Optional

`HttpRetryWaitMaxInput`^Optional

`HttpRetryWaitMinInput`^Optional

`RequestsPerSecondInput`^Optional

`SpacesAccessIdInput`^Optional

`SpacesEndpointInput`^Optional

`SpacesSecretKeyInput`^Optional

`TokenInput`^Optional

`ApiEndpoint`^Optional

`HttpRetryMax`^Optional

`HttpRetryWaitMax`^Optional

`HttpRetryWaitMin`^Optional

`RequestsPerSecond`^Optional

`SpacesAccessId`^Optional

`SpacesEndpoint`^Optional

`SpacesSecretKey`^Optional

`Token`^Optional

`TfResourceType`^Required

`Alias`^Optional

`ApiEndpoint`^Optional

`HttpRetryMax`^Optional

`HttpRetryWaitMax`^Optional

`HttpRetryWaitMin`^Optional

`RequestsPerSecond`^Optional

`SpacesAccessId`^Optional

`SpacesEndpoint`^Optional

`SpacesSecretKey`^Optional

`Token`^Optional