Skip to content

Instance

This class encapsulates and extends the ROS resource type DATASOURCE::ENS::Instance.

Initializers 

from ros_cdk_ens import datasource
datasource.Instance(
  scope: Construct,
  id: str,
  instance_id: typing.Union[str, IResolvable],
  refresh_options: 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.
instance_id typing.Union[str, ros_cdk_core.IResolvable] Property instanceId: The ID of the instance.
refresh_options typing.Union[str, ros_cdk_core.IResolvable] Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

instance_idRequired

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

Property instanceId: The ID of the instance.

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.

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

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_ens import datasource
datasource.Instance.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.
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_data_disk ros_cdk_core.IResolvable Attribute DataDisk: Data disk specifications.
attr_ens_region_id ros_cdk_core.IResolvable Attribute EnsRegionId: The node ID.
attr_host_name ros_cdk_core.IResolvable Attribute HostName: The hostname of the instance.
attr_image_id ros_cdk_core.IResolvable Attribute ImageId: The ID of the image.
attr_instance_id ros_cdk_core.IResolvable Attribute InstanceId: The ID of the instance.
attr_instance_name ros_cdk_core.IResolvable Attribute InstanceName: The instance name.
attr_instance_type ros_cdk_core.IResolvable Attribute InstanceType: The specification of the instance.
attr_internet_max_bandwidth_out ros_cdk_core.IResolvable Attribute InternetMaxBandwidthOut: Maximum public network bandwidth.
attr_network_id ros_cdk_core.IResolvable Attribute NetworkId: The ID of the network.
attr_payment_type ros_cdk_core.IResolvable Attribute PaymentType: Instance payment method.
attr_private_ip_address ros_cdk_core.IResolvable Attribute PrivateIpAddress: The private IP address.
attr_security_id ros_cdk_core.IResolvable Attribute SecurityId: ID of the security group to which the instance belongs.
attr_system_disk ros_cdk_core.IResolvable Attribute SystemDisk: System Disk Specification.
attr_v_switch_id ros_cdk_core.IResolvable Attribute VSwitchId: The ID of the vSwitch to which the instance belongs.

nodeRequired 

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

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_data_diskRequired 

attr_data_disk: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute DataDisk: Data disk specifications.

attr_ens_region_idRequired 

attr_ens_region_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute EnsRegionId: The node ID.

When ScheduleAreaLevel is Region, EnsRegionId is required. When ScheduleAreaLevel is Big,Middle,Small, EnsRegionId is invalid.

attr_host_nameRequired 

attr_host_name: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute HostName: The hostname of the instance.

attr_image_idRequired 

attr_image_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ImageId: The ID of the image.

attr_instance_idRequired 

attr_instance_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute InstanceId: The ID of the instance.

attr_instance_nameRequired 

attr_instance_name: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute InstanceName: The instance name.

Example value: test-InstanceName. It must be 2 to 128 characters in length and must start with an uppercase or lowercase letter or a Chinese character. It cannot start with http:// or https. Can contain Chinese, English, numbers, half-width colons (:), underscores (_), periods (.

attr_instance_typeRequired 

attr_instance_type: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute InstanceType: The specification of the instance.

Example value: ens.sn1.

attr_internet_max_bandwidth_outRequired 

attr_internet_max_bandwidth_out: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute InternetMaxBandwidthOut: Maximum public network bandwidth.

The field type is Long, and the precision may be lost during serialization/deserialization.

attr_network_idRequired 

attr_network_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute NetworkId: The ID of the network.

attr_payment_typeRequired 

attr_payment_type: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute PaymentType: Instance payment method.

attr_private_ip_addressRequired 

attr_private_ip_address: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute PrivateIpAddress: The private IP address.

Can only be used for node-level scheduling. If a private IP address is specified, the number of instances can only be one, and both the private IP address and the vSwitch ID are not empty, the private IP address takes effect.

attr_security_idRequired 

attr_security_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute SecurityId: ID of the security group to which the instance belongs.

attr_system_diskRequired 

attr_system_disk: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute SystemDisk: System Disk Specification.

SystemDisk is a non-required parameter when InstanceType is x86_pm,x86_bmi,x86_bm,pc_bmi, or arm_bmi. SystemDisk is a required parameter when instanceType is other specification families.

attr_v_switch_idRequired 

attr_v_switch_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute VSwitchId: The ID of the vSwitch to which the instance belongs.