1. Registry
  2. Packages
  3. Redpanda Provider
  4. API Docs
  5. getCloudProviderAccess
Viewing docs for redpanda 2.6.0
published on Friday, Oct 23, 2026 by redpanda-data
redpanda
Viewing docs for redpanda 2.6.0
published on Friday, Oct 23, 2026 by redpanda-data

    Data source for a Redpanda Cloud cloud provider access

    Preview: cloud provider access is a preview feature of Redpanda Cloud. Your organization must have cross-account BYOC enabled; contact Redpanda support to enable it.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as redpanda from "@pulumi/redpanda";
    
    const example = redpanda.getCloudProviderAccess({
        id: cloudProviderAccessId,
    });
    export const roleArn = example.then(example => example.aws?.roleArn);
    
    import pulumi
    import pulumi_redpanda as redpanda
    
    example = redpanda.get_cloud_provider_access(id=cloud_provider_access_id)
    pulumi.export("roleArn", example.aws.role_arn)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/redpanda/v2/redpanda"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := redpanda.LookupCloudProviderAccess(ctx, &redpanda.LookupCloudProviderAccessArgs{
    			Id: cloudProviderAccessId,
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("roleArn", example.Aws.RoleArn)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Redpanda = Pulumi.Redpanda;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Redpanda.GetCloudProviderAccess.Invoke(new()
        {
            Id = cloudProviderAccessId,
        });
    
        return new Dictionary<string, object?>
        {
            ["roleArn"] = example.Apply(getCloudProviderAccessResult => getCloudProviderAccessResult.Aws?.RoleArn),
        };
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.redpanda.RedpandaFunctions;
    import com.pulumi.redpanda.inputs.GetCloudProviderAccessArgs;
    import java.util.List;
    import java.util.ArrayList;
    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 example = RedpandaFunctions.getCloudProviderAccess(GetCloudProviderAccessArgs.builder()
                .id(cloudProviderAccessId)
                .build());
    
            ctx.export("roleArn", example.aws().roleArn());
        }
    }
    
    variables:
      example:
        fn::invoke:
          function: redpanda:getCloudProviderAccess
          arguments:
            id: ${cloudProviderAccessId}
    outputs:
      roleArn: ${example.aws.roleArn}
    
    Example coming soon!
    

    Using getCloudProviderAccess

    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 getCloudProviderAccess(args: GetCloudProviderAccessArgs, opts?: InvokeOptions): Promise<GetCloudProviderAccessResult>
    function getCloudProviderAccessOutput(args: GetCloudProviderAccessOutputArgs, opts?: InvokeOutputOptions): Output<GetCloudProviderAccessResult>
    def get_cloud_provider_access(id: Optional[str] = None,
                                  opts: Optional[InvokeOptions] = None) -> GetCloudProviderAccessResult
    def get_cloud_provider_access_output(id: pulumi.Input[Optional[str]] = None,
                                  opts: Optional[InvokeOutputOptions] = None) -> Output[GetCloudProviderAccessResult]
    func LookupCloudProviderAccess(ctx *Context, args *LookupCloudProviderAccessArgs, opts ...InvokeOption) (*LookupCloudProviderAccessResult, error)
    func LookupCloudProviderAccessOutput(ctx *Context, args *LookupCloudProviderAccessOutputArgs, opts ...InvokeOption) LookupCloudProviderAccessResultOutput

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

    public static class GetCloudProviderAccess 
    {
        public static Task<GetCloudProviderAccessResult> InvokeAsync(GetCloudProviderAccessArgs args, InvokeOptions? opts = null)
        public static Output<GetCloudProviderAccessResult> Invoke(GetCloudProviderAccessInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetCloudProviderAccessResult> Invoke(GetCloudProviderAccessInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetCloudProviderAccessResult> getCloudProviderAccess(GetCloudProviderAccessArgs args, InvokeOptions options)
    public static Output<GetCloudProviderAccessResult> getCloudProviderAccess(GetCloudProviderAccessArgs args, InvokeOptions options)
    public static Output<GetCloudProviderAccessResult> getCloudProviderAccess(GetCloudProviderAccessArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: redpanda:index/getCloudProviderAccess:getCloudProviderAccess
      arguments:
        # arguments dictionary
    data "redpanda_get_cloud_provider_access" "name" {
        # arguments
    }

    The following arguments are supported:

    Id string
    Unique identifier of the resource.
    Id string
    Unique identifier of the resource.
    id string
    Unique identifier of the resource.
    id String
    Unique identifier of the resource.
    id string
    Unique identifier of the resource.
    id str
    Unique identifier of the resource.
    id String
    Unique identifier of the resource.

    getCloudProviderAccess Result

    The following output properties are available:

    Aws GetCloudProviderAccessAws
    AWS cross-account access configuration, used when cloud_provider is aws.
    CloudProvider string
    Cloud provider type. Only aws is supported.
    Id string
    Unique identifier of the resource.
    Name string
    Human-readable name for this cloud provider access. Unique within the organization.
    State string
    Current state of the cloud provider access.
    Aws GetCloudProviderAccessAws
    AWS cross-account access configuration, used when cloud_provider is aws.
    CloudProvider string
    Cloud provider type. Only aws is supported.
    Id string
    Unique identifier of the resource.
    Name string
    Human-readable name for this cloud provider access. Unique within the organization.
    State string
    Current state of the cloud provider access.
    aws object
    AWS cross-account access configuration, used when cloud_provider is aws.
    cloud_provider string
    Cloud provider type. Only aws is supported.
    id string
    Unique identifier of the resource.
    name string
    Human-readable name for this cloud provider access. Unique within the organization.
    state string
    Current state of the cloud provider access.
    aws GetCloudProviderAccessAws
    AWS cross-account access configuration, used when cloud_provider is aws.
    cloudProvider String
    Cloud provider type. Only aws is supported.
    id String
    Unique identifier of the resource.
    name String
    Human-readable name for this cloud provider access. Unique within the organization.
    state String
    Current state of the cloud provider access.
    aws GetCloudProviderAccessAws
    AWS cross-account access configuration, used when cloud_provider is aws.
    cloudProvider string
    Cloud provider type. Only aws is supported.
    id string
    Unique identifier of the resource.
    name string
    Human-readable name for this cloud provider access. Unique within the organization.
    state string
    Current state of the cloud provider access.
    aws GetCloudProviderAccessAws
    AWS cross-account access configuration, used when cloud_provider is aws.
    cloud_provider str
    Cloud provider type. Only aws is supported.
    id str
    Unique identifier of the resource.
    name str
    Human-readable name for this cloud provider access. Unique within the organization.
    state str
    Current state of the cloud provider access.
    aws Property Map
    AWS cross-account access configuration, used when cloud_provider is aws.
    cloudProvider String
    Cloud provider type. Only aws is supported.
    id String
    Unique identifier of the resource.
    name String
    Human-readable name for this cloud provider access. Unique within the organization.
    state String
    Current state of the cloud provider access.

    Supporting Types

    GetCloudProviderAccessAws

    ExternalId string
    External ID for STS AssumeRole confused deputy protection, set by the server to the organization ID. Include it in the IAM role trust policy's sts:ExternalId condition.
    RoleArn string
    Full ARN of the IAM role Redpanda assumes in your AWS account, in the commercial aws partition. The role's trust policy must allow the principal and external ID returned by the redpanda.getCloudProviderAccessPrerequisites data source.
    ExternalId string
    External ID for STS AssumeRole confused deputy protection, set by the server to the organization ID. Include it in the IAM role trust policy's sts:ExternalId condition.
    RoleArn string
    Full ARN of the IAM role Redpanda assumes in your AWS account, in the commercial aws partition. The role's trust policy must allow the principal and external ID returned by the redpanda.getCloudProviderAccessPrerequisites data source.
    external_id string
    External ID for STS AssumeRole confused deputy protection, set by the server to the organization ID. Include it in the IAM role trust policy's sts:ExternalId condition.
    role_arn string
    Full ARN of the IAM role Redpanda assumes in your AWS account, in the commercial aws partition. The role's trust policy must allow the principal and external ID returned by the redpanda.getCloudProviderAccessPrerequisites data source.
    externalId String
    External ID for STS AssumeRole confused deputy protection, set by the server to the organization ID. Include it in the IAM role trust policy's sts:ExternalId condition.
    roleArn String
    Full ARN of the IAM role Redpanda assumes in your AWS account, in the commercial aws partition. The role's trust policy must allow the principal and external ID returned by the redpanda.getCloudProviderAccessPrerequisites data source.
    externalId string
    External ID for STS AssumeRole confused deputy protection, set by the server to the organization ID. Include it in the IAM role trust policy's sts:ExternalId condition.
    roleArn string
    Full ARN of the IAM role Redpanda assumes in your AWS account, in the commercial aws partition. The role's trust policy must allow the principal and external ID returned by the redpanda.getCloudProviderAccessPrerequisites data source.
    external_id str
    External ID for STS AssumeRole confused deputy protection, set by the server to the organization ID. Include it in the IAM role trust policy's sts:ExternalId condition.
    role_arn str
    Full ARN of the IAM role Redpanda assumes in your AWS account, in the commercial aws partition. The role's trust policy must allow the principal and external ID returned by the redpanda.getCloudProviderAccessPrerequisites data source.
    externalId String
    External ID for STS AssumeRole confused deputy protection, set by the server to the organization ID. Include it in the IAM role trust policy's sts:ExternalId condition.
    roleArn String
    Full ARN of the IAM role Redpanda assumes in your AWS account, in the commercial aws partition. The role's trust policy must allow the principal and external ID returned by the redpanda.getCloudProviderAccessPrerequisites data source.

    Package Details

    Repository
    redpanda redpanda-data/terraform-provider-redpanda
    License
    Notes
    This Pulumi package is based on the redpanda Terraform Provider.
    redpanda
    Viewing docs for redpanda 2.6.0
    published on Friday, Oct 23, 2026 by redpanda-data

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial