1. Registry
  2. Packages
  3. Redpanda Provider
  4. API Docs
  5. getCloudProviderAccessPrerequisites
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 the values an IAM role trust policy needs before a redpanda.CloudProviderAccess can use the role

    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 aws = redpanda.getCloudProviderAccessPrerequisites({
        cloudProvider: "aws",
    });
    export const trustPrincipalArn = aws.then(aws => aws.aws?.principalArn);
    export const trustExternalId = aws.then(aws => aws.aws?.externalId);
    
    import pulumi
    import pulumi_redpanda as redpanda
    
    aws = redpanda.get_cloud_provider_access_prerequisites(cloud_provider="aws")
    pulumi.export("trustPrincipalArn", aws.aws.principal_arn)
    pulumi.export("trustExternalId", aws.aws.external_id)
    
    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 {
    		aws, err := redpanda.GetCloudProviderAccessPrerequisites(ctx, &redpanda.GetCloudProviderAccessPrerequisitesArgs{
    			CloudProvider: "aws",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("trustPrincipalArn", aws.Aws.PrincipalArn)
    		ctx.Export("trustExternalId", aws.Aws.ExternalId)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Redpanda = Pulumi.Redpanda;
    
    return await Deployment.RunAsync(() => 
    {
        var aws = Redpanda.GetCloudProviderAccessPrerequisites.Invoke(new()
        {
            CloudProvider = "aws",
        });
    
        return new Dictionary<string, object?>
        {
            ["trustPrincipalArn"] = aws.Apply(getCloudProviderAccessPrerequisitesResult => getCloudProviderAccessPrerequisitesResult.Aws?.PrincipalArn),
            ["trustExternalId"] = aws.Apply(getCloudProviderAccessPrerequisitesResult => getCloudProviderAccessPrerequisitesResult.Aws?.ExternalId),
        };
    });
    
    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.GetCloudProviderAccessPrerequisitesArgs;
    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 aws = RedpandaFunctions.getCloudProviderAccessPrerequisites(GetCloudProviderAccessPrerequisitesArgs.builder()
                .cloudProvider("aws")
                .build());
    
            ctx.export("trustPrincipalArn", aws.aws().principalArn());
            ctx.export("trustExternalId", aws.aws().externalId());
        }
    }
    
    variables:
      aws:
        fn::invoke:
          function: redpanda:getCloudProviderAccessPrerequisites
          arguments:
            cloudProvider: aws
    outputs:
      trustPrincipalArn: ${aws.aws.principalArn}
      trustExternalId: ${aws.aws.externalId}
    
    Example coming soon!
    

    Using getCloudProviderAccessPrerequisites

    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 getCloudProviderAccessPrerequisites(args: GetCloudProviderAccessPrerequisitesArgs, opts?: InvokeOptions): Promise<GetCloudProviderAccessPrerequisitesResult>
    function getCloudProviderAccessPrerequisitesOutput(args: GetCloudProviderAccessPrerequisitesOutputArgs, opts?: InvokeOutputOptions): Output<GetCloudProviderAccessPrerequisitesResult>
    def get_cloud_provider_access_prerequisites(cloud_provider: Optional[str] = None,
                                                opts: Optional[InvokeOptions] = None) -> GetCloudProviderAccessPrerequisitesResult
    def get_cloud_provider_access_prerequisites_output(cloud_provider: pulumi.Input[Optional[str]] = None,
                                                opts: Optional[InvokeOutputOptions] = None) -> Output[GetCloudProviderAccessPrerequisitesResult]
    func GetCloudProviderAccessPrerequisites(ctx *Context, args *GetCloudProviderAccessPrerequisitesArgs, opts ...InvokeOption) (*GetCloudProviderAccessPrerequisitesResult, error)
    func GetCloudProviderAccessPrerequisitesOutput(ctx *Context, args *GetCloudProviderAccessPrerequisitesOutputArgs, opts ...InvokeOption) GetCloudProviderAccessPrerequisitesResultOutput

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

    public static class GetCloudProviderAccessPrerequisites 
    {
        public static Task<GetCloudProviderAccessPrerequisitesResult> InvokeAsync(GetCloudProviderAccessPrerequisitesArgs args, InvokeOptions? opts = null)
        public static Output<GetCloudProviderAccessPrerequisitesResult> Invoke(GetCloudProviderAccessPrerequisitesInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetCloudProviderAccessPrerequisitesResult> Invoke(GetCloudProviderAccessPrerequisitesInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetCloudProviderAccessPrerequisitesResult> getCloudProviderAccessPrerequisites(GetCloudProviderAccessPrerequisitesArgs args, InvokeOptions options)
    public static Output<GetCloudProviderAccessPrerequisitesResult> getCloudProviderAccessPrerequisites(GetCloudProviderAccessPrerequisitesArgs args, InvokeOptions options)
    public static Output<GetCloudProviderAccessPrerequisitesResult> getCloudProviderAccessPrerequisites(GetCloudProviderAccessPrerequisitesArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: redpanda:index/getCloudProviderAccessPrerequisites:getCloudProviderAccessPrerequisites
      arguments:
        # arguments dictionary
    data "redpanda_get_cloud_provider_access_prerequisites" "name" {
        # arguments
    }

    The following arguments are supported:

    CloudProvider string
    Cloud provider to get prerequisites for. Only aws is supported.
    CloudProvider string
    Cloud provider to get prerequisites for. Only aws is supported.
    cloud_provider string
    Cloud provider to get prerequisites for. Only aws is supported.
    cloudProvider String
    Cloud provider to get prerequisites for. Only aws is supported.
    cloudProvider string
    Cloud provider to get prerequisites for. Only aws is supported.
    cloud_provider str
    Cloud provider to get prerequisites for. Only aws is supported.
    cloudProvider String
    Cloud provider to get prerequisites for. Only aws is supported.

    getCloudProviderAccessPrerequisites Result

    The following output properties are available:

    Aws GetCloudProviderAccessPrerequisitesAws
    AWS prerequisites. Set when cloud_provider is aws.
    CloudProvider string
    Cloud provider to get prerequisites for. Only aws is supported.
    Id string
    The provider-assigned unique ID for this managed resource.
    Aws GetCloudProviderAccessPrerequisitesAws
    AWS prerequisites. Set when cloud_provider is aws.
    CloudProvider string
    Cloud provider to get prerequisites for. Only aws is supported.
    Id string
    The provider-assigned unique ID for this managed resource.
    aws object
    AWS prerequisites. Set when cloud_provider is aws.
    cloud_provider string
    Cloud provider to get prerequisites for. Only aws is supported.
    id string
    The provider-assigned unique ID for this managed resource.
    aws GetCloudProviderAccessPrerequisitesAws
    AWS prerequisites. Set when cloud_provider is aws.
    cloudProvider String
    Cloud provider to get prerequisites for. Only aws is supported.
    id String
    The provider-assigned unique ID for this managed resource.
    aws GetCloudProviderAccessPrerequisitesAws
    AWS prerequisites. Set when cloud_provider is aws.
    cloudProvider string
    Cloud provider to get prerequisites for. Only aws is supported.
    id string
    The provider-assigned unique ID for this managed resource.
    aws GetCloudProviderAccessPrerequisitesAws
    AWS prerequisites. Set when cloud_provider is aws.
    cloud_provider str
    Cloud provider to get prerequisites for. Only aws is supported.
    id str
    The provider-assigned unique ID for this managed resource.
    aws Property Map
    AWS prerequisites. Set when cloud_provider is aws.
    cloudProvider String
    Cloud provider to get prerequisites for. Only aws is supported.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    GetCloudProviderAccessPrerequisitesAws

    ExternalId string
    External ID to require in the IAM role trust policy's sts:ExternalId condition.
    PrincipalArn string
    ARN of the Redpanda principal that assumes the role. Allow it as the Principal in the IAM role trust policy.
    ExternalId string
    External ID to require in the IAM role trust policy's sts:ExternalId condition.
    PrincipalArn string
    ARN of the Redpanda principal that assumes the role. Allow it as the Principal in the IAM role trust policy.
    external_id string
    External ID to require in the IAM role trust policy's sts:ExternalId condition.
    principal_arn string
    ARN of the Redpanda principal that assumes the role. Allow it as the Principal in the IAM role trust policy.
    externalId String
    External ID to require in the IAM role trust policy's sts:ExternalId condition.
    principalArn String
    ARN of the Redpanda principal that assumes the role. Allow it as the Principal in the IAM role trust policy.
    externalId string
    External ID to require in the IAM role trust policy's sts:ExternalId condition.
    principalArn string
    ARN of the Redpanda principal that assumes the role. Allow it as the Principal in the IAM role trust policy.
    external_id str
    External ID to require in the IAM role trust policy's sts:ExternalId condition.
    principal_arn str
    ARN of the Redpanda principal that assumes the role. Allow it as the Principal in the IAM role trust policy.
    externalId String
    External ID to require in the IAM role trust policy's sts:ExternalId condition.
    principalArn String
    ARN of the Redpanda principal that assumes the role. Allow it as the Principal in the IAM role trust policy.

    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