Namespace

• Implements: ros_cdk_sae.datasource.INamespace

This class encapsulates and extends the ROS resource type DATASOURCE::SAE::Namespace.

Initializers

from ros_cdk_sae import datasource
datasource.Namespace(
  scope: Construct,
  id: str,
  namespace_id: typing.Union[str, IResolvable] = None,
  name_space_short_id: typing.Union[str, IResolvable] = None,
  refresh_options: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

namespace_id^Optional

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

Property namespaceId: The ID of the namespace.

name_space_short_id^Optional

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

Property nameSpaceShortId: The ID of the short namespace.

refresh_options^Optional

• 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.

enable_resource_property_constraint^Optional

• Type: bool

Methods

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.

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

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

count^Required

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

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• 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

name^Required

• Type: str

set_metadata

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

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

from ros_cdk_sae import datasource
datasource.Namespace.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

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.

ref^Required

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

attr_app_count^Required

attr_app_count: typing.Union[str, IResolvable]

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

Attribute AppCount: The number of applications.

attr_belong_region^Required

attr_belong_region: typing.Union[str, IResolvable]

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

Attribute BelongRegion: The region to which the namespace belongs.

attr_description^Required

attr_description: typing.Union[str, IResolvable]

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

Attribute Description: The description of the namespace.

attr_jump_server_app_id^Required

attr_jump_server_app_id: typing.Union[str, IResolvable]

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

Attribute JumpServerAppId: The ID of the jump server application.

attr_jump_server_ip^Required

attr_jump_server_ip: typing.Union[str, IResolvable]

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

Attribute JumpServerIp: The IP address of the jump server.

attr_last_change_order_id^Required

attr_last_change_order_id: typing.Union[str, IResolvable]

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

Attribute LastChangeOrderId: The ID of the change order.

attr_last_change_order_running^Required

attr_last_change_order_running: typing.Union[str, IResolvable]

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

Attribute LastChangeOrderRunning: Indicates whether a change order is being executed in the namespace.

attr_last_change_order_status^Required

attr_last_change_order_status: typing.Union[str, IResolvable]

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

Attribute LastChangeOrderStatus: The status of the latest change order.

attr_namespace_id^Required

attr_namespace_id: typing.Union[str, IResolvable]

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

Attribute NamespaceId: The ID of the namespace.

attr_namespace_name^Required

attr_namespace_name: typing.Union[str, IResolvable]

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

Attribute NamespaceName: The name of the namespace.

attr_name_space_short_id^Required

attr_name_space_short_id: typing.Union[str, IResolvable]

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

Attribute NameSpaceShortId: The ID of the short namespace.

attr_notification_expired^Required

attr_notification_expired: typing.Union[str, IResolvable]

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

Attribute NotificationExpired: Indicates whether the notification of a change order is expired.

attr_security_group_id^Required

attr_security_group_id: typing.Union[str, IResolvable]

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

Attribute SecurityGroupId: The ID of the security group.

attr_tenant_id^Required

attr_tenant_id: typing.Union[str, IResolvable]

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

Attribute TenantId: The ID of the tenant in the SAE namespace.

attr_user_id^Required

attr_user_id: typing.Union[str, IResolvable]

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

Attribute UserId: The ID of the user.

attr_vpc_id^Required

attr_vpc_id: typing.Union[str, IResolvable]

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

Attribute VpcId: The ID of the virtual private cloud (VPC).

attr_vpc_name^Required

attr_vpc_name: typing.Union[str, IResolvable]

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

Attribute VpcName: The name of the VPC.

attr_v_switch_id^Required

attr_v_switch_id: typing.Union[str, IResolvable]

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

Attribute VSwitchId: The ID of the vSwitch.

attr_v_switch_name^Required

attr_v_switch_name: typing.Union[str, IResolvable]

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

Attribute VSwitchName: The name of the vSwitch.

props^Required

props: NamespaceProps

• Type: NamespaceProps