CustomResource

This class encapsulates and extends the ROS resource type ALIYUN::ROS::CustomResource, which is used to create a custom resource.

Initializers

import ros_cdk_ros
ros_cdk_ros.CustomResource(
  scope: Construct,
  id: str,
  service_token: typing.Union[str, IResolvable],
  timeout: typing.Union[typing.Union[int, float], IResolvable],
  http_config: typing.Union[IResolvable, HttpConfigProperty] = None,
  parameters: typing.Union[IResolvable, typing.Mapping[typing.Any]] = None,
  enable_resource_property_constraint: bool = None
)

Name	Type	Description
scope	ros_cdk_core.Construct	No description.
id	str	No description.
service_token	typing.Union[str, ros_cdk_core.IResolvable]	Property serviceToken: The service token that was given to the template developer by the service provider to access the service.
timeout	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	Property timeout: Timeout seconds before service provider responses.
http_config	typing.Union[ros_cdk_core.IResolvable, HttpConfigProperty]	Property httpConfig: Config for HTTP&HTTPS service provider.
parameters	typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]]	Property parameters: Parameters to be passed to service provider.
enable_resource_property_constraint	bool	No description.

---

scope^Required

• Type: ros_cdk_core.Construct

---

id^Required

• Type: str

---

service_token^Required

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

Property serviceToken: The service token that was given to the template developer by the service provider to access the service.

Allowed values:

• Function Compute: acs:fc:::services//functions/
• MNS Queue: acs:mns:::queues/ or acs:mns:::/queues/
• MNS Topic: acs:mns:::topics/ or acs:mns:::/topics/

• HTTP&HTTPS: web[options]: Two options are supported:

• sync: sync HTTP&HTTPS request.

• idempotent: indicates that the Create request is idempotent. Update and Delete requests should be always idempotent. Examples:
• acs:fc:cn-hangzhou:123456789:services/test-service/functions/test-function
• acs:mns:cn-hangzhou:123456789:queues/test-queue
• acs:mns:cn-hangzhou:123456789:/queues/test-queue
• acs:mns:cn-hangzhou:123456789:topics/test-topic
• acs:mns:cn-hangzhou:123456789:/topics/test-topic
• web:https://abc.com
• web[sync]:http://abc.com
• web[sync,idempotent]:https://abc.com

---

timeout^Required

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

Property timeout: Timeout seconds before service provider responses.

It takes effects only if the type of ServiceToken is Function Compute, MNS Queue, MNS Topic or async HTTP&HTTPS request. Timeout seconds are always 10 for sync HTTP&HTTPS request.

---

http_config^Optional

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

Property httpConfig: Config for HTTP&HTTPS service provider.

---

parameters^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]]

Property parameters: Parameters to be passed to service provider.

---

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

import ros_cdk_ros
ros_cdk_ros.CustomResource.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_outputs	ros_cdk_core.IResolvable	Attribute Outputs: Output data received from service provider.

---

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

attr_outputs: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute Outputs: Output data received from service provider.

---