1. Registry
  2. Packages
  3. Google Cloud (GCP) Classic
  4. API Docs
  5. redis
  6. getClusterAclPolicy
Viewing docs for Google Cloud v9.36.1
published on Thursday, Sep 3, 2026 by Pulumi
gcp logo
Viewing docs for Google Cloud v9.36.1
published on Thursday, Sep 3, 2026 by Pulumi

    Get information about a Google Cloud Redis Cluster ACL policy. For more information see the official documentation or the API documentation.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const qa = gcp.redis.getClusterAclPolicy({
        aclPolicyId: "my-acl-policy",
        location: "us-central1",
    });
    
    import pulumi
    import pulumi_gcp as gcp
    
    qa = gcp.redis.get_cluster_acl_policy(acl_policy_id="my-acl-policy",
        location="us-central1")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/redis"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := redis.LookupClusterAclPolicy(ctx, &redis.LookupClusterAclPolicyArgs{
    			AclPolicyId: "my-acl-policy",
    			Location:    pulumi.StringRef("us-central1"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Gcp = Pulumi.Gcp;
    
    return await Deployment.RunAsync(() => 
    {
        var qa = Gcp.Redis.GetClusterAclPolicy.Invoke(new()
        {
            AclPolicyId = "my-acl-policy",
            Location = "us-central1",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.gcp.redis.RedisFunctions;
    import com.pulumi.gcp.redis.inputs.GetClusterAclPolicyArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var qa = RedisFunctions.getClusterAclPolicy(GetClusterAclPolicyArgs.builder()
                .aclPolicyId("my-acl-policy")
                .location("us-central1")
                .build());
    
        }
    }
    
    variables:
      qa:
        fn::invoke:
          function: gcp:redis:getClusterAclPolicy
          arguments:
            aclPolicyId: my-acl-policy
            location: us-central1
    
    pulumi {
      required_providers {
        gcp = {
          source = "pulumi/gcp"
        }
      }
    }
    
    data "gcp_redis_getclusteraclpolicy" "qa" {
      acl_policy_id = "my-acl-policy"
      location      = "us-central1"
    }
    

    Using getClusterAclPolicy

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getClusterAclPolicy(args: GetClusterAclPolicyArgs, opts?: InvokeOptions): Promise<GetClusterAclPolicyResult>
    function getClusterAclPolicyOutput(args: GetClusterAclPolicyOutputArgs, opts?: InvokeOutputOptions): Output<GetClusterAclPolicyResult>
    def get_cluster_acl_policy(acl_policy_id: Optional[str] = None,
                               location: Optional[str] = None,
                               project: Optional[str] = None,
                               opts: Optional[InvokeOptions] = None) -> GetClusterAclPolicyResult
    def get_cluster_acl_policy_output(acl_policy_id: pulumi.Input[Optional[str]] = None,
                               location: pulumi.Input[Optional[str]] = None,
                               project: pulumi.Input[Optional[str]] = None,
                               opts: Optional[InvokeOutputOptions] = None) -> Output[GetClusterAclPolicyResult]
    func LookupClusterAclPolicy(ctx *Context, args *LookupClusterAclPolicyArgs, opts ...InvokeOption) (*LookupClusterAclPolicyResult, error)
    func LookupClusterAclPolicyOutput(ctx *Context, args *LookupClusterAclPolicyOutputArgs, opts ...InvokeOption) LookupClusterAclPolicyResultOutput

    > Note: This function is named LookupClusterAclPolicy in the Go SDK.

    public static class GetClusterAclPolicy 
    {
        public static Task<GetClusterAclPolicyResult> InvokeAsync(GetClusterAclPolicyArgs args, InvokeOptions? opts = null)
        public static Output<GetClusterAclPolicyResult> Invoke(GetClusterAclPolicyInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetClusterAclPolicyResult> Invoke(GetClusterAclPolicyInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetClusterAclPolicyResult> getClusterAclPolicy(GetClusterAclPolicyArgs args, InvokeOptions options)
    public static Output<GetClusterAclPolicyResult> getClusterAclPolicy(GetClusterAclPolicyArgs args, InvokeOptions options)
    public static Output<GetClusterAclPolicyResult> getClusterAclPolicy(GetClusterAclPolicyArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: gcp:redis/getClusterAclPolicy:getClusterAclPolicy
      arguments:
        # arguments dictionary
    data "gcp_redis_get_cluster_acl_policy" "name" {
        # arguments
    }

    The following arguments are supported:

    AclPolicyId string
    The logical name of the ACL Policy in the customer project.
    Location string
    Resource ID segment making up resource name. It identifies the resource within its parent collection.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    AclPolicyId string
    The logical name of the ACL Policy in the customer project.
    Location string
    Resource ID segment making up resource name. It identifies the resource within its parent collection.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    acl_policy_id string
    The logical name of the ACL Policy in the customer project.
    location string
    Resource ID segment making up resource name. It identifies the resource within its parent collection.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    aclPolicyId String
    The logical name of the ACL Policy in the customer project.
    location String
    Resource ID segment making up resource name. It identifies the resource within its parent collection.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    aclPolicyId string
    The logical name of the ACL Policy in the customer project.
    location string
    Resource ID segment making up resource name. It identifies the resource within its parent collection.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    acl_policy_id str
    The logical name of the ACL Policy in the customer project.
    location str
    Resource ID segment making up resource name. It identifies the resource within its parent collection.
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    aclPolicyId String
    The logical name of the ACL Policy in the customer project.
    location String
    Resource ID segment making up resource name. It identifies the resource within its parent collection.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

    getClusterAclPolicy Result

    The following output properties are available:

    AclPolicyId string
    DeletionPolicy string
    Etag string
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Rules List<GetClusterAclPolicyRule>
    State string
    Location string
    Project string
    AclPolicyId string
    DeletionPolicy string
    Etag string
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Rules []GetClusterAclPolicyRule
    State string
    Location string
    Project string
    acl_policy_id string
    deletion_policy string
    etag string
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    rules list(object)
    state string
    location string
    project string
    aclPolicyId String
    deletionPolicy String
    etag String
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    rules List<GetClusterAclPolicyRule>
    state String
    location String
    project String
    aclPolicyId string
    deletionPolicy string
    etag string
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    rules GetClusterAclPolicyRule[]
    state string
    location string
    project string
    acl_policy_id str
    deletion_policy str
    etag str
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    rules Sequence[GetClusterAclPolicyRule]
    state str
    location str
    project str
    aclPolicyId String
    deletionPolicy String
    etag String
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    rules List<Property Map>
    state String
    location String
    project String

    Supporting Types

    GetClusterAclPolicyRule

    Rule string
    The rule to be applied to the username. Ex: "on >password123 ~* +@all" The format of the rule is defined by Redis OSS: https://redis.io/docs/latest/operate/oss_and_stack/management/security/acl/
    Username string
    Specifies the IAM user or service account to be added to the ACL policy. This username will be directly set on the Redis OSS.
    Rule string
    The rule to be applied to the username. Ex: "on >password123 ~* +@all" The format of the rule is defined by Redis OSS: https://redis.io/docs/latest/operate/oss_and_stack/management/security/acl/
    Username string
    Specifies the IAM user or service account to be added to the ACL policy. This username will be directly set on the Redis OSS.
    rule string
    The rule to be applied to the username. Ex: "on >password123 ~* +@all" The format of the rule is defined by Redis OSS: https://redis.io/docs/latest/operate/oss_and_stack/management/security/acl/
    username string
    Specifies the IAM user or service account to be added to the ACL policy. This username will be directly set on the Redis OSS.
    rule String
    The rule to be applied to the username. Ex: "on >password123 ~* +@all" The format of the rule is defined by Redis OSS: https://redis.io/docs/latest/operate/oss_and_stack/management/security/acl/
    username String
    Specifies the IAM user or service account to be added to the ACL policy. This username will be directly set on the Redis OSS.
    rule string
    The rule to be applied to the username. Ex: "on >password123 ~* +@all" The format of the rule is defined by Redis OSS: https://redis.io/docs/latest/operate/oss_and_stack/management/security/acl/
    username string
    Specifies the IAM user or service account to be added to the ACL policy. This username will be directly set on the Redis OSS.
    rule str
    The rule to be applied to the username. Ex: "on >password123 ~* +@all" The format of the rule is defined by Redis OSS: https://redis.io/docs/latest/operate/oss_and_stack/management/security/acl/
    username str
    Specifies the IAM user or service account to be added to the ACL policy. This username will be directly set on the Redis OSS.
    rule String
    The rule to be applied to the username. Ex: "on >password123 ~* +@all" The format of the rule is defined by Redis OSS: https://redis.io/docs/latest/operate/oss_and_stack/management/security/acl/
    username String
    Specifies the IAM user or service account to be added to the ACL policy. This username will be directly set on the Redis OSS.

    Package Details

    Repository
    Google Cloud (GCP) Classic pulumi/pulumi-gcp
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the google-beta Terraform Provider.
    gcp logo
    Viewing docs for Google Cloud v9.36.1
    published on Thursday, Sep 3, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial