Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. CockroachDB Cloud
  3. API Docs
  4. Provider
CockroachDB v0.9.4 published on Friday, Mar 21, 2025 by pulumiverse
pulumiverse/pulumi-cockroach

cockroach.Provider

Explore with Pulumi AI

CockroachDB v0.9.4 published on Friday, Mar 21, 2025 by pulumiverse
pulumiverse/pulumi-cockroach

The provider type for the cockroach 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,
             apijwt: Optional[str] = None,
             apikey: 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:cockroach
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. String
The unique name of the resource.
args This property is required. 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:

Apijwt string
The JWT from a JWT Issuer configured for the CockroachDB Cloud Organization. In this case, the vanity name of the organization is required and can be provided using the COCKROACH_VANITY_NAME environment variable. If the JWT is mapped to multiple identities, the identity to impersonate should be provided using the COCKROACH_USERNAME environment variable, and should contain either a user email address or a service account ID.
Apikey string
The API key to access CockroachDB Cloud. If this field is provided, it is used and apijwt is ignored.
Apijwt string
The JWT from a JWT Issuer configured for the CockroachDB Cloud Organization. In this case, the vanity name of the organization is required and can be provided using the COCKROACH_VANITY_NAME environment variable. If the JWT is mapped to multiple identities, the identity to impersonate should be provided using the COCKROACH_USERNAME environment variable, and should contain either a user email address or a service account ID.
Apikey string
The API key to access CockroachDB Cloud. If this field is provided, it is used and apijwt is ignored.
apijwt String
The JWT from a JWT Issuer configured for the CockroachDB Cloud Organization. In this case, the vanity name of the organization is required and can be provided using the COCKROACH_VANITY_NAME environment variable. If the JWT is mapped to multiple identities, the identity to impersonate should be provided using the COCKROACH_USERNAME environment variable, and should contain either a user email address or a service account ID.
apikey String
The API key to access CockroachDB Cloud. If this field is provided, it is used and apijwt is ignored.
apijwt string
The JWT from a JWT Issuer configured for the CockroachDB Cloud Organization. In this case, the vanity name of the organization is required and can be provided using the COCKROACH_VANITY_NAME environment variable. If the JWT is mapped to multiple identities, the identity to impersonate should be provided using the COCKROACH_USERNAME environment variable, and should contain either a user email address or a service account ID.
apikey string
The API key to access CockroachDB Cloud. If this field is provided, it is used and apijwt is ignored.
apijwt str
The JWT from a JWT Issuer configured for the CockroachDB Cloud Organization. In this case, the vanity name of the organization is required and can be provided using the COCKROACH_VANITY_NAME environment variable. If the JWT is mapped to multiple identities, the identity to impersonate should be provided using the COCKROACH_USERNAME environment variable, and should contain either a user email address or a service account ID.
apikey str
The API key to access CockroachDB Cloud. If this field is provided, it is used and apijwt is ignored.
apijwt String
The JWT from a JWT Issuer configured for the CockroachDB Cloud Organization. In this case, the vanity name of the organization is required and can be provided using the COCKROACH_VANITY_NAME environment variable. If the JWT is mapped to multiple identities, the identity to impersonate should be provided using the COCKROACH_USERNAME environment variable, and should contain either a user email address or a service account ID.
apikey String
The API key to access CockroachDB Cloud. If this field is provided, it is used and apijwt is ignored.

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
cockroach pulumiverse/pulumi-cockroach
License
Apache-2.0
Notes
This Pulumi package is based on the cockroach Terraform Provider.
CockroachDB v0.9.4 published on Friday, Mar 21, 2025 by pulumiverse
pulumiverse/pulumi-cockroach