Skip to content

CenRouteMaps

  • Implements: ros_cdk_cen.datasource.ICenRouteMaps

This class encapsulates and extends the ROS resource type DATASOURCE::CEN::CenRouteMaps, which is used to query the information about routing policies.

Initializers

from ros_cdk_cen import datasource
datasource.CenRouteMaps(
  scope: Construct,
  id: str,
  cen_id: typing.Union[str, IResolvable],
  cen_region_id: typing.Union[str, IResolvable] = None,
  refresh_options: typing.Union[str, IResolvable] = None,
  route_map_id: typing.Union[str, IResolvable] = None,
  transit_router_route_table_id: typing.Union[str, IResolvable] = None,
  transmit_direction: 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.
cen_id typing.Union[str, ros_cdk_core.IResolvable] Property cenId: The ID of the CEN instance.
cen_region_id typing.Union[str, ros_cdk_core.IResolvable] Property cenRegionId: The ID of the region where the routing policy is applied.
refresh_options typing.Union[str, ros_cdk_core.IResolvable] Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
route_map_id typing.Union[str, ros_cdk_core.IResolvable] Property routeMapId: The ID of the routing policy.
transit_router_route_table_id typing.Union[str, ros_cdk_core.IResolvable] Property transitRouterRouteTableId: The route table ID of the transit router with which the routing policy is associated.
transmit_direction typing.Union[str, ros_cdk_core.IResolvable] Property transmitDirection: The direction in which the routing policy is applied.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

cen_idRequired

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

Property cenId: The ID of the CEN instance.


cen_region_idOptional

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

Property cenRegionId: The ID of the region where the routing policy is applied.


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_map_idOptional

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

Property routeMapId: The ID of the routing policy.


transit_router_route_table_idOptional

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

Property transitRouterRouteTableId: The route table ID of the transit router with which the routing policy is associated.


transmit_directionOptional

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

Property transmitDirection: The direction in which the routing policy is applied.


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_cen import datasource
datasource.CenRouteMaps.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_map_ids typing.Union[str, ros_cdk_core.IResolvable] Attribute RouteMapIds: The list of The RouteMap ids.
attr_route_maps typing.Union[str, ros_cdk_core.IResolvable] Attribute RouteMaps: The information about RouteMaps.
props CenRouteMapsProps 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_map_idsRequired

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

Attribute RouteMapIds: The list of The RouteMap ids.


attr_route_mapsRequired

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

Attribute RouteMaps: The information about RouteMaps.


propsRequired

props: CenRouteMapsProps