ConsumerGroup
This class encapsulates and extends the ROS resource type ALIYUN::ROCKETMQ5::ConsumerGroup
, which is used to create a consumer group in ApsaraMQ for RocketMQ 5.0.
Initializers
import ros_cdk_rocketmq5
ros_cdk_rocketmq5.ConsumerGroup(
scope: Construct,
id: str,
consume_retry_policy: typing.Union[IResolvable, ConsumeRetryPolicyProperty],
consumer_group_id: typing.Union[str, IResolvable],
delivery_order_type: typing.Union[str, IResolvable],
instance_id: typing.Union[str, IResolvable],
remark: 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. |
consume_retry_policy |
typing.Union[ros_cdk_core.IResolvable, ConsumeRetryPolicyProperty] |
Property consumeRetryPolicy: The consumption retry policy of the consumer group to be created. |
consumer_group_id |
typing.Union[str, ros_cdk_core.IResolvable] |
Property consumerGroupId: The ID of the consumer group to be created. |
delivery_order_type |
typing.Union[str, ros_cdk_core.IResolvable] |
Property deliveryOrderType: Delivery sequence of the consumer group to be created. |
instance_id |
typing.Union[str, ros_cdk_core.IResolvable] |
Property instanceId: The ID of the instance. |
remark |
typing.Union[str, ros_cdk_core.IResolvable] |
Property remark: The remark of the consumer group to be created. |
enable_resource_property_constraint |
bool |
No description. |
scope
Required
- Type: ros_cdk_core.Construct
id
Required
- Type: str
consume_retry_policy
Required
- Type: typing.Union[ros_cdk_core.IResolvable, ConsumeRetryPolicyProperty]
Property consumeRetryPolicy: The consumption retry policy of the consumer group to be created.
consumer_group_id
Required
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property consumerGroupId: The ID of the consumer group to be created.
Used to identify consumer groups, globally unique. The value description is as follows: Character limitation: supports letters a~z or A-Z, numbers 0-9, underscore (_), dash (-) and percent sign (%). Length limit: 1-60 characters.
delivery_order_type
Required
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property deliveryOrderType: Delivery sequence of the consumer group to be created.
instance_id
Required
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property instanceId: The ID of the instance.
remark
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property remark: The remark of the consumer group to be created.
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.
- Type: ros_cdk_core.ISynthesisSession
The synthesis session.
add_condition
def add_condition(
condition: RosCondition
) -> None
- Type: ros_cdk_core.RosCondition
add_count
def add_count(
count: typing.Union[typing.Union[int, float], IResolvable]
) -> None
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
add_dependency
def add_dependency(
resource: Resource
) -> None
- Type: ros_cdk_core.Resource
add_resource_desc
def add_resource_desc(
desc: str
) -> None
- Type: str
apply_removal_policy
def apply_removal_policy(
policy: RemovalPolicy
) -> None
- Type: ros_cdk_core.RemovalPolicy
get_att
def get_att(
name: str
) -> IResolvable
- Type: str
set_metadata
def set_metadata(
key: str,
value: typing.Any
) -> None
- Type: str
- Type: typing.Any
Static Functions
Name | Description |
---|---|
is_construct |
Return whether the given object is a Construct. |
is_construct
import ros_cdk_rocketmq5
ros_cdk_rocketmq5.ConsumerGroup.is_construct(
x: typing.Any
)
Return whether the given object is a Construct.
- 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_consumer_group_id |
ros_cdk_core.IResolvable |
Attribute ConsumerGroupId: The ID of the consumer group. |
attr_delivery_order_type |
ros_cdk_core.IResolvable |
Attribute DeliveryOrderType: Delivery sequence of consumer group. |
attr_instance_id |
ros_cdk_core.IResolvable |
Attribute InstanceId: The ID of the instance. |
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_consumer_group_id
Required
attr_consumer_group_id: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute ConsumerGroupId: The ID of the consumer group.
attr_delivery_order_type
Required
attr_delivery_order_type: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute DeliveryOrderType: Delivery sequence of consumer group.
attr_instance_id
Required
attr_instance_id: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute InstanceId: The ID of the instance.