Skip to content

Latest commit

 

History

History
2554 lines (1624 loc) · 129 KB

File metadata and controls

2554 lines (1624 loc) · 129 KB

googleNetworkConnectivityTransport Submodule

Constructs

GoogleNetworkConnectivityTransport

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

Initializers

from cdktn_provider_google_beta import google_network_connectivity_transport

googleNetworkConnectivityTransport.GoogleNetworkConnectivityTransport(
  scope: Construct,
  id: str,
  connection: SSHProvisionerConnection | WinrmProvisionerConnection = None,
  count: typing.Union[int, float] | TerraformCount = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner] = None,
  name: str,
  network: str,
  region: str,
  remote_profile: str,
  admin_enabled: bool | IResolvable = None,
  advertised_routes: typing.List[str] = None,
  auto_accept: bool | IResolvable = None,
  bandwidth: str = None,
  deletion_policy: str = None,
  description: str = None,
  hub: str = None,
  id: str = None,
  labels: typing.Mapping[str] = None,
  mtu_limit: typing.Union[int, float] = None,
  project: str = None,
  provided_activation_key: str = None,
  psc_routing_enabled: bool | IResolvable = None,
  remote_account_id: str = None,
  stack_type: str = None,
  timeouts: GoogleNetworkConnectivityTransportTimeouts = None
)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id str The scoped construct ID.
connection cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection No description.
count typing.Union[int, float] | cdktn.TerraformCount No description.
depends_on typing.List[cdktn.ITerraformDependable] No description.
for_each cdktn.ITerraformIterator No description.
lifecycle cdktn.TerraformResourceLifecycle No description.
provider cdktn.TerraformProvider No description.
provisioners typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner] No description.
name str Name of the resource, see google.aip.dev/122 for resource naming.
network str Resource URL of the Network that will be peered with this Transport.
region str The region of this resource.
remote_profile str Resource URL of the remoteTransportProfile that this Transport is connecting to.
admin_enabled bool | cdktn.IResolvable Administrative state of the underlying connectivity.
advertised_routes typing.List[str] List of IP Prefixes that will be advertised to the remote provider. Both IPv4 and IPv6 addresses are supported.
auto_accept bool | cdktn.IResolvable Controls whether resources proposed by the Transport are automatically accepted on behalf of the user.
bandwidth str Bandwidth of the Transport. This must be one of the supported bandwidths for the remote profile.
deletion_policy str Whether Terraform will be prevented from destroying the instance.
description str An optional description of this resource.
hub str The NCC Hub that the Transport should attach to.
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.36.0/docs/resources/google_network_connectivity_transport#id GoogleNetworkConnectivityTransport#id}.
labels typing.Mapping[str] Optional labels in key:value format. For more information about labels, see Requirements for labels.
mtu_limit typing.Union[int, float] [Output only] The maximum transmission unit (MTU) of a packet that can be sent over this transport.
project str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.36.0/docs/resources/google_network_connectivity_transport#project GoogleNetworkConnectivityTransport#project}.
provided_activation_key str Key used for establishing a connection with the remote transport.
psc_routing_enabled bool | cdktn.IResolvable Controls whether a Routing VPC Spoke should be created and attached to the NCC Hub.
remote_account_id str The user supplied account id for the CSP associated with the remote profile.
stack_type str IP version stack for the established connectivity. Possible values: ["IPV4_IPV6", "IPV4_ONLY"].
timeouts GoogleNetworkConnectivityTransportTimeouts timeouts block.

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.


idRequired
  • Type: str

The scoped construct ID.

Must be unique amongst siblings in the same scope


connectionOptional
  • Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection

countOptional
  • Type: typing.Union[int, float] | cdktn.TerraformCount

depends_onOptional
  • Type: typing.List[cdktn.ITerraformDependable]

for_eachOptional
  • Type: cdktn.ITerraformIterator

lifecycleOptional
  • Type: cdktn.TerraformResourceLifecycle

providerOptional
  • Type: cdktn.TerraformProvider

provisionersOptional
  • Type: typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner]

nameRequired
  • Type: str

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.36.0/docs/resources/google_network_connectivity_transport#name GoogleNetworkConnectivityTransport#name}


networkRequired
  • Type: str

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.36.0/docs/resources/google_network_connectivity_transport#network GoogleNetworkConnectivityTransport#network}


regionRequired
  • Type: str

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.36.0/docs/resources/google_network_connectivity_transport#region GoogleNetworkConnectivityTransport#region}


remote_profileRequired
  • Type: str

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.36.0/docs/resources/google_network_connectivity_transport#remote_profile GoogleNetworkConnectivityTransport#remote_profile}


admin_enabledOptional
  • Type: bool | 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.36.0/docs/resources/google_network_connectivity_transport#admin_enabled GoogleNetworkConnectivityTransport#admin_enabled}


advertised_routesOptional
  • Type: typing.List[str]

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.36.0/docs/resources/google_network_connectivity_transport#advertised_routes GoogleNetworkConnectivityTransport#advertised_routes}


auto_acceptOptional
  • Type: bool | 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.36.0/docs/resources/google_network_connectivity_transport#auto_accept GoogleNetworkConnectivityTransport#auto_accept}


bandwidthOptional
  • Type: str

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.36.0/docs/resources/google_network_connectivity_transport#bandwidth GoogleNetworkConnectivityTransport#bandwidth}


deletion_policyOptional
  • Type: str

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.36.0/docs/resources/google_network_connectivity_transport#deletion_policy GoogleNetworkConnectivityTransport#deletion_policy}


descriptionOptional
  • Type: str

An optional description of this resource.

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


hubOptional
  • Type: str

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.36.0/docs/resources/google_network_connectivity_transport#hub GoogleNetworkConnectivityTransport#hub}


idOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.36.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
  • Type: typing.Mapping[str]

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.36.0/docs/resources/google_network_connectivity_transport#labels GoogleNetworkConnectivityTransport#labels}


mtu_limitOptional
  • Type: typing.Union[int, float]

[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.36.0/docs/resources/google_network_connectivity_transport#mtu_limit GoogleNetworkConnectivityTransport#mtu_limit}


projectOptional
  • Type: str

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


provided_activation_keyOptional
  • Type: str

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.36.0/docs/resources/google_network_connectivity_transport#provided_activation_key GoogleNetworkConnectivityTransport#provided_activation_key}


psc_routing_enabledOptional
  • Type: bool | 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.36.0/docs/resources/google_network_connectivity_transport#psc_routing_enabled GoogleNetworkConnectivityTransport#psc_routing_enabled}


remote_account_idOptional
  • Type: str

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.36.0/docs/resources/google_network_connectivity_transport#remote_account_id GoogleNetworkConnectivityTransport#remote_account_id}


stack_typeOptional
  • Type: str

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.36.0/docs/resources/google_network_connectivity_transport#stack_type GoogleNetworkConnectivityTransport#stack_type}


timeoutsOptional

timeouts block.

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


Methods

Name Description
to_string Returns a string representation of this construct.
with Applies one or more mixins to this construct.
add_override No description.
override_logical_id Overrides the auto-generated logical ID with a specific ID.
reset_override_logical_id Resets a previously passed logical Id to use the auto-generated logical id again.
to_hcl_terraform No description.
to_metadata No description.
to_terraform Adds this resource to the terraform JSON output.
add_move_target Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
has_resource_move No description.
import_from No description.
interpolation_for_attribute No description.
move_from_id Move the resource corresponding to "id" to this resource.
move_to Moves this resource to the target resource given by moveTarget.
move_to_id Moves this resource to the resource corresponding to "id".
put_timeouts No description.
reset_admin_enabled No description.
reset_advertised_routes No description.
reset_auto_accept No description.
reset_bandwidth No description.
reset_deletion_policy No description.
reset_description No description.
reset_hub No description.
reset_id No description.
reset_labels No description.
reset_mtu_limit No description.
reset_project No description.
reset_provided_activation_key No description.
reset_psc_routing_enabled No description.
reset_remote_account_id No description.
reset_stack_type No description.
reset_timeouts No description.

to_string
def to_string() -> str

Returns a string representation of this construct.

with
def 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.


add_override
def add_override(
  path: str,
  value: typing.Any
) -> None
pathRequired
  • Type: str

valueRequired
  • Type: typing.Any

override_logical_id
def override_logical_id(
  new_logical_id: str
) -> None

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

new_logical_idRequired
  • Type: str

The new logical ID to use for this stack element.


reset_override_logical_id
def reset_override_logical_id() -> None

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

to_hcl_terraform
def to_hcl_terraform() -> typing.Any
to_metadata
def to_metadata() -> typing.Any
to_terraform
def to_terraform() -> typing.Any

Adds this resource to the terraform JSON output.

add_move_target
def add_move_target(
  move_target: str
) -> None

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

move_targetRequired
  • Type: str

The string move target that will correspond to this resource.


get_any_map_attribute
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str

get_boolean_attribute
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str

get_boolean_map_attribute
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str

get_list_attribute
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str

get_number_attribute
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str

get_number_list_attribute
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str

get_number_map_attribute
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str

get_string_attribute
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str

get_string_map_attribute
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str

has_resource_move
def has_resource_move() -> TerraformResourceMoveByTarget | TerraformResourceMoveById
import_from
def import_from(
  id: str,
  provider: TerraformProvider = None
) -> None
idRequired
  • Type: str

providerOptional
  • Type: cdktn.TerraformProvider

interpolation_for_attribute
def interpolation_for_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str

move_from_id
def move_from_id(
  id: str
) -> None

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

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


move_to
def move_to(
  move_target: str,
  index: str | typing.Union[int, float] = None
) -> None

Moves this resource to the target resource given by moveTarget.

move_targetRequired
  • Type: str

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


indexOptional
  • Type: str | typing.Union[int, float]

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


move_to_id
def move_to_id(
  id: str
) -> None

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

idRequired
  • Type: str

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


put_timeouts
def put_timeouts(
  create: str = None,
  delete: str = None,
  update: str = None
) -> None
createOptional
  • Type: str

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


deleteOptional
  • Type: str

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


updateOptional
  • Type: str

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


reset_admin_enabled
def reset_admin_enabled() -> None
reset_advertised_routes
def reset_advertised_routes() -> None
reset_auto_accept
def reset_auto_accept() -> None
reset_bandwidth
def reset_bandwidth() -> None
reset_deletion_policy
def reset_deletion_policy() -> None
reset_description
def reset_description() -> None
reset_hub
def reset_hub() -> None
reset_id
def reset_id() -> None
reset_labels
def reset_labels() -> None
reset_mtu_limit
def reset_mtu_limit() -> None
reset_project
def reset_project() -> None
reset_provided_activation_key
def reset_provided_activation_key() -> None
reset_psc_routing_enabled
def reset_psc_routing_enabled() -> None
reset_remote_account_id
def reset_remote_account_id() -> None
reset_stack_type
def reset_stack_type() -> None
reset_timeouts
def reset_timeouts() -> None

Static Functions

Name Description
is_construct Checks if x is a construct.
is_terraform_element No description.
is_terraform_resource No description.
generate_config_for_import Generates CDKTN code for importing a GoogleNetworkConnectivityTransport resource upon running "cdktn plan ".

is_construct
from cdktn_provider_google_beta import google_network_connectivity_transport

googleNetworkConnectivityTransport.GoogleNetworkConnectivityTransport.is_construct(
  x: typing.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: typing.Any

Any object.


is_terraform_element
from cdktn_provider_google_beta import google_network_connectivity_transport

googleNetworkConnectivityTransport.GoogleNetworkConnectivityTransport.is_terraform_element(
  x: typing.Any
)
xRequired
  • Type: typing.Any

is_terraform_resource
from cdktn_provider_google_beta import google_network_connectivity_transport

googleNetworkConnectivityTransport.GoogleNetworkConnectivityTransport.is_terraform_resource(
  x: typing.Any
)
xRequired
  • Type: typing.Any

generate_config_for_import
from cdktn_provider_google_beta import google_network_connectivity_transport

googleNetworkConnectivityTransport.GoogleNetworkConnectivityTransport.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

Generates CDKTN code for importing a GoogleNetworkConnectivityTransport resource upon running "cdktn plan ".

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.


import_to_idRequired
  • Type: str

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


import_from_idRequired
  • Type: str

The id of the existing GoogleNetworkConnectivityTransport that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.36.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.
cdktf_stack cdktn.TerraformStack No description.
fqn str No description.
friendly_unique_id str No description.
terraform_meta_arguments typing.Mapping[typing.Any] No description.
terraform_resource_type str No description.
terraform_generator_metadata cdktn.TerraformProviderGeneratorMetadata No description.
connection cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection No description.
count typing.Union[int, float] | cdktn.TerraformCount No description.
depends_on typing.List[str] No description.
for_each cdktn.ITerraformIterator No description.
lifecycle cdktn.TerraformResourceLifecycle No description.
provider cdktn.TerraformProvider No description.
provisioners typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner] No description.
effective_labels cdktn.StringMap No description.
generated_activation_key str No description.
peering_network str No description.
state str No description.
terraform_labels cdktn.StringMap No description.
timeouts GoogleNetworkConnectivityTransportTimeoutsOutputReference No description.
admin_enabled_input bool | cdktn.IResolvable No description.
advertised_routes_input typing.List[str] No description.
auto_accept_input bool | cdktn.IResolvable No description.
bandwidth_input str No description.
deletion_policy_input str No description.
description_input str No description.
hub_input str No description.
id_input str No description.
labels_input typing.Mapping[str] No description.
mtu_limit_input typing.Union[int, float] No description.
name_input str No description.
network_input str No description.
project_input str No description.
provided_activation_key_input str No description.
psc_routing_enabled_input bool | cdktn.IResolvable No description.
region_input str No description.
remote_account_id_input str No description.
remote_profile_input str No description.
stack_type_input str No description.
timeouts_input cdktn.IResolvable | GoogleNetworkConnectivityTransportTimeouts No description.
admin_enabled bool | cdktn.IResolvable No description.
advertised_routes typing.List[str] No description.
auto_accept bool | cdktn.IResolvable No description.
bandwidth str No description.
deletion_policy str No description.
description str No description.
hub str No description.
id str No description.
labels typing.Mapping[str] No description.
mtu_limit typing.Union[int, float] No description.
name str No description.
network str No description.
project str No description.
provided_activation_key str No description.
psc_routing_enabled bool | cdktn.IResolvable No description.
region str No description.
remote_account_id str No description.
remote_profile str No description.
stack_type str No description.

nodeRequired
node: Node
  • Type: constructs.Node

The tree node.


cdktf_stackRequired
cdktf_stack: TerraformStack
  • Type: cdktn.TerraformStack

fqnRequired
fqn: str
  • Type: str

friendly_unique_idRequired
friendly_unique_id: str
  • Type: str

terraform_meta_argumentsRequired
terraform_meta_arguments: typing.Mapping[typing.Any]
  • Type: typing.Mapping[typing.Any]

terraform_resource_typeRequired
terraform_resource_type: str
  • Type: str

terraform_generator_metadataOptional
terraform_generator_metadata: TerraformProviderGeneratorMetadata
  • Type: cdktn.TerraformProviderGeneratorMetadata

connectionOptional
connection: SSHProvisionerConnection | WinrmProvisionerConnection
  • Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection

countOptional
count: typing.Union[int, float] | TerraformCount
  • Type: typing.Union[int, float] | cdktn.TerraformCount

depends_onOptional
depends_on: typing.List[str]
  • Type: typing.List[str]

for_eachOptional
for_each: ITerraformIterator
  • Type: cdktn.ITerraformIterator

lifecycleOptional
lifecycle: TerraformResourceLifecycle
  • Type: cdktn.TerraformResourceLifecycle

providerOptional
provider: TerraformProvider
  • Type: cdktn.TerraformProvider

provisionersOptional
provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner]
  • Type: typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner]

effective_labelsRequired
effective_labels: StringMap
  • Type: cdktn.StringMap

generated_activation_keyRequired
generated_activation_key: str
  • Type: str

peering_networkRequired
peering_network: str
  • Type: str

stateRequired
state: str
  • Type: str

terraform_labelsRequired
terraform_labels: StringMap
  • Type: cdktn.StringMap

timeoutsRequired
timeouts: GoogleNetworkConnectivityTransportTimeoutsOutputReference

admin_enabled_inputOptional
admin_enabled_input: bool | IResolvable
  • Type: bool | cdktn.IResolvable

advertised_routes_inputOptional
advertised_routes_input: typing.List[str]
  • Type: typing.List[str]

auto_accept_inputOptional
auto_accept_input: bool | IResolvable
  • Type: bool | cdktn.IResolvable

bandwidth_inputOptional
bandwidth_input: str
  • Type: str

deletion_policy_inputOptional
deletion_policy_input: str
  • Type: str

description_inputOptional
description_input: str
  • Type: str

hub_inputOptional
hub_input: str
  • Type: str

id_inputOptional
id_input: str
  • Type: str

labels_inputOptional
labels_input: typing.Mapping[str]
  • Type: typing.Mapping[str]

mtu_limit_inputOptional
mtu_limit_input: typing.Union[int, float]
  • Type: typing.Union[int, float]

name_inputOptional
name_input: str
  • Type: str

network_inputOptional
network_input: str
  • Type: str

project_inputOptional
project_input: str
  • Type: str

provided_activation_key_inputOptional
provided_activation_key_input: str
  • Type: str

psc_routing_enabled_inputOptional
psc_routing_enabled_input: bool | IResolvable
  • Type: bool | cdktn.IResolvable

region_inputOptional
region_input: str
  • Type: str

remote_account_id_inputOptional
remote_account_id_input: str
  • Type: str

remote_profile_inputOptional
remote_profile_input: str
  • Type: str

stack_type_inputOptional
stack_type_input: str
  • Type: str

timeouts_inputOptional
timeouts_input: IResolvable | GoogleNetworkConnectivityTransportTimeouts

admin_enabledRequired
admin_enabled: bool | IResolvable
  • Type: bool | cdktn.IResolvable

advertised_routesRequired
advertised_routes: typing.List[str]
  • Type: typing.List[str]

auto_acceptRequired
auto_accept: bool | IResolvable
  • Type: bool | cdktn.IResolvable

bandwidthRequired
bandwidth: str
  • Type: str

deletion_policyRequired
deletion_policy: str
  • Type: str

descriptionRequired
description: str
  • Type: str

hubRequired
hub: str
  • Type: str

idRequired
id: str
  • Type: str

labelsRequired
labels: typing.Mapping[str]
  • Type: typing.Mapping[str]

mtu_limitRequired
mtu_limit: typing.Union[int, float]
  • Type: typing.Union[int, float]

nameRequired
name: str
  • Type: str

networkRequired
network: str
  • Type: str

projectRequired
project: str
  • Type: str

provided_activation_keyRequired
provided_activation_key: str
  • Type: str

psc_routing_enabledRequired
psc_routing_enabled: bool | IResolvable
  • Type: bool | cdktn.IResolvable

regionRequired
region: str
  • Type: str

remote_account_idRequired
remote_account_id: str
  • Type: str

remote_profileRequired
remote_profile: str
  • Type: str

stack_typeRequired
stack_type: str
  • Type: str

Constants

Name Type Description
tfResourceType str No description.

tfResourceTypeRequired
tfResourceType: str
  • Type: str

Structs

GoogleNetworkConnectivityTransportConfig

Initializer

from cdktn_provider_google_beta import google_network_connectivity_transport

googleNetworkConnectivityTransport.GoogleNetworkConnectivityTransportConfig(
  connection: SSHProvisionerConnection | WinrmProvisionerConnection = None,
  count: typing.Union[int, float] | TerraformCount = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner] = None,
  name: str,
  network: str,
  region: str,
  remote_profile: str,
  admin_enabled: bool | IResolvable = None,
  advertised_routes: typing.List[str] = None,
  auto_accept: bool | IResolvable = None,
  bandwidth: str = None,
  deletion_policy: str = None,
  description: str = None,
  hub: str = None,
  id: str = None,
  labels: typing.Mapping[str] = None,
  mtu_limit: typing.Union[int, float] = None,
  project: str = None,
  provided_activation_key: str = None,
  psc_routing_enabled: bool | IResolvable = None,
  remote_account_id: str = None,
  stack_type: str = None,
  timeouts: GoogleNetworkConnectivityTransportTimeouts = None
)

Properties

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

connectionOptional
connection: SSHProvisionerConnection | WinrmProvisionerConnection
  • Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection

countOptional
count: typing.Union[int, float] | TerraformCount
  • Type: typing.Union[int, float] | cdktn.TerraformCount

depends_onOptional
depends_on: typing.List[ITerraformDependable]
  • Type: typing.List[cdktn.ITerraformDependable]

for_eachOptional
for_each: ITerraformIterator
  • Type: cdktn.ITerraformIterator

lifecycleOptional
lifecycle: TerraformResourceLifecycle
  • Type: cdktn.TerraformResourceLifecycle

providerOptional
provider: TerraformProvider
  • Type: cdktn.TerraformProvider

provisionersOptional
provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner]
  • Type: typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner]

nameRequired
name: str
  • Type: str

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.36.0/docs/resources/google_network_connectivity_transport#name GoogleNetworkConnectivityTransport#name}


networkRequired
network: str
  • Type: str

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.36.0/docs/resources/google_network_connectivity_transport#network GoogleNetworkConnectivityTransport#network}


regionRequired
region: str
  • Type: str

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.36.0/docs/resources/google_network_connectivity_transport#region GoogleNetworkConnectivityTransport#region}


remote_profileRequired
remote_profile: str
  • Type: str

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.36.0/docs/resources/google_network_connectivity_transport#remote_profile GoogleNetworkConnectivityTransport#remote_profile}


admin_enabledOptional
admin_enabled: bool | IResolvable
  • Type: bool | 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.36.0/docs/resources/google_network_connectivity_transport#admin_enabled GoogleNetworkConnectivityTransport#admin_enabled}


advertised_routesOptional
advertised_routes: typing.List[str]
  • Type: typing.List[str]

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.36.0/docs/resources/google_network_connectivity_transport#advertised_routes GoogleNetworkConnectivityTransport#advertised_routes}


auto_acceptOptional
auto_accept: bool | IResolvable
  • Type: bool | 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.36.0/docs/resources/google_network_connectivity_transport#auto_accept GoogleNetworkConnectivityTransport#auto_accept}


bandwidthOptional
bandwidth: str
  • Type: str

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.36.0/docs/resources/google_network_connectivity_transport#bandwidth GoogleNetworkConnectivityTransport#bandwidth}


deletion_policyOptional
deletion_policy: str
  • Type: str

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.36.0/docs/resources/google_network_connectivity_transport#deletion_policy GoogleNetworkConnectivityTransport#deletion_policy}


descriptionOptional
description: str
  • Type: str

An optional description of this resource.

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


hubOptional
hub: str
  • Type: str

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.36.0/docs/resources/google_network_connectivity_transport#hub GoogleNetworkConnectivityTransport#hub}


idOptional
id: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.36.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
labels: typing.Mapping[str]
  • Type: typing.Mapping[str]

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.36.0/docs/resources/google_network_connectivity_transport#labels GoogleNetworkConnectivityTransport#labels}


mtu_limitOptional
mtu_limit: typing.Union[int, float]
  • Type: typing.Union[int, float]

[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.36.0/docs/resources/google_network_connectivity_transport#mtu_limit GoogleNetworkConnectivityTransport#mtu_limit}


projectOptional
project: str
  • Type: str

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


provided_activation_keyOptional
provided_activation_key: str
  • Type: str

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.36.0/docs/resources/google_network_connectivity_transport#provided_activation_key GoogleNetworkConnectivityTransport#provided_activation_key}


psc_routing_enabledOptional
psc_routing_enabled: bool | IResolvable
  • Type: bool | 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.36.0/docs/resources/google_network_connectivity_transport#psc_routing_enabled GoogleNetworkConnectivityTransport#psc_routing_enabled}


remote_account_idOptional
remote_account_id: str
  • Type: str

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.36.0/docs/resources/google_network_connectivity_transport#remote_account_id GoogleNetworkConnectivityTransport#remote_account_id}


stack_typeOptional
stack_type: str
  • Type: str

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.36.0/docs/resources/google_network_connectivity_transport#stack_type GoogleNetworkConnectivityTransport#stack_type}


timeoutsOptional
timeouts: GoogleNetworkConnectivityTransportTimeouts

timeouts block.

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


GoogleNetworkConnectivityTransportTimeouts

Initializer

from cdktn_provider_google_beta import google_network_connectivity_transport

googleNetworkConnectivityTransport.GoogleNetworkConnectivityTransportTimeouts(
  create: str = None,
  delete: str = None,
  update: str = None
)

Properties

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

createOptional
create: str
  • Type: str

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


deleteOptional
delete: str
  • Type: str

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


updateOptional
update: str
  • Type: str

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


Classes

GoogleNetworkConnectivityTransportTimeoutsOutputReference

Initializers

from cdktn_provider_google_beta import google_network_connectivity_transport

googleNetworkConnectivityTransport.GoogleNetworkConnectivityTransportTimeoutsOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)
Name Type Description
terraform_resource cdktn.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.

terraform_resourceRequired
  • Type: cdktn.IInterpolatingParent

The parent resource.


terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.


Methods

Name Description
compute_fqn No description.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
interpolation_for_attribute No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
reset_create No description.
reset_delete No description.
reset_update No description.

compute_fqn
def compute_fqn() -> str
get_any_map_attribute
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str

get_boolean_attribute
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str

get_boolean_map_attribute
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str

get_list_attribute
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str

get_number_attribute
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str

get_number_list_attribute
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str

get_number_map_attribute
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str

get_string_attribute
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str

get_string_map_attribute
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str

interpolation_for_attribute
def interpolation_for_attribute(
  property: str
) -> IResolvable
propertyRequired
  • Type: str

resolve
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktn.IResolveContext

to_string
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

reset_create
def reset_create() -> None
reset_delete
def reset_delete() -> None
reset_update
def reset_update() -> None

Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
create_input str No description.
delete_input str No description.
update_input str No description.
create str No description.
delete str No description.
update str No description.
internal_value cdktn.IResolvable | GoogleNetworkConnectivityTransportTimeouts No description.

creation_stackRequired
creation_stack: typing.List[str]
  • Type: typing.List[str]

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
fqn: str
  • Type: str

create_inputOptional
create_input: str
  • Type: str

delete_inputOptional
delete_input: str
  • Type: str

update_inputOptional
update_input: str
  • Type: str

createRequired
create: str
  • Type: str

deleteRequired
delete: str
  • Type: str

updateRequired
update: str
  • Type: str

internal_valueOptional
internal_value: IResolvable | GoogleNetworkConnectivityTransportTimeouts