DeliveryChannel

This class encapsulates and extends the ROS resource type ALIYUN::Config::DeliveryChannel, which is used to create or update a delivery channel.

Initializers

import ros_cdk_config
ros_cdk_config.DeliveryChannel(
  scope: Construct,
  id: str,
  delivery_channel_assume_role_arn: typing.Union[str, IResolvable],
  delivery_channel_target_arn: typing.Union[str, IResolvable],
  delivery_channel_type: typing.Union[str, IResolvable],
  delivery_channel_condition: typing.Union[str, IResolvable] = None,
  delivery_channel_name: typing.Union[str, IResolvable] = None,
  description: 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.
delivery_channel_assume_role_arn	typing.Union[str, ros_cdk_core.IResolvable]	Property deliveryChannelAssumeRoleArn: The Alibaba Cloud Resource Name (ARN) of the role to be assumed by the delivery method.
delivery_channel_target_arn	typing.Union[str, ros_cdk_core.IResolvable]	Property deliveryChannelTargetArn: The ARN of the delivery destination.
delivery_channel_type	typing.Union[str, ros_cdk_core.IResolvable]	Property deliveryChannelType: The type of the delivery method.
delivery_channel_condition	typing.Union[str, ros_cdk_core.IResolvable]	Property deliveryChannelCondition: The rule attached to the delivery method.
delivery_channel_name	typing.Union[str, ros_cdk_core.IResolvable]	Property deliveryChannelName: The name of the delivery method.
description	typing.Union[str, ros_cdk_core.IResolvable]	Property description: The description of the delivery method.
enable_resource_property_constraint	bool	No description.

---

scope^Required

• Type: ros_cdk_core.Construct

---

id^Required

• Type: str

---

delivery_channel_assume_role_arn^Required

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

Property deliveryChannelAssumeRoleArn: The Alibaba Cloud Resource Name (ARN) of the role to be assumed by the delivery method.

This parameter is required when you create a delivery method. Note If the delivery method assumes the service linked role for Cloud Config, you can specify the ARN in the format of the provided example and replace the account ID with the ID of your Alibaba Cloud account.

---

delivery_channel_target_arn^Required

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

Property deliveryChannelTargetArn: The ARN of the delivery destination.

This parameter is required when you create a delivery method. The value must be in one of the following formats: acs:oss:{RegionId}:{Aliuid}:{bucketName} if your delivery destination is an Object Storage Service (OSS) bucket. acs:mns:{RegionId}:{Aliuid}:/topics/{topicName} if your delivery destination is a Message Service (MNS) topic. acs:log:{RegionId}:{Aliuid}:project/{projectName}/logstore/{logstoreName} if your delivery destination is a Log Service Logstore.

---

delivery_channel_type^Required

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

Property deliveryChannelType: The type of the delivery method.

This parameter is required when you create a delivery method. Valid values: OSS MNS SLS

---

delivery_channel_condition^Optional

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

Property deliveryChannelCondition: The rule attached to the delivery method.

This parameter is applicable only to delivery methods of the MNS type. This parameter allows you to specify the lowest risk level for the events to subscribe to and the resource types for which you want to subscribe to events. To specify the lowest risk level for the events to subscribe to, use the following format:{"filterType":"RuleRiskLevel","value":"1","multiple":false}. The value field indicates the lowest risk level and can be set to 1, 2, or 3, which indicates the high risk level, the medium risk level, and the low risk level, respectively. To specify the resource types for which you want to subscribe to events, use the following format:{"filterType":"ResourceType","values":["ACS::ACK::Cluster","ACS::ActionTrail::Trail","ACS::CBWP::CommonBandwidthPackage"],"multiple":true}. The values field indicates the resource types. Its value is a JSON array. Example: [{"filterType":"ResourceType","values":["ACS::ActionTrail::Trail","ACS::CBWP::CommonBandwidthPackage","ACS::CDN::Domain","ACS::CEN::CenBandwidthPackage","ACS::CEN::CenInstance","ACS::CEN::Flowlog","ACS::DdosCoo::Instance"],"multiple":true}]

---

delivery_channel_name^Optional

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

Property deliveryChannelName: The name of the delivery method.

---

description^Optional

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

Property description: The description of the delivery method.

---

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_config
ros_cdk_config.DeliveryChannel.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_delivery_channel_id	ros_cdk_core.IResolvable	Attribute DeliveryChannelId: The ID of the delivery method.

---

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

attr_delivery_channel_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute DeliveryChannelId: The ID of the delivery method.

---