Acl
This class encapsulates and extends the ROS resource type ALIYUN::KAFKA::Acl
.
Initializers
import ros_cdk_kafka
ros_cdk_kafka.Acl(
scope: Construct,
id: str,
acl_operation_types: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]],
acl_resource_name: typing.Union[str, IResolvable],
acl_resource_pattern_type: typing.Union[str, IResolvable],
acl_resource_type: typing.Union[str, IResolvable],
instance_id: typing.Union[str, IResolvable],
username: typing.Union[str, IResolvable],
acl_permission_type: typing.Union[str, IResolvable] = None,
host: 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. |
acl_operation_types |
typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] |
Property aclOperationTypes: The types of operations allowed by the ACL. |
acl_resource_name |
typing.Union[str, ros_cdk_core.IResolvable] |
Property aclResourceName: The resource name. |
acl_resource_pattern_type |
typing.Union[str, ros_cdk_core.IResolvable] |
Property aclResourcePatternType: The matching mode. |
acl_resource_type |
typing.Union[str, ros_cdk_core.IResolvable] |
Property aclResourceType: The resource type. |
instance_id |
typing.Union[str, ros_cdk_core.IResolvable] |
Property instanceId: The instance ID. |
username |
typing.Union[str, ros_cdk_core.IResolvable] |
Property username: The username. |
acl_permission_type |
typing.Union[str, ros_cdk_core.IResolvable] |
Property aclPermissionType: The authorization method. |
host |
typing.Union[str, ros_cdk_core.IResolvable] |
Property host: The source IP address. |
enable_resource_property_constraint |
bool |
No description. |
scope
Required
- Type: ros_cdk_core.Construct
id
Required
- Type: str
acl_operation_types
Required
- Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]
Property aclOperationTypes: The types of operations allowed by the ACL.
acl_resource_name
Required
- Type: typing.Union[str, 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.
acl_resource_pattern_type
Required
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property aclResourcePatternType: The matching mode.
Valid values: LITERAL: exact match PREFIXED: prefix match
acl_resource_type
Required
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property aclResourceType: The resource type.
Valid values: Topic Group Cluster TransactionalId: transactional ID
instance_id
Required
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property instanceId: The instance ID.
username
Required
- Type: typing.Union[str, 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.
acl_permission_type
Optional
- Type: typing.Union[str, 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.
host
Optional
- Type: typing.Union[str, 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.
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_kafka
ros_cdk_kafka.Acl.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_acl_resource_type |
ros_cdk_core.IResolvable |
Attribute AclResourceType: The resource type. |
attr_instance_id |
ros_cdk_core.IResolvable |
Attribute InstanceId: The instance ID. |
attr_username |
ros_cdk_core.IResolvable |
Attribute Username: The username. |
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_acl_resource_type
Required
attr_acl_resource_type: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute AclResourceType: The resource type.
attr_instance_id
Required
attr_instance_id: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute InstanceId: The instance ID.
attr_username
Required
attr_username: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute Username: The username.