Skip to content

Latest commit

 

History

History
966 lines (608 loc) · 39.2 KB

provider.python.md

File metadata and controls

966 lines (608 loc) · 39.2 KB
Raw

provider Submodule

Constructs

DigitaloceanProvider

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

Initializers 

from cdktf_cdktf_provider_digitalocean import provider

provider.DigitaloceanProvider(
  scope: Construct,
  id: str,
  alias: str = None,
  api_endpoint: str = None,
  http_retry_max: typing.Union[int, float] = None,
  http_retry_wait_max: typing.Union[int, float] = None,
  http_retry_wait_min: typing.Union[int, float] = None,
  requests_per_second: typing.Union[int, float] = None,
  spaces_access_id: str = None,
  spaces_endpoint: str = None,
  spaces_secret_key: str = None,
  token: str = None
)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id str The scoped construct ID.
alias str Alias name.
api_endpoint str The URL to use for the DigitalOcean API.
http_retry_max typing.Union[int, float] The maximum number of retries on a failed API request.
http_retry_wait_max typing.Union[int, float] The maximum wait time (in seconds) between failed API requests.
http_retry_wait_min typing.Union[int, float] The minimum wait time (in seconds) between failed API requests.
requests_per_second typing.Union[int, float] The rate of requests per second to limit the HTTP client.
spaces_access_id str The access key ID for Spaces API operations.
spaces_endpoint str The URL to use for the DigitalOcean Spaces API.
spaces_secret_key str The secret access key for Spaces API operations.
token str The token key for API operations.
scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: str

The scoped construct ID.

Must be unique amongst siblings in the same scope

aliasOptional
  • Type: str

Alias name.

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

api_endpointOptional
  • Type: str

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}

http_retry_maxOptional
  • Type: typing.Union[int, float]

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}

http_retry_wait_maxOptional
  • Type: typing.Union[int, float]

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}

http_retry_wait_minOptional
  • Type: typing.Union[int, float]

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}

requests_per_secondOptional
  • Type: typing.Union[int, float]

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}

spaces_access_idOptional
  • Type: str

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}

spaces_endpointOptional
  • Type: str

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}

spaces_secret_keyOptional
  • Type: str

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}

tokenOptional
  • Type: str

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}

Methods

Name Description
to_string Returns a string representation of this construct.
add_override No description.
override_logical_id Overrides the auto-generated logical ID with a specific ID.
reset_override_logical_id Resets a previously passed logical Id to use the auto-generated logical id again.
to_hcl_terraform No description.
to_metadata No description.
to_terraform Adds this resource to the terraform JSON output.
reset_alias No description.
reset_api_endpoint No description.
reset_http_retry_max No description.
reset_http_retry_wait_max No description.
reset_http_retry_wait_min No description.
reset_requests_per_second No description.
reset_spaces_access_id No description.
reset_spaces_endpoint No description.
reset_spaces_secret_key No description.
reset_token No description.
to_string 
def to_string() -> str

Returns a string representation of this construct.

add_override 
def add_override(
  path: str,
  value: typing.Any
) -> None
pathRequired
  • Type: str
valueRequired
  • Type: typing.Any
override_logical_id 
def override_logical_id(
  new_logical_id: str
) -> None

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

new_logical_idRequired
  • Type: str

The new logical ID to use for this stack element.

reset_override_logical_id 
def reset_override_logical_id() -> None

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

to_hcl_terraform 
def to_hcl_terraform() -> typing.Any
to_metadata 
def to_metadata() -> typing.Any
to_terraform 
def to_terraform() -> typing.Any

Adds this resource to the terraform JSON output.

reset_alias 
def reset_alias() -> None
reset_api_endpoint 
def reset_api_endpoint() -> None
reset_http_retry_max 
def reset_http_retry_max() -> None
reset_http_retry_wait_max 
def reset_http_retry_wait_max() -> None
reset_http_retry_wait_min 
def reset_http_retry_wait_min() -> None
reset_requests_per_second 
def reset_requests_per_second() -> None
reset_spaces_access_id 
def reset_spaces_access_id() -> None
reset_spaces_endpoint 
def reset_spaces_endpoint() -> None
reset_spaces_secret_key 
def reset_spaces_secret_key() -> None
reset_token 
def reset_token() -> None

Static Functions

Name Description
is_construct Checks if x is a construct.
is_terraform_element No description.
is_terraform_provider No description.
generate_config_for_import Generates CDKTF code for importing a DigitaloceanProvider resource upon running "cdktf plan ".
is_construct 
from cdktf_cdktf_provider_digitalocean import provider

provider.DigitaloceanProvider.is_construct(
  x: typing.Any
)

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.

xRequired
  • Type: typing.Any

Any object.

is_terraform_element 
from cdktf_cdktf_provider_digitalocean import provider

provider.DigitaloceanProvider.is_terraform_element(
  x: typing.Any
)
xRequired
  • Type: typing.Any
is_terraform_provider 
from cdktf_cdktf_provider_digitalocean import provider

provider.DigitaloceanProvider.is_terraform_provider(
  x: typing.Any
)
xRequired
  • Type: typing.Any
generate_config_for_import 
from cdktf_cdktf_provider_digitalocean import provider

provider.DigitaloceanProvider.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

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

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

import_to_idRequired
  • Type: str

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

import_from_idRequired
  • Type: str

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

providerOptional
  • Type: cdktf.TerraformProvider

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

Properties

Name Type Description
node constructs.Node The tree node.
cdktf_stack cdktf.TerraformStack No description.
fqn str No description.
friendly_unique_id str No description.
meta_attributes typing.Mapping[typing.Any] No description.
terraform_resource_type str No description.
terraform_generator_metadata cdktf.TerraformProviderGeneratorMetadata No description.
terraform_provider_source str No description.
alias str No description.
alias_input str No description.
api_endpoint_input str No description.
http_retry_max_input typing.Union[int, float] No description.
http_retry_wait_max_input typing.Union[int, float] No description.
http_retry_wait_min_input typing.Union[int, float] No description.
requests_per_second_input typing.Union[int, float] No description.
spaces_access_id_input str No description.
spaces_endpoint_input str No description.
spaces_secret_key_input str No description.
token_input str No description.
api_endpoint str No description.
http_retry_max typing.Union[int, float] No description.
http_retry_wait_max typing.Union[int, float] No description.
http_retry_wait_min typing.Union[int, float] No description.
requests_per_second typing.Union[int, float] No description.
spaces_access_id str No description.
spaces_endpoint str No description.
spaces_secret_key str No description.
token str No description.
nodeRequired 
node: Node
  • Type: constructs.Node

The tree node.

cdktf_stackRequired 
cdktf_stack: TerraformStack
  • Type: cdktf.TerraformStack
fqnRequired 
fqn: str
  • Type: str
friendly_unique_idRequired 
friendly_unique_id: str
  • Type: str
meta_attributesRequired 
meta_attributes: typing.Mapping[typing.Any]
  • Type: typing.Mapping[typing.Any]
terraform_resource_typeRequired 
terraform_resource_type: str
  • Type: str
terraform_generator_metadataOptional 
terraform_generator_metadata: TerraformProviderGeneratorMetadata
  • Type: cdktf.TerraformProviderGeneratorMetadata
terraform_provider_sourceOptional 
terraform_provider_source: str
  • Type: str
aliasOptional 
alias: str
  • Type: str
alias_inputOptional 
alias_input: str
  • Type: str
api_endpoint_inputOptional 
api_endpoint_input: str
  • Type: str
http_retry_max_inputOptional 
http_retry_max_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
http_retry_wait_max_inputOptional 
http_retry_wait_max_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
http_retry_wait_min_inputOptional 
http_retry_wait_min_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
requests_per_second_inputOptional 
requests_per_second_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
spaces_access_id_inputOptional 
spaces_access_id_input: str
  • Type: str
spaces_endpoint_inputOptional 
spaces_endpoint_input: str
  • Type: str
spaces_secret_key_inputOptional 
spaces_secret_key_input: str
  • Type: str
token_inputOptional 
token_input: str
  • Type: str
api_endpointOptional 
api_endpoint: str
  • Type: str
http_retry_maxOptional 
http_retry_max: typing.Union[int, float]
  • Type: typing.Union[int, float]
http_retry_wait_maxOptional 
http_retry_wait_max: typing.Union[int, float]
  • Type: typing.Union[int, float]
http_retry_wait_minOptional 
http_retry_wait_min: typing.Union[int, float]
  • Type: typing.Union[int, float]
requests_per_secondOptional 
requests_per_second: typing.Union[int, float]
  • Type: typing.Union[int, float]
spaces_access_idOptional 
spaces_access_id: str
  • Type: str
spaces_endpointOptional 
spaces_endpoint: str
  • Type: str
spaces_secret_keyOptional 
spaces_secret_key: str
  • Type: str
tokenOptional 
token: str
  • Type: str

Constants

Name Type Description
tfResourceType str No description.
tfResourceTypeRequired 
tfResourceType: str
  • Type: str

Structs

DigitaloceanProviderConfig

Initializer 

from cdktf_cdktf_provider_digitalocean import provider

provider.DigitaloceanProviderConfig(
  alias: str = None,
  api_endpoint: str = None,
  http_retry_max: typing.Union[int, float] = None,
  http_retry_wait_max: typing.Union[int, float] = None,
  http_retry_wait_min: typing.Union[int, float] = None,
  requests_per_second: typing.Union[int, float] = None,
  spaces_access_id: str = None,
  spaces_endpoint: str = None,
  spaces_secret_key: str = None,
  token: str = None
)

Properties

Name Type Description
alias str Alias name.
api_endpoint str The URL to use for the DigitalOcean API.
http_retry_max typing.Union[int, float] The maximum number of retries on a failed API request.
http_retry_wait_max typing.Union[int, float] The maximum wait time (in seconds) between failed API requests.
http_retry_wait_min typing.Union[int, float] The minimum wait time (in seconds) between failed API requests.
requests_per_second typing.Union[int, float] The rate of requests per second to limit the HTTP client.
spaces_access_id str The access key ID for Spaces API operations.
spaces_endpoint str The URL to use for the DigitalOcean Spaces API.
spaces_secret_key str The secret access key for Spaces API operations.
token str The token key for API operations.
aliasOptional 
alias: str
  • Type: str

Alias name.

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

api_endpointOptional 
api_endpoint: str
  • Type: str

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}

http_retry_maxOptional 
http_retry_max: typing.Union[int, float]
  • Type: typing.Union[int, float]

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}

http_retry_wait_maxOptional 
http_retry_wait_max: typing.Union[int, float]
  • Type: typing.Union[int, float]

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}

http_retry_wait_minOptional 
http_retry_wait_min: typing.Union[int, float]
  • Type: typing.Union[int, float]

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}

requests_per_secondOptional 
requests_per_second: typing.Union[int, float]
  • Type: typing.Union[int, float]

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}

spaces_access_idOptional 
spaces_access_id: str
  • Type: str

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}

spaces_endpointOptional 
spaces_endpoint: str
  • Type: str

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}

spaces_secret_keyOptional 
spaces_secret_key: str
  • Type: str

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}

tokenOptional 
token: str
  • Type: str

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}