1. Registry
  2. Packages
  3. Redpanda Provider
  4. API Docs
  5. CloudProviderAccess
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

    Example Usage

    Create CloudProviderAccess Resource

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

    Constructor syntax

    new CloudProviderAccess(name: string, args: CloudProviderAccessArgs, opts?: CustomResourceOptions);
    @overload
    def CloudProviderAccess(resource_name: str,
                            args: CloudProviderAccessArgs,
                            opts: Optional[ResourceOptions] = None)
    
    @overload
    def CloudProviderAccess(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            aws: Optional[CloudProviderAccessAwsArgs] = None,
                            cloud_provider: Optional[str] = None,
                            name: Optional[str] = None)
    func NewCloudProviderAccess(ctx *Context, name string, args CloudProviderAccessArgs, opts ...ResourceOption) (*CloudProviderAccess, error)
    public CloudProviderAccess(string name, CloudProviderAccessArgs args, CustomResourceOptions? opts = null)
    public CloudProviderAccess(String name, CloudProviderAccessArgs args)
    public CloudProviderAccess(String name, CloudProviderAccessArgs args, CustomResourceOptions options)
    
    type: redpanda:CloudProviderAccess
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "redpanda_cloud_provider_access" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args CloudProviderAccessArgs
    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 CloudProviderAccessArgs
    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 CloudProviderAccessArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CloudProviderAccessArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CloudProviderAccessArgs
    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 cloudProviderAccessResource = new Redpanda.CloudProviderAccess("cloudProviderAccessResource", new()
    {
        Aws = new Redpanda.Inputs.CloudProviderAccessAwsArgs
        {
            RoleArn = "string",
            ExternalId = "string",
        },
        CloudProvider = "string",
        Name = "string",
    });
    
    example, err := redpanda.NewCloudProviderAccess(ctx, "cloudProviderAccessResource", &redpanda.CloudProviderAccessArgs{
    	Aws: &redpanda.CloudProviderAccessAwsArgs{
    		RoleArn:    pulumi.String("string"),
    		ExternalId: pulumi.String("string"),
    	},
    	CloudProvider: pulumi.String("string"),
    	Name:          pulumi.String("string"),
    })
    
    resource "redpanda_cloud_provider_access" "cloudProviderAccessResource" {
      lifecycle {
        create_before_destroy = true
      }
      aws = {
        role_arn    = "string"
        external_id = "string"
      }
      cloud_provider = "string"
      name           = "string"
    }
    
    var cloudProviderAccessResource = new CloudProviderAccess("cloudProviderAccessResource", CloudProviderAccessArgs.builder()
        .aws(CloudProviderAccessAwsArgs.builder()
            .roleArn("string")
            .externalId("string")
            .build())
        .cloudProvider("string")
        .name("string")
        .build());
    
    cloud_provider_access_resource = redpanda.CloudProviderAccess("cloudProviderAccessResource",
        aws={
            "role_arn": "string",
            "external_id": "string",
        },
        cloud_provider="string",
        name="string")
    
    const cloudProviderAccessResource = new redpanda.CloudProviderAccess("cloudProviderAccessResource", {
        aws: {
            roleArn: "string",
            externalId: "string",
        },
        cloudProvider: "string",
        name: "string",
    });
    
    type: redpanda:CloudProviderAccess
    properties:
        aws:
            externalId: string
            roleArn: string
        cloudProvider: string
        name: string
    

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

    Aws CloudProviderAccessAws
    AWS cross-account access configuration, used when cloud_provider is aws.
    CloudProvider string
    Name string
    Aws CloudProviderAccessAwsArgs
    AWS cross-account access configuration, used when cloud_provider is aws.
    CloudProvider string
    Name string
    aws object
    AWS cross-account access configuration, used when cloud_provider is aws.
    cloud_provider string
    name string
    aws CloudProviderAccessAws
    AWS cross-account access configuration, used when cloud_provider is aws.
    cloudProvider String
    name String
    aws CloudProviderAccessAws
    AWS cross-account access configuration, used when cloud_provider is aws.
    cloudProvider string
    name string
    aws CloudProviderAccessAwsArgs
    AWS cross-account access configuration, used when cloud_provider is aws.
    cloud_provider str
    name str
    aws Property Map
    AWS cross-account access configuration, used when cloud_provider is aws.
    cloudProvider String
    name String

    Outputs

    All input properties are implicitly available as output properties. Additionally, the CloudProviderAccess resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    Current state of the cloud provider access.
    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    Current state of the cloud provider access.
    id string
    The provider-assigned unique ID for this managed resource.
    state string
    Current state of the cloud provider access.
    id String
    The provider-assigned unique ID for this managed resource.
    state String
    Current state of the cloud provider access.
    id string
    The provider-assigned unique ID for this managed resource.
    state string
    Current state of the cloud provider access.
    id str
    The provider-assigned unique ID for this managed resource.
    state str
    Current state of the cloud provider access.
    id String
    The provider-assigned unique ID for this managed resource.
    state String
    Current state of the cloud provider access.

    Look up Existing CloudProviderAccess Resource

    Get an existing CloudProviderAccess 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?: CloudProviderAccessState, opts?: CustomResourceOptions): CloudProviderAccess
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            aws: Optional[CloudProviderAccessAwsArgs] = None,
            cloud_provider: Optional[str] = None,
            name: Optional[str] = None,
            state: Optional[str] = None) -> CloudProviderAccess
    func GetCloudProviderAccess(ctx *Context, name string, id IDInput, state *CloudProviderAccessState, opts ...ResourceOption) (*CloudProviderAccess, error)
    public static CloudProviderAccess Get(string name, Input<string> id, CloudProviderAccessState? state, CustomResourceOptions? opts = null)
    public static CloudProviderAccess get(String name, Output<String> id, CloudProviderAccessState state, CustomResourceOptions options)
    resources:  _:    type: redpanda:CloudProviderAccess    get:      id: ${id}
    import {
      to = redpanda_cloud_provider_access.example
      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:
    Aws CloudProviderAccessAws
    AWS cross-account access configuration, used when cloud_provider is aws.
    CloudProvider string
    Name string
    State string
    Current state of the cloud provider access.
    Aws CloudProviderAccessAwsArgs
    AWS cross-account access configuration, used when cloud_provider is aws.
    CloudProvider string
    Name string
    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
    name string
    state string
    Current state of the cloud provider access.
    aws CloudProviderAccessAws
    AWS cross-account access configuration, used when cloud_provider is aws.
    cloudProvider String
    name String
    state String
    Current state of the cloud provider access.
    aws CloudProviderAccessAws
    AWS cross-account access configuration, used when cloud_provider is aws.
    cloudProvider string
    name string
    state string
    Current state of the cloud provider access.
    aws CloudProviderAccessAwsArgs
    AWS cross-account access configuration, used when cloud_provider is aws.
    cloud_provider str
    name str
    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
    name String
    state String
    Current state of the cloud provider access.

    Supporting Types

    CloudProviderAccessAws, CloudProviderAccessAwsArgs

    RoleArn string
    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
    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.
    role_arn string
    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.
    roleArn String
    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
    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.
    role_arn str
    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.
    roleArn String
    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.

    Import

    $ pulumi import redpanda:index/cloudProviderAccess:CloudProviderAccess example cloudProviderAccessId
    

    Where cloudProviderAccessId is the 20-character identifier assigned by Redpanda Cloud.

    To learn more about importing existing cloud resources, see Importing resources.

    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