Skip to content

Latest commit

 

History

History
2115 lines (1317 loc) · 108 KB

File metadata and controls

2115 lines (1317 loc) · 108 KB

googleNetworkConnectivityTransport Submodule

Constructs

GoogleNetworkConnectivityTransport

Represents a {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.40.0/docs/resources/google_network_connectivity_transport google_network_connectivity_transport}.

Initializers

import { googleNetworkConnectivityTransport } from '@cdktn/provider-google-beta'

new googleNetworkConnectivityTransport.GoogleNetworkConnectivityTransport(scope: Construct, id: string, config: GoogleNetworkConnectivityTransportConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config GoogleNetworkConnectivityTransportConfig 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.
with Applies one or more mixins to 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.
resetAdminEnabled No description.
resetAdvertisedRoutes No description.
resetAutoAccept No description.
resetBandwidth No description.
resetDeletionPolicy No description.
resetDescription No description.
resetHub No description.
resetId No description.
resetLabels No description.
resetMtuLimit No description.
resetProject No description.
resetProvidedActivationKey No description.
resetPscRoutingEnabled No description.
resetRemoteAccountId No description.
resetStackType No description.
resetTimeouts No description.

toString
public toString(): string

Returns a string representation of this construct.

with
public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixinsRequired
  • Type: ...constructs.IMixin[]

The mixins to apply.


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: cdktn.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: GoogleNetworkConnectivityTransportTimeouts): void
valueRequired

resetAdminEnabled
public resetAdminEnabled(): void
resetAdvertisedRoutes
public resetAdvertisedRoutes(): void
resetAutoAccept
public resetAutoAccept(): void
resetBandwidth
public resetBandwidth(): void
resetDeletionPolicy
public resetDeletionPolicy(): void
resetDescription
public resetDescription(): void
resetHub
public resetHub(): void
resetId
public resetId(): void
resetLabels
public resetLabels(): void
resetMtuLimit
public resetMtuLimit(): void
resetProject
public resetProject(): void
resetProvidedActivationKey
public resetProvidedActivationKey(): void
resetPscRoutingEnabled
public resetPscRoutingEnabled(): void
resetRemoteAccountId
public resetRemoteAccountId(): void
resetStackType
public resetStackType(): void
resetTimeouts
public resetTimeouts(): void

Static Functions

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

isConstruct
import { googleNetworkConnectivityTransport } from '@cdktn/provider-google-beta'

googleNetworkConnectivityTransport.GoogleNetworkConnectivityTransport.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 { googleNetworkConnectivityTransport } from '@cdktn/provider-google-beta'

googleNetworkConnectivityTransport.GoogleNetworkConnectivityTransport.isTerraformElement(x: any)
xRequired
  • Type: any

isTerraformResource
import { googleNetworkConnectivityTransport } from '@cdktn/provider-google-beta'

googleNetworkConnectivityTransport.GoogleNetworkConnectivityTransport.isTerraformResource(x: any)
xRequired
  • Type: any

generateConfigForImport
import { googleNetworkConnectivityTransport } from '@cdktn/provider-google-beta'

googleNetworkConnectivityTransport.GoogleNetworkConnectivityTransport.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

Generates CDKTN code for importing a GoogleNetworkConnectivityTransport resource upon running "cdktn 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 GoogleNetworkConnectivityTransport to import.


importFromIdRequired
  • Type: string

The id of the existing GoogleNetworkConnectivityTransport that should be imported.

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


providerOptional
  • Type: cdktn.TerraformProvider

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


Properties

Name Type Description
node constructs.Node The tree node.
cdktfStack cdktn.TerraformStack No description.
fqn string No description.
friendlyUniqueId string No description.
terraformMetaArguments {[ key: string ]: any} No description.
terraformResourceType string No description.
terraformGeneratorMetadata cdktn.TerraformProviderGeneratorMetadata No description.
connection cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection No description.
count number | cdktn.TerraformCount No description.
dependsOn string[] No description.
forEach cdktn.ITerraformIterator No description.
lifecycle cdktn.TerraformResourceLifecycle No description.
provider cdktn.TerraformProvider No description.
provisioners cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner[] No description.
effectiveLabels cdktn.StringMap No description.
generatedActivationKey string No description.
peeringNetwork string No description.
state string No description.
terraformLabels cdktn.StringMap No description.
timeouts GoogleNetworkConnectivityTransportTimeoutsOutputReference No description.
adminEnabledInput boolean | cdktn.IResolvable No description.
advertisedRoutesInput string[] No description.
autoAcceptInput boolean | cdktn.IResolvable No description.
bandwidthInput string No description.
deletionPolicyInput string No description.
descriptionInput string No description.
hubInput string No description.
idInput string No description.
labelsInput {[ key: string ]: string} No description.
mtuLimitInput number No description.
nameInput string No description.
networkInput string No description.
projectInput string No description.
providedActivationKeyInput string No description.
pscRoutingEnabledInput boolean | cdktn.IResolvable No description.
regionInput string No description.
remoteAccountIdInput string No description.
remoteProfileInput string No description.
stackTypeInput string No description.
timeoutsInput cdktn.IResolvable | GoogleNetworkConnectivityTransportTimeouts No description.
adminEnabled boolean | cdktn.IResolvable No description.
advertisedRoutes string[] No description.
autoAccept boolean | cdktn.IResolvable No description.
bandwidth string No description.
deletionPolicy string No description.
description string No description.
hub string No description.
id string No description.
labels {[ key: string ]: string} No description.
mtuLimit number No description.
name string No description.
network string No description.
project string No description.
providedActivationKey string No description.
pscRoutingEnabled boolean | cdktn.IResolvable No description.
region string No description.
remoteAccountId string No description.
remoteProfile string No description.
stackType string No description.

nodeRequired
public readonly node: Node;
  • Type: constructs.Node

The tree node.


cdktfStackRequired
public readonly cdktfStack: TerraformStack;
  • Type: cdktn.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: cdktn.TerraformProviderGeneratorMetadata

connectionOptional
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection

countOptional
public readonly count: number | TerraformCount;
  • Type: number | cdktn.TerraformCount

dependsOnOptional
public readonly dependsOn: string[];
  • Type: string[]

forEachOptional
public readonly forEach: ITerraformIterator;
  • Type: cdktn.ITerraformIterator

lifecycleOptional
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktn.TerraformResourceLifecycle

providerOptional
public readonly provider: TerraformProvider;
  • Type: cdktn.TerraformProvider

provisionersOptional
public readonly provisioners: (FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner)[];
  • Type: cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner[]

effectiveLabelsRequired
public readonly effectiveLabels: StringMap;
  • Type: cdktn.StringMap

generatedActivationKeyRequired
public readonly generatedActivationKey: string;
  • Type: string

peeringNetworkRequired
public readonly peeringNetwork: string;
  • Type: string

stateRequired
public readonly state: string;
  • Type: string

terraformLabelsRequired
public readonly terraformLabels: StringMap;
  • Type: cdktn.StringMap

timeoutsRequired
public readonly timeouts: GoogleNetworkConnectivityTransportTimeoutsOutputReference;

adminEnabledInputOptional
public readonly adminEnabledInput: boolean | IResolvable;
  • Type: boolean | cdktn.IResolvable

advertisedRoutesInputOptional
public readonly advertisedRoutesInput: string[];
  • Type: string[]

autoAcceptInputOptional
public readonly autoAcceptInput: boolean | IResolvable;
  • Type: boolean | cdktn.IResolvable

bandwidthInputOptional
public readonly bandwidthInput: string;
  • Type: string

deletionPolicyInputOptional
public readonly deletionPolicyInput: string;
  • Type: string

descriptionInputOptional
public readonly descriptionInput: string;
  • Type: string

hubInputOptional
public readonly hubInput: string;
  • Type: string

idInputOptional
public readonly idInput: string;
  • Type: string

labelsInputOptional
public readonly labelsInput: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

mtuLimitInputOptional
public readonly mtuLimitInput: number;
  • Type: number

nameInputOptional
public readonly nameInput: string;
  • Type: string

networkInputOptional
public readonly networkInput: string;
  • Type: string

projectInputOptional
public readonly projectInput: string;
  • Type: string

providedActivationKeyInputOptional
public readonly providedActivationKeyInput: string;
  • Type: string

pscRoutingEnabledInputOptional
public readonly pscRoutingEnabledInput: boolean | IResolvable;
  • Type: boolean | cdktn.IResolvable

regionInputOptional
public readonly regionInput: string;
  • Type: string

remoteAccountIdInputOptional
public readonly remoteAccountIdInput: string;
  • Type: string

remoteProfileInputOptional
public readonly remoteProfileInput: string;
  • Type: string

stackTypeInputOptional
public readonly stackTypeInput: string;
  • Type: string

timeoutsInputOptional
public readonly timeoutsInput: IResolvable | GoogleNetworkConnectivityTransportTimeouts;

adminEnabledRequired
public readonly adminEnabled: boolean | IResolvable;
  • Type: boolean | cdktn.IResolvable

advertisedRoutesRequired
public readonly advertisedRoutes: string[];
  • Type: string[]

autoAcceptRequired
public readonly autoAccept: boolean | IResolvable;
  • Type: boolean | cdktn.IResolvable

bandwidthRequired
public readonly bandwidth: string;
  • Type: string

deletionPolicyRequired
public readonly deletionPolicy: string;
  • Type: string

descriptionRequired
public readonly description: string;
  • Type: string

hubRequired
public readonly hub: string;
  • Type: string

idRequired
public readonly id: string;
  • Type: string

labelsRequired
public readonly labels: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

mtuLimitRequired
public readonly mtuLimit: number;
  • Type: number

nameRequired
public readonly name: string;
  • Type: string

networkRequired
public readonly network: string;
  • Type: string

projectRequired
public readonly project: string;
  • Type: string

providedActivationKeyRequired
public readonly providedActivationKey: string;
  • Type: string

pscRoutingEnabledRequired
public readonly pscRoutingEnabled: boolean | IResolvable;
  • Type: boolean | cdktn.IResolvable

regionRequired
public readonly region: string;
  • Type: string

remoteAccountIdRequired
public readonly remoteAccountId: string;
  • Type: string

remoteProfileRequired
public readonly remoteProfile: string;
  • Type: string

stackTypeRequired
public readonly stackType: string;
  • Type: string

Constants

Name Type Description
tfResourceType string No description.

tfResourceTypeRequired
public readonly tfResourceType: string;
  • Type: string

Structs

GoogleNetworkConnectivityTransportConfig

Initializer

import { googleNetworkConnectivityTransport } from '@cdktn/provider-google-beta'

const googleNetworkConnectivityTransportConfig: googleNetworkConnectivityTransport.GoogleNetworkConnectivityTransportConfig = { ... }

Properties

Name Type Description
connection cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection No description.
count number | cdktn.TerraformCount No description.
dependsOn cdktn.ITerraformDependable[] No description.
forEach cdktn.ITerraformIterator No description.
lifecycle cdktn.TerraformResourceLifecycle No description.
provider cdktn.TerraformProvider No description.
provisioners cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner[] No description.
name string Name of the resource, see google.aip.dev/122 for resource naming.
network string Resource URL of the Network that will be peered with this Transport.
region string The region of this resource.
remoteProfile string Resource URL of the remoteTransportProfile that this Transport is connecting to.
adminEnabled boolean | cdktn.IResolvable Administrative state of the underlying connectivity.
advertisedRoutes string[] List of IP Prefixes that will be advertised to the remote provider. Both IPv4 and IPv6 addresses are supported.
autoAccept boolean | cdktn.IResolvable Controls whether resources proposed by the Transport are automatically accepted on behalf of the user.
bandwidth string Bandwidth of the Transport. This must be one of the supported bandwidths for the remote profile.
deletionPolicy string Whether Terraform will be prevented from destroying the instance.
description string An optional description of this resource.
hub string The NCC Hub that the Transport should attach to.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.40.0/docs/resources/google_network_connectivity_transport#id GoogleNetworkConnectivityTransport#id}.
labels {[ key: string ]: string} Optional labels in key:value format. For more information about labels, see Requirements for labels.
mtuLimit number [Output only] The maximum transmission unit (MTU) of a packet that can be sent over this transport.
project string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.40.0/docs/resources/google_network_connectivity_transport#project GoogleNetworkConnectivityTransport#project}.
providedActivationKey string Key used for establishing a connection with the remote transport.
pscRoutingEnabled boolean | cdktn.IResolvable Controls whether a Routing VPC Spoke should be created and attached to the NCC Hub.
remoteAccountId string The user supplied account id for the CSP associated with the remote profile.
stackType string IP version stack for the established connectivity. Possible values: ["IPV4_IPV6", "IPV4_ONLY"].
timeouts GoogleNetworkConnectivityTransportTimeouts timeouts block.

connectionOptional
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection

countOptional
public readonly count: number | TerraformCount;
  • Type: number | cdktn.TerraformCount

dependsOnOptional
public readonly dependsOn: ITerraformDependable[];
  • Type: cdktn.ITerraformDependable[]

forEachOptional
public readonly forEach: ITerraformIterator;
  • Type: cdktn.ITerraformIterator

lifecycleOptional
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktn.TerraformResourceLifecycle

providerOptional
public readonly provider: TerraformProvider;
  • Type: cdktn.TerraformProvider

provisionersOptional
public readonly provisioners: (FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner)[];
  • Type: cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner[]

nameRequired
public readonly name: string;
  • Type: string

Name of the resource, see google.aip.dev/122 for resource naming.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.40.0/docs/resources/google_network_connectivity_transport#name GoogleNetworkConnectivityTransport#name}


networkRequired
public readonly network: string;
  • Type: string

Resource URL of the Network that will be peered with this Transport.

This field must be provided during resource creation and cannot be changed.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.40.0/docs/resources/google_network_connectivity_transport#network GoogleNetworkConnectivityTransport#network}


regionRequired
public readonly region: string;
  • Type: string

The region of this resource.

This is required to construct the resource name, but is not sent to the API since the region is already contained in the parent field.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.40.0/docs/resources/google_network_connectivity_transport#region GoogleNetworkConnectivityTransport#region}


remoteProfileRequired
public readonly remoteProfile: string;
  • Type: string

Resource URL of the remoteTransportProfile that this Transport is connecting to.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.40.0/docs/resources/google_network_connectivity_transport#remote_profile GoogleNetworkConnectivityTransport#remote_profile}


adminEnabledOptional
public readonly adminEnabled: boolean | IResolvable;
  • Type: boolean | cdktn.IResolvable

Administrative state of the underlying connectivity.

If set to true (default), connectivity should be available between your environments. If set to false, the connectivity over these links is disabled. Disabling your Transport does not affect billing, and retains the underlying network bandwidth associated with the connectivity.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.40.0/docs/resources/google_network_connectivity_transport#admin_enabled GoogleNetworkConnectivityTransport#admin_enabled}


advertisedRoutesOptional
public readonly advertisedRoutes: string[];
  • Type: string[]

List of IP Prefixes that will be advertised to the remote provider. Both IPv4 and IPv6 addresses are supported.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.40.0/docs/resources/google_network_connectivity_transport#advertised_routes GoogleNetworkConnectivityTransport#advertised_routes}


autoAcceptOptional
public readonly autoAccept: boolean | IResolvable;
  • Type: boolean | cdktn.IResolvable

Controls whether resources proposed by the Transport are automatically accepted on behalf of the user.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.40.0/docs/resources/google_network_connectivity_transport#auto_accept GoogleNetworkConnectivityTransport#auto_accept}


bandwidthOptional
public readonly bandwidth: string;
  • Type: string

Bandwidth of the Transport. This must be one of the supported bandwidths for the remote profile.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.40.0/docs/resources/google_network_connectivity_transport#bandwidth GoogleNetworkConnectivityTransport#bandwidth}


deletionPolicyOptional
public readonly deletionPolicy: string;
  • Type: string

Whether Terraform will be prevented from destroying the instance.

Defaults to "DELETE". When a 'terraform destroy' or 'terraform apply' would delete the instance, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.40.0/docs/resources/google_network_connectivity_transport#deletion_policy GoogleNetworkConnectivityTransport#deletion_policy}


descriptionOptional
public readonly description: string;
  • Type: string

An optional description of this resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.40.0/docs/resources/google_network_connectivity_transport#description GoogleNetworkConnectivityTransport#description}


hubOptional
public readonly hub: string;
  • Type: string

The NCC Hub that the Transport should attach to.

The hub must be in the same project as the Transport.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.40.0/docs/resources/google_network_connectivity_transport#hub GoogleNetworkConnectivityTransport#hub}


idOptional
public readonly id: string;
  • Type: string

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


labelsOptional
public readonly labels: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

Optional labels in key:value format. For more information about labels, see Requirements for labels.

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.40.0/docs/resources/google_network_connectivity_transport#labels GoogleNetworkConnectivityTransport#labels}


mtuLimitOptional
public readonly mtuLimit: number;
  • Type: number

[Output only] The maximum transmission unit (MTU) of a packet that can be sent over this transport.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.40.0/docs/resources/google_network_connectivity_transport#mtu_limit GoogleNetworkConnectivityTransport#mtu_limit}


projectOptional
public readonly project: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.40.0/docs/resources/google_network_connectivity_transport#project GoogleNetworkConnectivityTransport#project}.


providedActivationKeyOptional
public readonly providedActivationKey: string;
  • Type: string

Key used for establishing a connection with the remote transport.

This key can only be provided if the profile supports an INPUT key flow and the resource is in the PENDING_KEY state.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.40.0/docs/resources/google_network_connectivity_transport#provided_activation_key GoogleNetworkConnectivityTransport#provided_activation_key}


pscRoutingEnabledOptional
public readonly pscRoutingEnabled: boolean | IResolvable;
  • Type: boolean | cdktn.IResolvable

Controls whether a Routing VPC Spoke should be created and attached to the NCC Hub.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.40.0/docs/resources/google_network_connectivity_transport#psc_routing_enabled GoogleNetworkConnectivityTransport#psc_routing_enabled}


remoteAccountIdOptional
public readonly remoteAccountId: string;
  • Type: string

The user supplied account id for the CSP associated with the remote profile.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.40.0/docs/resources/google_network_connectivity_transport#remote_account_id GoogleNetworkConnectivityTransport#remote_account_id}


stackTypeOptional
public readonly stackType: string;
  • Type: string

IP version stack for the established connectivity. Possible values: ["IPV4_IPV6", "IPV4_ONLY"].

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.40.0/docs/resources/google_network_connectivity_transport#stack_type GoogleNetworkConnectivityTransport#stack_type}


timeoutsOptional
public readonly timeouts: GoogleNetworkConnectivityTransportTimeouts;

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.40.0/docs/resources/google_network_connectivity_transport#timeouts GoogleNetworkConnectivityTransport#timeouts}


GoogleNetworkConnectivityTransportTimeouts

Initializer

import { googleNetworkConnectivityTransport } from '@cdktn/provider-google-beta'

const googleNetworkConnectivityTransportTimeouts: googleNetworkConnectivityTransport.GoogleNetworkConnectivityTransportTimeouts = { ... }

Properties

Name Type Description
create string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.40.0/docs/resources/google_network_connectivity_transport#create GoogleNetworkConnectivityTransport#create}.
delete string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.40.0/docs/resources/google_network_connectivity_transport#delete GoogleNetworkConnectivityTransport#delete}.
update string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.40.0/docs/resources/google_network_connectivity_transport#update GoogleNetworkConnectivityTransport#update}.

createOptional
public readonly create: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.40.0/docs/resources/google_network_connectivity_transport#create GoogleNetworkConnectivityTransport#create}.


deleteOptional
public readonly delete: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.40.0/docs/resources/google_network_connectivity_transport#delete GoogleNetworkConnectivityTransport#delete}.


updateOptional
public readonly update: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.40.0/docs/resources/google_network_connectivity_transport#update GoogleNetworkConnectivityTransport#update}.


Classes

GoogleNetworkConnectivityTransportTimeoutsOutputReference

Initializers

import { googleNetworkConnectivityTransport } from '@cdktn/provider-google-beta'

new googleNetworkConnectivityTransport.GoogleNetworkConnectivityTransportTimeoutsOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)
Name Type Description
terraformResource cdktn.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.

terraformResourceRequired
  • Type: cdktn.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: cdktn.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 cdktn.IResolvable | GoogleNetworkConnectivityTransportTimeouts 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 | GoogleNetworkConnectivityTransportTimeouts;