Acl

• Implements: IAcl

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
)

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

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.

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

count^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

import ros_cdk_kafka
ros_cdk_kafka.Acl.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

• Type: 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.

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: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute AclResourceType: The resource type.

attr_instance_id^Required

attr_instance_id: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute InstanceId: The instance ID.

attr_username^Required

attr_username: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute Username: The username.

props^Required

props: AclProps

• Type: AclProps