ConsumerGroup
- Implements: IConsumerGroup
This class encapsulates and extends the ROS resource type ALIYUN::DTS::ConsumerGroup.
Initializers
import com.aliyun.ros.cdk.dts.ConsumerGroup;
ConsumerGroup.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.consumerGroupName(java.lang.String)
.consumerGroupName(IResolvable)
.consumerGroupPassword(java.lang.String)
.consumerGroupPassword(IResolvable)
.consumerGroupUserName(java.lang.String)
.consumerGroupUserName(IResolvable)
.subscriptionInstanceId(java.lang.String)
.subscriptionInstanceId(IResolvable)
.build();
| Name | Type | Description |
|---|---|---|
scope | com.aliyun.ros.cdk.core.Construct | No description. |
id | java.lang.String | No description. |
enableResourcePropertyConstraint | java.lang.Boolean | No description. |
consumerGroupName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property consumerGroupName: Consumer group name. |
consumerGroupPassword | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property consumerGroupPassword: Password of consumer group. |
consumerGroupUserName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property consumerGroupUserName: User name of consumer group. |
subscriptionInstanceId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property subscriptionInstanceId: Subscription instance ID. |
scopeRequired
- Type: com.aliyun.ros.cdk.core.Construct
idRequired
- Type: java.lang.String
enableResourcePropertyConstraintOptional
- Type: java.lang.Boolean
consumerGroupNameRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property consumerGroupName: Consumer group name.
consumerGroupPasswordRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property consumerGroupPassword: Password of consumer group.
consumerGroupUserNameRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property consumerGroupUserName: User name of consumer group.
subscriptionInstanceIdRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property subscriptionInstanceId: Subscription instance ID.
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 java.lang.String toString()
Returns a string representation of this construct.
synthesize
public void synthesize(ISynthesisSession session)
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: com.aliyun.ros.cdk.core.ISynthesisSession
The synthesis session.
addCondition
public void addCondition(RosCondition condition)
- Type: com.aliyun.ros.cdk.core.RosCondition
addCount
public void addCount(java.lang.Number OR IResolvable count)
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
addDependency
public void addDependency(Resource resource)
- Type: com.aliyun.ros.cdk.core.Resource
addResourceDesc
public void addResourceDesc(java.lang.String desc)
- Type: java.lang.String
applyRemovalPolicy
public void applyRemovalPolicy(RemovalPolicy policy)
- Type: com.aliyun.ros.cdk.core.RemovalPolicy
fetchCondition
public RosCondition fetchCondition()
fetchDependency
public java.util.List<java.lang.String> fetchDependency()
fetchResourceDesc
public java.lang.String fetchResourceDesc()
getAtt
public IResolvable getAtt(java.lang.String name)
- Type: java.lang.String
setMetadata
public void setMetadata(java.lang.String key, java.lang.Object value)
- Type: java.lang.String
- Type: java.lang.Object
Static Functions
| Name | Description |
|---|---|
isConstruct | Return whether the given object is a Construct. |
isConstruct
import com.aliyun.ros.cdk.dts.ConsumerGroup;
ConsumerGroup.isConstruct(java.lang.Object x)
Return whether the given object is a Construct.
- Type: java.lang.Object
Properties
| Name | Type | Description |
|---|---|---|
node | com.aliyun.ros.cdk.core.ConstructNode | The construct tree node associated with this construct. |
env | com.aliyun.ros.cdk.core.IResourceEnvironment | The environment this resource belongs to. |
ref | java.lang.String | No description. |
stack | com.aliyun.ros.cdk.core.Stack | The stack in which this resource is defined. |
resource | com.aliyun.ros.cdk.core.RosResource | No description. |
attrConsumerGroupId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ConsumerGroupID: Consumer group ID. |
attrConsumerGroupName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ConsumerGroupName: Consumer group name. |
attrSubscriptionInstanceId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute SubscriptionInstanceId: Subscription instance ID. |
props | ConsumerGroupProps | No description. |
nodeRequired
public ConstructNode getNode();
- Type: com.aliyun.ros.cdk.core.ConstructNode
The construct tree node associated with this construct.
envRequired
public IResourceEnvironment getEnv();
- Type: com.aliyun.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 java.lang.String getRef();
- Type: java.lang.String
stackRequired
public Stack getStack();
- Type: com.aliyun.ros.cdk.core.Stack
The stack in which this resource is defined.
resourceOptional
public RosResource getResource();
- Type: com.aliyun.ros.cdk.core.RosResource
attrConsumerGroupIdRequired
public java.lang.Object getAttrConsumerGroupId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ConsumerGroupID: Consumer group ID.
attrConsumerGroupNameRequired
public java.lang.Object getAttrConsumerGroupName();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ConsumerGroupName: Consumer group name.
attrSubscriptionInstanceIdRequired
public java.lang.Object getAttrSubscriptionInstanceId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute SubscriptionInstanceId: Subscription instance ID.
propsRequired
public ConsumerGroupProps getProps();
- Type: ConsumerGroupProps