Skip to content

Files

Latest commit

 

History

History
3352 lines (2063 loc) · 152 KB
·

computeNodeGroup.typescript.md

File metadata and controls

3352 lines (2063 loc) · 152 KB
·

computeNodeGroup Submodule

Constructs

ComputeNodeGroup

Represents a {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/compute_node_group google_compute_node_group}.

Initializers

import { computeNodeGroup } from '@cdktf/provider-google'

new computeNodeGroup.ComputeNodeGroup(scope: Construct, id: string, config: ComputeNodeGroupConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config ComputeNodeGroupConfig 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".
putAutoscalingPolicy No description.
putMaintenanceWindow No description.
putShareSettings No description.
putTimeouts No description.
resetAutoscalingPolicy No description.
resetDescription No description.
resetId No description.
resetInitialSize No description.
resetMaintenancePolicy No description.
resetMaintenanceWindow No description.
resetName No description.
resetProject No description.
resetShareSettings No description.
resetTimeouts No description.
resetZone 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
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.

moveTargetRequired
  • Type: string

The string move target that will correspond to this resource.


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

hasResourceMove
public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById
importFrom
public importFrom(id: string, provider?: TerraformProvider): void
idRequired
  • Type: string

providerOptional
  • Type: cdktf.TerraformProvider

interpolationForAttribute
public interpolationForAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • 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.

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

moveTargetRequired
  • Type: string

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


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

idRequired
  • Type: string

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


putAutoscalingPolicy
public putAutoscalingPolicy(value: ComputeNodeGroupAutoscalingPolicy): void
valueRequired

putMaintenanceWindow
public putMaintenanceWindow(value: ComputeNodeGroupMaintenanceWindow): void
valueRequired

putShareSettings
public putShareSettings(value: ComputeNodeGroupShareSettings): void
valueRequired

putTimeouts
public putTimeouts(value: ComputeNodeGroupTimeouts): void
valueRequired

resetAutoscalingPolicy
public resetAutoscalingPolicy(): void
resetDescription
public resetDescription(): void
resetId
public resetId(): void
resetInitialSize
public resetInitialSize(): void
resetMaintenancePolicy
public resetMaintenancePolicy(): void
resetMaintenanceWindow
public resetMaintenanceWindow(): void
resetName
public resetName(): void
resetProject
public resetProject(): void
resetShareSettings
public resetShareSettings(): void
resetTimeouts
public resetTimeouts(): void
resetZone
public resetZone(): 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 ComputeNodeGroup resource upon running "cdktf plan ".

isConstruct
import { computeNodeGroup } from '@cdktf/provider-google'

computeNodeGroup.ComputeNodeGroup.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 { computeNodeGroup } from '@cdktf/provider-google'

computeNodeGroup.ComputeNodeGroup.isTerraformElement(x: any)
xRequired
  • Type: any

isTerraformResource
import { computeNodeGroup } from '@cdktf/provider-google'

computeNodeGroup.ComputeNodeGroup.isTerraformResource(x: any)
xRequired
  • Type: any

generateConfigForImport
import { computeNodeGroup } from '@cdktf/provider-google'

computeNodeGroup.ComputeNodeGroup.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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


importFromIdRequired
  • Type: string

The id of the existing ComputeNodeGroup that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/compute_node_group#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 ComputeNodeGroup 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.
autoscalingPolicy ComputeNodeGroupAutoscalingPolicyOutputReference No description.
creationTimestamp string No description.
maintenanceWindow ComputeNodeGroupMaintenanceWindowOutputReference No description.
selfLink string No description.
shareSettings ComputeNodeGroupShareSettingsOutputReference No description.
size number No description.
timeouts ComputeNodeGroupTimeoutsOutputReference No description.
autoscalingPolicyInput ComputeNodeGroupAutoscalingPolicy No description.
descriptionInput string No description.
idInput string No description.
initialSizeInput number No description.
maintenancePolicyInput string No description.
maintenanceWindowInput ComputeNodeGroupMaintenanceWindow No description.
nameInput string No description.
nodeTemplateInput string No description.
projectInput string No description.
shareSettingsInput ComputeNodeGroupShareSettings No description.
timeoutsInput cdktf.IResolvable | ComputeNodeGroupTimeouts No description.
zoneInput string No description.
description string No description.
id string No description.
initialSize number No description.
maintenancePolicy string No description.
name string No description.
nodeTemplate string No description.
project string No description.
zone 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

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

provisionersOptional
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

autoscalingPolicyRequired
public readonly autoscalingPolicy: ComputeNodeGroupAutoscalingPolicyOutputReference;

creationTimestampRequired
public readonly creationTimestamp: string;
  • Type: string

maintenanceWindowRequired
public readonly maintenanceWindow: ComputeNodeGroupMaintenanceWindowOutputReference;

selfLinkRequired
public readonly selfLink: string;
  • Type: string

shareSettingsRequired
public readonly shareSettings: ComputeNodeGroupShareSettingsOutputReference;

sizeRequired
public readonly size: number;
  • Type: number

timeoutsRequired
public readonly timeouts: ComputeNodeGroupTimeoutsOutputReference;

autoscalingPolicyInputOptional
public readonly autoscalingPolicyInput: ComputeNodeGroupAutoscalingPolicy;

descriptionInputOptional
public readonly descriptionInput: string;
  • Type: string

idInputOptional
public readonly idInput: string;
  • Type: string

initialSizeInputOptional
public readonly initialSizeInput: number;
  • Type: number

maintenancePolicyInputOptional
public readonly maintenancePolicyInput: string;
  • Type: string

maintenanceWindowInputOptional
public readonly maintenanceWindowInput: ComputeNodeGroupMaintenanceWindow;

nameInputOptional
public readonly nameInput: string;
  • Type: string

nodeTemplateInputOptional
public readonly nodeTemplateInput: string;
  • Type: string

projectInputOptional
public readonly projectInput: string;
  • Type: string

shareSettingsInputOptional
public readonly shareSettingsInput: ComputeNodeGroupShareSettings;

timeoutsInputOptional
public readonly timeoutsInput: IResolvable | ComputeNodeGroupTimeouts;

zoneInputOptional
public readonly zoneInput: string;
  • Type: string

descriptionRequired
public readonly description: string;
  • Type: string

idRequired
public readonly id: string;
  • Type: string

initialSizeRequired
public readonly initialSize: number;
  • Type: number

maintenancePolicyRequired
public readonly maintenancePolicy: string;
  • Type: string

nameRequired
public readonly name: string;
  • Type: string

nodeTemplateRequired
public readonly nodeTemplate: string;
  • Type: string

projectRequired
public readonly project: string;
  • Type: string

zoneRequired
public readonly zone: string;
  • Type: string

Constants

Name Type Description
tfResourceType string No description.

tfResourceTypeRequired
public readonly tfResourceType: string;
  • Type: string

Structs

ComputeNodeGroupAutoscalingPolicy

Initializer

import { computeNodeGroup } from '@cdktf/provider-google'

const computeNodeGroupAutoscalingPolicy: computeNodeGroup.ComputeNodeGroupAutoscalingPolicy = { ... }

Properties

Name Type Description
maxNodes number Maximum size of the node group.
minNodes number Minimum size of the node group. Must be less than or equal to max-nodes. The default value is 0.
mode string The autoscaling mode.

maxNodesOptional
public readonly maxNodes: number;
  • Type: number

Maximum size of the node group.

Set to a value less than or equal to 100 and greater than or equal to min-nodes.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/compute_node_group#max_nodes ComputeNodeGroup#max_nodes}


minNodesOptional
public readonly minNodes: number;
  • Type: number

Minimum size of the node group. Must be less than or equal to max-nodes. The default value is 0.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/compute_node_group#min_nodes ComputeNodeGroup#min_nodes}


modeOptional
public readonly mode: string;
  • Type: string

The autoscaling mode.

Set to one of the following:

  • OFF: Disables the autoscaler.
  • ON: Enables scaling in and scaling out.
  • ONLY_SCALE_OUT: Enables only scaling out. You must use this mode if your node groups are configured to restart their hosted VMs on minimal servers. Possible values: ["OFF", "ON", "ONLY_SCALE_OUT"]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/compute_node_group#mode ComputeNodeGroup#mode}


ComputeNodeGroupConfig

Initializer

import { computeNodeGroup } from '@cdktf/provider-google'

const computeNodeGroupConfig: computeNodeGroup.ComputeNodeGroupConfig = { ... }

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.
nodeTemplate string The URL of the node template to which this node group belongs.
autoscalingPolicy ComputeNodeGroupAutoscalingPolicy autoscaling_policy block.
description string An optional textual description of the resource.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/compute_node_group#id ComputeNodeGroup#id}.
initialSize number The initial number of nodes in the node group.
maintenancePolicy string Specifies how to handle instances when a node in the group undergoes maintenance.
maintenanceWindow ComputeNodeGroupMaintenanceWindow maintenance_window block.
name string Name of the resource.
project string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/compute_node_group#project ComputeNodeGroup#project}.
shareSettings ComputeNodeGroupShareSettings share_settings block.
timeouts ComputeNodeGroupTimeouts timeouts block.
zone string Zone where this node group is located.

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[]

nodeTemplateRequired
public readonly nodeTemplate: string;
  • Type: string

The URL of the node template to which this node group belongs.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/compute_node_group#node_template ComputeNodeGroup#node_template}


autoscalingPolicyOptional
public readonly autoscalingPolicy: ComputeNodeGroupAutoscalingPolicy;

autoscaling_policy block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/compute_node_group#autoscaling_policy ComputeNodeGroup#autoscaling_policy}


descriptionOptional
public readonly description: string;
  • Type: string

An optional textual description of the resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/compute_node_group#description ComputeNodeGroup#description}


idOptional
public readonly id: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/compute_node_group#id ComputeNodeGroup#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.


initialSizeOptional
public readonly initialSize: number;
  • Type: number

The initial number of nodes in the node group.

One of 'initial_size' or 'autoscaling_policy' must be configured on resource creation.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/compute_node_group#initial_size ComputeNodeGroup#initial_size}


maintenancePolicyOptional
public readonly maintenancePolicy: string;
  • Type: string

Specifies how to handle instances when a node in the group undergoes maintenance.

Set to one of: DEFAULT, RESTART_IN_PLACE, or MIGRATE_WITHIN_NODE_GROUP. The default value is DEFAULT.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/compute_node_group#maintenance_policy ComputeNodeGroup#maintenance_policy}


maintenanceWindowOptional
public readonly maintenanceWindow: ComputeNodeGroupMaintenanceWindow;

maintenance_window block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/compute_node_group#maintenance_window ComputeNodeGroup#maintenance_window}


nameOptional
public readonly name: string;
  • Type: string

Name of the resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/compute_node_group#name ComputeNodeGroup#name}


projectOptional
public readonly project: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/compute_node_group#project ComputeNodeGroup#project}.


shareSettingsOptional
public readonly shareSettings: ComputeNodeGroupShareSettings;

share_settings block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/compute_node_group#share_settings ComputeNodeGroup#share_settings}


timeoutsOptional
public readonly timeouts: ComputeNodeGroupTimeouts;

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/compute_node_group#timeouts ComputeNodeGroup#timeouts}


zoneOptional
public readonly zone: string;
  • Type: string

Zone where this node group is located.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/compute_node_group#zone ComputeNodeGroup#zone}


ComputeNodeGroupMaintenanceWindow

Initializer

import { computeNodeGroup } from '@cdktf/provider-google'

const computeNodeGroupMaintenanceWindow: computeNodeGroup.ComputeNodeGroupMaintenanceWindow = { ... }

Properties

Name Type Description
startTime string instances.start time of the window. This must be in UTC format that resolves to one of 00:00, 04:00, 08:00, 12:00, 16:00, or 20:00. For example, both 13:00-5 and 08:00 are valid.

startTimeRequired
public readonly startTime: string;
  • Type: string

instances.start time of the window. This must be in UTC format that resolves to one of 00:00, 04:00, 08:00, 12:00, 16:00, or 20:00. For example, both 13:00-5 and 08:00 are valid.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/compute_node_group#start_time ComputeNodeGroup#start_time}


ComputeNodeGroupShareSettings

Initializer

import { computeNodeGroup } from '@cdktf/provider-google'

const computeNodeGroupShareSettings: computeNodeGroup.ComputeNodeGroupShareSettings = { ... }

Properties

Name Type Description
shareType string Node group sharing type. Possible values: ["ORGANIZATION", "SPECIFIC_PROJECTS", "LOCAL"].
projectMap cdktf.IResolvable | ComputeNodeGroupShareSettingsProjectMap[] project_map block.

shareTypeRequired
public readonly shareType: string;
  • Type: string

Node group sharing type. Possible values: ["ORGANIZATION", "SPECIFIC_PROJECTS", "LOCAL"].

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/compute_node_group#share_type ComputeNodeGroup#share_type}


projectMapOptional
public readonly projectMap: IResolvable | ComputeNodeGroupShareSettingsProjectMap[];

project_map block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/compute_node_group#project_map ComputeNodeGroup#project_map}


ComputeNodeGroupShareSettingsProjectMap

Initializer

import { computeNodeGroup } from '@cdktf/provider-google'

const computeNodeGroupShareSettingsProjectMap: computeNodeGroup.ComputeNodeGroupShareSettingsProjectMap = { ... }

Properties

Name Type Description
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/compute_node_group#id ComputeNodeGroup#id}.
projectId string The project id/number should be the same as the key of this project config in the project map.

idRequired
public readonly id: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/compute_node_group#id ComputeNodeGroup#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.


projectIdRequired
public readonly projectId: string;
  • Type: string

The project id/number should be the same as the key of this project config in the project map.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/compute_node_group#project_id ComputeNodeGroup#project_id}


ComputeNodeGroupTimeouts

Initializer

import { computeNodeGroup } from '@cdktf/provider-google'

const computeNodeGroupTimeouts: computeNodeGroup.ComputeNodeGroupTimeouts = { ... }

Properties

Name Type Description
create string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/compute_node_group#create ComputeNodeGroup#create}.
delete string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/compute_node_group#delete ComputeNodeGroup#delete}.
update string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/compute_node_group#update ComputeNodeGroup#update}.

createOptional
public readonly create: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/compute_node_group#create ComputeNodeGroup#create}.


deleteOptional
public readonly delete: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/compute_node_group#delete ComputeNodeGroup#delete}.


updateOptional
public readonly update: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/compute_node_group#update ComputeNodeGroup#update}.


Classes

ComputeNodeGroupAutoscalingPolicyOutputReference

Initializers

import { computeNodeGroup } from '@cdktf/provider-google'

new computeNodeGroup.ComputeNodeGroupAutoscalingPolicyOutputReference(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.
resetMaxNodes No description.
resetMinNodes No description.
resetMode 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.

resetMaxNodes
public resetMaxNodes(): void
resetMinNodes
public resetMinNodes(): void
resetMode
public resetMode(): 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.
maxNodesInput number No description.
minNodesInput number No description.
modeInput string No description.
maxNodes number No description.
minNodes number No description.
mode string No description.
internalValue ComputeNodeGroupAutoscalingPolicy 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

maxNodesInputOptional
public readonly maxNodesInput: number;
  • Type: number

minNodesInputOptional
public readonly minNodesInput: number;
  • Type: number

modeInputOptional
public readonly modeInput: string;
  • Type: string

maxNodesRequired
public readonly maxNodes: number;
  • Type: number

minNodesRequired
public readonly minNodes: number;
  • Type: number

modeRequired
public readonly mode: string;
  • Type: string

internalValueOptional
public readonly internalValue: ComputeNodeGroupAutoscalingPolicy;

ComputeNodeGroupMaintenanceWindowOutputReference

Initializers

import { computeNodeGroup } from '@cdktf/provider-google'

new computeNodeGroup.ComputeNodeGroupMaintenanceWindowOutputReference(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.

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.

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.
startTimeInput string No description.
startTime string No description.
internalValue ComputeNodeGroupMaintenanceWindow 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

startTimeInputOptional
public readonly startTimeInput: string;
  • Type: string

startTimeRequired
public readonly startTime: string;
  • Type: string

internalValueOptional
public readonly internalValue: ComputeNodeGroupMaintenanceWindow;

ComputeNodeGroupShareSettingsOutputReference

Initializers

import { computeNodeGroup } from '@cdktf/provider-google'

new computeNodeGroup.ComputeNodeGroupShareSettingsOutputReference(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.
putProjectMap No description.
resetProjectMap 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.

putProjectMap
public putProjectMap(value: IResolvable | ComputeNodeGroupShareSettingsProjectMap[]): void
valueRequired

resetProjectMap
public resetProjectMap(): 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.
projectMap ComputeNodeGroupShareSettingsProjectMapList No description.
projectMapInput cdktf.IResolvable | ComputeNodeGroupShareSettingsProjectMap[] No description.
shareTypeInput string No description.
shareType string No description.
internalValue ComputeNodeGroupShareSettings 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

projectMapRequired
public readonly projectMap: ComputeNodeGroupShareSettingsProjectMapList;

projectMapInputOptional
public readonly projectMapInput: IResolvable | ComputeNodeGroupShareSettingsProjectMap[];

shareTypeInputOptional
public readonly shareTypeInput: string;
  • Type: string

shareTypeRequired
public readonly shareType: string;
  • Type: string

internalValueOptional
public readonly internalValue: ComputeNodeGroupShareSettings;

ComputeNodeGroupShareSettingsProjectMapList

Initializers

import { computeNodeGroup } from '@cdktf/provider-google'

new computeNodeGroup.ComputeNodeGroupShareSettingsProjectMapList(terraformResource: IInterpolatingParent, terraformAttribute: string, wrapsSet: boolean)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.
wrapsSet boolean whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.


wrapsSetRequired
  • Type: boolean

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
public allWithMapKey(mapKeyAttributeName: string): DynamicListTerraformIterator

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
public computeFqn(): 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.

get
public get(index: number): ComputeNodeGroupShareSettingsProjectMapOutputReference
indexRequired
  • Type: number

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 cdktf.IResolvable | ComputeNodeGroupShareSettingsProjectMap[] 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

internalValueOptional
public readonly internalValue: IResolvable | ComputeNodeGroupShareSettingsProjectMap[];

ComputeNodeGroupShareSettingsProjectMapOutputReference

Initializers

import { computeNodeGroup } from '@cdktf/provider-google'

new computeNodeGroup.ComputeNodeGroupShareSettingsProjectMapOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string, complexObjectIndex: number, complexObjectIsFromSet: boolean)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.
complexObjectIndex number the index of this item in the list.
complexObjectIsFromSet boolean whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.


complexObjectIndexRequired
  • Type: number

the index of this item in the list.


complexObjectIsFromSetRequired
  • Type: boolean

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.

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.

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.
idInput string No description.
projectIdInput string No description.
id string No description.
projectId string No description.
internalValue cdktf.IResolvable | ComputeNodeGroupShareSettingsProjectMap 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

idInputOptional
public readonly idInput: string;
  • Type: string

projectIdInputOptional
public readonly projectIdInput: string;
  • Type: string

idRequired
public readonly id: string;
  • Type: string

projectIdRequired
public readonly projectId: string;
  • Type: string

internalValueOptional
public readonly internalValue: IResolvable | ComputeNodeGroupShareSettingsProjectMap;

ComputeNodeGroupTimeoutsOutputReference

Initializers

import { computeNodeGroup } from '@cdktf/provider-google'

new computeNodeGroup.ComputeNodeGroupTimeoutsOutputReference(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.
resetCreate No description.
resetDelete No description.
resetUpdate 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.

resetCreate
public resetCreate(): void
resetDelete
public resetDelete(): void
resetUpdate
public resetUpdate(): 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.
deleteInput string No description.
updateInput string No description.
create string No description.
delete string No description.
update string No description.
internalValue cdktf.IResolvable | ComputeNodeGroupTimeouts 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

createInputOptional
public readonly createInput: string;
  • Type: string

deleteInputOptional
public readonly deleteInput: string;
  • Type: string

updateInputOptional
public readonly updateInput: string;
  • Type: string

createRequired
public readonly create: string;
  • Type: string

deleteRequired
public readonly delete: string;
  • Type: string

updateRequired
public readonly update: string;
  • Type: string

internalValueOptional
public readonly internalValue: IResolvable | ComputeNodeGroupTimeouts;