Skip to content

Latest commit

 

History

History
2139 lines (1346 loc) · 92.4 KB

computeRoute.java.md

File metadata and controls

2139 lines (1346 loc) · 92.4 KB
Raw

computeRoute Submodule

Constructs

ComputeRoute

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

Initializers 

import com.hashicorp.cdktf.providers.google.compute_route.ComputeRoute;

ComputeRoute.Builder.create(Construct scope, java.lang.String id)
//  .connection(SSHProvisionerConnection)
//  .connection(WinrmProvisionerConnection)
//  .count(java.lang.Number)
//  .count(TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner)
//  .provisioners(LocalExecProvisioner)
//  .provisioners(RemoteExecProvisioner>)
    .destRange(java.lang.String)
    .name(java.lang.String)
    .network(java.lang.String)
//  .description(java.lang.String)
//  .id(java.lang.String)
//  .nextHopGateway(java.lang.String)
//  .nextHopIlb(java.lang.String)
//  .nextHopInstance(java.lang.String)
//  .nextHopInstanceZone(java.lang.String)
//  .nextHopIp(java.lang.String)
//  .nextHopVpnTunnel(java.lang.String)
//  .priority(java.lang.Number)
//  .project(java.lang.String)
//  .tags(java.util.List<java.lang.String>)
//  .timeouts(ComputeRouteTimeouts)
    .build();
Name Type Description
scope software.constructs.Construct The scope in which to define this construct.
id java.lang.String The scoped construct ID.
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<com.hashicorp.cdktf.ITerraformDependable> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
destRange java.lang.String The destination range of outgoing packets that this route applies to. Only IPv4 is supported.
name java.lang.String Name of the resource.
network java.lang.String The network that this route applies to.
description java.lang.String An optional description of this resource. Provide this property when you create the resource.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_route#id ComputeRoute#id}.
nextHopGateway java.lang.String URL to a gateway that should handle matching packets.
nextHopIlb java.lang.String The IP address or URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets.
nextHopInstance java.lang.String URL to an instance that should handle matching packets.
nextHopInstanceZone java.lang.String The zone of the instance specified in next_hop_instance. Omit if next_hop_instance is specified as a URL.
nextHopIp java.lang.String Network IP address of an instance that should handle matching packets.
nextHopVpnTunnel java.lang.String URL to a VpnTunnel that should handle matching packets.
priority java.lang.Number The priority of this route.
project java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_route#project ComputeRoute#project}.
tags java.util.List<java.lang.String> A list of instance tags to which this route applies.
timeouts ComputeRouteTimeouts timeouts block.
scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: java.lang.String

The scoped construct ID.

Must be unique amongst siblings in the same scope

connectionOptional
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
dependsOnOptional
  • Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>
forEachOptional
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
destRangeRequired
  • Type: java.lang.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.14.1/docs/resources/compute_route#dest_range ComputeRoute#dest_range}

nameRequired
  • Type: java.lang.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.14.1/docs/resources/compute_route#name ComputeRoute#name}

networkRequired
  • Type: java.lang.String

The network that this route applies to.

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

descriptionOptional
  • Type: java.lang.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.14.1/docs/resources/compute_route#description ComputeRoute#description}

idOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/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
  • Type: java.lang.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.14.1/docs/resources/compute_route#next_hop_gateway ComputeRoute#next_hop_gateway}

nextHopIlbOptional
  • Type: java.lang.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.14.1/docs/resources/compute_route#next_hop_ilb ComputeRoute#next_hop_ilb}

nextHopInstanceOptional
  • Type: java.lang.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.14.1/docs/resources/compute_route#next_hop_instance ComputeRoute#next_hop_instance}

nextHopInstanceZoneOptional
  • Type: java.lang.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.14.1/docs/resources/compute_route#next_hop_instance_zone ComputeRoute#next_hop_instance_zone}

nextHopIpOptional
  • Type: java.lang.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.14.1/docs/resources/compute_route#next_hop_ip ComputeRoute#next_hop_ip}

nextHopVpnTunnelOptional
  • Type: java.lang.String

URL to a VpnTunnel that should handle matching packets.

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

priorityOptional
  • Type: java.lang.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.14.1/docs/resources/compute_route#priority ComputeRoute#priority}

projectOptional
  • Type: java.lang.String

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

tagsOptional
  • Type: java.util.List<java.lang.String>

A list of instance tags to which this route applies.

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

timeoutsOptional

timeouts block.

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

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 java.lang.String toString()

Returns a string representation of this construct.

addOverride 
public void addOverride(java.lang.String path, java.lang.Object value)
pathRequired
  • Type: java.lang.String
valueRequired
  • Type: java.lang.Object
overrideLogicalId 
public void overrideLogicalId(java.lang.String newLogicalId)

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

newLogicalIdRequired
  • Type: java.lang.String

The new logical ID to use for this stack element.

resetOverrideLogicalId 
public void resetOverrideLogicalId()

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

toHclTerraform 
public java.lang.Object toHclTerraform()
toMetadata 
public java.lang.Object toMetadata()
toTerraform 
public java.lang.Object toTerraform()

Adds this resource to the terraform JSON output.

addMoveTarget 
public void addMoveTarget(java.lang.String moveTarget)

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

moveTargetRequired
  • Type: java.lang.String

The string move target that will correspond to this resource.

getAnyMapAttribute 
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanAttribute 
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanMapAttribute 
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getListAttribute 
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberAttribute 
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberListAttribute 
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberMapAttribute 
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringAttribute 
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringMapAttribute 
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
hasResourceMove 
public TerraformResourceMoveByTarget OR TerraformResourceMoveById hasResourceMove()
importFrom 
public void importFrom(java.lang.String id)
public void importFrom(java.lang.String id, TerraformProvider provider)
idRequired
  • Type: java.lang.String
providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider
interpolationForAttribute 
public IResolvable interpolationForAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
moveFromId 
public void moveFromId(java.lang.String id)

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

Note that the resource being moved from must be marked as moved using it's instance function.

idRequired
  • Type: java.lang.String

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

moveTo 
public void moveTo(java.lang.String moveTarget)
public void moveTo(java.lang.String moveTarget, java.lang.String OR java.lang.Number index)

Moves this resource to the target resource given by moveTarget.

moveTargetRequired
  • Type: java.lang.String

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

indexOptional
  • Type: java.lang.String OR java.lang.Number

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

moveToId 
public void moveToId(java.lang.String id)

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

idRequired
  • Type: java.lang.String

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

putTimeouts 
public void putTimeouts(ComputeRouteTimeouts value)
valueRequired
resetDescription 
public void resetDescription()
resetId 
public void resetId()
resetNextHopGateway 
public void resetNextHopGateway()
resetNextHopIlb 
public void resetNextHopIlb()
resetNextHopInstance 
public void resetNextHopInstance()
resetNextHopInstanceZone 
public void resetNextHopInstanceZone()
resetNextHopIp 
public void resetNextHopIp()
resetNextHopVpnTunnel 
public void resetNextHopVpnTunnel()
resetPriority 
public void resetPriority()
resetProject 
public void resetProject()
resetTags 
public void resetTags()
resetTimeouts 
public void resetTimeouts()

Static Functions

Name Description
isConstruct Checks if x is a construct.
isTerraformElement No description.
isTerraformResource No description.
generateConfigForImport Generates CDKTF code for importing a ComputeRoute resource upon running "cdktf plan ".
isConstruct 
import com.hashicorp.cdktf.providers.google.compute_route.ComputeRoute;

ComputeRoute.isConstruct(java.lang.Object x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

xRequired
  • Type: java.lang.Object

Any object.

isTerraformElement 
import com.hashicorp.cdktf.providers.google.compute_route.ComputeRoute;

ComputeRoute.isTerraformElement(java.lang.Object x)
xRequired
  • Type: java.lang.Object
isTerraformResource 
import com.hashicorp.cdktf.providers.google.compute_route.ComputeRoute;

ComputeRoute.isTerraformResource(java.lang.Object x)
xRequired
  • Type: java.lang.Object
generateConfigForImport 
import com.hashicorp.cdktf.providers.google.compute_route.ComputeRoute;

ComputeRoute.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),ComputeRoute.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider)

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

scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.

importToIdRequired
  • Type: java.lang.String

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

importFromIdRequired
  • Type: java.lang.String

The id of the existing ComputeRoute that should be imported.

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

providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider

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

Properties

Name Type Description
node software.constructs.Node The tree node.
cdktfStack com.hashicorp.cdktf.TerraformStack No description.
fqn java.lang.String No description.
friendlyUniqueId java.lang.String No description.
terraformMetaArguments java.util.Map<java.lang.String, java.lang.Object> No description.
terraformResourceType java.lang.String No description.
terraformGeneratorMetadata com.hashicorp.cdktf.TerraformProviderGeneratorMetadata No description.
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<java.lang.String> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
nextHopNetwork java.lang.String No description.
selfLink java.lang.String No description.
timeouts ComputeRouteTimeoutsOutputReference No description.
descriptionInput java.lang.String No description.
destRangeInput java.lang.String No description.
idInput java.lang.String No description.
nameInput java.lang.String No description.
networkInput java.lang.String No description.
nextHopGatewayInput java.lang.String No description.
nextHopIlbInput java.lang.String No description.
nextHopInstanceInput java.lang.String No description.
nextHopInstanceZoneInput java.lang.String No description.
nextHopIpInput java.lang.String No description.
nextHopVpnTunnelInput java.lang.String No description.
priorityInput java.lang.Number No description.
projectInput java.lang.String No description.
tagsInput java.util.List<java.lang.String> No description.
timeoutsInput com.hashicorp.cdktf.IResolvable OR ComputeRouteTimeouts No description.
description java.lang.String No description.
destRange java.lang.String No description.
id java.lang.String No description.
name java.lang.String No description.
network java.lang.String No description.
nextHopGateway java.lang.String No description.
nextHopIlb java.lang.String No description.
nextHopInstance java.lang.String No description.
nextHopInstanceZone java.lang.String No description.
nextHopIp java.lang.String No description.
nextHopVpnTunnel java.lang.String No description.
priority java.lang.Number No description.
project java.lang.String No description.
tags java.util.List<java.lang.String> No description.
nodeRequired 
public Node getNode();
  • Type: software.constructs.Node

The tree node.

cdktfStackRequired 
public TerraformStack getCdktfStack();
  • Type: com.hashicorp.cdktf.TerraformStack
fqnRequired 
public java.lang.String getFqn();
  • Type: java.lang.String
friendlyUniqueIdRequired 
public java.lang.String getFriendlyUniqueId();
  • Type: java.lang.String
terraformMetaArgumentsRequired 
public java.util.Map<java.lang.String, java.lang.Object> getTerraformMetaArguments();
  • Type: java.util.Map<java.lang.String, java.lang.Object>
terraformResourceTypeRequired 
public java.lang.String getTerraformResourceType();
  • Type: java.lang.String
terraformGeneratorMetadataOptional 
public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata();
  • Type: com.hashicorp.cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
public java.lang.Object getConnection();
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional 
public java.lang.Object getCount();
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
dependsOnOptional 
public java.util.List<java.lang.String> getDependsOn();
  • Type: java.util.List<java.lang.String>
forEachOptional 
public ITerraformIterator getForEach();
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional 
public TerraformResourceLifecycle getLifecycle();
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional 
public TerraformProvider getProvider();
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional 
public java.lang.Object getProvisioners();
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
nextHopNetworkRequired 
public java.lang.String getNextHopNetwork();
  • Type: java.lang.String
selfLinkRequired 
public java.lang.String getSelfLink();
  • Type: java.lang.String
timeoutsRequired 
public ComputeRouteTimeoutsOutputReference getTimeouts();
descriptionInputOptional 
public java.lang.String getDescriptionInput();
  • Type: java.lang.String
destRangeInputOptional 
public java.lang.String getDestRangeInput();
  • Type: java.lang.String
idInputOptional 
public java.lang.String getIdInput();
  • Type: java.lang.String
nameInputOptional 
public java.lang.String getNameInput();
  • Type: java.lang.String
networkInputOptional 
public java.lang.String getNetworkInput();
  • Type: java.lang.String
nextHopGatewayInputOptional 
public java.lang.String getNextHopGatewayInput();
  • Type: java.lang.String
nextHopIlbInputOptional 
public java.lang.String getNextHopIlbInput();
  • Type: java.lang.String
nextHopInstanceInputOptional 
public java.lang.String getNextHopInstanceInput();
  • Type: java.lang.String
nextHopInstanceZoneInputOptional 
public java.lang.String getNextHopInstanceZoneInput();
  • Type: java.lang.String
nextHopIpInputOptional 
public java.lang.String getNextHopIpInput();
  • Type: java.lang.String
nextHopVpnTunnelInputOptional 
public java.lang.String getNextHopVpnTunnelInput();
  • Type: java.lang.String
priorityInputOptional 
public java.lang.Number getPriorityInput();
  • Type: java.lang.Number
projectInputOptional 
public java.lang.String getProjectInput();
  • Type: java.lang.String
tagsInputOptional 
public java.util.List<java.lang.String> getTagsInput();
  • Type: java.util.List<java.lang.String>
timeoutsInputOptional 
public java.lang.Object getTimeoutsInput();
descriptionRequired 
public java.lang.String getDescription();
  • Type: java.lang.String
destRangeRequired 
public java.lang.String getDestRange();
  • Type: java.lang.String
idRequired 
public java.lang.String getId();
  • Type: java.lang.String
nameRequired 
public java.lang.String getName();
  • Type: java.lang.String
networkRequired 
public java.lang.String getNetwork();
  • Type: java.lang.String
nextHopGatewayRequired 
public java.lang.String getNextHopGateway();
  • Type: java.lang.String
nextHopIlbRequired 
public java.lang.String getNextHopIlb();
  • Type: java.lang.String
nextHopInstanceRequired 
public java.lang.String getNextHopInstance();
  • Type: java.lang.String
nextHopInstanceZoneRequired 
public java.lang.String getNextHopInstanceZone();
  • Type: java.lang.String
nextHopIpRequired 
public java.lang.String getNextHopIp();
  • Type: java.lang.String
nextHopVpnTunnelRequired 
public java.lang.String getNextHopVpnTunnel();
  • Type: java.lang.String
priorityRequired 
public java.lang.Number getPriority();
  • Type: java.lang.Number
projectRequired 
public java.lang.String getProject();
  • Type: java.lang.String
tagsRequired 
public java.util.List<java.lang.String> getTags();
  • Type: java.util.List<java.lang.String>

Constants

Name Type Description
tfResourceType java.lang.String No description.
tfResourceTypeRequired 
public java.lang.String getTfResourceType();
  • Type: java.lang.String

Structs

ComputeRouteConfig

Initializer 

import com.hashicorp.cdktf.providers.google.compute_route.ComputeRouteConfig;

ComputeRouteConfig.builder()
//  .connection(SSHProvisionerConnection)
//  .connection(WinrmProvisionerConnection)
//  .count(java.lang.Number)
//  .count(TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner)
//  .provisioners(LocalExecProvisioner)
//  .provisioners(RemoteExecProvisioner>)
    .destRange(java.lang.String)
    .name(java.lang.String)
    .network(java.lang.String)
//  .description(java.lang.String)
//  .id(java.lang.String)
//  .nextHopGateway(java.lang.String)
//  .nextHopIlb(java.lang.String)
//  .nextHopInstance(java.lang.String)
//  .nextHopInstanceZone(java.lang.String)
//  .nextHopIp(java.lang.String)
//  .nextHopVpnTunnel(java.lang.String)
//  .priority(java.lang.Number)
//  .project(java.lang.String)
//  .tags(java.util.List<java.lang.String>)
//  .timeouts(ComputeRouteTimeouts)
    .build();

Properties

Name Type Description
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<com.hashicorp.cdktf.ITerraformDependable> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
destRange java.lang.String The destination range of outgoing packets that this route applies to. Only IPv4 is supported.
name java.lang.String Name of the resource.
network java.lang.String The network that this route applies to.
description java.lang.String An optional description of this resource. Provide this property when you create the resource.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_route#id ComputeRoute#id}.
nextHopGateway java.lang.String URL to a gateway that should handle matching packets.
nextHopIlb java.lang.String The IP address or URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets.
nextHopInstance java.lang.String URL to an instance that should handle matching packets.
nextHopInstanceZone java.lang.String The zone of the instance specified in next_hop_instance. Omit if next_hop_instance is specified as a URL.
nextHopIp java.lang.String Network IP address of an instance that should handle matching packets.
nextHopVpnTunnel java.lang.String URL to a VpnTunnel that should handle matching packets.
priority java.lang.Number The priority of this route.
project java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_route#project ComputeRoute#project}.
tags java.util.List<java.lang.String> A list of instance tags to which this route applies.
timeouts ComputeRouteTimeouts timeouts block.
connectionOptional 
public java.lang.Object getConnection();
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional 
public java.lang.Object getCount();
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
dependsOnOptional 
public java.util.List<ITerraformDependable> getDependsOn();
  • Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>
forEachOptional 
public ITerraformIterator getForEach();
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional 
public TerraformResourceLifecycle getLifecycle();
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional 
public TerraformProvider getProvider();
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional 
public java.lang.Object getProvisioners();
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
destRangeRequired 
public java.lang.String getDestRange();
  • Type: java.lang.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.14.1/docs/resources/compute_route#dest_range ComputeRoute#dest_range}

nameRequired 
public java.lang.String getName();
  • Type: java.lang.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.14.1/docs/resources/compute_route#name ComputeRoute#name}

networkRequired 
public java.lang.String getNetwork();
  • Type: java.lang.String

The network that this route applies to.

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

descriptionOptional 
public java.lang.String getDescription();
  • Type: java.lang.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.14.1/docs/resources/compute_route#description ComputeRoute#description}

idOptional 
public java.lang.String getId();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/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 java.lang.String getNextHopGateway();
  • Type: java.lang.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.14.1/docs/resources/compute_route#next_hop_gateway ComputeRoute#next_hop_gateway}

nextHopIlbOptional 
public java.lang.String getNextHopIlb();
  • Type: java.lang.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.14.1/docs/resources/compute_route#next_hop_ilb ComputeRoute#next_hop_ilb}

nextHopInstanceOptional 
public java.lang.String getNextHopInstance();
  • Type: java.lang.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.14.1/docs/resources/compute_route#next_hop_instance ComputeRoute#next_hop_instance}

nextHopInstanceZoneOptional 
public java.lang.String getNextHopInstanceZone();
  • Type: java.lang.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.14.1/docs/resources/compute_route#next_hop_instance_zone ComputeRoute#next_hop_instance_zone}

nextHopIpOptional 
public java.lang.String getNextHopIp();
  • Type: java.lang.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.14.1/docs/resources/compute_route#next_hop_ip ComputeRoute#next_hop_ip}

nextHopVpnTunnelOptional 
public java.lang.String getNextHopVpnTunnel();
  • Type: java.lang.String

URL to a VpnTunnel that should handle matching packets.

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

priorityOptional 
public java.lang.Number getPriority();
  • Type: java.lang.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.14.1/docs/resources/compute_route#priority ComputeRoute#priority}

projectOptional 
public java.lang.String getProject();
  • Type: java.lang.String

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

tagsOptional 
public java.util.List<java.lang.String> getTags();
  • Type: java.util.List<java.lang.String>

A list of instance tags to which this route applies.

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

timeoutsOptional 
public ComputeRouteTimeouts getTimeouts();

timeouts block.

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

ComputeRouteTimeouts

Initializer 

import com.hashicorp.cdktf.providers.google.compute_route.ComputeRouteTimeouts;

ComputeRouteTimeouts.builder()
//  .create(java.lang.String)
//  .delete(java.lang.String)
    .build();

Properties

Name Type Description
create java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_route#create ComputeRoute#create}.
delete java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_route#delete ComputeRoute#delete}.
createOptional 
public java.lang.String getCreate();
  • Type: java.lang.String

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

deleteOptional 
public java.lang.String getDelete();
  • Type: java.lang.String

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

Classes

ComputeRouteTimeoutsOutputReference

Initializers 

import com.hashicorp.cdktf.providers.google.compute_route.ComputeRouteTimeoutsOutputReference;

new ComputeRouteTimeoutsOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute);
Name Type Description
terraformResource com.hashicorp.cdktf.IInterpolatingParent The parent resource.
terraformAttribute java.lang.String The attribute on the parent resource this class is referencing.
terraformResourceRequired
  • Type: com.hashicorp.cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: java.lang.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 java.lang.String computeFqn()
getAnyMapAttribute 
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanAttribute 
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanMapAttribute 
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getListAttribute 
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberAttribute 
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberListAttribute 
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberMapAttribute 
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringAttribute 
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringMapAttribute 
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
interpolationForAttribute 
public IResolvable interpolationForAttribute(java.lang.String property)
propertyRequired
  • Type: java.lang.String
resolve 
public java.lang.Object resolve(IResolveContext _context)

Produce the Token's value at resolution time.

_contextRequired
  • Type: com.hashicorp.cdktf.IResolveContext
toString 
public java.lang.String toString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetCreate 
public void resetCreate()
resetDelete 
public void resetDelete()

Properties

Name Type Description
creationStack java.util.List<java.lang.String> The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn java.lang.String No description.
createInput java.lang.String No description.
deleteInput java.lang.String No description.
create java.lang.String No description.
delete java.lang.String No description.
internalValue com.hashicorp.cdktf.IResolvable OR ComputeRouteTimeouts No description.
creationStackRequired 
public java.util.List<java.lang.String> getCreationStack();
  • Type: java.util.List<java.lang.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 java.lang.String getFqn();
  • Type: java.lang.String
createInputOptional 
public java.lang.String getCreateInput();
  • Type: java.lang.String
deleteInputOptional 
public java.lang.String getDeleteInput();
  • Type: java.lang.String
createRequired 
public java.lang.String getCreate();
  • Type: java.lang.String
deleteRequired 
public java.lang.String getDelete();
  • Type: java.lang.String
internalValueOptional 
public java.lang.Object getInternalValue();