Instance

This class encapsulates and extends the ROS resource type DATASOURCE::ApiGateway::Instance, which is used to query the information about an instance.

Initializers

from ros_cdk_apigateway 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: Instance id.
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.

---

scope^Required

• Type: ros_cdk_core.Construct

---

id^Required

• Type: str

---

instance_id^Required

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

Property instanceId: Instance id.

---

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

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.

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

---

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

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

---

is_construct

from ros_cdk_apigateway import datasource
datasource.Instance.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• 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_acl_id	ros_cdk_core.IResolvable	Attribute AclId: Access control ID.
attr_acl_name	ros_cdk_core.IResolvable	Attribute AclName: Access control name.
attr_acl_status	ros_cdk_core.IResolvable	Attribute AclStatus: Access control type.
attr_acl_type	ros_cdk_core.IResolvable	Attribute AclType: Access control type.
attr_classic_egress_address	ros_cdk_core.IResolvable	Attribute ClassicEgressAddress: Classic network exit address.
attr_create_time	ros_cdk_core.IResolvable	Attribute CreateTime: Creation time.
attr_egress_ipv6_enable	ros_cdk_core.IResolvable	Attribute EgressIpv6Enable: Does IPV6 Capability Support.
attr_expired_time	ros_cdk_core.IResolvable	Attribute ExpiredTime: Instance expiration time.
attr_https_policy	ros_cdk_core.IResolvable	Attribute HttpsPolicy: Https policy.
attr_instance_id	ros_cdk_core.IResolvable	Attribute InstanceId: Instance id.
attr_instance_name	ros_cdk_core.IResolvable	Attribute InstanceName: Instance name.
attr_instance_rps_limit	ros_cdk_core.IResolvable	Attribute InstanceRpsLimit: Instance rps limits.
attr_instance_spec	ros_cdk_core.IResolvable	Attribute InstanceSpec: Instance type.
attr_instance_spec_attributes	ros_cdk_core.IResolvable	Attribute InstanceSpecAttributes: Instance type.
attr_instance_type	ros_cdk_core.IResolvable	Attribute InstanceType: Instance type.
attr_internet_egress_address	ros_cdk_core.IResolvable	Attribute InternetEgressAddress: Public network exit address.
attr_payment_type	ros_cdk_core.IResolvable	Attribute PaymentType: The payment type of the resource.
attr_support_ipv6	ros_cdk_core.IResolvable	Attribute SupportIpv6: Does ipv6 support.
attr_user_vpc_id	ros_cdk_core.IResolvable	Attribute UserVpcId: User's VpcID.
attr_user_vswitch_id	ros_cdk_core.IResolvable	Attribute UserVswitchId: DescribeInstances.
attr_vip_type_list	ros_cdk_core.IResolvable	Attribute VipTypeList: Vip type.
attr_vpc_egress_address	ros_cdk_core.IResolvable	Attribute VpcEgressAddress: Intranet VPC exit network segment.
attr_vpc_intranet_enable	ros_cdk_core.IResolvable	Attribute VpcIntranetEnable: Whether Vpc allows authorization.
attr_vpc_owner_id	ros_cdk_core.IResolvable	Attribute VpcOwnerId: Vpc licensor ID.
attr_vpc_slb_intranet_enable	ros_cdk_core.IResolvable	Attribute VpcSlbIntranetEnable: Whether the slb of the Vpc supports.
attr_zone_id	ros_cdk_core.IResolvable	Attribute ZoneId: Zone.
attr_zone_local_name	ros_cdk_core.IResolvable	Attribute ZoneLocalName: Available area.

---

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

---

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_acl_id^Required

attr_acl_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute AclId: Access control ID.

---

attr_acl_name^Required

attr_acl_name: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute AclName: Access control name.

---

attr_acl_status^Required

attr_acl_status: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute AclStatus: Access control type.

---

attr_acl_type^Required

attr_acl_type: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute AclType: Access control type.

---

attr_classic_egress_address^Required

attr_classic_egress_address: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute ClassicEgressAddress: Classic network exit address.

---

attr_create_time^Required

attr_create_time: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute CreateTime: Creation time.

---

attr_egress_ipv6_enable^Required

attr_egress_ipv6_enable: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute EgressIpv6Enable: Does IPV6 Capability Support.

---

attr_expired_time^Required

attr_expired_time: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute ExpiredTime: Instance expiration time.

---

attr_https_policy^Required

attr_https_policy: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute HttpsPolicy: Https policy.

---

attr_instance_id^Required

attr_instance_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute InstanceId: Instance id.

---

attr_instance_name^Required

attr_instance_name: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute InstanceName: Instance name.

---

attr_instance_rps_limit^Required

attr_instance_rps_limit: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute InstanceRpsLimit: Instance rps limits.

---

attr_instance_spec^Required

attr_instance_spec: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute InstanceSpec: Instance type.

---

attr_instance_spec_attributes^Required

attr_instance_spec_attributes: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute InstanceSpecAttributes: Instance type.

---

attr_instance_type^Required

attr_instance_type: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute InstanceType: Instance type.

---

attr_internet_egress_address^Required

attr_internet_egress_address: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute InternetEgressAddress: Public network exit address.

---

attr_payment_type^Required

attr_payment_type: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute PaymentType: The payment type of the resource.

---

attr_support_ipv6^Required

attr_support_ipv6: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute SupportIpv6: Does ipv6 support.

---

attr_user_vpc_id^Required

attr_user_vpc_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute UserVpcId: User's VpcID.

---

attr_user_vswitch_id^Required

attr_user_vswitch_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute UserVswitchId: DescribeInstances.

---

attr_vip_type_list^Required

attr_vip_type_list: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute VipTypeList: Vip type.

---

attr_vpc_egress_address^Required

attr_vpc_egress_address: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute VpcEgressAddress: Intranet VPC exit network segment.

---

attr_vpc_intranet_enable^Required

attr_vpc_intranet_enable: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute VpcIntranetEnable: Whether Vpc allows authorization.

---

attr_vpc_owner_id^Required

attr_vpc_owner_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute VpcOwnerId: Vpc licensor ID.

---

attr_vpc_slb_intranet_enable^Required

attr_vpc_slb_intranet_enable: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute VpcSlbIntranetEnable: Whether the slb of the Vpc supports.

---

attr_zone_id^Required

attr_zone_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute ZoneId: Zone.

---

attr_zone_local_name^Required

attr_zone_local_name: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute ZoneLocalName: Available area.

---