Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Redpanda Provider
  3. API Docs
  4. Provider
redpanda 0.13.0 published on Monday, Mar 17, 2025 by redpanda-data
redpanda-data/terraform-provider-redpanda

redpanda.Provider

Explore with Pulumi AI

redpanda logo
redpanda 0.13.0 published on Monday, Mar 17, 2025 by redpanda-data
redpanda-data/terraform-provider-redpanda

    The provider type for the redpanda package. By default, resources use package-wide configuration settings, however an explicit Provider instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the documentation for more information.

    Create Provider Resource

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

    Constructor syntax

    new Provider(name: string, args?: ProviderArgs, opts?: CustomResourceOptions);
    @overload
def Provider(resource_name: str,
             args: Optional[ProviderArgs] = None,
             opts: Optional[ResourceOptions] = None)

@overload
def Provider(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             access_token: Optional[str] = None,
             azure_client_id: Optional[str] = None,
             azure_client_secret: Optional[str] = None,
             azure_subscription_id: Optional[str] = None,
             azure_tenant_id: Optional[str] = None,
             client_id: Optional[str] = None,
             client_secret: Optional[str] = None,
             gcp_project_id: Optional[str] = None,
             google_credentials: Optional[str] = None,
             google_credentials_base64: Optional[str] = None)
    func NewProvider(ctx *Context, name string, args *ProviderArgs, opts ...ResourceOption) (*Provider, error)
    public Provider(string name, ProviderArgs? args = null, CustomResourceOptions? opts = null)
    public Provider(String name, ProviderArgs args)
public Provider(String name, ProviderArgs args, CustomResourceOptions options)

    type: pulumi:providers:redpanda
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 ProviderArgs
    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 ProviderArgs
    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 ProviderArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ProviderArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ProviderArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    AccessToken string
    Redpanda client token. You need either access_token, or both client_id and client_secret to use this provider. Can also be set with the REDPANDA_ACCESS_TOKEN environment variable.
    AzureClientId string
    Used for creating and managing BYOC and BYOVPC clusters. Can also be specified in the environment as AZURE_CLIENT_ID or ARM_CLIENT_ID
    AzureClientSecret string
    Used for creating and managing BYOC and BYOVPC clusters. Can also be specified in the environment as AZURE_CLIENT_SECRET or ARM_CLIENT_SECRET
    AzureSubscriptionId string
    The default Azure Subscription ID which should be used for Redpanda BYOC clusters. If another subscription is specified on a resource, it will take precedence. This can also be sourced from the ARM_SUBSCRIPTION_ID environment variable.
    AzureTenantId string
    Used for creating and managing BYOC and BYOVPC clusters. Can also be specified in the environment as AZURE_TENANT_ID or ARM_TENANT_ID
    ClientId string
    The ID for the client. You need either client_id AND client_secret, or access_token, to use this provider. Can also be set with the REDPANDA_CLIENT_ID environment variable.
    ClientSecret string
    Redpanda client secret. You need either client_id AND client_secret, or access_token, to use this provider. Can also be set with the REDPANDA_CLIENT_SECRET environment variable.
    GcpProjectId string
    The default Google Cloud Project ID to use for Redpanda BYOC clusters. If another project is specified on a resource, it will take precedence. This can also be sourced from the GOOGLE_PROJECT environment variable, or any of the following ordered by precedence: GOOGLE_PROJECT, GOOGLE_CLOUD_PROJECT, GCLOUD_PROJECT, or CLOUDSDK_CORE_PROJECT.
    GoogleCredentials string
    Used for creating and managing BYOC and BYOVPC clusters. Can also be specified in the environment as GOOGLE_CREDENTIALS
    GoogleCredentialsBase64 string
    Used for creating and managing BYOC and BYOVPC clusters. Is a convenience passthrough for base64 encoded credentials intended for use in CI/CD. Can also be specified in the environment as GOOGLE_CREDENTIALS_BASE64
    AccessToken string
    Redpanda client token. You need either access_token, or both client_id and client_secret to use this provider. Can also be set with the REDPANDA_ACCESS_TOKEN environment variable.
    AzureClientId string
    Used for creating and managing BYOC and BYOVPC clusters. Can also be specified in the environment as AZURE_CLIENT_ID or ARM_CLIENT_ID
    AzureClientSecret string
    Used for creating and managing BYOC and BYOVPC clusters. Can also be specified in the environment as AZURE_CLIENT_SECRET or ARM_CLIENT_SECRET
    AzureSubscriptionId string
    The default Azure Subscription ID which should be used for Redpanda BYOC clusters. If another subscription is specified on a resource, it will take precedence. This can also be sourced from the ARM_SUBSCRIPTION_ID environment variable.
    AzureTenantId string
    Used for creating and managing BYOC and BYOVPC clusters. Can also be specified in the environment as AZURE_TENANT_ID or ARM_TENANT_ID
    ClientId string
    The ID for the client. You need either client_id AND client_secret, or access_token, to use this provider. Can also be set with the REDPANDA_CLIENT_ID environment variable.
    ClientSecret string
    Redpanda client secret. You need either client_id AND client_secret, or access_token, to use this provider. Can also be set with the REDPANDA_CLIENT_SECRET environment variable.
    GcpProjectId string
    The default Google Cloud Project ID to use for Redpanda BYOC clusters. If another project is specified on a resource, it will take precedence. This can also be sourced from the GOOGLE_PROJECT environment variable, or any of the following ordered by precedence: GOOGLE_PROJECT, GOOGLE_CLOUD_PROJECT, GCLOUD_PROJECT, or CLOUDSDK_CORE_PROJECT.
    GoogleCredentials string
    Used for creating and managing BYOC and BYOVPC clusters. Can also be specified in the environment as GOOGLE_CREDENTIALS
    GoogleCredentialsBase64 string
    Used for creating and managing BYOC and BYOVPC clusters. Is a convenience passthrough for base64 encoded credentials intended for use in CI/CD. Can also be specified in the environment as GOOGLE_CREDENTIALS_BASE64
    accessToken String
    Redpanda client token. You need either access_token, or both client_id and client_secret to use this provider. Can also be set with the REDPANDA_ACCESS_TOKEN environment variable.
    azureClientId String
    Used for creating and managing BYOC and BYOVPC clusters. Can also be specified in the environment as AZURE_CLIENT_ID or ARM_CLIENT_ID
    azureClientSecret String
    Used for creating and managing BYOC and BYOVPC clusters. Can also be specified in the environment as AZURE_CLIENT_SECRET or ARM_CLIENT_SECRET
    azureSubscriptionId String
    The default Azure Subscription ID which should be used for Redpanda BYOC clusters. If another subscription is specified on a resource, it will take precedence. This can also be sourced from the ARM_SUBSCRIPTION_ID environment variable.
    azureTenantId String
    Used for creating and managing BYOC and BYOVPC clusters. Can also be specified in the environment as AZURE_TENANT_ID or ARM_TENANT_ID
    clientId String
    The ID for the client. You need either client_id AND client_secret, or access_token, to use this provider. Can also be set with the REDPANDA_CLIENT_ID environment variable.
    clientSecret String
    Redpanda client secret. You need either client_id AND client_secret, or access_token, to use this provider. Can also be set with the REDPANDA_CLIENT_SECRET environment variable.
    gcpProjectId String
    The default Google Cloud Project ID to use for Redpanda BYOC clusters. If another project is specified on a resource, it will take precedence. This can also be sourced from the GOOGLE_PROJECT environment variable, or any of the following ordered by precedence: GOOGLE_PROJECT, GOOGLE_CLOUD_PROJECT, GCLOUD_PROJECT, or CLOUDSDK_CORE_PROJECT.
    googleCredentials String
    Used for creating and managing BYOC and BYOVPC clusters. Can also be specified in the environment as GOOGLE_CREDENTIALS
    googleCredentialsBase64 String
    Used for creating and managing BYOC and BYOVPC clusters. Is a convenience passthrough for base64 encoded credentials intended for use in CI/CD. Can also be specified in the environment as GOOGLE_CREDENTIALS_BASE64
    accessToken string
    Redpanda client token. You need either access_token, or both client_id and client_secret to use this provider. Can also be set with the REDPANDA_ACCESS_TOKEN environment variable.
    azureClientId string
    Used for creating and managing BYOC and BYOVPC clusters. Can also be specified in the environment as AZURE_CLIENT_ID or ARM_CLIENT_ID
    azureClientSecret string
    Used for creating and managing BYOC and BYOVPC clusters. Can also be specified in the environment as AZURE_CLIENT_SECRET or ARM_CLIENT_SECRET
    azureSubscriptionId string
    The default Azure Subscription ID which should be used for Redpanda BYOC clusters. If another subscription is specified on a resource, it will take precedence. This can also be sourced from the ARM_SUBSCRIPTION_ID environment variable.
    azureTenantId string
    Used for creating and managing BYOC and BYOVPC clusters. Can also be specified in the environment as AZURE_TENANT_ID or ARM_TENANT_ID
    clientId string
    The ID for the client. You need either client_id AND client_secret, or access_token, to use this provider. Can also be set with the REDPANDA_CLIENT_ID environment variable.
    clientSecret string
    Redpanda client secret. You need either client_id AND client_secret, or access_token, to use this provider. Can also be set with the REDPANDA_CLIENT_SECRET environment variable.
    gcpProjectId string
    The default Google Cloud Project ID to use for Redpanda BYOC clusters. If another project is specified on a resource, it will take precedence. This can also be sourced from the GOOGLE_PROJECT environment variable, or any of the following ordered by precedence: GOOGLE_PROJECT, GOOGLE_CLOUD_PROJECT, GCLOUD_PROJECT, or CLOUDSDK_CORE_PROJECT.
    googleCredentials string
    Used for creating and managing BYOC and BYOVPC clusters. Can also be specified in the environment as GOOGLE_CREDENTIALS
    googleCredentialsBase64 string
    Used for creating and managing BYOC and BYOVPC clusters. Is a convenience passthrough for base64 encoded credentials intended for use in CI/CD. Can also be specified in the environment as GOOGLE_CREDENTIALS_BASE64
    access_token str
    Redpanda client token. You need either access_token, or both client_id and client_secret to use this provider. Can also be set with the REDPANDA_ACCESS_TOKEN environment variable.
    azure_client_id str
    Used for creating and managing BYOC and BYOVPC clusters. Can also be specified in the environment as AZURE_CLIENT_ID or ARM_CLIENT_ID
    azure_client_secret str
    Used for creating and managing BYOC and BYOVPC clusters. Can also be specified in the environment as AZURE_CLIENT_SECRET or ARM_CLIENT_SECRET
    azure_subscription_id str
    The default Azure Subscription ID which should be used for Redpanda BYOC clusters. If another subscription is specified on a resource, it will take precedence. This can also be sourced from the ARM_SUBSCRIPTION_ID environment variable.
    azure_tenant_id str
    Used for creating and managing BYOC and BYOVPC clusters. Can also be specified in the environment as AZURE_TENANT_ID or ARM_TENANT_ID
    client_id str
    The ID for the client. You need either client_id AND client_secret, or access_token, to use this provider. Can also be set with the REDPANDA_CLIENT_ID environment variable.
    client_secret str
    Redpanda client secret. You need either client_id AND client_secret, or access_token, to use this provider. Can also be set with the REDPANDA_CLIENT_SECRET environment variable.
    gcp_project_id str
    The default Google Cloud Project ID to use for Redpanda BYOC clusters. If another project is specified on a resource, it will take precedence. This can also be sourced from the GOOGLE_PROJECT environment variable, or any of the following ordered by precedence: GOOGLE_PROJECT, GOOGLE_CLOUD_PROJECT, GCLOUD_PROJECT, or CLOUDSDK_CORE_PROJECT.
    google_credentials str
    Used for creating and managing BYOC and BYOVPC clusters. Can also be specified in the environment as GOOGLE_CREDENTIALS
    google_credentials_base64 str
    Used for creating and managing BYOC and BYOVPC clusters. Is a convenience passthrough for base64 encoded credentials intended for use in CI/CD. Can also be specified in the environment as GOOGLE_CREDENTIALS_BASE64
    accessToken String
    Redpanda client token. You need either access_token, or both client_id and client_secret to use this provider. Can also be set with the REDPANDA_ACCESS_TOKEN environment variable.
    azureClientId String
    Used for creating and managing BYOC and BYOVPC clusters. Can also be specified in the environment as AZURE_CLIENT_ID or ARM_CLIENT_ID
    azureClientSecret String
    Used for creating and managing BYOC and BYOVPC clusters. Can also be specified in the environment as AZURE_CLIENT_SECRET or ARM_CLIENT_SECRET
    azureSubscriptionId String
    The default Azure Subscription ID which should be used for Redpanda BYOC clusters. If another subscription is specified on a resource, it will take precedence. This can also be sourced from the ARM_SUBSCRIPTION_ID environment variable.
    azureTenantId String
    Used for creating and managing BYOC and BYOVPC clusters. Can also be specified in the environment as AZURE_TENANT_ID or ARM_TENANT_ID
    clientId String
    The ID for the client. You need either client_id AND client_secret, or access_token, to use this provider. Can also be set with the REDPANDA_CLIENT_ID environment variable.
    clientSecret String
    Redpanda client secret. You need either client_id AND client_secret, or access_token, to use this provider. Can also be set with the REDPANDA_CLIENT_SECRET environment variable.
    gcpProjectId String
    The default Google Cloud Project ID to use for Redpanda BYOC clusters. If another project is specified on a resource, it will take precedence. This can also be sourced from the GOOGLE_PROJECT environment variable, or any of the following ordered by precedence: GOOGLE_PROJECT, GOOGLE_CLOUD_PROJECT, GCLOUD_PROJECT, or CLOUDSDK_CORE_PROJECT.
    googleCredentials String
    Used for creating and managing BYOC and BYOVPC clusters. Can also be specified in the environment as GOOGLE_CREDENTIALS
    googleCredentialsBase64 String
    Used for creating and managing BYOC and BYOVPC clusters. Is a convenience passthrough for base64 encoded credentials intended for use in CI/CD. Can also be specified in the environment as GOOGLE_CREDENTIALS_BASE64

    Outputs

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

    Package Details

    Repository
    redpanda redpanda-data/terraform-provider-redpanda
    License
    Notes
    This Pulumi package is based on the redpanda Terraform Provider.
    redpanda logo
    redpanda 0.13.0 published on Monday, Mar 17, 2025 by redpanda-data
    redpanda-data/terraform-provider-redpanda