boundaryCluster.typescript.md

boundaryCluster Submodule

Constructs

BoundaryCluster

Represents a {@link https://registry.terraform.io/providers/hashicorp/hcp/0.99.0/docs/resources/boundary_cluster hcp_boundary_cluster}.

Initializers

import { boundaryCluster } from '@cdktf/provider-hcp'

new boundaryCluster.BoundaryCluster(scope: Construct, id: string, config: BoundaryClusterConfig)

Name	Type	Description
scope	constructs.Construct	The scope in which to define this construct.
id	string	The scoped construct ID.
config	BoundaryClusterConfig	No description.

---

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

id^Required

• Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

---

config^Required

• Type: BoundaryClusterConfig

---

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".
putMaintenanceWindowConfig	No description.
putTimeouts	No description.
resetId	No description.
resetMaintenanceWindowConfig	No description.
resetProjectId	No description.
resetTimeouts	No description.

---

toString

public toString(): string

Returns a string representation of this construct.

addOverride

public addOverride(path: string, value: any): void

path^Required

• Type: string

---

value^Required

• Type: any

---

overrideLogicalId

public overrideLogicalId(newLogicalId: string): void

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

newLogicalId^Required

• 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

toMetadata

public toMetadata(): any

toTerraform

public toTerraform(): any

Adds this resource to the terraform JSON output.

addMoveTarget

public addMoveTarget(moveTarget: string): void

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

moveTarget^Required

• Type: string

The string move target that will correspond to this resource.

---

getAnyMapAttribute

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

terraformAttribute^Required

• Type: string

---

hasResourceMove

public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById

importFrom

public importFrom(id: string, provider?: TerraformProvider): void

id^Required

• Type: string

---

provider^Optional

• Type: cdktf.TerraformProvider

---

interpolationForAttribute

public interpolationForAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

moveFromId

public moveFromId(id: string): void

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.

id^Required

• Type: string

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

---

moveTo

public moveTo(moveTarget: string, index?: string | number): void

Moves this resource to the target resource given by moveTarget.

moveTarget^Required

• Type: string

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

---

index^Optional

• Type: string | number

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

---

moveToId

public moveToId(id: string): void

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

id^Required

• Type: string

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

---

putMaintenanceWindowConfig

public putMaintenanceWindowConfig(value: BoundaryClusterMaintenanceWindowConfig): void

value^Required

• Type: BoundaryClusterMaintenanceWindowConfig

---

putTimeouts

public putTimeouts(value: BoundaryClusterTimeouts): void

value^Required

• Type: BoundaryClusterTimeouts

---

resetId

public resetId(): void

resetMaintenanceWindowConfig

public resetMaintenanceWindowConfig(): void

resetProjectId

public resetProjectId(): void

resetTimeouts

public resetTimeouts(): void

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isTerraformElement	No description.
isTerraformResource	No description.
generateConfigForImport	Generates CDKTF code for importing a BoundaryCluster resource upon running "cdktf plan ".

---

isConstruct

import { boundaryCluster } from '@cdktf/provider-hcp'

boundaryCluster.BoundaryCluster.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.

x^Required

• Type: any

Any object.

---

isTerraformElement

import { boundaryCluster } from '@cdktf/provider-hcp'

boundaryCluster.BoundaryCluster.isTerraformElement(x: any)

x^Required

• Type: any

---

isTerraformResource

import { boundaryCluster } from '@cdktf/provider-hcp'

boundaryCluster.BoundaryCluster.isTerraformResource(x: any)

x^Required

• Type: any

---

generateConfigForImport

import { boundaryCluster } from '@cdktf/provider-hcp'

boundaryCluster.BoundaryCluster.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

importToId^Required

• Type: string

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

---

importFromId^Required

• Type: string

The id of the existing BoundaryCluster that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/hcp/0.99.0/docs/resources/boundary_cluster#import import section} in the documentation of this resource for the id to use

---

provider^Optional

• Type: cdktf.TerraformProvider

? Optional instance of the provider where the BoundaryCluster 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.
connection	cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection	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.
provisioners	cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]	No description.
clusterUrl	string	No description.
createdAt	string	No description.
maintenanceWindowConfig	BoundaryClusterMaintenanceWindowConfigOutputReference	No description.
state	string	No description.
timeouts	BoundaryClusterTimeoutsOutputReference	No description.
version	string	No description.
clusterIdInput	string	No description.
idInput	string	No description.
maintenanceWindowConfigInput	BoundaryClusterMaintenanceWindowConfig	No description.
passwordInput	string	No description.
projectIdInput	string	No description.
tierInput	string	No description.
timeoutsInput	cdktf.IResolvable | BoundaryClusterTimeouts	No description.
usernameInput	string	No description.
clusterId	string	No description.
id	string	No description.
password	string	No description.
projectId	string	No description.
tier	string	No description.
username	string	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

cdktfStack^Required

public readonly cdktfStack: TerraformStack;

• Type: cdktf.TerraformStack

---

fqn^Required

public readonly fqn: string;

• Type: string

---

friendlyUniqueId^Required

public readonly friendlyUniqueId: string;

• Type: string

---

terraformMetaArguments^Required

public readonly terraformMetaArguments: {[ key: string ]: any};

• Type: {[ key: string ]: any}

---

terraformResourceType^Required

public readonly terraformResourceType: string;

• Type: string

---

terraformGeneratorMetadata^Optional

public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;

• Type: cdktf.TerraformProviderGeneratorMetadata

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: string[];

• Type: string[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

provisioners^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

• Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

---

clusterUrl^Required

public readonly clusterUrl: string;

• Type: string

---

createdAt^Required

public readonly createdAt: string;

• Type: string

---

maintenanceWindowConfig^Required

public readonly maintenanceWindowConfig: BoundaryClusterMaintenanceWindowConfigOutputReference;

• Type: BoundaryClusterMaintenanceWindowConfigOutputReference

---

state^Required

public readonly state: string;

• Type: string

---

timeouts^Required

public readonly timeouts: BoundaryClusterTimeoutsOutputReference;

• Type: BoundaryClusterTimeoutsOutputReference

---

version^Required

public readonly version: string;

• Type: string

---

clusterIdInput^Optional

public readonly clusterIdInput: string;

• Type: string

---

idInput^Optional

public readonly idInput: string;

• Type: string

---

maintenanceWindowConfigInput^Optional

public readonly maintenanceWindowConfigInput: BoundaryClusterMaintenanceWindowConfig;

• Type: BoundaryClusterMaintenanceWindowConfig

---

passwordInput^Optional

public readonly passwordInput: string;

• Type: string

---

projectIdInput^Optional

public readonly projectIdInput: string;

• Type: string

---

tierInput^Optional

public readonly tierInput: string;

• Type: string

---

timeoutsInput^Optional

public readonly timeoutsInput: IResolvable | BoundaryClusterTimeouts;

• Type: cdktf.IResolvable | BoundaryClusterTimeouts

---

usernameInput^Optional

public readonly usernameInput: string;

• Type: string

---

clusterId^Required

public readonly clusterId: string;

• Type: string

---

id^Required

public readonly id: string;

• Type: string

---

password^Required

public readonly password: string;

• Type: string

---

projectId^Required

public readonly projectId: string;

• Type: string

---

tier^Required

public readonly tier: string;

• Type: string

---

username^Required

public readonly username: string;

• Type: string

---

Constants

Name	Type	Description
tfResourceType	string	No description.

---

tfResourceType^Required

public readonly tfResourceType: string;

• Type: string

---

Structs

BoundaryClusterConfig

Initializer

import { boundaryCluster } from '@cdktf/provider-hcp'

const boundaryClusterConfig: boundaryCluster.BoundaryClusterConfig = { ... }

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.
clusterId	string	The ID of the Boundary cluster.
password	string	The password of the initial admin user.
tier	string	The tier that the HCP Boundary cluster will be provisioned as, 'Standard' or 'Plus'.
username	string	The username of the initial admin user.
id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.99.0/docs/resources/boundary_cluster#id BoundaryCluster#id}.
maintenanceWindowConfig	BoundaryClusterMaintenanceWindowConfig	maintenance_window_config block.
projectId	string	The ID of the HCP project where the Boundary cluster is located.
timeouts	BoundaryClusterTimeouts	timeouts block.

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: ITerraformDependable[];

• Type: cdktf.ITerraformDependable[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

provisioners^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

• Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

---

clusterId^Required

public readonly clusterId: string;

• Type: string

The ID of the Boundary cluster.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.99.0/docs/resources/boundary_cluster#cluster_id BoundaryCluster#cluster_id}

---

password^Required

public readonly password: string;

• Type: string

The password of the initial admin user.

This must be at least 8 characters in length. Note that this may show up in logs, and it will be stored in the state file.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.99.0/docs/resources/boundary_cluster#password BoundaryCluster#password}

---

tier^Required

public readonly tier: string;

• Type: string

The tier that the HCP Boundary cluster will be provisioned as, 'Standard' or 'Plus'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.99.0/docs/resources/boundary_cluster#tier BoundaryCluster#tier}

---

username^Required

public readonly username: string;

• Type: string

The username of the initial admin user.

This must be at least 3 characters in length, alphanumeric, hyphen, or period.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.99.0/docs/resources/boundary_cluster#username BoundaryCluster#username}

---

id^Optional

public readonly id: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.99.0/docs/resources/boundary_cluster#id BoundaryCluster#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.

---

maintenanceWindowConfig^Optional

public readonly maintenanceWindowConfig: BoundaryClusterMaintenanceWindowConfig;

• Type: BoundaryClusterMaintenanceWindowConfig

maintenance_window_config block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.99.0/docs/resources/boundary_cluster#maintenance_window_config BoundaryCluster#maintenance_window_config}

---

projectId^Optional

public readonly projectId: string;

• Type: string

The ID of the HCP project where the Boundary 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.99.0/docs/resources/boundary_cluster#project_id BoundaryCluster#project_id}

---

timeouts^Optional

public readonly timeouts: BoundaryClusterTimeouts;

• Type: BoundaryClusterTimeouts

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.99.0/docs/resources/boundary_cluster#timeouts BoundaryCluster#timeouts}

---

BoundaryClusterMaintenanceWindowConfig

Initializer

import { boundaryCluster } from '@cdktf/provider-hcp'

const boundaryClusterMaintenanceWindowConfig: boundaryCluster.BoundaryClusterMaintenanceWindowConfig = { ... }

Properties

Name	Type	Description
day	string	The maintenance day of the week for scheduled upgrades.
end	number	The end time which upgrades can be performed.
start	number	The start time which upgrades can be performed.
upgradeType	string	The upgrade type for the cluster. Valid options for upgrade type - AUTOMATIC, SCHEDULED.

---

day^Optional

public readonly day: string;

• Type: string

The maintenance day of the week for scheduled upgrades.

Valid options for maintenance window day - MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.99.0/docs/resources/boundary_cluster#day BoundaryCluster#day}

---

end^Optional

public readonly end: number;

• Type: number

The end time which upgrades can be performed.

Uses 24H clock and must be in UTC time zone. Valid options include - 1 to 24 (inclusive)

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.99.0/docs/resources/boundary_cluster#end BoundaryCluster#end}

---

start^Optional

public readonly start: number;

• Type: number

The start time which upgrades can be performed.

Uses 24H clock and must be in UTC time zone. Valid options include - 0 to 23 (inclusive)

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.99.0/docs/resources/boundary_cluster#start BoundaryCluster#start}

---

upgradeType^Optional

public readonly upgradeType: string;

• Type: string

The upgrade type for the cluster. Valid options for upgrade type - AUTOMATIC, SCHEDULED.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.99.0/docs/resources/boundary_cluster#upgrade_type BoundaryCluster#upgrade_type}

---

BoundaryClusterTimeouts

Initializer

import { boundaryCluster } from '@cdktf/provider-hcp'

const boundaryClusterTimeouts: boundaryCluster.BoundaryClusterTimeouts = { ... }

Properties

Name	Type	Description
create	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.99.0/docs/resources/boundary_cluster#create BoundaryCluster#create}.
default	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.99.0/docs/resources/boundary_cluster#default BoundaryCluster#default}.
delete	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.99.0/docs/resources/boundary_cluster#delete BoundaryCluster#delete}.

---

create^Optional

public readonly create: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.99.0/docs/resources/boundary_cluster#create BoundaryCluster#create}.

---

default^Optional

public readonly default: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.99.0/docs/resources/boundary_cluster#default BoundaryCluster#default}.

---

delete^Optional

public readonly delete: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.99.0/docs/resources/boundary_cluster#delete BoundaryCluster#delete}.

---

Classes

BoundaryClusterMaintenanceWindowConfigOutputReference

Initializers

import { boundaryCluster } from '@cdktf/provider-hcp'

new boundaryCluster.BoundaryClusterMaintenanceWindowConfigOutputReference(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.

---

terraformResource^Required

• Type: cdktf.IInterpolatingParent

The parent resource.

---

terraformAttribute^Required

• 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.
resetDay	No description.
resetEnd	No description.
resetStart	No description.
resetUpgradeType	No description.

---

computeFqn

public computeFqn(): string

getAnyMapAttribute

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

terraformAttribute^Required

• Type: string

---

interpolationForAttribute

public interpolationForAttribute(property: string): IResolvable

property^Required

• Type: string

---

resolve

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_context^Required

• Type: cdktf.IResolveContext

---

toString

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetDay

public resetDay(): void

resetEnd

public resetEnd(): void

resetStart

public resetStart(): void

resetUpgradeType

public resetUpgradeType(): 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.
dayInput	string	No description.
endInput	number	No description.
startInput	number	No description.
upgradeTypeInput	string	No description.
day	string	No description.
end	number	No description.
start	number	No description.
upgradeType	string	No description.
internalValue	BoundaryClusterMaintenanceWindowConfig	No description.

---

creationStack^Required

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.

---

fqn^Required

public readonly fqn: string;

• Type: string

---

dayInput^Optional

public readonly dayInput: string;

• Type: string

---

endInput^Optional

public readonly endInput: number;

• Type: number

---

startInput^Optional

public readonly startInput: number;

• Type: number

---

upgradeTypeInput^Optional

public readonly upgradeTypeInput: string;

• Type: string

---

day^Required

public readonly day: string;

• Type: string

---

end^Required

public readonly end: number;

• Type: number

---

start^Required

public readonly start: number;

• Type: number

---

upgradeType^Required

public readonly upgradeType: string;

• Type: string

---

internalValue^Optional

public readonly internalValue: BoundaryClusterMaintenanceWindowConfig;

• Type: BoundaryClusterMaintenanceWindowConfig

---

BoundaryClusterTimeoutsOutputReference

Initializers

import { boundaryCluster } from '@cdktf/provider-hcp'

new boundaryCluster.BoundaryClusterTimeoutsOutputReference(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.

---

terraformResource^Required

• Type: cdktf.IInterpolatingParent

The parent resource.

---

terraformAttribute^Required

• 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.

---

computeFqn

public computeFqn(): string

getAnyMapAttribute

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

terraformAttribute^Required

• Type: string

---

interpolationForAttribute

public interpolationForAttribute(property: string): IResolvable

property^Required

• Type: string

---

resolve

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_context^Required

• Type: cdktf.IResolveContext

---

toString

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetCreate

public resetCreate(): void

resetDefault

public resetDefault(): void

resetDelete

public resetDelete(): 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.
createInput	string	No description.
defaultInput	string	No description.
deleteInput	string	No description.
create	string	No description.
default	string	No description.
delete	string	No description.
internalValue	cdktf.IResolvable | BoundaryClusterTimeouts	No description.

---

creationStack^Required

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.

---

fqn^Required

public readonly fqn: string;

• Type: string

---

createInput^Optional

public readonly createInput: string;

• Type: string

---

defaultInput^Optional

public readonly defaultInput: string;

• Type: string

---

deleteInput^Optional

public readonly deleteInput: string;

• Type: string

---

create^Required

public readonly create: string;

• Type: string

---

default^Required

public readonly default: string;

• Type: string

---

delete^Required

public readonly delete: string;

• Type: string

---

internalValue^Optional

public readonly internalValue: IResolvable | BoundaryClusterTimeouts;

• Type: cdktf.IResolvable | BoundaryClusterTimeouts

---