Skip to content

Latest commit

 

History

History
1826 lines (1140 loc) · 73.5 KB

computeRoute.typescript.md

File metadata and controls

1826 lines (1140 loc) · 73.5 KB

computeRoute Submodule

Constructs

ComputeRoute

Represents a {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/compute_route google_compute_route}.

Initializers 

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

new computeRoute.ComputeRoute(scope: Construct, id: string, config: ComputeRouteConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config ComputeRouteConfig 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".
putTimeouts No description.
resetDescription No description.
resetId No description.
resetNextHopGateway No description.
resetNextHopIlb No description.
resetNextHopInstance No description.
resetNextHopInstanceZone No description.
resetNextHopIp No description.
resetNextHopVpnTunnel No description.
resetPriority No description.
resetProject No description.
resetTags 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
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".

putTimeouts 
public putTimeouts(value: ComputeRouteTimeouts): void
valueRequired
resetDescription 
public resetDescription(): void
resetId 
public resetId(): void
resetNextHopGateway 
public resetNextHopGateway(): void
resetNextHopIlb 
public resetNextHopIlb(): void
resetNextHopInstance 
public resetNextHopInstance(): void
resetNextHopInstanceZone 
public resetNextHopInstanceZone(): void
resetNextHopIp 
public resetNextHopIp(): void
resetNextHopVpnTunnel 
public resetNextHopVpnTunnel(): void
resetPriority 
public resetPriority(): void
resetProject 
public resetProject(): void
resetTags 
public resetTags(): 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 ComputeRoute resource upon running "cdktf plan ".
isConstruct 
import { computeRoute } from '@cdktf/provider-google'

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

computeRoute.ComputeRoute.isTerraformElement(x: any)
xRequired
  • Type: any
isTerraformResource 
import { computeRoute } from '@cdktf/provider-google'

computeRoute.ComputeRoute.isTerraformResource(x: any)
xRequired
  • Type: any
generateConfigForImport 
import { computeRoute } from '@cdktf/provider-google'

computeRoute.ComputeRoute.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

importFromIdRequired
  • Type: string

The id of the existing ComputeRoute that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/compute_route#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 ComputeRoute 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.
nextHopNetwork string No description.
selfLink string No description.
timeouts ComputeRouteTimeoutsOutputReference No description.
descriptionInput string No description.
destRangeInput string No description.
idInput string No description.
nameInput string No description.
networkInput string No description.
nextHopGatewayInput string No description.
nextHopIlbInput string No description.
nextHopInstanceInput string No description.
nextHopInstanceZoneInput string No description.
nextHopIpInput string No description.
nextHopVpnTunnelInput string No description.
priorityInput number No description.
projectInput string No description.
tagsInput string[] No description.
timeoutsInput cdktf.IResolvable | ComputeRouteTimeouts No description.
description string No description.
destRange string No description.
id string No description.
name string No description.
network string No description.
nextHopGateway string No description.
nextHopIlb string No description.
nextHopInstance string No description.
nextHopInstanceZone string No description.
nextHopIp string No description.
nextHopVpnTunnel string No description.
priority number No description.
project string No description.
tags 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[]
nextHopNetworkRequired 
public readonly nextHopNetwork: string;
  • Type: string
selfLinkRequired 
public readonly selfLink: string;
  • Type: string
timeoutsRequired 
public readonly timeouts: ComputeRouteTimeoutsOutputReference;
descriptionInputOptional 
public readonly descriptionInput: string;
  • Type: string
destRangeInputOptional 
public readonly destRangeInput: string;
  • Type: string
idInputOptional 
public readonly idInput: string;
  • Type: string
nameInputOptional 
public readonly nameInput: string;
  • Type: string
networkInputOptional 
public readonly networkInput: string;
  • Type: string
nextHopGatewayInputOptional 
public readonly nextHopGatewayInput: string;
  • Type: string
nextHopIlbInputOptional 
public readonly nextHopIlbInput: string;
  • Type: string
nextHopInstanceInputOptional 
public readonly nextHopInstanceInput: string;
  • Type: string
nextHopInstanceZoneInputOptional 
public readonly nextHopInstanceZoneInput: string;
  • Type: string
nextHopIpInputOptional 
public readonly nextHopIpInput: string;
  • Type: string
nextHopVpnTunnelInputOptional 
public readonly nextHopVpnTunnelInput: string;
  • Type: string
priorityInputOptional 
public readonly priorityInput: number;
  • Type: number
projectInputOptional 
public readonly projectInput: string;
  • Type: string
tagsInputOptional 
public readonly tagsInput: string[];
  • Type: string[]
timeoutsInputOptional 
public readonly timeoutsInput: IResolvable | ComputeRouteTimeouts;
descriptionRequired 
public readonly description: string;
  • Type: string
destRangeRequired 
public readonly destRange: string;
  • Type: string
idRequired 
public readonly id: string;
  • Type: string
nameRequired 
public readonly name: string;
  • Type: string
networkRequired 
public readonly network: string;
  • Type: string
nextHopGatewayRequired 
public readonly nextHopGateway: string;
  • Type: string
nextHopIlbRequired 
public readonly nextHopIlb: string;
  • Type: string
nextHopInstanceRequired 
public readonly nextHopInstance: string;
  • Type: string
nextHopInstanceZoneRequired 
public readonly nextHopInstanceZone: string;
  • Type: string
nextHopIpRequired 
public readonly nextHopIp: string;
  • Type: string
nextHopVpnTunnelRequired 
public readonly nextHopVpnTunnel: string;
  • Type: string
priorityRequired 
public readonly priority: number;
  • Type: number
projectRequired 
public readonly project: string;
  • Type: string
tagsRequired 
public readonly tags: string[];
  • Type: string[]

Constants

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

Structs

ComputeRouteConfig

Initializer 

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

const computeRouteConfig: computeRoute.ComputeRouteConfig = { ... }

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.
destRange string The destination range of outgoing packets that this route applies to. Only IPv4 is supported.
name string Name of the resource.
network string The network that this route applies to.
description string An optional description of this resource. Provide this property when you create the resource.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/compute_route#id ComputeRoute#id}.
nextHopGateway string URL to a gateway that should handle matching packets.
nextHopIlb string The IP address or URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets.
nextHopInstance string URL to an instance that should handle matching packets.
nextHopInstanceZone string The zone of the instance specified in next_hop_instance. Omit if next_hop_instance is specified as a URL.
nextHopIp string Network IP address of an instance that should handle matching packets.
nextHopVpnTunnel string URL to a VpnTunnel that should handle matching packets.
priority number The priority of this route.
project string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/compute_route#project ComputeRoute#project}.
tags string[] A list of instance tags to which this route applies.
timeouts ComputeRouteTimeouts 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[]
destRangeRequired 
public readonly destRange: string;
  • Type: string

The destination range of outgoing packets that this route applies to. Only IPv4 is supported.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/compute_route#dest_range ComputeRoute#dest_range}

nameRequired 
public readonly name: string;
  • Type: string

Name of the resource.

Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression 'a-z?' which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/compute_route#name ComputeRoute#name}

networkRequired 
public readonly network: string;
  • Type: string

The network that this route applies to.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/compute_route#network ComputeRoute#network}

descriptionOptional 
public readonly description: string;
  • Type: string

An optional description of this resource. Provide this property when you create the resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/compute_route#description ComputeRoute#description}

idOptional 
public readonly id: string;
  • Type: string

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

nextHopGatewayOptional 
public readonly nextHopGateway: string;
  • Type: string

URL to a gateway that should handle matching packets.

Currently, you can only specify the internet gateway, using a full or partial valid URL:

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/compute_route#next_hop_gateway ComputeRoute#next_hop_gateway}

nextHopIlbOptional 
public readonly nextHopIlb: string;
  • Type: string

The IP address or URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets.

With the GA provider you can only specify the forwarding rule as a partial or full URL. For example, the following are all valid values:

When the beta provider, you can also specify the IP address of a forwarding rule from the same VPC or any peered VPC.

Note that this can only be used when the destinationRange is a public (non-RFC 1918) IP CIDR range.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/compute_route#next_hop_ilb ComputeRoute#next_hop_ilb}

nextHopInstanceOptional 
public readonly nextHopInstance: string;
  • Type: string

URL to an instance that should handle matching packets.

You can specify this as a full or partial URL. For example:

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/compute_route#next_hop_instance ComputeRoute#next_hop_instance}

nextHopInstanceZoneOptional 
public readonly nextHopInstanceZone: string;
  • Type: string

The zone of the instance specified in next_hop_instance. Omit if next_hop_instance is specified as a URL.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/compute_route#next_hop_instance_zone ComputeRoute#next_hop_instance_zone}

nextHopIpOptional 
public readonly nextHopIp: string;
  • Type: string

Network IP address of an instance that should handle matching packets.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/compute_route#next_hop_ip ComputeRoute#next_hop_ip}

nextHopVpnTunnelOptional 
public readonly nextHopVpnTunnel: string;
  • Type: string

URL to a VpnTunnel that should handle matching packets.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/compute_route#next_hop_vpn_tunnel ComputeRoute#next_hop_vpn_tunnel}

priorityOptional 
public readonly priority: number;
  • Type: number

The priority of this route.

Priority is used to break ties in cases where there is more than one matching route of equal prefix length.

In the case of two routes with equal prefix length, the one with the lowest-numbered priority value wins.

Default value is 1000. Valid range is 0 through 65535.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/compute_route#priority ComputeRoute#priority}

projectOptional 
public readonly project: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/compute_route#project ComputeRoute#project}.

tagsOptional 
public readonly tags: string[];
  • Type: string[]

A list of instance tags to which this route applies.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/compute_route#tags ComputeRoute#tags}

timeoutsOptional 
public readonly timeouts: ComputeRouteTimeouts;

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/compute_route#timeouts ComputeRoute#timeouts}

ComputeRouteTimeouts

Initializer 

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

const computeRouteTimeouts: computeRoute.ComputeRouteTimeouts = { ... }

Properties

Name Type Description
create string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/compute_route#create ComputeRoute#create}.
delete string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/compute_route#delete ComputeRoute#delete}.
createOptional 
public readonly create: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/compute_route#create ComputeRoute#create}.

deleteOptional 
public readonly delete: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/compute_route#delete ComputeRoute#delete}.

Classes

ComputeRouteTimeoutsOutputReference

Initializers 

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

new computeRoute.ComputeRouteTimeoutsOutputReference(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.
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

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.
create string No description.
delete string No description.
internalValue cdktf.IResolvable | ComputeRouteTimeouts 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
createRequired 
public readonly create: string;
  • Type: string
deleteRequired 
public readonly delete: string;
  • Type: string
internalValueOptional 
public readonly internalValue: IResolvable | ComputeRouteTimeouts;