1. Packages
  2. Redpanda Provider
  3. API Docs
  4. SchemaRegistryAcl
redpanda 1.6.0 published on Friday, Jan 30, 2026 by redpanda-data
redpanda logo
redpanda 1.6.0 published on Friday, Jan 30, 2026 by redpanda-data

    Import

    Schema Registry ACLs can be imported using a colon-separated string with the following format:

    cluster_id:principal:resource_type:resource_name:pattern_type:host:operation:permission:username:password

    Example imports:

    Import a subject-level READ ACL for user alice

    $ pulumi import redpanda:index/schemaRegistryAcl:SchemaRegistryAcl example "cluster-123:User:alice:SUBJECT:user-value:LITERAL:*:READ:ALLOW:alice:mypassword"
    

    Import a registry-level ALL ACL for a role

    $ pulumi import redpanda:index/schemaRegistryAcl:SchemaRegistryAcl admin "cluster-123:RedpandaRole:admin:REGISTRY:*:LITERAL:*:ALL:ALLOW:admin:secret"
    

    Import a prefixed pattern ACL

    $ pulumi import redpanda:index/schemaRegistryAcl:SchemaRegistryAcl prefix "cluster-123:User:bob:SUBJECT:orders-:PREFIXED:*:WRITE:ALLOW:bob:pass123"
    

    Create SchemaRegistryAcl Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new SchemaRegistryAcl(name: string, args: SchemaRegistryAclArgs, opts?: CustomResourceOptions);
    @overload
    def SchemaRegistryAcl(resource_name: str,
                          args: SchemaRegistryAclArgs,
                          opts: Optional[ResourceOptions] = None)
    
    @overload
    def SchemaRegistryAcl(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          principal: Optional[str] = None,
                          cluster_id: Optional[str] = None,
                          host: Optional[str] = None,
                          operation: Optional[str] = None,
                          pattern_type: Optional[str] = None,
                          permission: Optional[str] = None,
                          resource_name_: Optional[str] = None,
                          resource_type: Optional[str] = None,
                          password: Optional[str] = None,
                          password_wo: Optional[str] = None,
                          password_wo_version: Optional[float] = None,
                          allow_deletion: Optional[bool] = None,
                          username: Optional[str] = None)
    func NewSchemaRegistryAcl(ctx *Context, name string, args SchemaRegistryAclArgs, opts ...ResourceOption) (*SchemaRegistryAcl, error)
    public SchemaRegistryAcl(string name, SchemaRegistryAclArgs args, CustomResourceOptions? opts = null)
    public SchemaRegistryAcl(String name, SchemaRegistryAclArgs args)
    public SchemaRegistryAcl(String name, SchemaRegistryAclArgs args, CustomResourceOptions options)
    
    type: redpanda:SchemaRegistryAcl
    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 SchemaRegistryAclArgs
    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 SchemaRegistryAclArgs
    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 SchemaRegistryAclArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SchemaRegistryAclArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SchemaRegistryAclArgs
    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 schemaRegistryAclResource = new Redpanda.SchemaRegistryAcl("schemaRegistryAclResource", new()
    {
        Principal = "string",
        ClusterId = "string",
        Host = "string",
        Operation = "string",
        PatternType = "string",
        Permission = "string",
        ResourceName = "string",
        ResourceType = "string",
        PasswordWo = "string",
        PasswordWoVersion = 0,
        AllowDeletion = false,
        Username = "string",
    });
    
    example, err := redpanda.NewSchemaRegistryAcl(ctx, "schemaRegistryAclResource", &redpanda.SchemaRegistryAclArgs{
    	Principal:         pulumi.String("string"),
    	ClusterId:         pulumi.String("string"),
    	Host:              pulumi.String("string"),
    	Operation:         pulumi.String("string"),
    	PatternType:       pulumi.String("string"),
    	Permission:        pulumi.String("string"),
    	ResourceName:      pulumi.String("string"),
    	ResourceType:      pulumi.String("string"),
    	PasswordWo:        pulumi.String("string"),
    	PasswordWoVersion: pulumi.Float64(0),
    	AllowDeletion:     pulumi.Bool(false),
    	Username:          pulumi.String("string"),
    })
    
    var schemaRegistryAclResource = new SchemaRegistryAcl("schemaRegistryAclResource", SchemaRegistryAclArgs.builder()
        .principal("string")
        .clusterId("string")
        .host("string")
        .operation("string")
        .patternType("string")
        .permission("string")
        .resourceName("string")
        .resourceType("string")
        .passwordWo("string")
        .passwordWoVersion(0.0)
        .allowDeletion(false)
        .username("string")
        .build());
    
    schema_registry_acl_resource = redpanda.SchemaRegistryAcl("schemaRegistryAclResource",
        principal="string",
        cluster_id="string",
        host="string",
        operation="string",
        pattern_type="string",
        permission="string",
        resource_name_="string",
        resource_type="string",
        password_wo="string",
        password_wo_version=0,
        allow_deletion=False,
        username="string")
    
    const schemaRegistryAclResource = new redpanda.SchemaRegistryAcl("schemaRegistryAclResource", {
        principal: "string",
        clusterId: "string",
        host: "string",
        operation: "string",
        patternType: "string",
        permission: "string",
        resourceName: "string",
        resourceType: "string",
        passwordWo: "string",
        passwordWoVersion: 0,
        allowDeletion: false,
        username: "string",
    });
    
    type: redpanda:SchemaRegistryAcl
    properties:
        allowDeletion: false
        clusterId: string
        host: string
        operation: string
        passwordWo: string
        passwordWoVersion: 0
        patternType: string
        permission: string
        principal: string
        resourceName: string
        resourceType: string
        username: string
    

    SchemaRegistryAcl 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 SchemaRegistryAcl resource accepts the following input properties:

    ClusterId string
    The ID of the cluster where the Schema Registry ACL will be created
    Host string
    The host address to use for this ACL. Use '*' for wildcard
    Operation string
    The operation type that shall be allowed or denied: ALL, READ, WRITE, DELETE, DESCRIBE, DESCRIBECONFIGS, ALTER, ALTERCONFIGS
    PatternType string
    The pattern type of the resource: LITERAL or PREFIXED
    Permission string
    The permission type: ALLOW or DENY
    Principal string
    The principal to apply this ACL for (e.g., User:alice or RedpandaRole:admin)
    ResourceName string
    The name of the resource this ACL entry will be on. Use '*' for wildcard
    ResourceType string
    The type of the resource: SUBJECT or REGISTRY
    AllowDeletion bool
    When set to true, allows the resource to be removed from state even if deletion fails due to permission errors
    Password string
    Password for authentication. Deprecated: use password_wo instead. Can be set via REDPANDA_SR_PASSWORD environment variable

    Deprecated: Deprecated

    PasswordWo string
    PasswordWoVersion double
    Version number for password_wo. Increment this value to trigger a password update when using password_wo.
    Username string
    Username for authentication. Can be set via REDPANDA_SR_USERNAME environment variable
    ClusterId string
    The ID of the cluster where the Schema Registry ACL will be created
    Host string
    The host address to use for this ACL. Use '*' for wildcard
    Operation string
    The operation type that shall be allowed or denied: ALL, READ, WRITE, DELETE, DESCRIBE, DESCRIBECONFIGS, ALTER, ALTERCONFIGS
    PatternType string
    The pattern type of the resource: LITERAL or PREFIXED
    Permission string
    The permission type: ALLOW or DENY
    Principal string
    The principal to apply this ACL for (e.g., User:alice or RedpandaRole:admin)
    ResourceName string
    The name of the resource this ACL entry will be on. Use '*' for wildcard
    ResourceType string
    The type of the resource: SUBJECT or REGISTRY
    AllowDeletion bool
    When set to true, allows the resource to be removed from state even if deletion fails due to permission errors
    Password string
    Password for authentication. Deprecated: use password_wo instead. Can be set via REDPANDA_SR_PASSWORD environment variable

    Deprecated: Deprecated

    PasswordWo string
    PasswordWoVersion float64
    Version number for password_wo. Increment this value to trigger a password update when using password_wo.
    Username string
    Username for authentication. Can be set via REDPANDA_SR_USERNAME environment variable
    clusterId String
    The ID of the cluster where the Schema Registry ACL will be created
    host String
    The host address to use for this ACL. Use '*' for wildcard
    operation String
    The operation type that shall be allowed or denied: ALL, READ, WRITE, DELETE, DESCRIBE, DESCRIBECONFIGS, ALTER, ALTERCONFIGS
    patternType String
    The pattern type of the resource: LITERAL or PREFIXED
    permission String
    The permission type: ALLOW or DENY
    principal String
    The principal to apply this ACL for (e.g., User:alice or RedpandaRole:admin)
    resourceName String
    The name of the resource this ACL entry will be on. Use '*' for wildcard
    resourceType String
    The type of the resource: SUBJECT or REGISTRY
    allowDeletion Boolean
    When set to true, allows the resource to be removed from state even if deletion fails due to permission errors
    password String
    Password for authentication. Deprecated: use password_wo instead. Can be set via REDPANDA_SR_PASSWORD environment variable

    Deprecated: Deprecated

    passwordWo String
    passwordWoVersion Double
    Version number for password_wo. Increment this value to trigger a password update when using password_wo.
    username String
    Username for authentication. Can be set via REDPANDA_SR_USERNAME environment variable
    clusterId string
    The ID of the cluster where the Schema Registry ACL will be created
    host string
    The host address to use for this ACL. Use '*' for wildcard
    operation string
    The operation type that shall be allowed or denied: ALL, READ, WRITE, DELETE, DESCRIBE, DESCRIBECONFIGS, ALTER, ALTERCONFIGS
    patternType string
    The pattern type of the resource: LITERAL or PREFIXED
    permission string
    The permission type: ALLOW or DENY
    principal string
    The principal to apply this ACL for (e.g., User:alice or RedpandaRole:admin)
    resourceName string
    The name of the resource this ACL entry will be on. Use '*' for wildcard
    resourceType string
    The type of the resource: SUBJECT or REGISTRY
    allowDeletion boolean
    When set to true, allows the resource to be removed from state even if deletion fails due to permission errors
    password string
    Password for authentication. Deprecated: use password_wo instead. Can be set via REDPANDA_SR_PASSWORD environment variable

    Deprecated: Deprecated

    passwordWo string
    passwordWoVersion number
    Version number for password_wo. Increment this value to trigger a password update when using password_wo.
    username string
    Username for authentication. Can be set via REDPANDA_SR_USERNAME environment variable
    cluster_id str
    The ID of the cluster where the Schema Registry ACL will be created
    host str
    The host address to use for this ACL. Use '*' for wildcard
    operation str
    The operation type that shall be allowed or denied: ALL, READ, WRITE, DELETE, DESCRIBE, DESCRIBECONFIGS, ALTER, ALTERCONFIGS
    pattern_type str
    The pattern type of the resource: LITERAL or PREFIXED
    permission str
    The permission type: ALLOW or DENY
    principal str
    The principal to apply this ACL for (e.g., User:alice or RedpandaRole:admin)
    resource_name str
    The name of the resource this ACL entry will be on. Use '*' for wildcard
    resource_type str
    The type of the resource: SUBJECT or REGISTRY
    allow_deletion bool
    When set to true, allows the resource to be removed from state even if deletion fails due to permission errors
    password str
    Password for authentication. Deprecated: use password_wo instead. Can be set via REDPANDA_SR_PASSWORD environment variable

    Deprecated: Deprecated

    password_wo str
    password_wo_version float
    Version number for password_wo. Increment this value to trigger a password update when using password_wo.
    username str
    Username for authentication. Can be set via REDPANDA_SR_USERNAME environment variable
    clusterId String
    The ID of the cluster where the Schema Registry ACL will be created
    host String
    The host address to use for this ACL. Use '*' for wildcard
    operation String
    The operation type that shall be allowed or denied: ALL, READ, WRITE, DELETE, DESCRIBE, DESCRIBECONFIGS, ALTER, ALTERCONFIGS
    patternType String
    The pattern type of the resource: LITERAL or PREFIXED
    permission String
    The permission type: ALLOW or DENY
    principal String
    The principal to apply this ACL for (e.g., User:alice or RedpandaRole:admin)
    resourceName String
    The name of the resource this ACL entry will be on. Use '*' for wildcard
    resourceType String
    The type of the resource: SUBJECT or REGISTRY
    allowDeletion Boolean
    When set to true, allows the resource to be removed from state even if deletion fails due to permission errors
    password String
    Password for authentication. Deprecated: use password_wo instead. Can be set via REDPANDA_SR_PASSWORD environment variable

    Deprecated: Deprecated

    passwordWo String
    passwordWoVersion Number
    Version number for password_wo. Increment this value to trigger a password update when using password_wo.
    username String
    Username for authentication. Can be set via REDPANDA_SR_USERNAME environment variable

    Outputs

    All input properties are implicitly available as output properties. Additionally, the SchemaRegistryAcl 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 SchemaRegistryAcl Resource

    Get an existing SchemaRegistryAcl 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?: SchemaRegistryAclState, opts?: CustomResourceOptions): SchemaRegistryAcl
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            allow_deletion: Optional[bool] = None,
            cluster_id: Optional[str] = None,
            host: Optional[str] = None,
            operation: Optional[str] = None,
            password: Optional[str] = None,
            password_wo: Optional[str] = None,
            password_wo_version: Optional[float] = None,
            pattern_type: Optional[str] = None,
            permission: Optional[str] = None,
            principal: Optional[str] = None,
            resource_name: Optional[str] = None,
            resource_type: Optional[str] = None,
            username: Optional[str] = None) -> SchemaRegistryAcl
    func GetSchemaRegistryAcl(ctx *Context, name string, id IDInput, state *SchemaRegistryAclState, opts ...ResourceOption) (*SchemaRegistryAcl, error)
    public static SchemaRegistryAcl Get(string name, Input<string> id, SchemaRegistryAclState? state, CustomResourceOptions? opts = null)
    public static SchemaRegistryAcl get(String name, Output<String> id, SchemaRegistryAclState state, CustomResourceOptions options)
    resources:  _:    type: redpanda:SchemaRegistryAcl    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.
    The following state arguments are supported:
    AllowDeletion bool
    When set to true, allows the resource to be removed from state even if deletion fails due to permission errors
    ClusterId string
    The ID of the cluster where the Schema Registry ACL will be created
    Host string
    The host address to use for this ACL. Use '*' for wildcard
    Operation string
    The operation type that shall be allowed or denied: ALL, READ, WRITE, DELETE, DESCRIBE, DESCRIBECONFIGS, ALTER, ALTERCONFIGS
    Password string
    Password for authentication. Deprecated: use password_wo instead. Can be set via REDPANDA_SR_PASSWORD environment variable

    Deprecated: Deprecated

    PasswordWo string
    PasswordWoVersion double
    Version number for password_wo. Increment this value to trigger a password update when using password_wo.
    PatternType string
    The pattern type of the resource: LITERAL or PREFIXED
    Permission string
    The permission type: ALLOW or DENY
    Principal string
    The principal to apply this ACL for (e.g., User:alice or RedpandaRole:admin)
    ResourceName string
    The name of the resource this ACL entry will be on. Use '*' for wildcard
    ResourceType string
    The type of the resource: SUBJECT or REGISTRY
    Username string
    Username for authentication. Can be set via REDPANDA_SR_USERNAME environment variable
    AllowDeletion bool
    When set to true, allows the resource to be removed from state even if deletion fails due to permission errors
    ClusterId string
    The ID of the cluster where the Schema Registry ACL will be created
    Host string
    The host address to use for this ACL. Use '*' for wildcard
    Operation string
    The operation type that shall be allowed or denied: ALL, READ, WRITE, DELETE, DESCRIBE, DESCRIBECONFIGS, ALTER, ALTERCONFIGS
    Password string
    Password for authentication. Deprecated: use password_wo instead. Can be set via REDPANDA_SR_PASSWORD environment variable

    Deprecated: Deprecated

    PasswordWo string
    PasswordWoVersion float64
    Version number for password_wo. Increment this value to trigger a password update when using password_wo.
    PatternType string
    The pattern type of the resource: LITERAL or PREFIXED
    Permission string
    The permission type: ALLOW or DENY
    Principal string
    The principal to apply this ACL for (e.g., User:alice or RedpandaRole:admin)
    ResourceName string
    The name of the resource this ACL entry will be on. Use '*' for wildcard
    ResourceType string
    The type of the resource: SUBJECT or REGISTRY
    Username string
    Username for authentication. Can be set via REDPANDA_SR_USERNAME environment variable
    allowDeletion Boolean
    When set to true, allows the resource to be removed from state even if deletion fails due to permission errors
    clusterId String
    The ID of the cluster where the Schema Registry ACL will be created
    host String
    The host address to use for this ACL. Use '*' for wildcard
    operation String
    The operation type that shall be allowed or denied: ALL, READ, WRITE, DELETE, DESCRIBE, DESCRIBECONFIGS, ALTER, ALTERCONFIGS
    password String
    Password for authentication. Deprecated: use password_wo instead. Can be set via REDPANDA_SR_PASSWORD environment variable

    Deprecated: Deprecated

    passwordWo String
    passwordWoVersion Double
    Version number for password_wo. Increment this value to trigger a password update when using password_wo.
    patternType String
    The pattern type of the resource: LITERAL or PREFIXED
    permission String
    The permission type: ALLOW or DENY
    principal String
    The principal to apply this ACL for (e.g., User:alice or RedpandaRole:admin)
    resourceName String
    The name of the resource this ACL entry will be on. Use '*' for wildcard
    resourceType String
    The type of the resource: SUBJECT or REGISTRY
    username String
    Username for authentication. Can be set via REDPANDA_SR_USERNAME environment variable
    allowDeletion boolean
    When set to true, allows the resource to be removed from state even if deletion fails due to permission errors
    clusterId string
    The ID of the cluster where the Schema Registry ACL will be created
    host string
    The host address to use for this ACL. Use '*' for wildcard
    operation string
    The operation type that shall be allowed or denied: ALL, READ, WRITE, DELETE, DESCRIBE, DESCRIBECONFIGS, ALTER, ALTERCONFIGS
    password string
    Password for authentication. Deprecated: use password_wo instead. Can be set via REDPANDA_SR_PASSWORD environment variable

    Deprecated: Deprecated

    passwordWo string
    passwordWoVersion number
    Version number for password_wo. Increment this value to trigger a password update when using password_wo.
    patternType string
    The pattern type of the resource: LITERAL or PREFIXED
    permission string
    The permission type: ALLOW or DENY
    principal string
    The principal to apply this ACL for (e.g., User:alice or RedpandaRole:admin)
    resourceName string
    The name of the resource this ACL entry will be on. Use '*' for wildcard
    resourceType string
    The type of the resource: SUBJECT or REGISTRY
    username string
    Username for authentication. Can be set via REDPANDA_SR_USERNAME environment variable
    allow_deletion bool
    When set to true, allows the resource to be removed from state even if deletion fails due to permission errors
    cluster_id str
    The ID of the cluster where the Schema Registry ACL will be created
    host str
    The host address to use for this ACL. Use '*' for wildcard
    operation str
    The operation type that shall be allowed or denied: ALL, READ, WRITE, DELETE, DESCRIBE, DESCRIBECONFIGS, ALTER, ALTERCONFIGS
    password str
    Password for authentication. Deprecated: use password_wo instead. Can be set via REDPANDA_SR_PASSWORD environment variable

    Deprecated: Deprecated

    password_wo str
    password_wo_version float
    Version number for password_wo. Increment this value to trigger a password update when using password_wo.
    pattern_type str
    The pattern type of the resource: LITERAL or PREFIXED
    permission str
    The permission type: ALLOW or DENY
    principal str
    The principal to apply this ACL for (e.g., User:alice or RedpandaRole:admin)
    resource_name str
    The name of the resource this ACL entry will be on. Use '*' for wildcard
    resource_type str
    The type of the resource: SUBJECT or REGISTRY
    username str
    Username for authentication. Can be set via REDPANDA_SR_USERNAME environment variable
    allowDeletion Boolean
    When set to true, allows the resource to be removed from state even if deletion fails due to permission errors
    clusterId String
    The ID of the cluster where the Schema Registry ACL will be created
    host String
    The host address to use for this ACL. Use '*' for wildcard
    operation String
    The operation type that shall be allowed or denied: ALL, READ, WRITE, DELETE, DESCRIBE, DESCRIBECONFIGS, ALTER, ALTERCONFIGS
    password String
    Password for authentication. Deprecated: use password_wo instead. Can be set via REDPANDA_SR_PASSWORD environment variable

    Deprecated: Deprecated

    passwordWo String
    passwordWoVersion Number
    Version number for password_wo. Increment this value to trigger a password update when using password_wo.
    patternType String
    The pattern type of the resource: LITERAL or PREFIXED
    permission String
    The permission type: ALLOW or DENY
    principal String
    The principal to apply this ACL for (e.g., User:alice or RedpandaRole:admin)
    resourceName String
    The name of the resource this ACL entry will be on. Use '*' for wildcard
    resourceType String
    The type of the resource: SUBJECT or REGISTRY
    username String
    Username for authentication. Can be set via REDPANDA_SR_USERNAME environment variable

    Package Details

    Repository
    redpanda redpanda-data/terraform-provider-redpanda
    License
    Notes
    This Pulumi package is based on the redpanda Terraform Provider.
    redpanda logo
    redpanda 1.6.0 published on Friday, Jan 30, 2026 by redpanda-data
      Meet Neo: Your AI Platform Teammate