ConsumerChannel

• Implements: IConsumerChannel

This class encapsulates and extends the ROS resource type ALIYUN::DTS::ConsumerChannel.

Initializers

import ros_cdk_dts
ros_cdk_dts.ConsumerChannel(
  scope: Construct,
  id: str,
  consumer_group_name: typing.Union[str, IResolvable],
  consumer_group_password: typing.Union[str, IResolvable],
  consumer_group_user_name: typing.Union[str, IResolvable],
  dts_instance_id: typing.Union[str, IResolvable] = None,
  dts_job_id: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

consumer_group_name^Required

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

Property consumerGroupName: Consumer group name, up to 128 characters.

consumer_group_password^Required

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

Property consumerGroupPassword: Consumer group password, composed of uppercase letters, lowercase letters, numbers, and special characters (at least two types), 8-32 characters long.

consumer_group_user_name^Required

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

Property consumerGroupUserName: Username, composed of uppercase letters, lowercase letters, numbers, and underscores, up to 16 characters.

dts_instance_id^Optional

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

Property dtsInstanceId: DTS subscription instance ID.

Either DtsInstanceId or DtsJobId must be provided.

dts_job_id^Optional

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

Property dtsJobId: DTS subscription job ID.

Either DtsInstanceId or DtsJobId must be provided.

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

import ros_cdk_dts
ros_cdk_dts.ConsumerChannel.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_consumer_group_id^Required

attr_consumer_group_id: typing.Union[str, IResolvable]

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

Attribute ConsumerGroupId: Consumer group ID.

attr_consumer_group_name^Required

attr_consumer_group_name: typing.Union[str, IResolvable]

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

Attribute ConsumerGroupName: Consumer group name.

attr_consumer_group_user_name^Required

attr_consumer_group_user_name: typing.Union[str, IResolvable]

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

Attribute ConsumerGroupUserName: Consumer group username.

attr_dts_instance_id^Required

attr_dts_instance_id: typing.Union[str, IResolvable]

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

Attribute DtsInstanceId: DTS instance ID.

attr_dts_job_id^Required

attr_dts_job_id: typing.Union[str, IResolvable]

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

Attribute DtsJobId: DTS job ID.

props^Required

props: ConsumerChannelProps

• Type: ConsumerChannelProps