published on Monday, Mar 9, 2026 by Pulumi
published on Monday, Mar 9, 2026 by Pulumi
Import
You can import Kafka ACLs by using the Kafka cluster ID and attributes of confluent_kafka_acl resource in the format <Kafka cluster ID>/<Kafka ACL resource type>#<Kafka ACL resource name>#<Kafka ACL pattern type>#<Kafka ACL principal>#<Kafka ACL host>#<Kafka ACL operation>#<Kafka ACL permission>, for example$ export CONFLUENT_CLOUD_API_KEY="<cloud_api_key>" $ export CONFLUENT_CLOUD_API_SECRET="<cloud_api_secret>" $ export KAFKA_API_KEY="<kafka_api_key>" $ export KAFKA_API_SECRET="<kafka_api_secret>" $ export KAFKA_HTTP_ENDPOINT="<kafka_http_endpoint>"
$ pulumi import confluentcloud:index/kafkaAcl:KafkaAcl describe-cluster "lkc-12345/CLUSTER#kafka-cluster#LITERAL#User:sa-xyz123#*#DESCRIBE#ALLOW"
!> Warning: Do not forget to delete terminal command history afterwards for security purposes.
Create KafkaAcl Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new KafkaAcl(name: string, args: KafkaAclArgs, opts?: CustomResourceOptions);@overload
def KafkaAcl(resource_name: str,
args: KafkaAclArgs,
opts: Optional[ResourceOptions] = None)
@overload
def KafkaAcl(resource_name: str,
opts: Optional[ResourceOptions] = None,
credentials: Optional[KafkaAclCredentialsArgs] = None,
host: Optional[str] = None,
http_endpoint: Optional[str] = None,
kafka_cluster: Optional[KafkaAclKafkaClusterArgs] = None,
operation: Optional[str] = None,
pattern_type: Optional[str] = None,
permission: Optional[str] = None,
principal: Optional[str] = None,
resource_name_: Optional[str] = None,
resource_type: Optional[str] = None)func NewKafkaAcl(ctx *Context, name string, args KafkaAclArgs, opts ...ResourceOption) (*KafkaAcl, error)public KafkaAcl(string name, KafkaAclArgs args, CustomResourceOptions? opts = null)
public KafkaAcl(String name, KafkaAclArgs args)
public KafkaAcl(String name, KafkaAclArgs args, CustomResourceOptions options)
type: confluentcloud:KafkaAcl
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args KafkaAclArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args KafkaAclArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args KafkaAclArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args KafkaAclArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args KafkaAclArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var kafkaAclResource = new ConfluentCloud.KafkaAcl("kafkaAclResource", new()
{
Credentials = new ConfluentCloud.Inputs.KafkaAclCredentialsArgs
{
Key = "string",
Secret = "string",
},
Host = "string",
HttpEndpoint = "string",
KafkaCluster = new ConfluentCloud.Inputs.KafkaAclKafkaClusterArgs
{
Id = "string",
},
Operation = "string",
PatternType = "string",
Permission = "string",
Principal = "string",
ResourceName = "string",
ResourceType = "string",
});
example, err := confluentcloud.NewKafkaAcl(ctx, "kafkaAclResource", &confluentcloud.KafkaAclArgs{
Credentials: &confluentcloud.KafkaAclCredentialsArgs{
Key: pulumi.String("string"),
Secret: pulumi.String("string"),
},
Host: pulumi.String("string"),
HttpEndpoint: pulumi.String("string"),
KafkaCluster: &confluentcloud.KafkaAclKafkaClusterArgs{
Id: pulumi.String("string"),
},
Operation: pulumi.String("string"),
PatternType: pulumi.String("string"),
Permission: pulumi.String("string"),
Principal: pulumi.String("string"),
ResourceName: pulumi.String("string"),
ResourceType: pulumi.String("string"),
})
var kafkaAclResource = new KafkaAcl("kafkaAclResource", KafkaAclArgs.builder()
.credentials(KafkaAclCredentialsArgs.builder()
.key("string")
.secret("string")
.build())
.host("string")
.httpEndpoint("string")
.kafkaCluster(KafkaAclKafkaClusterArgs.builder()
.id("string")
.build())
.operation("string")
.patternType("string")
.permission("string")
.principal("string")
.resourceName("string")
.resourceType("string")
.build());
kafka_acl_resource = confluentcloud.KafkaAcl("kafkaAclResource",
credentials={
"key": "string",
"secret": "string",
},
host="string",
http_endpoint="string",
kafka_cluster={
"id": "string",
},
operation="string",
pattern_type="string",
permission="string",
principal="string",
resource_name_="string",
resource_type="string")
const kafkaAclResource = new confluentcloud.KafkaAcl("kafkaAclResource", {
credentials: {
key: "string",
secret: "string",
},
host: "string",
httpEndpoint: "string",
kafkaCluster: {
id: "string",
},
operation: "string",
patternType: "string",
permission: "string",
principal: "string",
resourceName: "string",
resourceType: "string",
});
type: confluentcloud:KafkaAcl
properties:
credentials:
key: string
secret: string
host: string
httpEndpoint: string
kafkaCluster:
id: string
operation: string
patternType: string
permission: string
principal: string
resourceName: string
resourceType: string
KafkaAcl Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The KafkaAcl resource accepts the following input properties:
- Credentials
Pulumi.
Confluent Cloud. Inputs. Kafka Acl Credentials - The Cluster API Credentials.
- Host string
- The host for the ACL. Should be set to
*for Confluent Cloud. - Http
Endpoint string - The REST endpoint of the Kafka cluster, for example,
https://pkc-00000.us-central1.gcp.confluent.cloud:443. - Kafka
Cluster Pulumi.Confluent Cloud. Inputs. Kafka Acl Kafka Cluster - Operation string
- The operation type for the ACL. Accepted values are:
UNKNOWN,ANY,ALL,READ,WRITE,CREATE,DELETE,ALTER,DESCRIBE,CLUSTER_ACTION,DESCRIBE_CONFIGS,ALTER_CONFIGS, andIDEMPOTENT_WRITE. - Pattern
Type string - The pattern type for the ACL. Accepted values are:
UNKNOWN,ANY,MATCH,LITERAL, andPREFIXED. - Permission string
- The permission for the ACL. Accepted values are:
UNKNOWN,ANY,DENY, andALLOW. - Principal string
- The principal for the ACL.
- Resource
Name string - The resource name for the ACL.
- Resource
Type string - The type of the resource. Accepted values are:
UNKNOWN,ANY,TOPIC,GROUP,CLUSTER,TRANSACTIONAL_ID,DELEGATION_TOKEN.
- Credentials
Kafka
Acl Credentials Args - The Cluster API Credentials.
- Host string
- The host for the ACL. Should be set to
*for Confluent Cloud. - Http
Endpoint string - The REST endpoint of the Kafka cluster, for example,
https://pkc-00000.us-central1.gcp.confluent.cloud:443. - Kafka
Cluster KafkaAcl Kafka Cluster Args - Operation string
- The operation type for the ACL. Accepted values are:
UNKNOWN,ANY,ALL,READ,WRITE,CREATE,DELETE,ALTER,DESCRIBE,CLUSTER_ACTION,DESCRIBE_CONFIGS,ALTER_CONFIGS, andIDEMPOTENT_WRITE. - Pattern
Type string - The pattern type for the ACL. Accepted values are:
UNKNOWN,ANY,MATCH,LITERAL, andPREFIXED. - Permission string
- The permission for the ACL. Accepted values are:
UNKNOWN,ANY,DENY, andALLOW. - Principal string
- The principal for the ACL.
- Resource
Name string - The resource name for the ACL.
- Resource
Type string - The type of the resource. Accepted values are:
UNKNOWN,ANY,TOPIC,GROUP,CLUSTER,TRANSACTIONAL_ID,DELEGATION_TOKEN.
- credentials
Kafka
Acl Credentials - The Cluster API Credentials.
- host String
- The host for the ACL. Should be set to
*for Confluent Cloud. - http
Endpoint String - The REST endpoint of the Kafka cluster, for example,
https://pkc-00000.us-central1.gcp.confluent.cloud:443. - kafka
Cluster KafkaAcl Kafka Cluster - operation String
- The operation type for the ACL. Accepted values are:
UNKNOWN,ANY,ALL,READ,WRITE,CREATE,DELETE,ALTER,DESCRIBE,CLUSTER_ACTION,DESCRIBE_CONFIGS,ALTER_CONFIGS, andIDEMPOTENT_WRITE. - pattern
Type String - The pattern type for the ACL. Accepted values are:
UNKNOWN,ANY,MATCH,LITERAL, andPREFIXED. - permission String
- The permission for the ACL. Accepted values are:
UNKNOWN,ANY,DENY, andALLOW. - principal String
- The principal for the ACL.
- resource
Name String - The resource name for the ACL.
- resource
Type String - The type of the resource. Accepted values are:
UNKNOWN,ANY,TOPIC,GROUP,CLUSTER,TRANSACTIONAL_ID,DELEGATION_TOKEN.
- credentials
Kafka
Acl Credentials - The Cluster API Credentials.
- host string
- The host for the ACL. Should be set to
*for Confluent Cloud. - http
Endpoint string - The REST endpoint of the Kafka cluster, for example,
https://pkc-00000.us-central1.gcp.confluent.cloud:443. - kafka
Cluster KafkaAcl Kafka Cluster - operation string
- The operation type for the ACL. Accepted values are:
UNKNOWN,ANY,ALL,READ,WRITE,CREATE,DELETE,ALTER,DESCRIBE,CLUSTER_ACTION,DESCRIBE_CONFIGS,ALTER_CONFIGS, andIDEMPOTENT_WRITE. - pattern
Type string - The pattern type for the ACL. Accepted values are:
UNKNOWN,ANY,MATCH,LITERAL, andPREFIXED. - permission string
- The permission for the ACL. Accepted values are:
UNKNOWN,ANY,DENY, andALLOW. - principal string
- The principal for the ACL.
- resource
Name string - The resource name for the ACL.
- resource
Type string - The type of the resource. Accepted values are:
UNKNOWN,ANY,TOPIC,GROUP,CLUSTER,TRANSACTIONAL_ID,DELEGATION_TOKEN.
- credentials
Kafka
Acl Credentials Args - The Cluster API Credentials.
- host str
- The host for the ACL. Should be set to
*for Confluent Cloud. - http_
endpoint str - The REST endpoint of the Kafka cluster, for example,
https://pkc-00000.us-central1.gcp.confluent.cloud:443. - kafka_
cluster KafkaAcl Kafka Cluster Args - operation str
- The operation type for the ACL. Accepted values are:
UNKNOWN,ANY,ALL,READ,WRITE,CREATE,DELETE,ALTER,DESCRIBE,CLUSTER_ACTION,DESCRIBE_CONFIGS,ALTER_CONFIGS, andIDEMPOTENT_WRITE. - pattern_
type str - The pattern type for the ACL. Accepted values are:
UNKNOWN,ANY,MATCH,LITERAL, andPREFIXED. - permission str
- The permission for the ACL. Accepted values are:
UNKNOWN,ANY,DENY, andALLOW. - principal str
- The principal for the ACL.
- resource_
name str - The resource name for the ACL.
- resource_
type str - The type of the resource. Accepted values are:
UNKNOWN,ANY,TOPIC,GROUP,CLUSTER,TRANSACTIONAL_ID,DELEGATION_TOKEN.
- credentials Property Map
- The Cluster API Credentials.
- host String
- The host for the ACL. Should be set to
*for Confluent Cloud. - http
Endpoint String - The REST endpoint of the Kafka cluster, for example,
https://pkc-00000.us-central1.gcp.confluent.cloud:443. - kafka
Cluster Property Map - operation String
- The operation type for the ACL. Accepted values are:
UNKNOWN,ANY,ALL,READ,WRITE,CREATE,DELETE,ALTER,DESCRIBE,CLUSTER_ACTION,DESCRIBE_CONFIGS,ALTER_CONFIGS, andIDEMPOTENT_WRITE. - pattern
Type String - The pattern type for the ACL. Accepted values are:
UNKNOWN,ANY,MATCH,LITERAL, andPREFIXED. - permission String
- The permission for the ACL. Accepted values are:
UNKNOWN,ANY,DENY, andALLOW. - principal String
- The principal for the ACL.
- resource
Name String - The resource name for the ACL.
- resource
Type String - The type of the resource. Accepted values are:
UNKNOWN,ANY,TOPIC,GROUP,CLUSTER,TRANSACTIONAL_ID,DELEGATION_TOKEN.
Outputs
All input properties are implicitly available as output properties. Additionally, the KafkaAcl resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing KafkaAcl Resource
Get an existing KafkaAcl resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: KafkaAclState, opts?: CustomResourceOptions): KafkaAcl@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
credentials: Optional[KafkaAclCredentialsArgs] = None,
host: Optional[str] = None,
http_endpoint: Optional[str] = None,
kafka_cluster: Optional[KafkaAclKafkaClusterArgs] = None,
operation: Optional[str] = None,
pattern_type: Optional[str] = None,
permission: Optional[str] = None,
principal: Optional[str] = None,
resource_name: Optional[str] = None,
resource_type: Optional[str] = None) -> KafkaAclfunc GetKafkaAcl(ctx *Context, name string, id IDInput, state *KafkaAclState, opts ...ResourceOption) (*KafkaAcl, error)public static KafkaAcl Get(string name, Input<string> id, KafkaAclState? state, CustomResourceOptions? opts = null)public static KafkaAcl get(String name, Output<String> id, KafkaAclState state, CustomResourceOptions options)resources: _: type: confluentcloud:KafkaAcl get: id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Credentials
Pulumi.
Confluent Cloud. Inputs. Kafka Acl Credentials - The Cluster API Credentials.
- Host string
- The host for the ACL. Should be set to
*for Confluent Cloud. - Http
Endpoint string - The REST endpoint of the Kafka cluster, for example,
https://pkc-00000.us-central1.gcp.confluent.cloud:443. - Kafka
Cluster Pulumi.Confluent Cloud. Inputs. Kafka Acl Kafka Cluster - Operation string
- The operation type for the ACL. Accepted values are:
UNKNOWN,ANY,ALL,READ,WRITE,CREATE,DELETE,ALTER,DESCRIBE,CLUSTER_ACTION,DESCRIBE_CONFIGS,ALTER_CONFIGS, andIDEMPOTENT_WRITE. - Pattern
Type string - The pattern type for the ACL. Accepted values are:
UNKNOWN,ANY,MATCH,LITERAL, andPREFIXED. - Permission string
- The permission for the ACL. Accepted values are:
UNKNOWN,ANY,DENY, andALLOW. - Principal string
- The principal for the ACL.
- Resource
Name string - The resource name for the ACL.
- Resource
Type string - The type of the resource. Accepted values are:
UNKNOWN,ANY,TOPIC,GROUP,CLUSTER,TRANSACTIONAL_ID,DELEGATION_TOKEN.
- Credentials
Kafka
Acl Credentials Args - The Cluster API Credentials.
- Host string
- The host for the ACL. Should be set to
*for Confluent Cloud. - Http
Endpoint string - The REST endpoint of the Kafka cluster, for example,
https://pkc-00000.us-central1.gcp.confluent.cloud:443. - Kafka
Cluster KafkaAcl Kafka Cluster Args - Operation string
- The operation type for the ACL. Accepted values are:
UNKNOWN,ANY,ALL,READ,WRITE,CREATE,DELETE,ALTER,DESCRIBE,CLUSTER_ACTION,DESCRIBE_CONFIGS,ALTER_CONFIGS, andIDEMPOTENT_WRITE. - Pattern
Type string - The pattern type for the ACL. Accepted values are:
UNKNOWN,ANY,MATCH,LITERAL, andPREFIXED. - Permission string
- The permission for the ACL. Accepted values are:
UNKNOWN,ANY,DENY, andALLOW. - Principal string
- The principal for the ACL.
- Resource
Name string - The resource name for the ACL.
- Resource
Type string - The type of the resource. Accepted values are:
UNKNOWN,ANY,TOPIC,GROUP,CLUSTER,TRANSACTIONAL_ID,DELEGATION_TOKEN.
- credentials
Kafka
Acl Credentials - The Cluster API Credentials.
- host String
- The host for the ACL. Should be set to
*for Confluent Cloud. - http
Endpoint String - The REST endpoint of the Kafka cluster, for example,
https://pkc-00000.us-central1.gcp.confluent.cloud:443. - kafka
Cluster KafkaAcl Kafka Cluster - operation String
- The operation type for the ACL. Accepted values are:
UNKNOWN,ANY,ALL,READ,WRITE,CREATE,DELETE,ALTER,DESCRIBE,CLUSTER_ACTION,DESCRIBE_CONFIGS,ALTER_CONFIGS, andIDEMPOTENT_WRITE. - pattern
Type String - The pattern type for the ACL. Accepted values are:
UNKNOWN,ANY,MATCH,LITERAL, andPREFIXED. - permission String
- The permission for the ACL. Accepted values are:
UNKNOWN,ANY,DENY, andALLOW. - principal String
- The principal for the ACL.
- resource
Name String - The resource name for the ACL.
- resource
Type String - The type of the resource. Accepted values are:
UNKNOWN,ANY,TOPIC,GROUP,CLUSTER,TRANSACTIONAL_ID,DELEGATION_TOKEN.
- credentials
Kafka
Acl Credentials - The Cluster API Credentials.
- host string
- The host for the ACL. Should be set to
*for Confluent Cloud. - http
Endpoint string - The REST endpoint of the Kafka cluster, for example,
https://pkc-00000.us-central1.gcp.confluent.cloud:443. - kafka
Cluster KafkaAcl Kafka Cluster - operation string
- The operation type for the ACL. Accepted values are:
UNKNOWN,ANY,ALL,READ,WRITE,CREATE,DELETE,ALTER,DESCRIBE,CLUSTER_ACTION,DESCRIBE_CONFIGS,ALTER_CONFIGS, andIDEMPOTENT_WRITE. - pattern
Type string - The pattern type for the ACL. Accepted values are:
UNKNOWN,ANY,MATCH,LITERAL, andPREFIXED. - permission string
- The permission for the ACL. Accepted values are:
UNKNOWN,ANY,DENY, andALLOW. - principal string
- The principal for the ACL.
- resource
Name string - The resource name for the ACL.
- resource
Type string - The type of the resource. Accepted values are:
UNKNOWN,ANY,TOPIC,GROUP,CLUSTER,TRANSACTIONAL_ID,DELEGATION_TOKEN.
- credentials
Kafka
Acl Credentials Args - The Cluster API Credentials.
- host str
- The host for the ACL. Should be set to
*for Confluent Cloud. - http_
endpoint str - The REST endpoint of the Kafka cluster, for example,
https://pkc-00000.us-central1.gcp.confluent.cloud:443. - kafka_
cluster KafkaAcl Kafka Cluster Args - operation str
- The operation type for the ACL. Accepted values are:
UNKNOWN,ANY,ALL,READ,WRITE,CREATE,DELETE,ALTER,DESCRIBE,CLUSTER_ACTION,DESCRIBE_CONFIGS,ALTER_CONFIGS, andIDEMPOTENT_WRITE. - pattern_
type str - The pattern type for the ACL. Accepted values are:
UNKNOWN,ANY,MATCH,LITERAL, andPREFIXED. - permission str
- The permission for the ACL. Accepted values are:
UNKNOWN,ANY,DENY, andALLOW. - principal str
- The principal for the ACL.
- resource_
name str - The resource name for the ACL.
- resource_
type str - The type of the resource. Accepted values are:
UNKNOWN,ANY,TOPIC,GROUP,CLUSTER,TRANSACTIONAL_ID,DELEGATION_TOKEN.
- credentials Property Map
- The Cluster API Credentials.
- host String
- The host for the ACL. Should be set to
*for Confluent Cloud. - http
Endpoint String - The REST endpoint of the Kafka cluster, for example,
https://pkc-00000.us-central1.gcp.confluent.cloud:443. - kafka
Cluster Property Map - operation String
- The operation type for the ACL. Accepted values are:
UNKNOWN,ANY,ALL,READ,WRITE,CREATE,DELETE,ALTER,DESCRIBE,CLUSTER_ACTION,DESCRIBE_CONFIGS,ALTER_CONFIGS, andIDEMPOTENT_WRITE. - pattern
Type String - The pattern type for the ACL. Accepted values are:
UNKNOWN,ANY,MATCH,LITERAL, andPREFIXED. - permission String
- The permission for the ACL. Accepted values are:
UNKNOWN,ANY,DENY, andALLOW. - principal String
- The principal for the ACL.
- resource
Name String - The resource name for the ACL.
- resource
Type String - The type of the resource. Accepted values are:
UNKNOWN,ANY,TOPIC,GROUP,CLUSTER,TRANSACTIONAL_ID,DELEGATION_TOKEN.
Supporting Types
KafkaAclCredentials, KafkaAclCredentialsArgs
KafkaAclKafkaCluster, KafkaAclKafkaClusterArgs
- Id string
- The ID of the Kafka cluster, for example,
lkc-abc123.
- Id string
- The ID of the Kafka cluster, for example,
lkc-abc123.
- id String
- The ID of the Kafka cluster, for example,
lkc-abc123.
- id string
- The ID of the Kafka cluster, for example,
lkc-abc123.
- id str
- The ID of the Kafka cluster, for example,
lkc-abc123.
- id String
- The ID of the Kafka cluster, for example,
lkc-abc123.
Package Details
- Repository
- Confluent Cloud pulumi/pulumi-confluentcloud
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
confluentTerraform Provider.
published on Monday, Mar 9, 2026 by Pulumi
