»API Reference for Python

»Constructs

»App

Represents a cdktf application.

»Initializers

import cdktf

cdktf.App(
  context: typing.Mapping[typing.Any] = None,
  outdir: str = None,
  skip_validation: bool = None,
  stack_traces: bool = None
)

import cdktf

cdktf.App(
  context: typing.Mapping[typing.Any] = None,
  outdir: str = None,
  skip_validation: bool = None,
  stack_traces: bool = None
)

»context^Optional

• Type: typing.Mapping[typing.Any]
• Default: no additional context

Additional context values for the application.

Context set by the CLI or the context key in cdktf.json has precedence.

Context can be read from any construct using node.getContext(key).

»outdir^Optional

• Type: str
• Default: CDKTF_OUTDIR if defined, otherwise "cdktf.out"

The directory to output Terraform resources.

»skip_validation^Optional

• Type: bool
• Default: false

Whether to skip the validation during synthesis of the app.

»stack_traces^Optional

• Type: bool

»Methods

»to_string

def to_string() - > str

def to_string() - > str

Returns a string representation of this construct.

»cross_stack_reference

def cross_stack_reference(
  from_stack: TerraformStack,
  to_stack: TerraformStack,
  identifier: str
) - > str

def cross_stack_reference(
  from_stack: TerraformStack,
  to_stack: TerraformStack,
  identifier: str
) - > str

Creates a reference from one stack to another, invoked on prepareStack since it creates extra resources.

»from_stack^Required

• Type: TerraformStack

»to_stack^Required

• Type: TerraformStack

»identifier^Required

• Type: str

»synth

def synth() - > None

def synth() - > None

Synthesizes all resources to the output directory.

»Static Functions

»is_construct

import cdktf

cdktf.App.is_construct(
  x: typing.Any
)

import cdktf

cdktf.App.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.

»x^Required

• Type: typing.Any

Any object.

»is_app

import cdktf

cdktf.App.is_app(
  x: typing.Any
)

import cdktf

cdktf.App.is_app(
  x: typing.Any
)

»x^Required

• Type: typing.Any

»of

import cdktf

cdktf.App.of(
  construct: IConstruct
)

import cdktf

cdktf.App.of(
  construct: IConstruct
)

»construct^Required

• Type: constructs.IConstruct

»Properties

»node^Required

node: Node

node: Node

• Type: constructs.Node

The tree node.

»manifest^Required

manifest: Manifest

manifest: Manifest

• Type: Manifest

»outdir^Required

outdir: str

outdir: str

• Type: str

The output directory into which resources will be synthesized.

»skip_validation^Optional

skip_validation: bool

skip_validation: bool

• Type: bool

Whether to skip the validation during synthesis of the app.

»target_stack_id^Optional

target_stack_id: str

target_stack_id: str

• Type: str

The stack which will be synthesized.

If not set, all stacks will be synthesized.

»ArtifactoryBackend

»Initializers

import cdktf

cdktf.ArtifactoryBackend(
  scope: Construct,
  password: str,
  repo: str,
  subpath: str,
  url: str,
  username: str
)

import cdktf

cdktf.ArtifactoryBackend(
  scope: Construct,
  password: str,
  repo: str,
  subpath: str,
  url: str,
  username: str
)

»scope^Required

• Type: constructs.Construct

»password^Required

• Type: str

(Required) - The password.

»repo^Required

• Type: str

(Required) - The repository name.

»subpath^Required

• Type: str

(Required) - Path within the repository.

»url^Required

• Type: str

(Required) - The URL.

Note that this is the base url to artifactory not the full repo and subpath.

»username^Required

• Type: str

(Required) - The username.

»Methods

»to_string

def to_string() - > str

def to_string() - > str

Returns a string representation of this construct.

»add_override

def add_override(
  path: str,
  value: typing.Any
) - > None

def add_override(
  path: str,
  value: typing.Any
) - > None

»path^Required

• Type: str

»value^Required

• Type: typing.Any

»override_logical_id

def override_logical_id(
  new_logical_id: str
) - > None

def override_logical_id(
  new_logical_id: str
) - > None

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

»new_logical_id^Required

• Type: str

The new logical ID to use for this stack element.

»reset_override_logical_id

def reset_override_logical_id() - > None

def reset_override_logical_id() - > None

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

»to_metadata

def to_metadata() - > typing.Any

def to_metadata() - > typing.Any

»to_terraform

def to_terraform() - > typing.Any

def to_terraform() - > typing.Any

Adds this resource to the terraform JSON output.

»get_remote_state_data_source

def get_remote_state_data_source(
  scope: Construct,
  name: str,
  _fromstack: str
) - > TerraformRemoteState

def get_remote_state_data_source(
  scope: Construct,
  name: str,
  _fromstack: str
) - > TerraformRemoteState

Creates a TerraformRemoteState resource that accesses this backend.

»scope^Required

• Type: constructs.Construct

»name^Required

• Type: str

»_fromstack^Required

• Type: str

»Static Functions

»is_construct

import cdktf

cdktf.ArtifactoryBackend.is_construct(
  x: typing.Any
)

import cdktf

cdktf.ArtifactoryBackend.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.

»x^Required

• Type: typing.Any

Any object.

»is_backend

import cdktf

cdktf.ArtifactoryBackend.is_backend(
  x: typing.Any
)

import cdktf

cdktf.ArtifactoryBackend.is_backend(
  x: typing.Any
)

»x^Required

• Type: typing.Any

»Properties

»node^Required

node: Node

node: Node

• Type: constructs.Node

The tree node.

»cdktf_stack^Required

cdktf_stack: TerraformStack

cdktf_stack: TerraformStack

• Type: TerraformStack

»fqn^Required

fqn: str

fqn: str

• Type: str

»friendly_unique_id^Required

friendly_unique_id: str

friendly_unique_id: str

• Type: str

»AzurermBackend

»Initializers

import cdktf

cdktf.AzurermBackend(
  scope: Construct,
  container_name: str,
  key: str,
  storage_account_name: str,
  access_key: str = None,
  client_id: str = None,
  client_secret: str = None,
  endpoint: str = None,
  environment: str = None,
  msi_endpoint: str = None,
  resource_group_name: str = None,
  sas_token: str = None,
  subscription_id: str = None,
  tenant_id: str = None,
  use_msi: bool = None
)

import cdktf

cdktf.AzurermBackend(
  scope: Construct,
  container_name: str,
  key: str,
  storage_account_name: str,
  access_key: str = None,
  client_id: str = None,
  client_secret: str = None,
  endpoint: str = None,
  environment: str = None,
  msi_endpoint: str = None,
  resource_group_name: str = None,
  sas_token: str = None,
  subscription_id: str = None,
  tenant_id: str = None,
  use_msi: bool = None
)

»scope^Required

• Type: constructs.Construct

»container_name^Required

• Type: str

(Required) The Name of the Storage Container within the Storage Account.

»key^Required

• Type: str

(Required) The name of the Blob used to retrieve/store Terraform's State file inside the Storage Container.

»storage_account_name^Required

• Type: str

(Required) The Name of the Storage Account.

»access_key^Optional

• Type: str

access_key - (Optional) The Access Key used to access the Blob Storage Account.

This can also be sourced from the ARM_ACCESS_KEY environment variable.

»client_id^Optional

• Type: str

(Optional) The Client ID of the Service Principal.

This can also be sourced from the ARM_CLIENT_ID environment variable.

»client_secret^Optional

• Type: str

(Optional) The Client Secret of the Service Principal.

This can also be sourced from the ARM_CLIENT_SECRET environment variable.

»endpoint^Optional

• Type: str

(Optional) The Custom Endpoint for Azure Resource Manager. This can also be sourced from the ARM_ENDPOINT environment variable.

NOTE: An endpoint should only be configured when using Azure Stack.

»environment^Optional

• Type: str

(Optional) The Azure Environment which should be used.

This can also be sourced from the ARM_ENVIRONMENT environment variable. Possible values are public, china, german, stack and usgovernment. Defaults to public.

»msi_endpoint^Optional

• Type: str

(Optional) The path to a custom Managed Service Identity endpoint which is automatically determined if not specified.

This can also be sourced from the ARM_MSI_ENDPOINT environment variable.

»resource_group_name^Optional

• Type: str

(Required) The Name of the Resource Group in which the Storage Account exists.

»sas_token^Optional

• Type: str

(Optional) The SAS Token used to access the Blob Storage Account.

This can also be sourced from the ARM_SAS_TOKEN environment variable.

»subscription_id^Optional

• Type: str

(Optional) The Subscription ID in which the Storage Account exists.

This can also be sourced from the ARM_SUBSCRIPTION_ID environment variable.

»tenant_id^Optional

• Type: str

(Optional) The Tenant ID in which the Subscription exists.

This can also be sourced from the ARM_TENANT_ID environment variable.

»use_msi^Optional

• Type: bool

(Optional) Should Managed Service Identity authentication be used?

This can also be sourced from the ARM_USE_MSI environment variable.

»Methods

»to_string

def to_string() - > str

def to_string() - > str

Returns a string representation of this construct.

»add_override

def add_override(
  path: str,
  value: typing.Any
) - > None

def add_override(
  path: str,
  value: typing.Any
) - > None

»path^Required

• Type: str

»value^Required

• Type: typing.Any

»override_logical_id

def override_logical_id(
  new_logical_id: str
) - > None

def override_logical_id(
  new_logical_id: str
) - > None

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

»new_logical_id^Required

• Type: str

The new logical ID to use for this stack element.

»reset_override_logical_id

def reset_override_logical_id() - > None

def reset_override_logical_id() - > None

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

»to_metadata

def to_metadata() - > typing.Any

def to_metadata() - > typing.Any

»to_terraform

def to_terraform() - > typing.Any

def to_terraform() - > typing.Any

Adds this resource to the terraform JSON output.

»get_remote_state_data_source

def get_remote_state_data_source(
  scope: Construct,
  name: str,
  _fromstack: str
) - > TerraformRemoteState

def get_remote_state_data_source(
  scope: Construct,
  name: str,
  _fromstack: str
) - > TerraformRemoteState

Creates a TerraformRemoteState resource that accesses this backend.

»scope^Required

• Type: constructs.Construct

»name^Required

• Type: str

»_fromstack^Required

• Type: str

»Static Functions

»is_construct

import cdktf

cdktf.AzurermBackend.is_construct(
  x: typing.Any
)

import cdktf

cdktf.AzurermBackend.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.

»x^Required

• Type: typing.Any

Any object.

»is_backend

import cdktf

cdktf.AzurermBackend.is_backend(
  x: typing.Any
)

import cdktf

cdktf.AzurermBackend.is_backend(
  x: typing.Any
)

»x^Required

• Type: typing.Any

»Properties

»node^Required

node: Node

node: Node

• Type: constructs.Node

The tree node.

»cdktf_stack^Required

cdktf_stack: TerraformStack

cdktf_stack: TerraformStack

• Type: TerraformStack

»fqn^Required

fqn: str

fqn: str

• Type: str

»friendly_unique_id^Required

friendly_unique_id: str

friendly_unique_id: str

• Type: str

»ConsulBackend

»Initializers

import cdktf

cdktf.ConsulBackend(
  scope: Construct,
  access_token: str,
  path: str,
  address: str = None,
  ca_file: str = None,
  cert_file: str = None,
  datacenter: str = None,
  gzip: bool = None,
  http_auth: str = None,
  key_file: str = None,
  lock: bool = None,
  scheme: str = None
)

import cdktf

cdktf.ConsulBackend(
  scope: Construct,
  access_token: str,
  path: str,
  address: str = None,
  ca_file: str = None,
  cert_file: str = None,
  datacenter: str = None,
  gzip: bool = None,
  http_auth: str = None,
  key_file: str = None,
  lock: bool = None,
  scheme: str = None
)

»scope^Required

• Type: constructs.Construct

»access_token^Required

• Type: str

(Required) Access token.

»path^Required

• Type: str

(Required) Path in the Consul KV store.

»address^Optional

• Type: str

(Optional) DNS name and port of your Consul endpoint specified in the format dnsname:port.

Defaults to the local agent HTTP listener.

»ca_file^Optional

• Type: str

(Optional) A path to a PEM-encoded certificate authority used to verify the remote agent's certificate.

»cert_file^Optional

• Type: str

(Optional) A path to a PEM-encoded certificate provided to the remote agent;

requires use of key_file.

»datacenter^Optional

• Type: str

(Optional) The datacenter to use.

Defaults to that of the agent.

»gzip^Optional

• Type: bool

(Optional) true to compress the state data using gzip, or false (the default) to leave it uncompressed.

»http_auth^Optional

• Type: str

(Optional) HTTP Basic Authentication credentials to be used when communicating with Consul, in the format of either user or user:pass.

»key_file^Optional

• Type: str

(Optional) A path to a PEM-encoded private key, required if cert_file is specified.

»lock^Optional

• Type: bool

(Optional) false to disable locking.

This defaults to true, but will require session permissions with Consul and at least kv write permissions on $path/.lock to perform locking.

»scheme^Optional

• Type: str

(Optional) Specifies what protocol to use when talking to the given address,either http or https.

SSL support can also be triggered by setting then environment variable CONSUL_HTTP_SSL to true.

»Methods

»to_string

def to_string() - > str

def to_string() - > str

Returns a string representation of this construct.

»add_override

def add_override(
  path: str,
  value: typing.Any
) - > None

def add_override(
  path: str,
  value: typing.Any
) - > None

»path^Required

• Type: str

»value^Required

• Type: typing.Any

»override_logical_id

def override_logical_id(
  new_logical_id: str
) - > None

def override_logical_id(
  new_logical_id: str
) - > None

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

»new_logical_id^Required

• Type: str

The new logical ID to use for this stack element.

»reset_override_logical_id

def reset_override_logical_id() - > None

def reset_override_logical_id() - > None

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

»to_metadata

def to_metadata() - > typing.Any

def to_metadata() - > typing.Any

»to_terraform

def to_terraform() - > typing.Any

def to_terraform() - > typing.Any

Adds this resource to the terraform JSON output.

»get_remote_state_data_source

def get_remote_state_data_source(
  scope: Construct,
  name: str,
  _fromstack: str
) - > TerraformRemoteState

def get_remote_state_data_source(
  scope: Construct,
  name: str,
  _fromstack: str
) - > TerraformRemoteState

Creates a TerraformRemoteState resource that accesses this backend.

»scope^Required

• Type: constructs.Construct

»name^Required

• Type: str

»_fromstack^Required

• Type: str

»Static Functions

»is_construct

import cdktf

cdktf.ConsulBackend.is_construct(
  x: typing.Any
)

import cdktf

cdktf.ConsulBackend.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.

»x^Required

• Type: typing.Any

Any object.

»is_backend

import cdktf

cdktf.ConsulBackend.is_backend(
  x: typing.Any
)

import cdktf

cdktf.ConsulBackend.is_backend(
  x: typing.Any
)

»x^Required

• Type: typing.Any

»Properties

»node^Required

node: Node

node: Node

• Type: constructs.Node

The tree node.

»cdktf_stack^Required

cdktf_stack: TerraformStack

cdktf_stack: TerraformStack

• Type: TerraformStack

»fqn^Required

fqn: str

fqn: str

• Type: str

»friendly_unique_id^Required

friendly_unique_id: str

friendly_unique_id: str

• Type: str

»CosBackend

»Initializers

import cdktf

cdktf.CosBackend(
  scope: Construct,
  bucket: str,
  acl: str = None,
  encrypt: bool = None,
  key: str = None,
  prefix: str = None,
  region: str = None,
  secret_id: str = None,
  secret_key: str = None
)

import cdktf

cdktf.CosBackend(
  scope: Construct,
  bucket: str,
  acl: str = None,
  encrypt: bool = None,
  key: str = None,
  prefix: str = None,
  region: str = None,
  secret_id: str = None,
  secret_key: str = None
)

»scope^Required

• Type: constructs.Construct

»bucket^Required

• Type: str

(Required) The name of the COS bucket.

You shall manually create it first.

»acl^Optional

• Type: str

(Optional) Object ACL to be applied to the state file, allows private and public-read.

Defaults to private.

»encrypt^Optional

• Type: bool

(Optional) Whether to enable server side encryption of the state file.

If it is true, COS will use 'AES256' encryption algorithm to encrypt state file.

»key^Optional

• Type: str

(Optional) The path for saving the state file in bucket.

Defaults to terraform.tfstate.

»prefix^Optional

• Type: str

(Optional) The directory for saving the state file in bucket.

Default to "env:".

»region^Optional

• Type: str

(Optional) The region of the COS bucket.

It supports environment variables TENCENTCLOUD_REGION.

»secret_id^Optional

• Type: str

(Optional) Secret id of Tencent Cloud.

It supports environment variables TENCENTCLOUD_SECRET_ID.

»secret_key^Optional

• Type: str

(Optional) Secret key of Tencent Cloud.

It supports environment variables TENCENTCLOUD_SECRET_KEY.

»Methods

»to_string

def to_string() - > str

def to_string() - > str

Returns a string representation of this construct.

»add_override

def add_override(
  path: str,
  value: typing.Any
) - > None

def add_override(
  path: str,
  value: typing.Any
) - > None

»path^Required

• Type: str

»value^Required

• Type: typing.Any

»override_logical_id

def override_logical_id(
  new_logical_id: str
) - > None

def override_logical_id(
  new_logical_id: str
) - > None

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

»new_logical_id^Required

• Type: str

The new logical ID to use for this stack element.

»reset_override_logical_id

def reset_override_logical_id() - > None

def reset_override_logical_id() - > None

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

»to_metadata

def to_metadata() - > typing.Any

def to_metadata() - > typing.Any

»to_terraform

def to_terraform() - > typing.Any

def to_terraform() - > typing.Any

Adds this resource to the terraform JSON output.

»get_remote_state_data_source

def get_remote_state_data_source(
  scope: Construct,
  name: str,
  _fromstack: str
) - > TerraformRemoteState

def get_remote_state_data_source(
  scope: Construct,
  name: str,
  _fromstack: str
) - > TerraformRemoteState

Creates a TerraformRemoteState resource that accesses this backend.

»scope^Required

• Type: constructs.Construct

»name^Required

• Type: str

»_fromstack^Required

• Type: str

»Static Functions

»is_construct

import cdktf

cdktf.CosBackend.is_construct(
  x: typing.Any
)

import cdktf

cdktf.CosBackend.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.

»x^Required

• Type: typing.Any

Any object.

»is_backend

import cdktf

cdktf.CosBackend.is_backend(
  x: typing.Any
)

import cdktf

cdktf.CosBackend.is_backend(
  x: typing.Any
)

»x^Required

• Type: typing.Any

»Properties

»node^Required

node: Node

node: Node

• Type: constructs.Node

The tree node.

»cdktf_stack^Required

cdktf_stack: TerraformStack

cdktf_stack: TerraformStack

• Type: TerraformStack

»fqn^Required

fqn: str

fqn: str

• Type: str

»friendly_unique_id^Required

friendly_unique_id: str

friendly_unique_id: str

• Type: str

»DataTerraformRemoteState

»Initializers

import cdktf

cdktf.DataTerraformRemoteState(
  scope: Construct,
  id: str,
  defaults: typing.Mapping[typing.Any] = None,
  workspace: str = None,
  organization: str,
  workspaces: IRemoteWorkspace,
  hostname: str = None,
  token: str = None
)

import cdktf

cdktf.DataTerraformRemoteState(
  scope: Construct,
  id: str,
  defaults: typing.Mapping[typing.Any] = None,
  workspace: str = None,
  organization: str,
  workspaces: IRemoteWorkspace,
  hostname: str = None,
  token: str = None
)

»scope^Required

• Type: constructs.Construct

»id^Required

• Type: str

»defaults^Optional

• Type: typing.Mapping[typing.Any]

»workspace^Optional

• Type: str

»organization^Required

• Type: str

»workspaces^Required

• Type: IRemoteWorkspace

»hostname^Optional

• Type: str

»token^Optional

• Type: str

»Methods

»to_string

def to_string() - > str

def to_string() - > str

Returns a string representation of this construct.

»add_override

def add_override(
  path: str,
  value: typing.Any
) - > None

def add_override(
  path: str,
  value: typing.Any
) - > None

»path^Required

• Type: str

»value^Required

• Type: typing.Any

»override_logical_id

def override_logical_id(
  new_logical_id: str
) - > None

def override_logical_id(
  new_logical_id: str
) - > None

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

»new_logical_id^Required

• Type: str

The new logical ID to use for this stack element.

»reset_override_logical_id

def reset_override_logical_id() - > None

def reset_override_logical_id() - > None

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

»to_metadata

def to_metadata() - > typing.Any

def to_metadata() - > typing.Any

»to_terraform

def to_terraform() - > typing.Any

def to_terraform() - > typing.Any

Adds this resource to the terraform JSON output.

»get

def get(
  output: str
) - > IResolvable

def get(
  output: str
) - > IResolvable

»output^Required

• Type: str

»get_boolean

def get_boolean(
  output: str
) - > IResolvable

def get_boolean(
  output: str
) - > IResolvable

»output^Required

• Type: str

»get_list

def get_list(
  output: str
) - > typing.List[str]

def get_list(
  output: str
) - > typing.List[str]

»output^Required

• Type: str

»get_number

def get_number(
  output: str
) - > typing.Union[int, float]

def get_number(
  output: str
) - > typing.Union[int, float]

»output^Required

• Type: str

»get_string

def get_string(
  output: str
) - > str

def get_string(
  output: str
) - > str

»output^Required

• Type: str

»Static Functions

»is_construct

import cdktf

cdktf.DataTerraformRemoteState.is_construct(
  x: typing.Any
)

import cdktf

cdktf.DataTerraformRemoteState.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.

»x^Required

• Type: typing.Any

Any object.

»Properties

»node^Required

node: Node

node: Node

• Type: constructs.Node

The tree node.

»cdktf_stack^Required

cdktf_stack: TerraformStack

cdktf_stack: TerraformStack

• Type: TerraformStack

»fqn^Required

fqn: str

fqn: str

• Type: str

»friendly_unique_id^Required

friendly_unique_id: str

friendly_unique_id: str

• Type: str

»Constants

»tfResourceType^Required

tfResourceType: str

tfResourceType: str

• Type: str

»DataTerraformRemoteStateArtifactory

»Initializers

import cdktf

cdktf.DataTerraformRemoteStateArtifactory(
  scope: Construct,
  id: str,
  defaults: typing.Mapping[typing.Any] = None,
  workspace: str = None,
  password: str,
  repo: str,
  subpath: str,
  url: str,
  username: str
)

import cdktf

cdktf.DataTerraformRemoteStateArtifactory(
  scope: Construct,
  id: str,
  defaults: typing.Mapping[typing.Any] = None,
  workspace: str = None,
  password: str,
  repo: str,
  subpath: str,
  url: str,
  username: str
)

»scope^Required

• Type: constructs.Construct

»id^Required

• Type: str

»defaults^Optional

• Type: typing.Mapping[typing.Any]

»workspace^Optional

• Type: str

»password^Required

• Type: str

(Required) - The password.

»repo^Required

• Type: str

(Required) - The repository name.

»subpath^Required

• Type: str

(Required) - Path within the repository.

»url^Required

• Type: str

(Required) - The URL.

Note that this is the base url to artifactory not the full repo and subpath.

»username^Required

• Type: str

(Required) - The username.

»Methods

»to_string

def to_string() - > str

def to_string() - > str

Returns a string representation of this construct.

»add_override

def add_override(
  path: str,
  value: typing.Any
) - > None

def add_override(
  path: str,
  value: typing.Any
) - > None

»path^Required

• Type: str

»value^Required

• Type: typing.Any

»override_logical_id

def override_logical_id(
  new_logical_id: str
) - > None

def override_logical_id(
  new_logical_id: str
) - > None

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

»new_logical_id^Required

• Type: str

The new logical ID to use for this stack element.

»reset_override_logical_id

def reset_override_logical_id() - > None

def reset_override_logical_id() - > None

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

»to_metadata

def to_metadata() - > typing.Any

def to_metadata() - > typing.Any

»to_terraform

def to_terraform() - > typing.Any

def to_terraform() - > typing.Any

Adds this resource to the terraform JSON output.

»get

def get(
  output: str
) - > IResolvable

def get(
  output: str
) - > IResolvable

»output^Required

• Type: str

»get_boolean

def get_boolean(
  output: str
) - > IResolvable

def get_boolean(
  output: str
) - > IResolvable

»output^Required

• Type: str

»get_list

def get_list(
  output: str
) - > typing.List[str]

def get_list(
  output: str
) - > typing.List[str]

»output^Required

• Type: str

»get_number

def get_number(
  output: str
) - > typing.Union[int, float]

def get_number(
  output: str
) - > typing.Union[int, float]

»output^Required

• Type: str

»get_string

def get_string(
  output: str
) - > str

def get_string(
  output: str
) - > str

»output^Required

• Type: str

»Static Functions

»is_construct

import cdktf

cdktf.DataTerraformRemoteStateArtifactory.is_construct(
  x: typing.Any
)

import cdktf

cdktf.DataTerraformRemoteStateArtifactory.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.

»x^Required

• Type: typing.Any

Any object.

»Properties

»node^Required

node: Node

node: Node

• Type: constructs.Node

The tree node.

»cdktf_stack^Required

cdktf_stack: TerraformStack

cdktf_stack: TerraformStack

• Type: TerraformStack

»fqn^Required

fqn: str

fqn: str

• Type: str

»friendly_unique_id^Required

friendly_unique_id: str

friendly_unique_id: str

• Type: str

»Constants

»tfResourceType^Required

tfResourceType: str

tfResourceType: str

• Type: str

»DataTerraformRemoteStateAzurerm

»Initializers

import cdktf

cdktf.DataTerraformRemoteStateAzurerm(
  scope: Construct,
  id: str,
  defaults: typing.Mapping[typing.Any] = None,
  workspace: str = None,
  container_name: str,
  key: str,
  storage_account_name: str,
  access_key: str = None,
  client_id: str = None,
  client_secret: str = None,
  endpoint: str = None,
  environment: str = None,
  msi_endpoint: str = None,
  resource_group_name: str = None,
  sas_token: str = None,
  subscription_id: str = None,
  tenant_id: str = None,
  use_msi: bool = None
)

import cdktf

cdktf.DataTerraformRemoteStateAzurerm(
  scope: Construct,
  id: str,
  defaults: typing.Mapping[typing.Any] = None,
  workspace: str = None,
  container_name: str,
  key: str,
  storage_account_name: str,
  access_key: str = None,
  client_id: str = None,
  client_secret: str = None,
  endpoint: str = None,
  environment: str = None,
  msi_endpoint: str = None,
  resource_group_name: str = None,
  sas_token: str = None,
  subscription_id: str = None,
  tenant_id: str = None,
  use_msi: bool = None
)

»scope^Required

• Type: constructs.Construct

»id^Required

• Type: str

»defaults^Optional

• Type: typing.Mapping[typing.Any]

»workspace^Optional

• Type: str

»container_name^Required

• Type: str

(Required) The Name of the Storage Container within the Storage Account.

»key^Required

• Type: str

(Required) The name of the Blob used to retrieve/store Terraform's State file inside the Storage Container.

»storage_account_name^Required

• Type: str

(Required) The Name of the Storage Account.

»access_key^Optional

• Type: str

access_key - (Optional) The Access Key used to access the Blob Storage Account.

This can also be sourced from the ARM_ACCESS_KEY environment variable.

»client_id^Optional

• Type: str

(Optional) The Client ID of the Service Principal.

This can also be sourced from the ARM_CLIENT_ID environment variable.

»client_secret^Optional

• Type: str

(Optional) The Client Secret of the Service Principal.

This can also be sourced from the ARM_CLIENT_SECRET environment variable.

»endpoint^Optional

• Type: str

(Optional) The Custom Endpoint for Azure Resource Manager. This can also be sourced from the ARM_ENDPOINT environment variable.

NOTE: An endpoint should only be configured when using Azure Stack.

»environment^Optional

• Type: str

(Optional) The Azure Environment which should be used.

This can also be sourced from the ARM_ENVIRONMENT environment variable. Possible values are public, china, german, stack and usgovernment. Defaults to public.

»msi_endpoint^Optional

• Type: str

(Optional) The path to a custom Managed Service Identity endpoint which is automatically determined if not specified.

This can also be sourced from the ARM_MSI_ENDPOINT environment variable.

»resource_group_name^Optional

• Type: str

(Required) The Name of the Resource Group in which the Storage Account exists.

»sas_token^Optional

• Type: str

(Optional) The SAS Token used to access the Blob Storage Account.

This can also be sourced from the ARM_SAS_TOKEN environment variable.

»subscription_id^Optional

• Type: str

(Optional) The Subscription ID in which the Storage Account exists.

This can also be sourced from the ARM_SUBSCRIPTION_ID environment variable.

»tenant_id^Optional

• Type: str

(Optional) The Tenant ID in which the Subscription exists.

This can also be sourced from the ARM_TENANT_ID environment variable.

»use_msi^Optional

• Type: bool

(Optional) Should Managed Service Identity authentication be used?

This can also be sourced from the ARM_USE_MSI environment variable.

»Methods

»to_string

def to_string() - > str

def to_string() - > str

Returns a string representation of this construct.

»add_override

def add_override(
  path: str,
  value: typing.Any
) - > None

def add_override(
  path: str,
  value: typing.Any
) - > None

»path^Required

• Type: str

»value^Required

• Type: typing.Any

»override_logical_id

def override_logical_id(
  new_logical_id: str
) - > None

def override_logical_id(
  new_logical_id: str
) - > None

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

»new_logical_id^Required

• Type: str

The new logical ID to use for this stack element.

»reset_override_logical_id

def reset_override_logical_id() - > None

def reset_override_logical_id() - > None

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

»to_metadata

def to_metadata() - > typing.Any

def to_metadata() - > typing.Any

»to_terraform

def to_terraform() - > typing.Any

def to_terraform() - > typing.Any

Adds this resource to the terraform JSON output.

»get

def get(
  output: str
) - > IResolvable

def get(
  output: str
) - > IResolvable

»output^Required

• Type: str

»get_boolean

def get_boolean(
  output: str
) - > IResolvable

def get_boolean(
  output: str
) - > IResolvable

»output^Required

• Type: str

»get_list

def get_list(
  output: str
) - > typing.List[str]

def get_list(
  output: str
) - > typing.List[str]

»output^Required

• Type: str

»get_number

def get_number(
  output: str
) - > typing.Union[int, float]

def get_number(
  output: str
) - > typing.Union[int, float]

»output^Required

• Type: str

»get_string

def get_string(
  output: str
) - > str

def get_string(
  output: str
) - > str

»output^Required

• Type: str

»Static Functions

»is_construct

import cdktf

cdktf.DataTerraformRemoteStateAzurerm.is_construct(
  x: typing.Any
)

import cdktf

cdktf.DataTerraformRemoteStateAzurerm.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.