Skip to content

Latest commit

 

History

History
2561 lines (1594 loc) · 103 KB

consulCluster.csharp.md

File metadata and controls

2561 lines (1594 loc) · 103 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 

using HashiCorp.Cdktf.Providers.Hcp;

new ConsulCluster(Construct Scope, string Id, ConsulClusterConfig Config);
Name Type Description
Scope Constructs.Construct The scope in which to define this construct.
Id string The scoped construct ID.
Config ConsulClusterConfig No description.
ScopeRequired
  • Type: Constructs.Construct

The scope in which to define this construct.

IdRequired
  • Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

ConfigRequired

Methods

Name Description
ToString Returns a string representation of this construct.
AddOverride No description.
OverrideLogicalId Overrides the auto-generated logical ID with a specific ID.
ResetOverrideLogicalId Resets a previously passed logical Id to use the auto-generated logical id again.
ToHclTerraform No description.
ToMetadata No description.
ToTerraform Adds this resource to the terraform JSON output.
AddMoveTarget Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
GetAnyMapAttribute No description.
GetBooleanAttribute No description.
GetBooleanMapAttribute No description.
GetListAttribute No description.
GetNumberAttribute No description.
GetNumberListAttribute No description.
GetNumberMapAttribute No description.
GetStringAttribute No description.
GetStringMapAttribute No description.
HasResourceMove No description.
ImportFrom No description.
InterpolationForAttribute No description.
MoveFromId Move the resource corresponding to "id" to this resource.
MoveTo Moves this resource to the target resource given by moveTarget.
MoveToId Moves this resource to the resource corresponding to "id".
PutIpAllowlist No description.
PutTimeouts No description.
ResetAutoHvnToHvnPeering No description.
ResetConnectEnabled No description.
ResetDatacenter No description.
ResetId No description.
ResetIpAllowlist No description.
ResetMinConsulVersion No description.
ResetPrimaryLink No description.
ResetProjectId No description.
ResetPublicEndpoint No description.
ResetSize No description.
ResetTimeouts No description.
ToString 
private string ToString()

Returns a string representation of this construct.

AddOverride 
private void AddOverride(string Path, object Value)
PathRequired
  • Type: string
ValueRequired
  • Type: object
OverrideLogicalId 
private void OverrideLogicalId(string NewLogicalId)

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

NewLogicalIdRequired
  • Type: string

The new logical ID to use for this stack element.

ResetOverrideLogicalId 
private void ResetOverrideLogicalId()

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

ToHclTerraform 
private object ToHclTerraform()
ToMetadata 
private object ToMetadata()
ToTerraform 
private object ToTerraform()

Adds this resource to the terraform JSON output.

AddMoveTarget 
private void AddMoveTarget(string MoveTarget)

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

MoveTargetRequired
  • Type: string

The string move target that will correspond to this resource.

GetAnyMapAttribute 
private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetBooleanAttribute 
private IResolvable GetBooleanAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetBooleanMapAttribute 
private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetListAttribute 
private string[] GetListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetNumberAttribute 
private double GetNumberAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetNumberListAttribute 
private double[] GetNumberListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetNumberMapAttribute 
private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetStringAttribute 
private string GetStringAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetStringMapAttribute 
private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
HasResourceMove 
private object HasResourceMove()
ImportFrom 
private void ImportFrom(string Id, TerraformProvider Provider = null)
IdRequired
  • Type: string
ProviderOptional
  • Type: HashiCorp.Cdktf.TerraformProvider
InterpolationForAttribute 
private IResolvable InterpolationForAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
MoveFromId 
private void MoveFromId(string Id)

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: string

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

MoveTo 
private void MoveTo(string MoveTarget, object Index = null)

Moves this resource to the target resource given by moveTarget.

MoveTargetRequired
  • Type: string

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

IndexOptional
  • Type: object

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

MoveToId 
private void MoveToId(string Id)

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

IdRequired
  • Type: string

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

PutIpAllowlist 
private void PutIpAllowlist(object Value)
ValueRequired
  • Type: object
PutTimeouts 
private void PutTimeouts(ConsulClusterTimeouts Value)
ValueRequired
ResetAutoHvnToHvnPeering 
private void ResetAutoHvnToHvnPeering()
ResetConnectEnabled 
private void ResetConnectEnabled()
ResetDatacenter 
private void ResetDatacenter()
ResetId 
private void ResetId()
ResetIpAllowlist 
private void ResetIpAllowlist()
ResetMinConsulVersion 
private void ResetMinConsulVersion()
ResetPrimaryLink 
private void ResetPrimaryLink()
ResetProjectId 
private void ResetProjectId()
ResetPublicEndpoint 
private void ResetPublicEndpoint()
ResetSize 
private void ResetSize()
ResetTimeouts 
private void ResetTimeouts()

Static Functions

Name Description
IsConstruct Checks if x is a construct.
IsTerraformElement No description.
IsTerraformResource No description.
GenerateConfigForImport Generates CDKTF code for importing a ConsulCluster resource upon running "cdktf plan ".
IsConstruct 
using HashiCorp.Cdktf.Providers.Hcp;

ConsulCluster.IsConstruct(object X);

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: object

Any object.

IsTerraformElement 
using HashiCorp.Cdktf.Providers.Hcp;

ConsulCluster.IsTerraformElement(object X);
XRequired
  • Type: object
IsTerraformResource 
using HashiCorp.Cdktf.Providers.Hcp;

ConsulCluster.IsTerraformResource(object X);
XRequired
  • Type: object
GenerateConfigForImport 
using HashiCorp.Cdktf.Providers.Hcp;

ConsulCluster.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null);

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

ScopeRequired
  • Type: Constructs.Construct

The scope in which to define this construct.

ImportToIdRequired
  • Type: string

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

ImportFromIdRequired
  • Type: string

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: HashiCorp.Cdktf.TerraformProvider

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

Properties

Name Type Description
Node Constructs.Node The tree node.
CdktfStack HashiCorp.Cdktf.TerraformStack No description.
Fqn string No description.
FriendlyUniqueId string No description.
TerraformMetaArguments System.Collections.Generic.IDictionary<string, object> No description.
TerraformResourceType string No description.
TerraformGeneratorMetadata HashiCorp.Cdktf.TerraformProviderGeneratorMetadata No description.
Connection object No description.
Count object No description.
DependsOn string[] No description.
ForEach HashiCorp.Cdktf.ITerraformIterator No description.
Lifecycle HashiCorp.Cdktf.TerraformResourceLifecycle No description.
Provider HashiCorp.Cdktf.TerraformProvider No description.
Provisioners object[] No description.
CloudProvider string No description.
ConsulAutomaticUpgrades HashiCorp.Cdktf.IResolvable No description.
ConsulCaFile string No description.
ConsulConfigFile string No description.
ConsulPrivateEndpointUrl string No description.
ConsulPublicEndpointUrl string No description.
ConsulRootTokenAccessorId string No description.
ConsulRootTokenSecretId string No description.
ConsulSnapshotInterval string No description.
ConsulSnapshotRetention string No description.
ConsulVersion string No description.
IpAllowlist ConsulClusterIpAllowlistStructList No description.
OrganizationId string No description.
Region string No description.
Scale double No description.
SelfLink string No description.
State string No description.
Timeouts ConsulClusterTimeoutsOutputReference No description.
AutoHvnToHvnPeeringInput object No description.
ClusterIdInput string No description.
ConnectEnabledInput object No description.
DatacenterInput string No description.
HvnIdInput string No description.
IdInput string No description.
IpAllowlistInput object No description.
MinConsulVersionInput string No description.
PrimaryLinkInput string No description.
ProjectIdInput string No description.
PublicEndpointInput object No description.
SizeInput string No description.
TierInput string No description.
TimeoutsInput object No description.
AutoHvnToHvnPeering object No description.
ClusterId string No description.
ConnectEnabled object No description.
Datacenter string No description.
HvnId string No description.
Id string No description.
MinConsulVersion string No description.
PrimaryLink string No description.
ProjectId string No description.
PublicEndpoint object No description.
Size string No description.
Tier string No description.
NodeRequired 
public Node Node { get; }
  • Type: Constructs.Node

The tree node.

CdktfStackRequired 
public TerraformStack CdktfStack { get; }
  • Type: HashiCorp.Cdktf.TerraformStack
FqnRequired 
public string Fqn { get; }
  • Type: string
FriendlyUniqueIdRequired 
public string FriendlyUniqueId { get; }
  • Type: string
TerraformMetaArgumentsRequired 
public System.Collections.Generic.IDictionary<string, object> TerraformMetaArguments { get; }
  • Type: System.Collections.Generic.IDictionary<string, object>
TerraformResourceTypeRequired 
public string TerraformResourceType { get; }
  • Type: string
TerraformGeneratorMetadataOptional 
public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; }
  • Type: HashiCorp.Cdktf.TerraformProviderGeneratorMetadata
ConnectionOptional 
public object Connection { get; }
  • Type: object
CountOptional 
public object Count { get; }
  • Type: object
DependsOnOptional 
public string[] DependsOn { get; }
  • Type: string[]
ForEachOptional 
public ITerraformIterator ForEach { get; }
  • Type: HashiCorp.Cdktf.ITerraformIterator
LifecycleOptional 
public TerraformResourceLifecycle Lifecycle { get; }
  • Type: HashiCorp.Cdktf.TerraformResourceLifecycle
ProviderOptional 
public TerraformProvider Provider { get; }
  • Type: HashiCorp.Cdktf.TerraformProvider
ProvisionersOptional 
public object[] Provisioners { get; }
  • Type: object[]
CloudProviderRequired 
public string CloudProvider { get; }
  • Type: string
ConsulAutomaticUpgradesRequired 
public IResolvable ConsulAutomaticUpgrades { get; }
  • Type: HashiCorp.Cdktf.IResolvable
ConsulCaFileRequired 
public string ConsulCaFile { get; }
  • Type: string
ConsulConfigFileRequired 
public string ConsulConfigFile { get; }
  • Type: string
ConsulPrivateEndpointUrlRequired 
public string ConsulPrivateEndpointUrl { get; }
  • Type: string
ConsulPublicEndpointUrlRequired 
public string ConsulPublicEndpointUrl { get; }
  • Type: string
ConsulRootTokenAccessorIdRequired 
public string ConsulRootTokenAccessorId { get; }
  • Type: string
ConsulRootTokenSecretIdRequired 
public string ConsulRootTokenSecretId { get; }
  • Type: string
ConsulSnapshotIntervalRequired 
public string ConsulSnapshotInterval { get; }
  • Type: string
ConsulSnapshotRetentionRequired 
public string ConsulSnapshotRetention { get; }
  • Type: string
ConsulVersionRequired 
public string ConsulVersion { get; }
  • Type: string
IpAllowlistRequired 
public ConsulClusterIpAllowlistStructList IpAllowlist { get; }
OrganizationIdRequired 
public string OrganizationId { get; }
  • Type: string
RegionRequired 
public string Region { get; }
  • Type: string
ScaleRequired 
public double Scale { get; }
  • Type: double
SelfLinkRequired 
public string SelfLink { get; }
  • Type: string
StateRequired 
public string State { get; }
  • Type: string
TimeoutsRequired 
public ConsulClusterTimeoutsOutputReference Timeouts { get; }
AutoHvnToHvnPeeringInputOptional 
public object AutoHvnToHvnPeeringInput { get; }
  • Type: object
ClusterIdInputOptional 
public string ClusterIdInput { get; }
  • Type: string
ConnectEnabledInputOptional 
public object ConnectEnabledInput { get; }
  • Type: object
DatacenterInputOptional 
public string DatacenterInput { get; }
  • Type: string
HvnIdInputOptional 
public string HvnIdInput { get; }
  • Type: string
IdInputOptional 
public string IdInput { get; }
  • Type: string
IpAllowlistInputOptional 
public object IpAllowlistInput { get; }
  • Type: object
MinConsulVersionInputOptional 
public string MinConsulVersionInput { get; }
  • Type: string
PrimaryLinkInputOptional 
public string PrimaryLinkInput { get; }
  • Type: string
ProjectIdInputOptional 
public string ProjectIdInput { get; }
  • Type: string
PublicEndpointInputOptional 
public object PublicEndpointInput { get; }
  • Type: object
SizeInputOptional 
public string SizeInput { get; }
  • Type: string
TierInputOptional 
public string TierInput { get; }
  • Type: string
TimeoutsInputOptional 
public object TimeoutsInput { get; }
  • Type: object
AutoHvnToHvnPeeringRequired 
public object AutoHvnToHvnPeering { get; }
  • Type: object
ClusterIdRequired 
public string ClusterId { get; }
  • Type: string
ConnectEnabledRequired 
public object ConnectEnabled { get; }
  • Type: object
DatacenterRequired 
public string Datacenter { get; }
  • Type: string
HvnIdRequired 
public string HvnId { get; }
  • Type: string
IdRequired 
public string Id { get; }
  • Type: string
MinConsulVersionRequired 
public string MinConsulVersion { get; }
  • Type: string
PrimaryLinkRequired 
public string PrimaryLink { get; }
  • Type: string
ProjectIdRequired 
public string ProjectId { get; }
  • Type: string
PublicEndpointRequired 
public object PublicEndpoint { get; }
  • Type: object
SizeRequired 
public string Size { get; }
  • Type: string
TierRequired 
public string Tier { get; }
  • Type: string

Constants

Name Type Description
TfResourceType string No description.
TfResourceTypeRequired 
public string TfResourceType { get; }
  • Type: string

Structs

ConsulClusterConfig

Initializer 

using HashiCorp.Cdktf.Providers.Hcp;

new ConsulClusterConfig {
    object Connection = null,
    object Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    object[] Provisioners = null,
    string ClusterId,
    string HvnId,
    string Tier,
    object AutoHvnToHvnPeering = null,
    object ConnectEnabled = null,
    string Datacenter = null,
    string Id = null,
    object IpAllowlist = null,
    string MinConsulVersion = null,
    string PrimaryLink = null,
    string ProjectId = null,
    object PublicEndpoint = null,
    string Size = null,
    ConsulClusterTimeouts Timeouts = null
};

Properties

Name Type Description
Connection object No description.
Count object No description.
DependsOn HashiCorp.Cdktf.ITerraformDependable[] No description.
ForEach HashiCorp.Cdktf.ITerraformIterator No description.
Lifecycle HashiCorp.Cdktf.TerraformResourceLifecycle No description.
Provider HashiCorp.Cdktf.TerraformProvider No description.
Provisioners object[] No description.
ClusterId string The ID of the HCP Consul cluster.
HvnId string The ID of the HVN this HCP Consul cluster is associated to.
Tier string The tier that the HCP Consul cluster will be provisioned as.
AutoHvnToHvnPeering object Enables automatic HVN to HVN peering when creating a secondary cluster in a federation.
ConnectEnabled object Denotes the Consul connect feature should be enabled for this cluster. Default to true.
Datacenter string The Consul data center name of the cluster. If not specified, it is defaulted to the value of cluster_id.
Id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/consul_cluster#id ConsulCluster#id}.
IpAllowlist object ip_allowlist block.
MinConsulVersion string The minimum Consul patch version of the cluster.
PrimaryLink string The self_link of the HCP Consul cluster which is the primary in the federation setup with this HCP Consul cluster.
ProjectId string The ID of the HCP project where the HCP Consul cluster is located.
PublicEndpoint object Denotes that the cluster has a public endpoint for the Consul UI. Defaults to false.
Size string The t-shirt size representation of each server VM that this Consul cluster is provisioned with.
Timeouts ConsulClusterTimeouts timeouts block.
ConnectionOptional 
public object Connection { get; set; }
  • Type: object
CountOptional 
public object Count { get; set; }
  • Type: object
DependsOnOptional 
public ITerraformDependable[] DependsOn { get; set; }
  • Type: HashiCorp.Cdktf.ITerraformDependable[]
ForEachOptional 
public ITerraformIterator ForEach { get; set; }
  • Type: HashiCorp.Cdktf.ITerraformIterator
LifecycleOptional 
public TerraformResourceLifecycle Lifecycle { get; set; }
  • Type: HashiCorp.Cdktf.TerraformResourceLifecycle
ProviderOptional 
public TerraformProvider Provider { get; set; }
  • Type: HashiCorp.Cdktf.TerraformProvider
ProvisionersOptional 
public object[] Provisioners { get; set; }
  • Type: object[]
ClusterIdRequired 
public string ClusterId { get; set; }
  • Type: string

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}

HvnIdRequired 
public string HvnId { get; set; }
  • Type: string

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 
public string Tier { get; set; }
  • Type: string

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}

AutoHvnToHvnPeeringOptional 
public object AutoHvnToHvnPeering { get; set; }
  • Type: object

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}

ConnectEnabledOptional 
public object ConnectEnabled { get; set; }
  • Type: object

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 
public string Datacenter { get; set; }
  • Type: string

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 
public string Id { get; set; }
  • Type: string

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.

IpAllowlistOptional 
public object IpAllowlist { get; set; }
  • Type: object

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}

MinConsulVersionOptional 
public string MinConsulVersion { get; set; }
  • Type: string

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}

PrimaryLinkOptional 
public string PrimaryLink { get; set; }
  • Type: string

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}

ProjectIdOptional 
public string ProjectId { get; set; }
  • Type: string

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}

PublicEndpointOptional 
public object PublicEndpoint { get; set; }
  • Type: object

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 
public string Size { get; set; }
  • Type: string

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 
public ConsulClusterTimeouts Timeouts { get; set; }

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 

using HashiCorp.Cdktf.Providers.Hcp;

new ConsulClusterIpAllowlistStruct {
    string Address,
    string Description = null
};

Properties

Name Type Description
Address string IP address range in CIDR notation.
Description string Description to help identify source (maximum 255 chars).
AddressRequired 
public string Address { get; set; }
  • Type: string

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 
public string Description { get; set; }
  • Type: string

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 

using HashiCorp.Cdktf.Providers.Hcp;

new ConsulClusterTimeouts {
    string Create = null,
    string Default = null,
    string Delete = null,
    string Update = null
};

Properties

Name Type Description
Create string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/consul_cluster#create ConsulCluster#create}.
Default string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/consul_cluster#default ConsulCluster#default}.
Delete string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/consul_cluster#delete ConsulCluster#delete}.
Update string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/consul_cluster#update ConsulCluster#update}.
CreateOptional 
public string Create { get; set; }
  • Type: string

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

DefaultOptional 
public string Default { get; set; }
  • Type: string

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

DeleteOptional 
public string Delete { get; set; }
  • Type: string

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

UpdateOptional 
public string Update { get; set; }
  • Type: string

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 

using HashiCorp.Cdktf.Providers.Hcp;

new ConsulClusterIpAllowlistStructList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet);
Name Type Description
TerraformResource HashiCorp.Cdktf.IInterpolatingParent The parent resource.
TerraformAttribute string The attribute on the parent resource this class is referencing.
WrapsSet bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
TerraformResourceRequired
  • Type: HashiCorp.Cdktf.IInterpolatingParent

The parent resource.

TerraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.

WrapsSetRequired
  • 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
AllWithMapKey Creating an iterator for this complex list.
ComputeFqn No description.
Resolve Produce the Token's value at resolution time.
ToString Return a string representation of this resolvable object.
Get No description.
AllWithMapKey 
private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName)

Creating an iterator for this complex list.

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

MapKeyAttributeNameRequired
  • Type: string
ComputeFqn 
private string ComputeFqn()
Resolve 
private object Resolve(IResolveContext Context)

Produce the Token's value at resolution time.

ContextRequired
  • Type: HashiCorp.Cdktf.IResolveContext
ToString 
private string ToString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

Get 
private ConsulClusterIpAllowlistStructOutputReference Get(double Index)
IndexRequired
  • Type: double

the index of the item to return.

Properties

Name Type Description
CreationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
Fqn string No description.
InternalValue object No description.
CreationStackRequired 
public string[] CreationStack { get; }
  • Type: string[]

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 
public string Fqn { get; }
  • Type: string
InternalValueOptional 
public object InternalValue { get; }
  • Type: object

ConsulClusterIpAllowlistStructOutputReference

Initializers 

using HashiCorp.Cdktf.Providers.Hcp;

new ConsulClusterIpAllowlistStructOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet);
Name Type Description
TerraformResource HashiCorp.Cdktf.IInterpolatingParent The parent resource.
TerraformAttribute string The attribute on the parent resource this class is referencing.
ComplexObjectIndex double the index of this item in the list.
ComplexObjectIsFromSet bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
TerraformResourceRequired
  • Type: HashiCorp.Cdktf.IInterpolatingParent

The parent resource.

TerraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.

ComplexObjectIndexRequired
  • Type: double

the index of this item in the list.

ComplexObjectIsFromSetRequired
  • 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
ComputeFqn No description.
GetAnyMapAttribute No description.
GetBooleanAttribute No description.
GetBooleanMapAttribute No description.
GetListAttribute No description.
GetNumberAttribute No description.
GetNumberListAttribute No description.
GetNumberMapAttribute No description.
GetStringAttribute No description.
GetStringMapAttribute No description.
InterpolationForAttribute No description.
Resolve Produce the Token's value at resolution time.
ToString Return a string representation of this resolvable object.
ResetDescription No description.
ComputeFqn 
private string ComputeFqn()
GetAnyMapAttribute 
private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetBooleanAttribute 
private IResolvable GetBooleanAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetBooleanMapAttribute 
private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetListAttribute 
private string[] GetListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetNumberAttribute 
private double GetNumberAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetNumberListAttribute 
private double[] GetNumberListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetNumberMapAttribute 
private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetStringAttribute 
private string GetStringAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetStringMapAttribute 
private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
InterpolationForAttribute 
private IResolvable InterpolationForAttribute(string Property)
PropertyRequired
  • Type: string
Resolve 
private object Resolve(IResolveContext Context)

Produce the Token's value at resolution time.

ContextRequired
  • Type: HashiCorp.Cdktf.IResolveContext
ToString 
private string ToString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

ResetDescription 
private void ResetDescription()

Properties

Name Type Description
CreationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
Fqn string No description.
AddressInput string No description.
DescriptionInput string No description.
Address string No description.
Description string No description.
InternalValue object No description.
CreationStackRequired 
public string[] CreationStack { get; }
  • Type: string[]

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 
public string Fqn { get; }
  • Type: string
AddressInputOptional 
public string AddressInput { get; }
  • Type: string
DescriptionInputOptional 
public string DescriptionInput { get; }
  • Type: string
AddressRequired 
public string Address { get; }
  • Type: string
DescriptionRequired 
public string Description { get; }
  • Type: string
InternalValueOptional 
public object InternalValue { get; }
  • Type: object

ConsulClusterTimeoutsOutputReference

Initializers 

using HashiCorp.Cdktf.Providers.Hcp;

new ConsulClusterTimeoutsOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute);
Name Type Description
TerraformResource HashiCorp.Cdktf.IInterpolatingParent The parent resource.
TerraformAttribute string The attribute on the parent resource this class is referencing.
TerraformResourceRequired
  • Type: HashiCorp.Cdktf.IInterpolatingParent

The parent resource.

TerraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.

Methods

Name Description
ComputeFqn No description.
GetAnyMapAttribute No description.
GetBooleanAttribute No description.
GetBooleanMapAttribute No description.
GetListAttribute No description.
GetNumberAttribute No description.
GetNumberListAttribute No description.
GetNumberMapAttribute No description.
GetStringAttribute No description.
GetStringMapAttribute No description.
InterpolationForAttribute No description.
Resolve Produce the Token's value at resolution time.
ToString Return a string representation of this resolvable object.
ResetCreate No description.
ResetDefault No description.
ResetDelete No description.
ResetUpdate No description.
ComputeFqn 
private string ComputeFqn()
GetAnyMapAttribute 
private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetBooleanAttribute 
private IResolvable GetBooleanAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetBooleanMapAttribute 
private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetListAttribute 
private string[] GetListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetNumberAttribute 
private double GetNumberAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetNumberListAttribute 
private double[] GetNumberListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetNumberMapAttribute 
private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetStringAttribute 
private string GetStringAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetStringMapAttribute 
private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
InterpolationForAttribute 
private IResolvable InterpolationForAttribute(string Property)
PropertyRequired
  • Type: string
Resolve 
private object Resolve(IResolveContext Context)

Produce the Token's value at resolution time.

ContextRequired
  • Type: HashiCorp.Cdktf.IResolveContext
ToString 
private string ToString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

ResetCreate 
private void ResetCreate()
ResetDefault 
private void ResetDefault()
ResetDelete 
private void ResetDelete()
ResetUpdate 
private void ResetUpdate()

Properties

Name Type Description
CreationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
Fqn string No description.
CreateInput string No description.
DefaultInput string No description.
DeleteInput string No description.
UpdateInput string No description.
Create string No description.
Default string No description.
Delete string No description.
Update string No description.
InternalValue object No description.
CreationStackRequired 
public string[] CreationStack { get; }
  • Type: string[]

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 
public string Fqn { get; }
  • Type: string
CreateInputOptional 
public string CreateInput { get; }
  • Type: string
DefaultInputOptional 
public string DefaultInput { get; }
  • Type: string
DeleteInputOptional 
public string DeleteInput { get; }
  • Type: string
UpdateInputOptional 
public string UpdateInput { get; }
  • Type: string
CreateRequired 
public string Create { get; }
  • Type: string
DefaultRequired 
public string Default { get; }
  • Type: string
DeleteRequired 
public string Delete { get; }
  • Type: string
UpdateRequired 
public string Update { get; }
  • Type: string
InternalValueOptional 
public object InternalValue { get; }
  • Type: object