Skip to content
This repository has been archived by the owner on Jan 17, 2024. It is now read-only.

Latest commit

 

History

History
1473 lines (914 loc) · 59.2 KB

dataHcsCluster.typescript.md

File metadata and controls

1473 lines (914 loc) · 59.2 KB

dataHcsCluster Submodule

Constructs

DataHcsCluster

Represents a {@link https://registry.terraform.io/providers/hashicorp/hcs/0.5.1/docs/data-sources/cluster hcs_cluster}.

Initializers 

import { dataHcsCluster } from '@cdktf/provider-hcs'

new dataHcsCluster.DataHcsCluster(scope: Construct, id: string, config: DataHcsClusterConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config DataHcsClusterConfig 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 Adds this resource to the terraform JSON output.
toMetadata No description.
toTerraform Adds this resource to the terraform JSON output.
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.
putTimeouts No description.
resetClusterName No description.
resetId No description.
resetTimeouts No description.
toString 
public toString(): string

Returns a string representation of this construct.

addOverride 
public addOverride(path: string, value: any): void
pathRequired
  • Type: string
valueRequired
  • Type: any
overrideLogicalId 
public overrideLogicalId(newLogicalId: string): void

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

newLogicalIdRequired
  • Type: string

The new logical ID to use for this stack element.

resetOverrideLogicalId 
public resetOverrideLogicalId(): void

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

toHclTerraform 
public toHclTerraform(): any

Adds this resource to the terraform JSON output.

toMetadata 
public toMetadata(): any
toTerraform 
public toTerraform(): any

Adds this resource to the terraform JSON output.

getAnyMapAttribute 
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string
getBooleanAttribute 
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
getBooleanMapAttribute 
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string
getListAttribute 
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string
getNumberAttribute 
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string
getNumberListAttribute 
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string
getNumberMapAttribute 
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string
getStringAttribute 
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string
getStringMapAttribute 
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string
interpolationForAttribute 
public interpolationForAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
putTimeouts 
public putTimeouts(value: DataHcsClusterTimeouts): void
valueRequired
resetClusterName 
public resetClusterName(): void
resetId 
public resetId(): void
resetTimeouts 
public resetTimeouts(): void

Static Functions

Name Description
isConstruct Checks if x is a construct.
isTerraformElement No description.
isTerraformDataSource No description.
generateConfigForImport Generates CDKTF code for importing a DataHcsCluster resource upon running "cdktf plan ".
isConstruct 
import { dataHcsCluster } from '@cdktf/provider-hcs'

dataHcsCluster.DataHcsCluster.isConstruct(x: 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: any

Any object.

isTerraformElement 
import { dataHcsCluster } from '@cdktf/provider-hcs'

dataHcsCluster.DataHcsCluster.isTerraformElement(x: any)
xRequired
  • Type: any
isTerraformDataSource 
import { dataHcsCluster } from '@cdktf/provider-hcs'

dataHcsCluster.DataHcsCluster.isTerraformDataSource(x: any)
xRequired
  • Type: any
generateConfigForImport 
import { dataHcsCluster } from '@cdktf/provider-hcs'

dataHcsCluster.DataHcsCluster.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

importFromIdRequired
  • Type: string

The id of the existing DataHcsCluster that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/hcs/0.5.1/docs/data-sources/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 DataHcsCluster to import is found.

Properties

Name Type Description
node constructs.Node The tree node.
cdktfStack cdktf.TerraformStack No description.
fqn string No description.
friendlyUniqueId string No description.
terraformMetaArguments {[ key: string ]: any} No description.
terraformResourceType string No description.
terraformGeneratorMetadata cdktf.TerraformProviderGeneratorMetadata No description.
count number | cdktf.TerraformCount No description.
dependsOn string[] No description.
forEach cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
blobContainerName string No description.
clusterMode string No description.
consulAutomaticUpgrades cdktf.IResolvable No description.
consulCaFile string No description.
consulClusterId string No description.
consulConfigFile string No description.
consulConnect cdktf.IResolvable No description.
consulDatacenter string No description.
consulExternalEndpoint cdktf.IResolvable No description.
consulExternalEndpointUrl string No description.
consulFederationToken string No description.
consulPrivateEndpointUrl string No description.
consulSnapshotInterval string No description.
consulSnapshotRetention string No description.
consulVersion string No description.
email string No description.
location string No description.
managedApplicationId string No description.
managedResourceGroupName string No description.
planName string No description.
state string No description.
storageAccountName string No description.
storageAccountResourceGroup string No description.
tags cdktf.StringMap No description.
timeouts DataHcsClusterTimeoutsOutputReference No description.
vnetCidr string No description.
vnetId string No description.
vnetName string No description.
vnetResourceGroupName string No description.
clusterNameInput string No description.
idInput string No description.
managedApplicationNameInput string No description.
resourceGroupNameInput string No description.
timeoutsInput cdktf.IResolvable | DataHcsClusterTimeouts No description.
clusterName string No description.
id string No description.
managedApplicationName string No description.
resourceGroupName string No description.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

cdktfStackRequired 
public readonly cdktfStack: TerraformStack;
  • Type: cdktf.TerraformStack
fqnRequired 
public readonly fqn: string;
  • Type: string
friendlyUniqueIdRequired 
public readonly friendlyUniqueId: string;
  • Type: string
terraformMetaArgumentsRequired 
public readonly terraformMetaArguments: {[ key: string ]: any};
  • Type: {[ key: string ]: any}
terraformResourceTypeRequired 
public readonly terraformResourceType: string;
  • Type: string
terraformGeneratorMetadataOptional 
public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;
  • Type: cdktf.TerraformProviderGeneratorMetadata
countOptional 
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount
dependsOnOptional 
public readonly dependsOn: string[];
  • Type: string[]
forEachOptional 
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider
blobContainerNameRequired 
public readonly blobContainerName: string;
  • Type: string
clusterModeRequired 
public readonly clusterMode: string;
  • Type: string
consulAutomaticUpgradesRequired 
public readonly consulAutomaticUpgrades: IResolvable;
  • Type: cdktf.IResolvable
consulCaFileRequired 
public readonly consulCaFile: string;
  • Type: string
consulClusterIdRequired 
public readonly consulClusterId: string;
  • Type: string
consulConfigFileRequired 
public readonly consulConfigFile: string;
  • Type: string
consulConnectRequired 
public readonly consulConnect: IResolvable;
  • Type: cdktf.IResolvable
consulDatacenterRequired 
public readonly consulDatacenter: string;
  • Type: string
consulExternalEndpointRequired 
public readonly consulExternalEndpoint: IResolvable;
  • Type: cdktf.IResolvable
consulExternalEndpointUrlRequired 
public readonly consulExternalEndpointUrl: string;
  • Type: string
consulFederationTokenRequired 
public readonly consulFederationToken: string;
  • Type: string
consulPrivateEndpointUrlRequired 
public readonly consulPrivateEndpointUrl: string;
  • Type: string
consulSnapshotIntervalRequired 
public readonly consulSnapshotInterval: string;
  • Type: string
consulSnapshotRetentionRequired 
public readonly consulSnapshotRetention: string;
  • Type: string
consulVersionRequired 
public readonly consulVersion: string;
  • Type: string
emailRequired 
public readonly email: string;
  • Type: string
locationRequired 
public readonly location: string;
  • Type: string
managedApplicationIdRequired 
public readonly managedApplicationId: string;
  • Type: string
managedResourceGroupNameRequired 
public readonly managedResourceGroupName: string;
  • Type: string
planNameRequired 
public readonly planName: string;
  • Type: string
stateRequired 
public readonly state: string;
  • Type: string
storageAccountNameRequired 
public readonly storageAccountName: string;
  • Type: string
storageAccountResourceGroupRequired 
public readonly storageAccountResourceGroup: string;
  • Type: string
tagsRequired 
public readonly tags: StringMap;
  • Type: cdktf.StringMap
timeoutsRequired 
public readonly timeouts: DataHcsClusterTimeoutsOutputReference;
vnetCidrRequired 
public readonly vnetCidr: string;
  • Type: string
vnetIdRequired 
public readonly vnetId: string;
  • Type: string
vnetNameRequired 
public readonly vnetName: string;
  • Type: string
vnetResourceGroupNameRequired 
public readonly vnetResourceGroupName: string;
  • Type: string
clusterNameInputOptional 
public readonly clusterNameInput: string;
  • Type: string
idInputOptional 
public readonly idInput: string;
  • Type: string
managedApplicationNameInputOptional 
public readonly managedApplicationNameInput: string;
  • Type: string
resourceGroupNameInputOptional 
public readonly resourceGroupNameInput: string;
  • Type: string
timeoutsInputOptional 
public readonly timeoutsInput: IResolvable | DataHcsClusterTimeouts;
clusterNameRequired 
public readonly clusterName: string;
  • Type: string
idRequired 
public readonly id: string;
  • Type: string
managedApplicationNameRequired 
public readonly managedApplicationName: string;
  • Type: string
resourceGroupNameRequired 
public readonly resourceGroupName: string;
  • Type: string

Constants

Name Type Description
tfResourceType string No description.
tfResourceTypeRequired 
public readonly tfResourceType: string;
  • Type: string

Structs

DataHcsClusterConfig

Initializer 

import { dataHcsCluster } from '@cdktf/provider-hcs'

const dataHcsClusterConfig: dataHcsCluster.DataHcsClusterConfig = { ... }

Properties

Name Type Description
connection cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection No description.
count number | cdktf.TerraformCount No description.
dependsOn cdktf.ITerraformDependable[] No description.
forEach cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[] No description.
managedApplicationName string The name of the HCS Azure Managed Application.
resourceGroupName string The name of the Resource Group in which the HCS Azure Managed Application belongs.
clusterName string The name of the cluster Managed Resource. If not specified, it is defaulted to the value of managed_application_name.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcs/0.5.1/docs/data-sources/cluster#id DataHcsCluster#id}.
timeouts DataHcsClusterTimeouts timeouts block.
connectionOptional 
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
countOptional 
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount
dependsOnOptional 
public readonly dependsOn: ITerraformDependable[];
  • Type: cdktf.ITerraformDependable[]
forEachOptional 
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider
provisionersOptional 
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
managedApplicationNameRequired 
public readonly managedApplicationName: string;
  • Type: string

The name of the HCS Azure Managed Application.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcs/0.5.1/docs/data-sources/cluster#managed_application_name DataHcsCluster#managed_application_name}

resourceGroupNameRequired 
public readonly resourceGroupName: string;
  • Type: string

The name of the Resource Group in which the HCS Azure Managed Application belongs.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcs/0.5.1/docs/data-sources/cluster#resource_group_name DataHcsCluster#resource_group_name}

clusterNameOptional 
public readonly clusterName: string;
  • Type: string

The name of the cluster Managed Resource. If not specified, it is defaulted to the value of managed_application_name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcs/0.5.1/docs/data-sources/cluster#cluster_name DataHcsCluster#cluster_name}

idOptional 
public readonly id: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcs/0.5.1/docs/data-sources/cluster#id DataHcsCluster#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.

timeoutsOptional 
public readonly timeouts: DataHcsClusterTimeouts;

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcs/0.5.1/docs/data-sources/cluster#timeouts DataHcsCluster#timeouts}

DataHcsClusterTimeouts

Initializer 

import { dataHcsCluster } from '@cdktf/provider-hcs'

const dataHcsClusterTimeouts: dataHcsCluster.DataHcsClusterTimeouts = { ... }

Properties

Name Type Description
default string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcs/0.5.1/docs/data-sources/cluster#default DataHcsCluster#default}.
defaultOptional 
public readonly default: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcs/0.5.1/docs/data-sources/cluster#default DataHcsCluster#default}.

Classes

DataHcsClusterTimeoutsOutputReference

Initializers 

import { dataHcsCluster } from '@cdktf/provider-hcs'

new dataHcsCluster.DataHcsClusterTimeoutsOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.
terraformResourceRequired
  • Type: 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.
resetDefault No description.
computeFqn 
public computeFqn(): string
getAnyMapAttribute 
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string
getBooleanAttribute 
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
getBooleanMapAttribute 
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string
getListAttribute 
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string
getNumberAttribute 
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string
getNumberListAttribute 
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string
getNumberMapAttribute 
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string
getStringAttribute 
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string
getStringMapAttribute 
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string
interpolationForAttribute 
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string
resolve 
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
toString 
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetDefault 
public resetDefault(): void

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.
defaultInput string No description.
default string No description.
internalValue cdktf.IResolvable | DataHcsClusterTimeouts No description.
creationStackRequired 
public readonly creationStack: string[];
  • 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 readonly fqn: string;
  • Type: string
defaultInputOptional 
public readonly defaultInput: string;
  • Type: string
defaultRequired 
public readonly default: string;
  • Type: string
internalValueOptional 
public readonly internalValue: IResolvable | DataHcsClusterTimeouts;