Skip to content

Latest commit

 

History

History
2938 lines (1864 loc) · 121 KB

consulCluster.python.md

File metadata and controls

2938 lines (1864 loc) · 121 KB
Raw

consulCluster Submodule

Constructs

ConsulCluster

Represents a {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/consul_cluster hcp_consul_cluster}.

Initializers 

from cdktf_cdktf_provider_hcp import consul_cluster

consulCluster.ConsulCluster(
  scope: Construct,
  id: str,
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[typing.Union[int, float], TerraformCount] = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  cluster_id: str,
  hvn_id: str,
  tier: str,
  auto_hvn_to_hvn_peering: typing.Union[bool, IResolvable] = None,
  connect_enabled: typing.Union[bool, IResolvable] = None,
  datacenter: str = None,
  id: str = None,
  ip_allowlist: typing.Union[IResolvable, typing.List[ConsulClusterIpAllowlistStruct]] = None,
  min_consul_version: str = None,
  primary_link: str = None,
  project_id: str = None,
  public_endpoint: typing.Union[bool, IResolvable] = None,
  size: str = None,
  timeouts: ConsulClusterTimeouts = None
)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id str The scoped construct ID.
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[cdktf.ITerraformDependable] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
cluster_id str The ID of the HCP Consul cluster.
hvn_id str The ID of the HVN this HCP Consul cluster is associated to.
tier str The tier that the HCP Consul cluster will be provisioned as.
auto_hvn_to_hvn_peering typing.Union[bool, cdktf.IResolvable] Enables automatic HVN to HVN peering when creating a secondary cluster in a federation.
connect_enabled typing.Union[bool, cdktf.IResolvable] Denotes the Consul connect feature should be enabled for this cluster. Default to true.
datacenter str The Consul data center name of the cluster. If not specified, it is defaulted to the value of cluster_id.
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/consul_cluster#id ConsulCluster#id}.
ip_allowlist typing.Union[cdktf.IResolvable, typing.List[ConsulClusterIpAllowlistStruct]] ip_allowlist block.
min_consul_version str The minimum Consul patch version of the cluster.
primary_link str The self_link of the HCP Consul cluster which is the primary in the federation setup with this HCP Consul cluster.
project_id str The ID of the HCP project where the HCP Consul cluster is located.
public_endpoint typing.Union[bool, cdktf.IResolvable] Denotes that the cluster has a public endpoint for the Consul UI. Defaults to false.
size str The t-shirt size representation of each server VM that this Consul cluster is provisioned with.
timeouts ConsulClusterTimeouts timeouts block.
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

connectionOptional
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional
  • Type: typing.List[cdktf.ITerraformDependable]
for_eachOptional
  • Type: cdktf.ITerraformIterator
lifecycleOptional
  • Type: cdktf.TerraformResourceLifecycle
providerOptional
  • Type: cdktf.TerraformProvider
provisionersOptional
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
cluster_idRequired
  • Type: str

The ID of the HCP Consul cluster.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/consul_cluster#cluster_id ConsulCluster#cluster_id}

hvn_idRequired
  • Type: str

The ID of the HVN this HCP Consul cluster is associated to.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/consul_cluster#hvn_id ConsulCluster#hvn_id}

tierRequired
  • Type: str

The tier that the HCP Consul cluster will be provisioned as.

Only development, standard, plus, and premium are available at this time. See pricing information.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/consul_cluster#tier ConsulCluster#tier}

auto_hvn_to_hvn_peeringOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Enables automatic HVN to HVN peering when creating a secondary cluster in a federation.

The alternative to using the auto-accept feature is to create an hcp_hvn_peering_connection resource that explicitly defines the HVN resources that are allowed to communicate with each other.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/consul_cluster#auto_hvn_to_hvn_peering ConsulCluster#auto_hvn_to_hvn_peering}

connect_enabledOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Denotes the Consul connect feature should be enabled for this cluster. Default to true.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/consul_cluster#connect_enabled ConsulCluster#connect_enabled}

datacenterOptional
  • Type: str

The Consul data center name of the cluster. If not specified, it is defaulted to the value of cluster_id.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/consul_cluster#datacenter ConsulCluster#datacenter}

idOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/consul_cluster#id ConsulCluster#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

ip_allowlistOptional

ip_allowlist block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/consul_cluster#ip_allowlist ConsulCluster#ip_allowlist}

min_consul_versionOptional
  • Type: str

The minimum Consul patch version of the cluster.

Allows only the rightmost version component to increment (E.g: 1.13.0 will allow installation of 1.13.2 and 1.13.3 etc., but not 1.14.0). If not specified, it is defaulted to the version that is currently recommended by HCP.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/consul_cluster#min_consul_version ConsulCluster#min_consul_version}

primary_linkOptional
  • Type: str

The self_link of the HCP Consul cluster which is the primary in the federation setup with this HCP Consul cluster.

If not specified, it is a standalone cluster.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/consul_cluster#primary_link ConsulCluster#primary_link}

project_idOptional
  • Type: str

The ID of the HCP project where the HCP Consul cluster is located.

If not specified, the project specified in the HCP Provider config block will be used, if configured. If a project is not configured in the HCP Provider config block, the oldest project in the organization will be used.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/consul_cluster#project_id ConsulCluster#project_id}

public_endpointOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Denotes that the cluster has a public endpoint for the Consul UI. Defaults to false.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/consul_cluster#public_endpoint ConsulCluster#public_endpoint}

sizeOptional
  • Type: str

The t-shirt size representation of each server VM that this Consul cluster is provisioned with.

Valid option for development tier - x_small. Valid options for other tiers - small, medium, large. For more details - https://cloud.hashicorp.com/pricing/consul. Upgrading the size of a cluster after creation is allowed.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/consul_cluster#size ConsulCluster#size}

timeoutsOptional

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/consul_cluster#timeouts ConsulCluster#timeouts}

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.
add_move_target Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
has_resource_move No description.
import_from No description.
interpolation_for_attribute No description.
move_from_id Move the resource corresponding to "id" to this resource.
move_to Moves this resource to the target resource given by moveTarget.
move_to_id Moves this resource to the resource corresponding to "id".
put_ip_allowlist No description.
put_timeouts No description.
reset_auto_hvn_to_hvn_peering No description.
reset_connect_enabled No description.
reset_datacenter No description.
reset_id No description.
reset_ip_allowlist No description.
reset_min_consul_version No description.
reset_primary_link No description.
reset_project_id No description.
reset_public_endpoint No description.
reset_size No description.
reset_timeouts 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.

add_move_target 
def add_move_target(
  move_target: str
) -> None

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

move_targetRequired
  • Type: str

The string move target that will correspond to this resource.

get_any_map_attribute 
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
has_resource_move 
def has_resource_move() -> typing.Union[TerraformResourceMoveByTarget, TerraformResourceMoveById]
import_from 
def import_from(
  id: str,
  provider: TerraformProvider = None
) -> None
idRequired
  • Type: str
providerOptional
  • Type: cdktf.TerraformProvider
interpolation_for_attribute 
def interpolation_for_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
move_from_id 
def move_from_id(
  id: str
) -> None

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

idRequired
  • Type: str

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

move_to 
def move_to(
  move_target: str,
  index: typing.Union[str, typing.Union[int, float]] = None
) -> None

Moves this resource to the target resource given by moveTarget.

move_targetRequired
  • Type: str

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

indexOptional
  • Type: typing.Union[str, typing.Union[int, float]]

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

move_to_id 
def move_to_id(
  id: str
) -> None

Moves this resource to the resource corresponding to "id".

idRequired
  • Type: str

Full id of resource to move to, e.g. "aws_s3_bucket.example".

put_ip_allowlist 
def put_ip_allowlist(
  value: typing.Union[IResolvable, typing.List[ConsulClusterIpAllowlistStruct]]
) -> None
valueRequired
put_timeouts 
def put_timeouts(
  create: str = None,
  default: str = None,
  delete: str = None,
  update: str = None
) -> None
createOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/consul_cluster#create ConsulCluster#create}.

defaultOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/consul_cluster#default ConsulCluster#default}.

deleteOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/consul_cluster#delete ConsulCluster#delete}.

updateOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/consul_cluster#update ConsulCluster#update}.

reset_auto_hvn_to_hvn_peering 
def reset_auto_hvn_to_hvn_peering() -> None
reset_connect_enabled 
def reset_connect_enabled() -> None
reset_datacenter 
def reset_datacenter() -> None
reset_id 
def reset_id() -> None
reset_ip_allowlist 
def reset_ip_allowlist() -> None
reset_min_consul_version 
def reset_min_consul_version() -> None
reset_primary_link 
def reset_primary_link() -> None
reset_project_id 
def reset_project_id() -> None
reset_public_endpoint 
def reset_public_endpoint() -> None
reset_size 
def reset_size() -> None
reset_timeouts 
def reset_timeouts() -> None

Static Functions

Name Description
is_construct Checks if x is a construct.
is_terraform_element No description.
is_terraform_resource No description.
generate_config_for_import Generates CDKTF code for importing a ConsulCluster resource upon running "cdktf plan ".
is_construct 
from cdktf_cdktf_provider_hcp import consul_cluster

consulCluster.ConsulCluster.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_hcp import consul_cluster

consulCluster.ConsulCluster.is_terraform_element(
  x: typing.Any
)
xRequired
  • Type: typing.Any
is_terraform_resource 
from cdktf_cdktf_provider_hcp import consul_cluster

consulCluster.ConsulCluster.is_terraform_resource(
  x: typing.Any
)
xRequired
  • Type: typing.Any
generate_config_for_import 
from cdktf_cdktf_provider_hcp import consul_cluster

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

Generates CDKTF code for importing a ConsulCluster 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 ConsulCluster to import.

import_from_idRequired
  • Type: str

The id of the existing ConsulCluster that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/consul_cluster#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 ConsulCluster 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.
terraform_meta_arguments typing.Mapping[typing.Any] No description.
terraform_resource_type str No description.
terraform_generator_metadata cdktf.TerraformProviderGeneratorMetadata No description.
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[str] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
cloud_provider str No description.
consul_automatic_upgrades cdktf.IResolvable No description.
consul_ca_file str No description.
consul_config_file str No description.
consul_private_endpoint_url str No description.
consul_public_endpoint_url str No description.
consul_root_token_accessor_id str No description.
consul_root_token_secret_id str No description.
consul_snapshot_interval str No description.
consul_snapshot_retention str No description.
consul_version str No description.
ip_allowlist ConsulClusterIpAllowlistStructList No description.
organization_id str No description.
region str No description.
scale typing.Union[int, float] No description.
self_link str No description.
state str No description.
timeouts ConsulClusterTimeoutsOutputReference No description.
auto_hvn_to_hvn_peering_input typing.Union[bool, cdktf.IResolvable] No description.
cluster_id_input str No description.
connect_enabled_input typing.Union[bool, cdktf.IResolvable] No description.
datacenter_input str No description.
hvn_id_input str No description.
id_input str No description.
ip_allowlist_input typing.Union[cdktf.IResolvable, typing.List[ConsulClusterIpAllowlistStruct]] No description.
min_consul_version_input str No description.
primary_link_input str No description.
project_id_input str No description.
public_endpoint_input typing.Union[bool, cdktf.IResolvable] No description.
size_input str No description.
tier_input str No description.
timeouts_input typing.Union[cdktf.IResolvable, ConsulClusterTimeouts] No description.
auto_hvn_to_hvn_peering typing.Union[bool, cdktf.IResolvable] No description.
cluster_id str No description.
connect_enabled typing.Union[bool, cdktf.IResolvable] No description.
datacenter str No description.
hvn_id str No description.
id str No description.
min_consul_version str No description.
primary_link str No description.
project_id str No description.
public_endpoint typing.Union[bool, cdktf.IResolvable] No description.
size str No description.
tier 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
terraform_meta_argumentsRequired 
terraform_meta_arguments: 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
connectionOptional 
connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional 
count: typing.Union[typing.Union[int, float], TerraformCount]
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional 
depends_on: typing.List[str]
  • Type: typing.List[str]
for_eachOptional 
for_each: ITerraformIterator
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
lifecycle: TerraformResourceLifecycle
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
provider: TerraformProvider
  • Type: cdktf.TerraformProvider
provisionersOptional 
provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
cloud_providerRequired 
cloud_provider: str
  • Type: str
consul_automatic_upgradesRequired 
consul_automatic_upgrades: IResolvable
  • Type: cdktf.IResolvable
consul_ca_fileRequired 
consul_ca_file: str
  • Type: str
consul_config_fileRequired 
consul_config_file: str
  • Type: str
consul_private_endpoint_urlRequired 
consul_private_endpoint_url: str
  • Type: str
consul_public_endpoint_urlRequired 
consul_public_endpoint_url: str
  • Type: str
consul_root_token_accessor_idRequired 
consul_root_token_accessor_id: str
  • Type: str
consul_root_token_secret_idRequired 
consul_root_token_secret_id: str
  • Type: str
consul_snapshot_intervalRequired 
consul_snapshot_interval: str
  • Type: str
consul_snapshot_retentionRequired 
consul_snapshot_retention: str
  • Type: str
consul_versionRequired 
consul_version: str
  • Type: str
ip_allowlistRequired 
ip_allowlist: ConsulClusterIpAllowlistStructList
organization_idRequired 
organization_id: str
  • Type: str
regionRequired 
region: str
  • Type: str
scaleRequired 
scale: typing.Union[int, float]
  • Type: typing.Union[int, float]
self_linkRequired 
self_link: str
  • Type: str
stateRequired 
state: str
  • Type: str
timeoutsRequired 
timeouts: ConsulClusterTimeoutsOutputReference
auto_hvn_to_hvn_peering_inputOptional 
auto_hvn_to_hvn_peering_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
cluster_id_inputOptional 
cluster_id_input: str
  • Type: str
connect_enabled_inputOptional 
connect_enabled_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
datacenter_inputOptional 
datacenter_input: str
  • Type: str
hvn_id_inputOptional 
hvn_id_input: str
  • Type: str
id_inputOptional 
id_input: str
  • Type: str
ip_allowlist_inputOptional 
ip_allowlist_input: typing.Union[IResolvable, typing.List[ConsulClusterIpAllowlistStruct]]
min_consul_version_inputOptional 
min_consul_version_input: str
  • Type: str
primary_link_inputOptional 
primary_link_input: str
  • Type: str
project_id_inputOptional 
project_id_input: str
  • Type: str
public_endpoint_inputOptional 
public_endpoint_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
size_inputOptional 
size_input: str
  • Type: str
tier_inputOptional 
tier_input: str
  • Type: str
timeouts_inputOptional 
timeouts_input: typing.Union[IResolvable, ConsulClusterTimeouts]
auto_hvn_to_hvn_peeringRequired 
auto_hvn_to_hvn_peering: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
cluster_idRequired 
cluster_id: str
  • Type: str
connect_enabledRequired 
connect_enabled: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
datacenterRequired 
datacenter: str
  • Type: str
hvn_idRequired 
hvn_id: str
  • Type: str
idRequired 
id: str
  • Type: str
min_consul_versionRequired 
min_consul_version: str
  • Type: str
primary_linkRequired 
primary_link: str
  • Type: str
project_idRequired 
project_id: str
  • Type: str
public_endpointRequired 
public_endpoint: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
sizeRequired 
size: str
  • Type: str
tierRequired 
tier: str
  • Type: str

Constants

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

Structs

ConsulClusterConfig

Initializer 

from cdktf_cdktf_provider_hcp import consul_cluster

consulCluster.ConsulClusterConfig(
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[typing.Union[int, float], TerraformCount] = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  cluster_id: str,
  hvn_id: str,
  tier: str,
  auto_hvn_to_hvn_peering: typing.Union[bool, IResolvable] = None,
  connect_enabled: typing.Union[bool, IResolvable] = None,
  datacenter: str = None,
  id: str = None,
  ip_allowlist: typing.Union[IResolvable, typing.List[ConsulClusterIpAllowlistStruct]] = None,
  min_consul_version: str = None,
  primary_link: str = None,
  project_id: str = None,
  public_endpoint: typing.Union[bool, IResolvable] = None,
  size: str = None,
  timeouts: ConsulClusterTimeouts = None
)

Properties

Name Type Description
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[cdktf.ITerraformDependable] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
cluster_id str The ID of the HCP Consul cluster.
hvn_id str The ID of the HVN this HCP Consul cluster is associated to.
tier str The tier that the HCP Consul cluster will be provisioned as.
auto_hvn_to_hvn_peering typing.Union[bool, cdktf.IResolvable] Enables automatic HVN to HVN peering when creating a secondary cluster in a federation.
connect_enabled typing.Union[bool, cdktf.IResolvable] Denotes the Consul connect feature should be enabled for this cluster. Default to true.
datacenter str The Consul data center name of the cluster. If not specified, it is defaulted to the value of cluster_id.
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/consul_cluster#id ConsulCluster#id}.
ip_allowlist typing.Union[cdktf.IResolvable, typing.List[ConsulClusterIpAllowlistStruct]] ip_allowlist block.
min_consul_version str The minimum Consul patch version of the cluster.
primary_link str The self_link of the HCP Consul cluster which is the primary in the federation setup with this HCP Consul cluster.
project_id str The ID of the HCP project where the HCP Consul cluster is located.
public_endpoint typing.Union[bool, cdktf.IResolvable] Denotes that the cluster has a public endpoint for the Consul UI. Defaults to false.
size str The t-shirt size representation of each server VM that this Consul cluster is provisioned with.
timeouts ConsulClusterTimeouts timeouts block.
connectionOptional 
connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional 
count: typing.Union[typing.Union[int, float], TerraformCount]
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional 
depends_on: typing.List[ITerraformDependable]
  • Type: typing.List[cdktf.ITerraformDependable]
for_eachOptional 
for_each: ITerraformIterator
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
lifecycle: TerraformResourceLifecycle
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
provider: TerraformProvider
  • Type: cdktf.TerraformProvider
provisionersOptional 
provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
cluster_idRequired 
cluster_id: str
  • Type: str

The ID of the HCP Consul cluster.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/consul_cluster#cluster_id ConsulCluster#cluster_id}

hvn_idRequired 
hvn_id: str
  • Type: str

The ID of the HVN this HCP Consul cluster is associated to.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/consul_cluster#hvn_id ConsulCluster#hvn_id}

tierRequired 
tier: str
  • Type: str

The tier that the HCP Consul cluster will be provisioned as.

Only development, standard, plus, and premium are available at this time. See pricing information.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/consul_cluster#tier ConsulCluster#tier}

auto_hvn_to_hvn_peeringOptional 
auto_hvn_to_hvn_peering: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Enables automatic HVN to HVN peering when creating a secondary cluster in a federation.

The alternative to using the auto-accept feature is to create an hcp_hvn_peering_connection resource that explicitly defines the HVN resources that are allowed to communicate with each other.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/consul_cluster#auto_hvn_to_hvn_peering ConsulCluster#auto_hvn_to_hvn_peering}

connect_enabledOptional 
connect_enabled: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Denotes the Consul connect feature should be enabled for this cluster. Default to true.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/consul_cluster#connect_enabled ConsulCluster#connect_enabled}

datacenterOptional 
datacenter: str
  • Type: str

The Consul data center name of the cluster. If not specified, it is defaulted to the value of cluster_id.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/consul_cluster#datacenter ConsulCluster#datacenter}

idOptional 
id: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/consul_cluster#id ConsulCluster#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

ip_allowlistOptional 
ip_allowlist: typing.Union[IResolvable, typing.List[ConsulClusterIpAllowlistStruct]]

ip_allowlist block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/consul_cluster#ip_allowlist ConsulCluster#ip_allowlist}

min_consul_versionOptional 
min_consul_version: str
  • Type: str

The minimum Consul patch version of the cluster.

Allows only the rightmost version component to increment (E.g: 1.13.0 will allow installation of 1.13.2 and 1.13.3 etc., but not 1.14.0). If not specified, it is defaulted to the version that is currently recommended by HCP.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/consul_cluster#min_consul_version ConsulCluster#min_consul_version}

primary_linkOptional 
primary_link: str
  • Type: str

The self_link of the HCP Consul cluster which is the primary in the federation setup with this HCP Consul cluster.

If not specified, it is a standalone cluster.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/consul_cluster#primary_link ConsulCluster#primary_link}

project_idOptional 
project_id: str
  • Type: str

The ID of the HCP project where the HCP Consul cluster is located.

If not specified, the project specified in the HCP Provider config block will be used, if configured. If a project is not configured in the HCP Provider config block, the oldest project in the organization will be used.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/consul_cluster#project_id ConsulCluster#project_id}

public_endpointOptional 
public_endpoint: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Denotes that the cluster has a public endpoint for the Consul UI. Defaults to false.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/consul_cluster#public_endpoint ConsulCluster#public_endpoint}

sizeOptional 
size: str
  • Type: str

The t-shirt size representation of each server VM that this Consul cluster is provisioned with.

Valid option for development tier - x_small. Valid options for other tiers - small, medium, large. For more details - https://cloud.hashicorp.com/pricing/consul. Upgrading the size of a cluster after creation is allowed.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/consul_cluster#size ConsulCluster#size}

timeoutsOptional 
timeouts: ConsulClusterTimeouts

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/consul_cluster#timeouts ConsulCluster#timeouts}

ConsulClusterIpAllowlistStruct

Initializer 

from cdktf_cdktf_provider_hcp import consul_cluster

consulCluster.ConsulClusterIpAllowlistStruct(
  address: str,
  description: str = None
)

Properties

Name Type Description
address str IP address range in CIDR notation.
description str Description to help identify source (maximum 255 chars).
addressRequired 
address: str
  • Type: str

IP address range in CIDR notation.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/consul_cluster#address ConsulCluster#address}

descriptionOptional 
description: str
  • Type: str

Description to help identify source (maximum 255 chars).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/consul_cluster#description ConsulCluster#description}

ConsulClusterTimeouts

Initializer 

from cdktf_cdktf_provider_hcp import consul_cluster

consulCluster.ConsulClusterTimeouts(
  create: str = None,
  default: str = None,
  delete: str = None,
  update: str = None
)

Properties

Name Type Description
create str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/consul_cluster#create ConsulCluster#create}.
default str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/consul_cluster#default ConsulCluster#default}.
delete str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/consul_cluster#delete ConsulCluster#delete}.
update str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/consul_cluster#update ConsulCluster#update}.
createOptional 
create: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/consul_cluster#create ConsulCluster#create}.

defaultOptional 
default: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/consul_cluster#default ConsulCluster#default}.

deleteOptional 
delete: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/consul_cluster#delete ConsulCluster#delete}.

updateOptional 
update: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/consul_cluster#update ConsulCluster#update}.

Classes

ConsulClusterIpAllowlistStructList

Initializers 

from cdktf_cdktf_provider_hcp import consul_cluster

consulCluster.ConsulClusterIpAllowlistStructList(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str,
  wraps_set: bool
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
wraps_set bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.

wraps_setRequired
  • Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name Description
all_with_map_key Creating an iterator for this complex list.
compute_fqn No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
get No description.
all_with_map_key 
def all_with_map_key(
  map_key_attribute_name: str
) -> DynamicListTerraformIterator

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

map_key_attribute_nameRequired
  • Type: str
compute_fqn 
def compute_fqn() -> str
resolve 
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
to_string 
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

get 
def get(
  index: typing.Union[int, float]
) -> ConsulClusterIpAllowlistStructOutputReference
indexRequired
  • Type: typing.Union[int, float]

the index of the item to return.

Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
internal_value typing.Union[cdktf.IResolvable, typing.List[ConsulClusterIpAllowlistStruct]] No description.
creation_stackRequired 
creation_stack: typing.List[str]
  • Type: typing.List[str]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
fqn: str
  • Type: str
internal_valueOptional 
internal_value: typing.Union[IResolvable, typing.List[ConsulClusterIpAllowlistStruct]]

ConsulClusterIpAllowlistStructOutputReference

Initializers 

from cdktf_cdktf_provider_hcp import consul_cluster

consulCluster.ConsulClusterIpAllowlistStructOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str,
  complex_object_index: typing.Union[int, float],
  complex_object_is_from_set: bool
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
complex_object_index typing.Union[int, float] the index of this item in the list.
complex_object_is_from_set bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.

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

the index of this item in the list.

complex_object_is_from_setRequired
  • Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name Description
compute_fqn No description.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
interpolation_for_attribute No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
reset_description No description.
compute_fqn 
def compute_fqn() -> str
get_any_map_attribute 
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
interpolation_for_attribute 
def interpolation_for_attribute(
  property: str
) -> IResolvable
propertyRequired
  • Type: str
resolve 
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
to_string 
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

reset_description 
def reset_description() -> None

Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
address_input str No description.
description_input str No description.
address str No description.
description str No description.
internal_value typing.Union[cdktf.IResolvable, ConsulClusterIpAllowlistStruct] No description.
creation_stackRequired 
creation_stack: typing.List[str]
  • Type: typing.List[str]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
fqn: str
  • Type: str
address_inputOptional 
address_input: str
  • Type: str
description_inputOptional 
description_input: str
  • Type: str
addressRequired 
address: str
  • Type: str
descriptionRequired 
description: str
  • Type: str
internal_valueOptional 
internal_value: typing.Union[IResolvable, ConsulClusterIpAllowlistStruct]

ConsulClusterTimeoutsOutputReference

Initializers 

from cdktf_cdktf_provider_hcp import consul_cluster

consulCluster.ConsulClusterTimeoutsOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.

Methods

Name Description
compute_fqn No description.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
interpolation_for_attribute No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
reset_create No description.
reset_default No description.
reset_delete No description.
reset_update No description.
compute_fqn 
def compute_fqn() -> str
get_any_map_attribute 
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
interpolation_for_attribute 
def interpolation_for_attribute(
  property: str
) -> IResolvable
propertyRequired
  • Type: str
resolve 
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
to_string 
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

reset_create 
def reset_create() -> None
reset_default 
def reset_default() -> None
reset_delete 
def reset_delete() -> None
reset_update 
def reset_update() -> None

Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
create_input str No description.
default_input str No description.
delete_input str No description.
update_input str No description.
create str No description.
default str No description.
delete str No description.
update str No description.
internal_value typing.Union[cdktf.IResolvable, ConsulClusterTimeouts] No description.
creation_stackRequired 
creation_stack: typing.List[str]
  • Type: typing.List[str]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
fqn: str
  • Type: str
create_inputOptional 
create_input: str
  • Type: str
default_inputOptional 
default_input: str
  • Type: str
delete_inputOptional 
delete_input: str
  • Type: str
update_inputOptional 
update_input: str
  • Type: str
createRequired 
create: str
  • Type: str
defaultRequired 
default: str
  • Type: str
deleteRequired 
delete: str
  • Type: str
updateRequired 
update: str
  • Type: str
internal_valueOptional 
internal_value: typing.Union[IResolvable, ConsulClusterTimeouts]