Skip to content

RouteEntries

  • Implements: ros_cdk_vpc.datasource.IRouteEntries

This class encapsulates and extends the ROS resource type DATASOURCE::VPC::RouteEntries, which is used to query routes.

Initializers

from ros_cdk_vpc import datasource
datasource.RouteEntries(
  scope: Construct,
  id: str,
  route_table_id: typing.Union[str, IResolvable],
  destination_cidr_block: typing.Union[str, IResolvable] = None,
  ip_version: typing.Union[str, IResolvable] = None,
  next_hop_id: typing.Union[str, IResolvable] = None,
  next_hop_type: typing.Union[str, IResolvable] = None,
  refresh_options: typing.Union[str, IResolvable] = None,
  route_entry_id: typing.Union[str, IResolvable] = None,
  route_entry_name: typing.Union[str, IResolvable] = None,
  route_entry_type: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
route_table_id typing.Union[str, ros_cdk_core.IResolvable] Property routeTableId: The ID of the route table.
destination_cidr_block typing.Union[str, ros_cdk_core.IResolvable] Property destinationCidrBlock: The destination CIDR block of the route.
ip_version typing.Union[str, ros_cdk_core.IResolvable] Property ipVersion: The IP version.
next_hop_id typing.Union[str, ros_cdk_core.IResolvable] Property nextHopId: The ID of the next hop.
next_hop_type typing.Union[str, ros_cdk_core.IResolvable] Property nextHopType: The type of the next hop.
refresh_options typing.Union[str, ros_cdk_core.IResolvable] Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
route_entry_id typing.Union[str, ros_cdk_core.IResolvable] Property routeEntryId: The ID of the route.
route_entry_name typing.Union[str, ros_cdk_core.IResolvable] Property routeEntryName: The name of the route.
route_entry_type typing.Union[str, ros_cdk_core.IResolvable] Property routeEntryType: The type of the route.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

route_table_idRequired

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property routeTableId: The ID of the route table.


destination_cidr_blockOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property destinationCidrBlock: The destination CIDR block of the route.

IPv4 and IPv6 CIDR blocks are supported.


ip_versionOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property ipVersion: The IP version.

Valid values: IPv4: IPv4 IPv6: IPv6


next_hop_idOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property nextHopId: The ID of the next hop.


next_hop_typeOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property nextHopType: The type of the next hop.

Valid values: Instance (default): an Elastic Compute Service (ECS) instance HaVip: a high-availability virtual IP address (HAVIP) VpnGateway: a VPN gateway NatGateway: a NAT gateway NetworkInterface: a secondary elastic network interface (ENI) RouterInterface: a router interface IPv6Gateway: an IPv6 gateway Attachment: a transit router


refresh_optionsOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

Valid values:

  • Never: Never refresh the datasource resource when the stack is updated.
  • Always: Always refresh the datasource resource when the stack is updated. Default is Never.

route_entry_idOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property routeEntryId: The ID of the route.


route_entry_nameOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property routeEntryName: The name of the route.


route_entry_typeOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property routeEntryType: The type of the route.

Valid values: Custom: a custom route System: a system route BGP: a Border Gateway Protocol (BGP) route CEN: a Cloud Enterprise Network (CEN) route


enable_resource_property_constraintOptional

  • Type: bool

Methods

Name Description
to_string Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition No description.
add_count No description.
add_dependency No description.
add_resource_desc No description.
apply_removal_policy No description.
fetch_condition No description.
fetch_dependency No description.
fetch_resource_desc No description.
get_att No description.
set_metadata No description.

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

sessionRequired

  • Type: ros_cdk_core.ISynthesisSession

The synthesis session.


add_condition

def add_condition(
  condition: RosCondition
) -> None

conditionRequired

  • Type: ros_cdk_core.RosCondition

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

countRequired

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency

def add_dependency(
  resource: Resource
) -> None

resourceRequired

  • Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

descRequired

  • Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policyRequired

  • Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

get_att

def get_att(
  name: str
) -> IResolvable

nameRequired

  • Type: str

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

keyRequired

  • Type: str

valueRequired

  • Type: typing.Any

Static Functions

Name Description
is_construct Return whether the given object is a Construct.

is_construct

from ros_cdk_vpc import datasource
datasource.RouteEntries.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

xRequired

  • Type: typing.Any

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node associated with this construct.
env ros_cdk_core.IResourceEnvironment The environment this resource belongs to.
ref str No description.
stack ros_cdk_core.Stack The stack in which this resource is defined.
resource ros_cdk_core.RosResource No description.
attr_route_entries typing.Union[str, ros_cdk_core.IResolvable] Attribute RouteEntries: The list of The route entries.
attr_route_entry_ids typing.Union[str, ros_cdk_core.IResolvable] Attribute RouteEntryIds: the list of the route entry ids.
props RouteEntriesProps No description.

nodeRequired

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.


envRequired

env: IResourceEnvironment
  • Type: ros_cdk_core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.


refRequired

ref: str
  • Type: str

stackRequired

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.


resourceOptional

resource: RosResource
  • Type: ros_cdk_core.RosResource

attr_route_entriesRequired

attr_route_entries: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute RouteEntries: The list of The route entries.


attr_route_entry_idsRequired

attr_route_entry_ids: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute RouteEntryIds: the list of the route entry ids.


propsRequired

props: RouteEntriesProps