confluentcloud logo
Confluent v1.8.0, Jan 26 23

confluentcloud.KafkaAcl

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 exampleOption #1Manage multiple Kafka clusters in the same Terraform workspace $ export CONFLUENT_CLOUD_API_KEY="<cloud_api_key>" $ export CONFLUENT_CLOUD_API_SECRET="<cloud_api_secret>" $ export IMPORT_KAFKA_API_KEY="<kafka_api_key>" $ export IMPORT_KAFKA_API_SECRET="<kafka_api_secret>" $ export IMPORT_KAFKA_REST_ENDPOINT="<kafka_rest_endpoint>"

 $ pulumi import confluentcloud:index/kafkaAcl:KafkaAcl describe-cluster "lkc-12345/CLUSTER#kafka-cluster#LITERAL#User:sa-xyz123#*#DESCRIBE#ALLOW"

Option #2Manage a single Kafka cluster in the same Terraform workspace $ export CONFLUENT_CLOUD_API_KEY="<cloud_api_key>" $ export CONFLUENT_CLOUD_API_SECRET="<cloud_api_secret>"

 $ 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

new KafkaAcl(name: string, args: KafkaAclArgs, opts?: CustomResourceOptions);
@overload
def KafkaAcl(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             credentials: Optional[KafkaAclCredentialsArgs] = None,
             host: 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,
             rest_endpoint: Optional[str] = None)
@overload
def KafkaAcl(resource_name: str,
             args: KafkaAclArgs,
             opts: Optional[ResourceOptions] = 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.

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.

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

The KafkaAcl resource accepts the following input properties:

Host string

The host for the ACL. Should be set to * for Confluent Cloud.

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, and IDEMPOTENT_WRITE. See Authorization using ACLs to find mappings of (resource_type, operation) to one or more Kafka APIs or request types.

PatternType string

The pattern type for the ACL. Accepted values are: LITERAL and PREFIXED.

Permission string

The permission for the ACL. Accepted values are: UNKNOWN, ANY, DENY, and ALLOW.

Principal string

The principal for the ACL.

ResourceName string

The resource name for the ACL. Must be kafka-cluster if resource_type equals to CLUSTER.

ResourceType string

The type of the resource. Accepted values are: UNKNOWN, ANY, TOPIC, GROUP, CLUSTER, TRANSACTIONAL_ID, DELEGATION_TOKEN. See Authorization using ACLs to find definitions of resource types and mappings of (resource_type, operation) to one or more Kafka APIs or request types.

Credentials Pulumi.ConfluentCloud.Inputs.KafkaAclCredentialsArgs

The Cluster API Credentials.

KafkaCluster Pulumi.ConfluentCloud.Inputs.KafkaAclKafkaClusterArgs
RestEndpoint string

The REST endpoint of the Kafka cluster, for example, https://pkc-00000.us-central1.gcp.confluent.cloud:443.

Host string

The host for the ACL. Should be set to * for Confluent Cloud.

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, and IDEMPOTENT_WRITE. See Authorization using ACLs to find mappings of (resource_type, operation) to one or more Kafka APIs or request types.

PatternType string

The pattern type for the ACL. Accepted values are: LITERAL and PREFIXED.

Permission string

The permission for the ACL. Accepted values are: UNKNOWN, ANY, DENY, and ALLOW.

Principal string

The principal for the ACL.

ResourceName string

The resource name for the ACL. Must be kafka-cluster if resource_type equals to CLUSTER.

ResourceType string

The type of the resource. Accepted values are: UNKNOWN, ANY, TOPIC, GROUP, CLUSTER, TRANSACTIONAL_ID, DELEGATION_TOKEN. See Authorization using ACLs to find definitions of resource types and mappings of (resource_type, operation) to one or more Kafka APIs or request types.

Credentials KafkaAclCredentialsArgs

The Cluster API Credentials.

KafkaCluster KafkaAclKafkaClusterArgs
RestEndpoint string

The REST endpoint of the Kafka cluster, for example, https://pkc-00000.us-central1.gcp.confluent.cloud:443.

host String

The host for the ACL. Should be set to * for Confluent Cloud.

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, and IDEMPOTENT_WRITE. See Authorization using ACLs to find mappings of (resource_type, operation) to one or more Kafka APIs or request types.

patternType String

The pattern type for the ACL. Accepted values are: LITERAL and PREFIXED.

permission String

The permission for the ACL. Accepted values are: UNKNOWN, ANY, DENY, and ALLOW.

principal String

The principal for the ACL.

resourceName String

The resource name for the ACL. Must be kafka-cluster if resource_type equals to CLUSTER.

resourceType String

The type of the resource. Accepted values are: UNKNOWN, ANY, TOPIC, GROUP, CLUSTER, TRANSACTIONAL_ID, DELEGATION_TOKEN. See Authorization using ACLs to find definitions of resource types and mappings of (resource_type, operation) to one or more Kafka APIs or request types.

credentials KafkaAclCredentialsArgs

The Cluster API Credentials.

kafkaCluster KafkaAclKafkaClusterArgs
restEndpoint String

The REST endpoint of the Kafka cluster, for example, https://pkc-00000.us-central1.gcp.confluent.cloud:443.

host string

The host for the ACL. Should be set to * for Confluent Cloud.

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, and IDEMPOTENT_WRITE. See Authorization using ACLs to find mappings of (resource_type, operation) to one or more Kafka APIs or request types.

patternType string

The pattern type for the ACL. Accepted values are: LITERAL and PREFIXED.

permission string

The permission for the ACL. Accepted values are: UNKNOWN, ANY, DENY, and ALLOW.

principal string

The principal for the ACL.

resourceName string

The resource name for the ACL. Must be kafka-cluster if resource_type equals to CLUSTER.

resourceType string

The type of the resource. Accepted values are: UNKNOWN, ANY, TOPIC, GROUP, CLUSTER, TRANSACTIONAL_ID, DELEGATION_TOKEN. See Authorization using ACLs to find definitions of resource types and mappings of (resource_type, operation) to one or more Kafka APIs or request types.

credentials KafkaAclCredentialsArgs

The Cluster API Credentials.

kafkaCluster KafkaAclKafkaClusterArgs
restEndpoint string

The REST endpoint of the Kafka cluster, for example, https://pkc-00000.us-central1.gcp.confluent.cloud:443.

host str

The host for the ACL. Should be set to * for Confluent Cloud.

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, and IDEMPOTENT_WRITE. See Authorization using ACLs to find mappings of (resource_type, operation) to one or more Kafka APIs or request types.

pattern_type str

The pattern type for the ACL. Accepted values are: LITERAL and PREFIXED.

permission str

The permission for the ACL. Accepted values are: UNKNOWN, ANY, DENY, and ALLOW.

principal str

The principal for the ACL.

resource_name str

The resource name for the ACL. Must be kafka-cluster if resource_type equals to CLUSTER.

resource_type str

The type of the resource. Accepted values are: UNKNOWN, ANY, TOPIC, GROUP, CLUSTER, TRANSACTIONAL_ID, DELEGATION_TOKEN. See Authorization using ACLs to find definitions of resource types and mappings of (resource_type, operation) to one or more Kafka APIs or request types.

credentials KafkaAclCredentialsArgs

The Cluster API Credentials.

kafka_cluster KafkaAclKafkaClusterArgs
rest_endpoint str

The REST endpoint of the Kafka cluster, for example, https://pkc-00000.us-central1.gcp.confluent.cloud:443.

host String

The host for the ACL. Should be set to * for Confluent Cloud.

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, and IDEMPOTENT_WRITE. See Authorization using ACLs to find mappings of (resource_type, operation) to one or more Kafka APIs or request types.

patternType String

The pattern type for the ACL. Accepted values are: LITERAL and PREFIXED.

permission String

The permission for the ACL. Accepted values are: UNKNOWN, ANY, DENY, and ALLOW.

principal String

The principal for the ACL.

resourceName String

The resource name for the ACL. Must be kafka-cluster if resource_type equals to CLUSTER.

resourceType String

The type of the resource. Accepted values are: UNKNOWN, ANY, TOPIC, GROUP, CLUSTER, TRANSACTIONAL_ID, DELEGATION_TOKEN. See Authorization using ACLs to find definitions of resource types and mappings of (resource_type, operation) to one or more Kafka APIs or request types.

credentials Property Map

The Cluster API Credentials.

kafkaCluster Property Map
restEndpoint String

The REST endpoint of the Kafka cluster, for example, https://pkc-00000.us-central1.gcp.confluent.cloud:443.

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,
        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,
        rest_endpoint: Optional[str] = None) -> KafkaAcl
func 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)
Resource lookup is not supported in YAML
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.
The following state arguments are supported:
Credentials Pulumi.ConfluentCloud.Inputs.KafkaAclCredentialsArgs

The Cluster API Credentials.

Host string

The host for the ACL. Should be set to * for Confluent Cloud.

KafkaCluster Pulumi.ConfluentCloud.Inputs.KafkaAclKafkaClusterArgs
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, and IDEMPOTENT_WRITE. See Authorization using ACLs to find mappings of (resource_type, operation) to one or more Kafka APIs or request types.

PatternType string

The pattern type for the ACL. Accepted values are: LITERAL and PREFIXED.

Permission string

The permission for the ACL. Accepted values are: UNKNOWN, ANY, DENY, and ALLOW.

Principal string

The principal for the ACL.

ResourceName string

The resource name for the ACL. Must be kafka-cluster if resource_type equals to CLUSTER.

ResourceType string

The type of the resource. Accepted values are: UNKNOWN, ANY, TOPIC, GROUP, CLUSTER, TRANSACTIONAL_ID, DELEGATION_TOKEN. See Authorization using ACLs to find definitions of resource types and mappings of (resource_type, operation) to one or more Kafka APIs or request types.

RestEndpoint string

The REST endpoint of the Kafka cluster, for example, https://pkc-00000.us-central1.gcp.confluent.cloud:443.

Credentials KafkaAclCredentialsArgs

The Cluster API Credentials.

Host string

The host for the ACL. Should be set to * for Confluent Cloud.

KafkaCluster KafkaAclKafkaClusterArgs
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, and IDEMPOTENT_WRITE. See Authorization using ACLs to find mappings of (resource_type, operation) to one or more Kafka APIs or request types.

PatternType string

The pattern type for the ACL. Accepted values are: LITERAL and PREFIXED.

Permission string

The permission for the ACL. Accepted values are: UNKNOWN, ANY, DENY, and ALLOW.

Principal string

The principal for the ACL.

ResourceName string

The resource name for the ACL. Must be kafka-cluster if resource_type equals to CLUSTER.

ResourceType string

The type of the resource. Accepted values are: UNKNOWN, ANY, TOPIC, GROUP, CLUSTER, TRANSACTIONAL_ID, DELEGATION_TOKEN. See Authorization using ACLs to find definitions of resource types and mappings of (resource_type, operation) to one or more Kafka APIs or request types.

RestEndpoint string

The REST endpoint of the Kafka cluster, for example, https://pkc-00000.us-central1.gcp.confluent.cloud:443.

credentials KafkaAclCredentialsArgs

The Cluster API Credentials.

host String

The host for the ACL. Should be set to * for Confluent Cloud.

kafkaCluster KafkaAclKafkaClusterArgs
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, and IDEMPOTENT_WRITE. See Authorization using ACLs to find mappings of (resource_type, operation) to one or more Kafka APIs or request types.

patternType String

The pattern type for the ACL. Accepted values are: LITERAL and PREFIXED.

permission String

The permission for the ACL. Accepted values are: UNKNOWN, ANY, DENY, and ALLOW.

principal String

The principal for the ACL.

resourceName String

The resource name for the ACL. Must be kafka-cluster if resource_type equals to CLUSTER.

resourceType String

The type of the resource. Accepted values are: UNKNOWN, ANY, TOPIC, GROUP, CLUSTER, TRANSACTIONAL_ID, DELEGATION_TOKEN. See Authorization using ACLs to find definitions of resource types and mappings of (resource_type, operation) to one or more Kafka APIs or request types.

restEndpoint String

The REST endpoint of the Kafka cluster, for example, https://pkc-00000.us-central1.gcp.confluent.cloud:443.

credentials KafkaAclCredentialsArgs

The Cluster API Credentials.

host string

The host for the ACL. Should be set to * for Confluent Cloud.

kafkaCluster KafkaAclKafkaClusterArgs
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, and IDEMPOTENT_WRITE. See Authorization using ACLs to find mappings of (resource_type, operation) to one or more Kafka APIs or request types.

patternType string

The pattern type for the ACL. Accepted values are: LITERAL and PREFIXED.

permission string

The permission for the ACL. Accepted values are: UNKNOWN, ANY, DENY, and ALLOW.

principal string

The principal for the ACL.

resourceName string

The resource name for the ACL. Must be kafka-cluster if resource_type equals to CLUSTER.

resourceType string

The type of the resource. Accepted values are: UNKNOWN, ANY, TOPIC, GROUP, CLUSTER, TRANSACTIONAL_ID, DELEGATION_TOKEN. See Authorization using ACLs to find definitions of resource types and mappings of (resource_type, operation) to one or more Kafka APIs or request types.

restEndpoint string

The REST endpoint of the Kafka cluster, for example, https://pkc-00000.us-central1.gcp.confluent.cloud:443.

credentials KafkaAclCredentialsArgs

The Cluster API Credentials.

host str

The host for the ACL. Should be set to * for Confluent Cloud.

kafka_cluster KafkaAclKafkaClusterArgs
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, and IDEMPOTENT_WRITE. See Authorization using ACLs to find mappings of (resource_type, operation) to one or more Kafka APIs or request types.

pattern_type str

The pattern type for the ACL. Accepted values are: LITERAL and PREFIXED.

permission str

The permission for the ACL. Accepted values are: UNKNOWN, ANY, DENY, and ALLOW.

principal str

The principal for the ACL.

resource_name str

The resource name for the ACL. Must be kafka-cluster if resource_type equals to CLUSTER.

resource_type str

The type of the resource. Accepted values are: UNKNOWN, ANY, TOPIC, GROUP, CLUSTER, TRANSACTIONAL_ID, DELEGATION_TOKEN. See Authorization using ACLs to find definitions of resource types and mappings of (resource_type, operation) to one or more Kafka APIs or request types.

rest_endpoint str

The REST endpoint of the Kafka cluster, for example, https://pkc-00000.us-central1.gcp.confluent.cloud:443.

credentials Property Map

The Cluster API Credentials.

host String

The host for the ACL. Should be set to * for Confluent Cloud.

kafkaCluster 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, and IDEMPOTENT_WRITE. See Authorization using ACLs to find mappings of (resource_type, operation) to one or more Kafka APIs or request types.

patternType String

The pattern type for the ACL. Accepted values are: LITERAL and PREFIXED.

permission String

The permission for the ACL. Accepted values are: UNKNOWN, ANY, DENY, and ALLOW.

principal String

The principal for the ACL.

resourceName String

The resource name for the ACL. Must be kafka-cluster if resource_type equals to CLUSTER.

resourceType String

The type of the resource. Accepted values are: UNKNOWN, ANY, TOPIC, GROUP, CLUSTER, TRANSACTIONAL_ID, DELEGATION_TOKEN. See Authorization using ACLs to find definitions of resource types and mappings of (resource_type, operation) to one or more Kafka APIs or request types.

restEndpoint String

The REST endpoint of the Kafka cluster, for example, https://pkc-00000.us-central1.gcp.confluent.cloud:443.

Supporting Types

KafkaAclCredentials

Key string

The Kafka API Key.

Secret string

The Kafka API Secret.

Key string

The Kafka API Key.

Secret string

The Kafka API Secret.

key String

The Kafka API Key.

secret String

The Kafka API Secret.

key string

The Kafka API Key.

secret string

The Kafka API Secret.

key str

The Kafka API Key.

secret str

The Kafka API Secret.

key String

The Kafka API Key.

secret String

The Kafka API Secret.

KafkaAclKafkaCluster

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 confluent Terraform Provider.