Acl
This class encapsulates and extends the ROS resource type ALIYUN::KAFKA::Acl, which is used to create an access control list (ACL).
Initializers
import com.aliyun.ros.cdk.kafka.Acl;
Acl.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.aclOperationTypes(IResolvable)
.aclOperationTypes(java.util.List<java.lang.String)
.aclOperationTypes(IResolvable>)
.aclResourceName(java.lang.String)
.aclResourceName(IResolvable)
.aclResourcePatternType(java.lang.String)
.aclResourcePatternType(IResolvable)
.aclResourceType(java.lang.String)
.aclResourceType(IResolvable)
.instanceId(java.lang.String)
.instanceId(IResolvable)
.username(java.lang.String)
.username(IResolvable)
// .aclPermissionType(java.lang.String)
// .aclPermissionType(IResolvable)
// .host(java.lang.String)
// .host(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. |
aclOperationTypes |
com.aliyun.ros.cdk.core.IResolvable OR java.util.List |
Property aclOperationTypes: The types of operations allowed by the ACL. |
aclResourceName |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property aclResourceName: The resource name. |
aclResourcePatternType |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property aclResourcePatternType: The matching mode. |
aclResourceType |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property aclResourceType: The resource type. |
instanceId |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property instanceId: The instance ID. |
username |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property username: The username. |
aclPermissionType |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property aclPermissionType: The authorization method. |
host |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property host: The source IP address. |
scopeRequired
- Type: com.aliyun.ros.cdk.core.Construct
idRequired
- Type: java.lang.String
enableResourcePropertyConstraintOptional
- Type: java.lang.Boolean
aclOperationTypesRequired
- Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List
Property aclOperationTypes: The types of operations allowed by the ACL.
aclResourceNameRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property aclResourceName: The resource name.
The value can be a topic name, a group ID, a cluster name, or a transaction ID. You can use an asterisk () to specify the names of all resources of the specified type. Note You can use an asterisk () to query the resources on which permissions are granted only after you grant the user the required permissions on all resources.
aclResourcePatternTypeRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property aclResourcePatternType: The matching mode.
Valid values: LITERAL: exact match PREFIXED: prefix match
aclResourceTypeRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property aclResourceType: The resource type.
Valid values: Topic Group Cluster TransactionalId: transactional ID
instanceIdRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property instanceId: The instance ID.
usernameRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property username: The username.
You can use an asterisk () to specify all usernames. Note You can use an asterisk () to query the authorized users only after you grant the required permissions to all users.
aclPermissionTypeOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property aclPermissionType: The authorization method.
Valid values: DENY ALLOW Note This parameter is available only for ApsaraMQ for Kafka V3 serverless instances.
hostOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property host: The source IP address.
Note You can specify only a specific IP address or use the asterisk (*) wildcard character to specify all IP addresses. CIDR blocks are not supported. This parameter is available only for ApsaraMQ for Kafka V3 serverless instances.
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. |
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
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.kafka.Acl;
Acl.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. |
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. |
attrAclResourceType |
com.aliyun.ros.cdk.core.IResolvable |
Attribute AclResourceType: The resource type. |
attrInstanceId |
com.aliyun.ros.cdk.core.IResolvable |
Attribute InstanceId: The instance ID. |
attrUsername |
com.aliyun.ros.cdk.core.IResolvable |
Attribute Username: The username. |
nodeRequired
public ConstructNode getNode();
- Type: com.aliyun.ros.cdk.core.ConstructNode
The construct tree node associated with this construct.
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
attrAclResourceTypeRequired
public IResolvable getAttrAclResourceType();
- Type: com.aliyun.ros.cdk.core.IResolvable
Attribute AclResourceType: The resource type.
attrInstanceIdRequired
public IResolvable getAttrInstanceId();
- Type: com.aliyun.ros.cdk.core.IResolvable
Attribute InstanceId: The instance ID.
attrUsernameRequired
public IResolvable getAttrUsername();
- Type: com.aliyun.ros.cdk.core.IResolvable
Attribute Username: The username.