`dataAwsRoute` Submodule

Constructs

DataAwsRoute

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/route aws_route}.

Initializers

from cdktf_cdktf_provider_aws import data_aws_route

dataAwsRoute.DataAwsRoute(
  scope: Construct,
  id: str,
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[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[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  route_table_id: str,
  carrier_gateway_id: str = None,
  core_network_arn: str = None,
  destination_cidr_block: str = None,
  destination_ipv6_cidr_block: str = None,
  destination_prefix_list_id: str = None,
  egress_only_gateway_id: str = None,
  gateway_id: str = None,
  id: str = None,
  instance_id: str = None,
  local_gateway_id: str = None,
  nat_gateway_id: str = None,
  network_interface_id: str = None,
  timeouts: DataAwsRouteTimeouts = None,
  transit_gateway_id: str = None,
  vpc_peering_connection_id: str = None
)

Name	Type	Description
`scope`	`constructs.Construct`	The scope in which to define this construct.
`id`	`str`	The scoped construct ID.
`connection`	`typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]`	No description.
`count`	`typing.Union[typing.Union[int, float], cdktf.TerraformCount]`	No description.
`depends_on`	`typing.List[cdktf.ITerraformDependable]`	No description.
`for_each`	`cdktf.ITerraformIterator`	No description.
`lifecycle`	`cdktf.TerraformResourceLifecycle`	No description.
`provider`	`cdktf.TerraformProvider`	No description.
`provisioners`	`typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]`	No description.
`route_table_id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/route#route_table_id DataAwsRoute#route_table_id}.
`carrier_gateway_id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/route#carrier_gateway_id DataAwsRoute#carrier_gateway_id}.
`core_network_arn`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/route#core_network_arn DataAwsRoute#core_network_arn}.
`destination_cidr_block`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/route#destination_cidr_block DataAwsRoute#destination_cidr_block}.
`destination_ipv6_cidr_block`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/route#destination_ipv6_cidr_block DataAwsRoute#destination_ipv6_cidr_block}.
`destination_prefix_list_id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/route#destination_prefix_list_id DataAwsRoute#destination_prefix_list_id}.
`egress_only_gateway_id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/route#egress_only_gateway_id DataAwsRoute#egress_only_gateway_id}.
`gateway_id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/route#gateway_id DataAwsRoute#gateway_id}.
`id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/route#id DataAwsRoute#id}.
`instance_id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/route#instance_id DataAwsRoute#instance_id}.
`local_gateway_id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/route#local_gateway_id DataAwsRoute#local_gateway_id}.
`nat_gateway_id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/route#nat_gateway_id DataAwsRoute#nat_gateway_id}.
`network_interface_id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/route#network_interface_id DataAwsRoute#network_interface_id}.
`timeouts`	`DataAwsRouteTimeouts`	timeouts block.
`transit_gateway_id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/route#transit_gateway_id DataAwsRoute#transit_gateway_id}.
`vpc_peering_connection_id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/route#vpc_peering_connection_id DataAwsRoute#vpc_peering_connection_id}.

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`id`^Required

Type: str

The scoped construct ID.

Must be unique amongst siblings in the same scope

`connection`^Optional

Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]

`count`^Optional

Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]

`depends_on`^Optional

Type: typing.List[cdktf.ITerraformDependable]

`for_each`^Optional

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

Type: cdktf.TerraformProvider

`provisioners`^Optional

Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]

`route_table_id`^Required

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/route#route_table_id DataAwsRoute#route_table_id}.

`carrier_gateway_id`^Optional

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/route#carrier_gateway_id DataAwsRoute#carrier_gateway_id}.

`core_network_arn`^Optional

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/route#core_network_arn DataAwsRoute#core_network_arn}.

`destination_cidr_block`^Optional

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/route#destination_cidr_block DataAwsRoute#destination_cidr_block}.

`destination_ipv6_cidr_block`^Optional

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/route#destination_ipv6_cidr_block DataAwsRoute#destination_ipv6_cidr_block}.

`destination_prefix_list_id`^Optional

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/route#destination_prefix_list_id DataAwsRoute#destination_prefix_list_id}.

`egress_only_gateway_id`^Optional

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/route#egress_only_gateway_id DataAwsRoute#egress_only_gateway_id}.

`gateway_id`^Optional

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/route#gateway_id DataAwsRoute#gateway_id}.

`id`^Optional

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/route#id DataAwsRoute#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.

`instance_id`^Optional

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/route#instance_id DataAwsRoute#instance_id}.

`local_gateway_id`^Optional

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/route#local_gateway_id DataAwsRoute#local_gateway_id}.

`nat_gateway_id`^Optional

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/route#nat_gateway_id DataAwsRoute#nat_gateway_id}.

`network_interface_id`^Optional

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/route#network_interface_id DataAwsRoute#network_interface_id}.

`timeouts`^Optional

Type: DataAwsRouteTimeouts

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/route#timeouts DataAwsRoute#timeouts}

`transit_gateway_id`^Optional

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/route#transit_gateway_id DataAwsRoute#transit_gateway_id}.

`vpc_peering_connection_id`^Optional

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/route#vpc_peering_connection_id DataAwsRoute#vpc_peering_connection_id}.

Methods

Name	Description
`to_string`	Returns a string representation of 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`	Adds this resource to the terraform JSON output.
`to_metadata`	No description.
`to_terraform`	Adds this resource to the terraform JSON output.
`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.
`put_timeouts`	No description.
`reset_carrier_gateway_id`	No description.
`reset_core_network_arn`	No description.
`reset_destination_cidr_block`	No description.
`reset_destination_ipv6_cidr_block`	No description.
`reset_destination_prefix_list_id`	No description.
`reset_egress_only_gateway_id`	No description.
`reset_gateway_id`	No description.
`reset_id`	No description.
`reset_instance_id`	No description.
`reset_local_gateway_id`	No description.
`reset_nat_gateway_id`	No description.
`reset_network_interface_id`	No description.
`reset_timeouts`	No description.
`reset_transit_gateway_id`	No description.
`reset_vpc_peering_connection_id`	No description.

`to_string`

def to_string() -> str

Returns a string representation of this construct.

`add_override`

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

`path`^Required

Type: str

`value`^Required

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_id`^Required

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

Adds this resource to the terraform JSON output.

`to_metadata`

def to_metadata() -> typing.Any

`to_terraform`

def to_terraform() -> typing.Any

Adds this resource to the terraform JSON output.

`get_any_map_attribute`

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

`terraform_attribute`^Required

Type: str

`get_boolean_attribute`

def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable

`terraform_attribute`^Required

Type: str

`get_boolean_map_attribute`

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

`terraform_attribute`^Required

Type: str

`get_list_attribute`

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

`terraform_attribute`^Required

Type: str

`get_number_attribute`

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

`terraform_attribute`^Required

Type: str

`get_number_list_attribute`

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

`terraform_attribute`^Required

Type: str

`get_number_map_attribute`

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

`terraform_attribute`^Required

Type: str

`get_string_attribute`

def get_string_attribute(
  terraform_attribute: str
) -> str

`terraform_attribute`^Required

Type: str

`get_string_map_attribute`

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

`terraform_attribute`^Required

Type: str

`interpolation_for_attribute`

def interpolation_for_attribute(
  terraform_attribute: str
) -> IResolvable

`terraform_attribute`^Required

Type: str

`put_timeouts`

def put_timeouts(
  read: str = None
) -> None

`read`^Optional

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/route#read DataAwsRoute#read}.

`reset_carrier_gateway_id`

def reset_carrier_gateway_id() -> None

`reset_core_network_arn`

def reset_core_network_arn() -> None

`reset_destination_cidr_block`

def reset_destination_cidr_block() -> None

`reset_destination_ipv6_cidr_block`

def reset_destination_ipv6_cidr_block() -> None

`reset_destination_prefix_list_id`

def reset_destination_prefix_list_id() -> None

`reset_egress_only_gateway_id`

def reset_egress_only_gateway_id() -> None

`reset_gateway_id`

def reset_gateway_id() -> None

`reset_id`

def reset_id() -> None

`reset_instance_id`

def reset_instance_id() -> None

`reset_local_gateway_id`

def reset_local_gateway_id() -> None

`reset_nat_gateway_id`

def reset_nat_gateway_id() -> None

`reset_network_interface_id`

def reset_network_interface_id() -> None

`reset_timeouts`

def reset_timeouts() -> None

`reset_transit_gateway_id`

def reset_transit_gateway_id() -> None

`reset_vpc_peering_connection_id`

def reset_vpc_peering_connection_id() -> None

Static Functions

Name	Description
`is_construct`	Checks if `x` is a construct.
`is_terraform_element`	No description.
`is_terraform_data_source`	No description.
`generate_config_for_import`	Generates CDKTF code for importing a DataAwsRoute resource upon running "cdktf plan ".

`is_construct`

from cdktf_cdktf_provider_aws import data_aws_route

dataAwsRoute.DataAwsRoute.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.

`x`^Required

Type: typing.Any

Any object.

`is_terraform_element`

from cdktf_cdktf_provider_aws import data_aws_route

dataAwsRoute.DataAwsRoute.is_terraform_element(
  x: typing.Any
)

`x`^Required

Type: typing.Any

`is_terraform_data_source`

from cdktf_cdktf_provider_aws import data_aws_route

dataAwsRoute.DataAwsRoute.is_terraform_data_source(
  x: typing.Any
)

`x`^Required

Type: typing.Any

`generate_config_for_import`

from cdktf_cdktf_provider_aws import data_aws_route

dataAwsRoute.DataAwsRoute.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

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

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`import_to_id`^Required

Type: str

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

`import_from_id`^Required

Type: str

The id of the existing DataAwsRoute that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/route#import import section} in the documentation of this resource for the id to use

`provider`^Optional

Type: cdktf.TerraformProvider

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

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`cdktf_stack`	`cdktf.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`	`cdktf.TerraformProviderGeneratorMetadata`	No description.
`count`	`typing.Union[typing.Union[int, float], cdktf.TerraformCount]`	No description.
`depends_on`	`typing.List[str]`	No description.
`for_each`	`cdktf.ITerraformIterator`	No description.
`lifecycle`	`cdktf.TerraformResourceLifecycle`	No description.
`provider`	`cdktf.TerraformProvider`	No description.
`timeouts`	`DataAwsRouteTimeoutsOutputReference`	No description.
`carrier_gateway_id_input`	`str`	No description.
`core_network_arn_input`	`str`	No description.
`destination_cidr_block_input`	`str`	No description.
`destination_ipv6_cidr_block_input`	`str`	No description.
`destination_prefix_list_id_input`	`str`	No description.
`egress_only_gateway_id_input`	`str`	No description.
`gateway_id_input`	`str`	No description.
`id_input`	`str`	No description.
`instance_id_input`	`str`	No description.
`local_gateway_id_input`	`str`	No description.
`nat_gateway_id_input`	`str`	No description.
`network_interface_id_input`	`str`	No description.
`route_table_id_input`	`str`	No description.
`timeouts_input`	`typing.Union[cdktf.IResolvable, DataAwsRouteTimeouts]`	No description.
`transit_gateway_id_input`	`str`	No description.
`vpc_peering_connection_id_input`	`str`	No description.
`carrier_gateway_id`	`str`	No description.
`core_network_arn`	`str`	No description.
`destination_cidr_block`	`str`	No description.
`destination_ipv6_cidr_block`	`str`	No description.
`destination_prefix_list_id`	`str`	No description.
`egress_only_gateway_id`	`str`	No description.
`gateway_id`	`str`	No description.
`id`	`str`	No description.
`instance_id`	`str`	No description.
`local_gateway_id`	`str`	No description.
`nat_gateway_id`	`str`	No description.
`network_interface_id`	`str`	No description.
`route_table_id`	`str`	No description.
`transit_gateway_id`	`str`	No description.
`vpc_peering_connection_id`	`str`	No description.

`node`^Required

node: Node

Type: constructs.Node

The tree node.

`cdktf_stack`^Required

cdktf_stack: TerraformStack

Type: cdktf.TerraformStack

`fqn`^Required

fqn: str

Type: str

`friendly_unique_id`^Required

friendly_unique_id: str

Type: str

`terraform_meta_arguments`^Required

terraform_meta_arguments: typing.Mapping[typing.Any]

Type: typing.Mapping[typing.Any]

`terraform_resource_type`^Required

terraform_resource_type: str

Type: str

`terraform_generator_metadata`^Optional

terraform_generator_metadata: TerraformProviderGeneratorMetadata

Type: cdktf.TerraformProviderGeneratorMetadata

`count`^Optional

count: typing.Union[typing.Union[int, float], TerraformCount]

Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]

`depends_on`^Optional

depends_on: typing.List[str]

Type: typing.List[str]

`for_each`^Optional

for_each: ITerraformIterator

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

lifecycle: TerraformResourceLifecycle

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

provider: TerraformProvider

Type: cdktf.TerraformProvider

`timeouts`^Required

timeouts: DataAwsRouteTimeoutsOutputReference

Type: DataAwsRouteTimeoutsOutputReference

`carrier_gateway_id_input`^Optional

carrier_gateway_id_input: str

Type: str

`core_network_arn_input`^Optional

core_network_arn_input: str

Type: str

`destination_cidr_block_input`^Optional

destination_cidr_block_input: str

Type: str

`destination_ipv6_cidr_block_input`^Optional

destination_ipv6_cidr_block_input: str

Type: str

`destination_prefix_list_id_input`^Optional

destination_prefix_list_id_input: str

Type: str

`egress_only_gateway_id_input`^Optional

egress_only_gateway_id_input: str

Type: str

`gateway_id_input`^Optional

gateway_id_input: str

Type: str

`id_input`^Optional

id_input: str

Type: str

`instance_id_input`^Optional

instance_id_input: str

Type: str

`local_gateway_id_input`^Optional

local_gateway_id_input: str

Type: str

`nat_gateway_id_input`^Optional

nat_gateway_id_input: str

Type: str

`network_interface_id_input`^Optional

network_interface_id_input: str

Type: str

`route_table_id_input`^Optional

route_table_id_input: str

Type: str

`timeouts_input`^Optional

timeouts_input: typing.Union[IResolvable, DataAwsRouteTimeouts]

Type: typing.Union[cdktf.IResolvable, DataAwsRouteTimeouts]

`transit_gateway_id_input`^Optional

transit_gateway_id_input: str

Type: str

`vpc_peering_connection_id_input`^Optional

vpc_peering_connection_id_input: str

Type: str

`carrier_gateway_id`^Required

carrier_gateway_id: str

Type: str

`core_network_arn`^Required

core_network_arn: str

Type: str

`destination_cidr_block`^Required

destination_cidr_block: str

Type: str

`destination_ipv6_cidr_block`^Required

destination_ipv6_cidr_block: str

Type: str

`destination_prefix_list_id`^Required

destination_prefix_list_id: str

Type: str

`egress_only_gateway_id`^Required

egress_only_gateway_id: str

Type: str

`gateway_id`^Required

gateway_id: str

Type: str

`id`^Required

id: str

Type: str

`instance_id`^Required

instance_id: str

Type: str

`local_gateway_id`^Required

local_gateway_id: str

Type: str

`nat_gateway_id`^Required

nat_gateway_id: str

Type: str

`network_interface_id`^Required

network_interface_id: str

Type: str

`route_table_id`^Required

route_table_id: str

Type: str

`transit_gateway_id`^Required

transit_gateway_id: str

Type: str

`vpc_peering_connection_id`^Required

vpc_peering_connection_id: str

Type: str

Constants

Name	Type	Description
`tfResourceType`	`str`	No description.

`tfResourceType`^Required

tfResourceType: str

Type: str

Structs

DataAwsRouteConfig

Initializer

from cdktf_cdktf_provider_aws import data_aws_route

dataAwsRoute.DataAwsRouteConfig(
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[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[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  route_table_id: str,
  carrier_gateway_id: str = None,
  core_network_arn: str = None,
  destination_cidr_block: str = None,
  destination_ipv6_cidr_block: str = None,
  destination_prefix_list_id: str = None,
  egress_only_gateway_id: str = None,
  gateway_id: str = None,
  id: str = None,
  instance_id: str = None,
  local_gateway_id: str = None,
  nat_gateway_id: str = None,
  network_interface_id: str = None,
  timeouts: DataAwsRouteTimeouts = None,
  transit_gateway_id: str = None,
  vpc_peering_connection_id: str = None
)

Properties

Name	Type	Description
`connection`	`typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]`	No description.
`count`	`typing.Union[typing.Union[int, float], cdktf.TerraformCount]`	No description.
`depends_on`	`typing.List[cdktf.ITerraformDependable]`	No description.
`for_each`	`cdktf.ITerraformIterator`	No description.
`lifecycle`	`cdktf.TerraformResourceLifecycle`	No description.
`provider`	`cdktf.TerraformProvider`	No description.
`provisioners`	`typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]`	No description.
`route_table_id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/route#route_table_id DataAwsRoute#route_table_id}.
`carrier_gateway_id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/route#carrier_gateway_id DataAwsRoute#carrier_gateway_id}.
`core_network_arn`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/route#core_network_arn DataAwsRoute#core_network_arn}.
`destination_cidr_block`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/route#destination_cidr_block DataAwsRoute#destination_cidr_block}.
`destination_ipv6_cidr_block`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/route#destination_ipv6_cidr_block DataAwsRoute#destination_ipv6_cidr_block}.
`destination_prefix_list_id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/route#destination_prefix_list_id DataAwsRoute#destination_prefix_list_id}.
`egress_only_gateway_id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/route#egress_only_gateway_id DataAwsRoute#egress_only_gateway_id}.
`gateway_id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/route#gateway_id DataAwsRoute#gateway_id}.
`id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/route#id DataAwsRoute#id}.
`instance_id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/route#instance_id DataAwsRoute#instance_id}.
`local_gateway_id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/route#local_gateway_id DataAwsRoute#local_gateway_id}.
`nat_gateway_id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/route#nat_gateway_id DataAwsRoute#nat_gateway_id}.
`network_interface_id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/route#network_interface_id DataAwsRoute#network_interface_id}.
`timeouts`	`DataAwsRouteTimeouts`	timeouts block.
`transit_gateway_id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/route#transit_gateway_id DataAwsRoute#transit_gateway_id}.
`vpc_peering_connection_id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/route#vpc_peering_connection_id DataAwsRoute#vpc_peering_connection_id}.

`connection`^Optional

connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]

Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]

`count`^Optional

count: typing.Union[typing.Union[int, float], TerraformCount]

Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]

`depends_on`^Optional

depends_on: typing.List[ITerraformDependable]

Type: typing.List[cdktf.ITerraformDependable]

`for_each`^Optional

for_each: ITerraformIterator

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

lifecycle: TerraformResourceLifecycle

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

provider: TerraformProvider

Type: cdktf.TerraformProvider

`provisioners`^Optional

provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]

Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]

`route_table_id`^Required

route_table_id: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/route#route_table_id DataAwsRoute#route_table_id}.

`carrier_gateway_id`^Optional

carrier_gateway_id: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/route#carrier_gateway_id DataAwsRoute#carrier_gateway_id}.

`core_network_arn`^Optional

core_network_arn: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/route#core_network_arn DataAwsRoute#core_network_arn}.

`destination_cidr_block`^Optional

destination_cidr_block: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/route#destination_cidr_block DataAwsRoute#destination_cidr_block}.

`destination_ipv6_cidr_block`^Optional

destination_ipv6_cidr_block: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/route#destination_ipv6_cidr_block DataAwsRoute#destination_ipv6_cidr_block}.

`destination_prefix_list_id`^Optional

destination_prefix_list_id: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/route#destination_prefix_list_id DataAwsRoute#destination_prefix_list_id}.

`egress_only_gateway_id`^Optional

egress_only_gateway_id: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/route#egress_only_gateway_id DataAwsRoute#egress_only_gateway_id}.

`gateway_id`^Optional

gateway_id: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/route#gateway_id DataAwsRoute#gateway_id}.

`id`^Optional

id: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/route#id DataAwsRoute#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.

`instance_id`^Optional

instance_id: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/route#instance_id DataAwsRoute#instance_id}.

`local_gateway_id`^Optional

local_gateway_id: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/route#local_gateway_id DataAwsRoute#local_gateway_id}.

`nat_gateway_id`^Optional

nat_gateway_id: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/route#nat_gateway_id DataAwsRoute#nat_gateway_id}.

`network_interface_id`^Optional

network_interface_id: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/route#network_interface_id DataAwsRoute#network_interface_id}.

`timeouts`^Optional

timeouts: DataAwsRouteTimeouts

Type: DataAwsRouteTimeouts

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/route#timeouts DataAwsRoute#timeouts}

`transit_gateway_id`^Optional

transit_gateway_id: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/route#transit_gateway_id DataAwsRoute#transit_gateway_id}.

`vpc_peering_connection_id`^Optional

vpc_peering_connection_id: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/route#vpc_peering_connection_id DataAwsRoute#vpc_peering_connection_id}.

DataAwsRouteTimeouts

Initializer

from cdktf_cdktf_provider_aws import data_aws_route

dataAwsRoute.DataAwsRouteTimeouts(
  read: str = None
)

Properties

Name	Type	Description
`read`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/route#read DataAwsRoute#read}.

`read`^Optional

read: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/route#read DataAwsRoute#read}.

Classes

DataAwsRouteTimeoutsOutputReference

Initializers

from cdktf_cdktf_provider_aws import data_aws_route

dataAwsRoute.DataAwsRouteTimeoutsOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)

Name	Type	Description
`terraform_resource`	`cdktf.IInterpolatingParent`	The parent resource.
`terraform_attribute`	`str`	The attribute on the parent resource this class is referencing.

`terraform_resource`^Required

Type: cdktf.IInterpolatingParent

The parent resource.

`terraform_attribute`^Required

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_read`	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_attribute`^Required

Type: str

`get_boolean_attribute`

def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable

`terraform_attribute`^Required

Type: str

`get_boolean_map_attribute`

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

`terraform_attribute`^Required

Type: str

`get_list_attribute`

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

`terraform_attribute`^Required

Type: str

`get_number_attribute`

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

`terraform_attribute`^Required

Type: str

`get_number_list_attribute`

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

`terraform_attribute`^Required

Type: str

`get_number_map_attribute`

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

`terraform_attribute`^Required

Type: str

`get_string_attribute`

def get_string_attribute(
  terraform_attribute: str
) -> str

`terraform_attribute`^Required

Type: str

`get_string_map_attribute`

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

`terraform_attribute`^Required

Type: str

`interpolation_for_attribute`

def interpolation_for_attribute(
  property: str
) -> IResolvable

`property`^Required

Type: str

`resolve`

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

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktf.IResolveContext

`to_string`

def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

`reset_read`

def reset_read() -> 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.
`read_input`	`str`	No description.
`read`	`str`	No description.
`internal_value`	`typing.Union[cdktf.IResolvable, DataAwsRouteTimeouts]`	No description.

`creation_stack`^Required

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.

`fqn`^Required

fqn: str

Type: str

`read_input`^Optional

read_input: str

Type: str

`read`^Required

read: str

Type: str

`internal_value`^Optional

internal_value: typing.Union[IResolvable, DataAwsRouteTimeouts]

Type: typing.Union[cdktf.IResolvable, DataAwsRouteTimeouts]

Files

dataAwsRoute.python.md

Latest commit

History

dataAwsRoute.python.md

File metadata and controls

dataAwsRoute Submodule

Constructs

DataAwsRoute

Initializers

scopeRequired

idRequired

connectionOptional

countOptional

depends_onOptional

for_eachOptional

lifecycleOptional

providerOptional

provisionersOptional

route_table_idRequired

carrier_gateway_idOptional

core_network_arnOptional

destination_cidr_blockOptional

destination_ipv6_cidr_blockOptional

destination_prefix_list_idOptional

egress_only_gateway_idOptional

gateway_idOptional

idOptional

instance_idOptional

local_gateway_idOptional

nat_gateway_idOptional

network_interface_idOptional

timeoutsOptional

transit_gateway_idOptional

vpc_peering_connection_idOptional

Methods

to_string

add_override

pathRequired

valueRequired

override_logical_id

new_logical_idRequired

reset_override_logical_id

to_hcl_terraform

to_metadata

to_terraform

get_any_map_attribute

terraform_attributeRequired

get_boolean_attribute

terraform_attributeRequired

get_boolean_map_attribute

terraform_attributeRequired

get_list_attribute

terraform_attributeRequired

get_number_attribute

terraform_attributeRequired

get_number_list_attribute

terraform_attributeRequired

get_number_map_attribute

terraform_attributeRequired

get_string_attribute

terraform_attributeRequired

get_string_map_attribute

terraform_attributeRequired

interpolation_for_attribute

terraform_attributeRequired

put_timeouts

readOptional

reset_carrier_gateway_id

reset_core_network_arn

reset_destination_cidr_block

reset_destination_ipv6_cidr_block

reset_destination_prefix_list_id

reset_egress_only_gateway_id

reset_gateway_id

reset_id

reset_instance_id

reset_local_gateway_id

reset_nat_gateway_id

reset_network_interface_id

`dataAwsRoute` Submodule

`scope`^Required

`id`^Required

`connection`^Optional

`count`^Optional

`depends_on`^Optional

`for_each`^Optional

`lifecycle`^Optional

`provider`^Optional

`provisioners`^Optional

`route_table_id`^Required

`carrier_gateway_id`^Optional

`core_network_arn`^Optional

`destination_cidr_block`^Optional

`destination_ipv6_cidr_block`^Optional

`destination_prefix_list_id`^Optional

`egress_only_gateway_id`^Optional

`gateway_id`^Optional

`id`^Optional

`instance_id`^Optional

`local_gateway_id`^Optional

`nat_gateway_id`^Optional

`network_interface_id`^Optional

`timeouts`^Optional

`transit_gateway_id`^Optional

`vpc_peering_connection_id`^Optional

`to_string`

`add_override`

`path`^Required

`value`^Required

`override_logical_id`

`new_logical_id`^Required

`reset_override_logical_id`

`to_hcl_terraform`

`to_metadata`

`to_terraform`

`get_any_map_attribute`

`terraform_attribute`^Required

`get_boolean_attribute`

`terraform_attribute`^Required

`get_boolean_map_attribute`

`terraform_attribute`^Required

`get_list_attribute`

`terraform_attribute`^Required

`get_number_attribute`

`terraform_attribute`^Required

`get_number_list_attribute`

`terraform_attribute`^Required

`get_number_map_attribute`

`terraform_attribute`^Required

`get_string_attribute`

`terraform_attribute`^Required

`get_string_map_attribute`

`terraform_attribute`^Required

`interpolation_for_attribute`

`terraform_attribute`^Required

`put_timeouts`

`read`^Optional

`reset_carrier_gateway_id`

`reset_core_network_arn`

`reset_destination_cidr_block`

`reset_destination_ipv6_cidr_block`

`reset_destination_prefix_list_id`

`reset_egress_only_gateway_id`

`reset_gateway_id`

`reset_id`

`reset_instance_id`

`reset_local_gateway_id`

`reset_nat_gateway_id`

`reset_network_interface_id`

`reset_timeouts`

`reset_transit_gateway_id`

`reset_vpc_peering_connection_id`

`is_construct`

`x`^Required

`is_terraform_element`

`x`^Required

`is_terraform_data_source`

`x`^Required

`generate_config_for_import`