Skip to content

ConsumerGroup

  • Implements: @alicloud/ros-cdk-rocketmq5.datasource.IConsumerGroup

This class encapsulates and extends the ROS resource type DATASOURCE::ROCKETMQ5::ConsumerGroup.

Initializers

import { datasource } from '@alicloud/ros-cdk-rocketmq5'
new datasource.ConsumerGroup(scope: Construct, id: string, props: ConsumerGroupProps, enableResourcePropertyConstraint?: boolean)
Name Type Description
scope @alicloud/ros-cdk-core.Construct No description.
id string No description.
props ConsumerGroupProps No description.
enableResourcePropertyConstraint boolean No description.

scopeRequired

  • Type: @alicloud/ros-cdk-core.Construct

idRequired

  • Type: string

propsRequired


enableResourcePropertyConstraintOptional

  • Type: boolean

Methods

Name Description
toString Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition No description.
addCount No description.
addDependency No description.
addResourceDesc No description.
applyRemovalPolicy No description.
fetchCondition No description.
fetchDependency No description.
fetchResourceDesc No description.
getAtt No description.
setMetadata No description.

toString

public toString(): string

Returns a string representation of this construct.

synthesize

public synthesize(session: ISynthesisSession): void

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.

sessionRequired

  • Type: @alicloud/ros-cdk-core.ISynthesisSession

The synthesis session.


addCondition

public addCondition(condition: RosCondition): void

conditionRequired

  • Type: @alicloud/ros-cdk-core.RosCondition

addCount

public addCount(count: number | IResolvable): void

countRequired

  • Type: number | @alicloud/ros-cdk-core.IResolvable

addDependency

public addDependency(resource: Resource): void

resourceRequired

  • Type: @alicloud/ros-cdk-core.Resource

addResourceDesc

public addResourceDesc(desc: string): void

descRequired

  • Type: string

applyRemovalPolicy

public applyRemovalPolicy(policy: RemovalPolicy): void

policyRequired

  • Type: @alicloud/ros-cdk-core.RemovalPolicy

fetchCondition

public fetchCondition(): RosCondition

fetchDependency

public fetchDependency(): string[]

fetchResourceDesc

public fetchResourceDesc(): string

getAtt

public getAtt(name: string): IResolvable

nameRequired

  • Type: string

setMetadata

public setMetadata(key: string, value: any): void

keyRequired

  • Type: string

valueRequired

  • Type: any

Static Functions

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

isConstruct

import { datasource } from '@alicloud/ros-cdk-rocketmq5'
datasource.ConsumerGroup.isConstruct(x: any)

Return whether the given object is a Construct.

xRequired

  • Type: any

Properties

Name Type Description
node @alicloud/ros-cdk-core.ConstructNode The construct tree node associated with this construct.
env @alicloud/ros-cdk-core.IResourceEnvironment The environment this resource belongs to.
ref string No description.
stack @alicloud/ros-cdk-core.Stack The stack in which this resource is defined.
resource @alicloud/ros-cdk-core.RosResource No description.
attrConsumeRetryPolicy string | @alicloud/ros-cdk-core.IResolvable Attribute ConsumeRetryPolicy: The consumption retry policy that you want to configure for the consumer group.
attrConsumerGroupId string | @alicloud/ros-cdk-core.IResolvable Attribute ConsumerGroupId: The ID of the consumer group.
attrCreateTime string | @alicloud/ros-cdk-core.IResolvable Attribute CreateTime: The time when the consumer group was created.
attrDeliveryOrderType string | @alicloud/ros-cdk-core.IResolvable Attribute DeliveryOrderType: The message delivery order of the consumer group.
attrInstanceId string | @alicloud/ros-cdk-core.IResolvable Attribute InstanceId: The ID of the RocketMQ instance.
attrRemark string | @alicloud/ros-cdk-core.IResolvable Attribute Remark: The remarks on the consumer group.
attrStatus string | @alicloud/ros-cdk-core.IResolvable Attribute Status: The state of the consumer group.
attrUpdateTime string | @alicloud/ros-cdk-core.IResolvable Attribute UpdateTime: The time when the consumer group was last updated.
props ConsumerGroupProps No description.

nodeRequired

public readonly node: ConstructNode;
  • Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node associated with this construct.


envRequired

public readonly env: IResourceEnvironment;
  • Type: @alicloud/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.


refRequired

public readonly ref: string;
  • Type: string

stackRequired

public readonly stack: Stack;
  • Type: @alicloud/ros-cdk-core.Stack

The stack in which this resource is defined.


resourceOptional

public readonly resource: RosResource;
  • Type: @alicloud/ros-cdk-core.RosResource

attrConsumeRetryPolicyRequired

public readonly attrConsumeRetryPolicy: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute ConsumeRetryPolicy: The consumption retry policy that you want to configure for the consumer group.


attrConsumerGroupIdRequired

public readonly attrConsumerGroupId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute ConsumerGroupId: The ID of the consumer group.


attrCreateTimeRequired

public readonly attrCreateTime: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute CreateTime: The time when the consumer group was created.


attrDeliveryOrderTypeRequired

public readonly attrDeliveryOrderType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute DeliveryOrderType: The message delivery order of the consumer group.


attrInstanceIdRequired

public readonly attrInstanceId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute InstanceId: The ID of the RocketMQ instance.


attrRemarkRequired

public readonly attrRemark: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute Remark: The remarks on the consumer group.


attrStatusRequired

public readonly attrStatus: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute Status: The state of the consumer group.


attrUpdateTimeRequired

public readonly attrUpdateTime: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute UpdateTime: The time when the consumer group was last updated.


propsRequired

public readonly props: ConsumerGroupProps;