Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Confluent Provider
  3. API Docs
  4. Provider
Confluent v2.23.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-confluentcloud

confluentcloud.Provider

Explore with Pulumi AI

Confluent v2.23.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-confluentcloud

The provider type for the confluent 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,
             catalog_rest_endpoint: Optional[str] = None,
             cloud_api_key: Optional[str] = None,
             cloud_api_secret: Optional[str] = None,
             endpoint: Optional[str] = None,
             environment_id: Optional[str] = None,
             flink_api_key: Optional[str] = None,
             flink_api_secret: Optional[str] = None,
             flink_compute_pool_id: Optional[str] = None,
             flink_principal_id: Optional[str] = None,
             flink_rest_endpoint: Optional[str] = None,
             kafka_api_key: Optional[str] = None,
             kafka_api_secret: Optional[str] = None,
             kafka_id: Optional[str] = None,
             kafka_rest_endpoint: Optional[str] = None,
             max_retries: Optional[int] = None,
             organization_id: Optional[str] = None,
             schema_registry_api_key: Optional[str] = None,
             schema_registry_api_secret: Optional[str] = None,
             schema_registry_id: Optional[str] = None,
             schema_registry_rest_endpoint: Optional[str] = None,
             tableflow_api_key: Optional[str] = None,
             tableflow_api_secret: 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:confluentcloud
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:

CatalogRestEndpoint string
The Stream Catalog REST Endpoint.
CloudApiKey string
The Confluent Cloud API Key.
CloudApiSecret string
The Confluent Cloud API Secret.
Endpoint string
The base endpoint of Confluent Cloud API.
EnvironmentId string
The Flink Environment ID.
FlinkApiKey string
The Flink API Key.
FlinkApiSecret string
The Flink API Secret.
FlinkComputePoolId string
The Flink Compute Pool ID.
FlinkPrincipalId string
The Flink Principal ID.
FlinkRestEndpoint string
The Flink REST Endpoint.
KafkaApiKey string
The Kafka Cluster API Key.
KafkaApiSecret string
The Kafka Cluster API Secret.
KafkaId string
The Kafka Cluster ID.
KafkaRestEndpoint string
The Kafka Cluster REST Endpoint.
MaxRetries int
Maximum number of retries of HTTP client. Defaults to 4.
OrganizationId string
The Flink Organization ID.
SchemaRegistryApiKey string
The Schema Registry Cluster API Key.
SchemaRegistryApiSecret string
The Schema Registry Cluster API Secret.
SchemaRegistryId string
The Schema Registry Cluster ID.
SchemaRegistryRestEndpoint string
The Schema Registry Cluster REST Endpoint.
TableflowApiKey string
The Tableflow API Key.
TableflowApiSecret string
The Tableflow API Secret.
CatalogRestEndpoint string
The Stream Catalog REST Endpoint.
CloudApiKey string
The Confluent Cloud API Key.
CloudApiSecret string
The Confluent Cloud API Secret.
Endpoint string
The base endpoint of Confluent Cloud API.
EnvironmentId string
The Flink Environment ID.
FlinkApiKey string
The Flink API Key.
FlinkApiSecret string
The Flink API Secret.
FlinkComputePoolId string
The Flink Compute Pool ID.
FlinkPrincipalId string
The Flink Principal ID.
FlinkRestEndpoint string
The Flink REST Endpoint.
KafkaApiKey string
The Kafka Cluster API Key.
KafkaApiSecret string
The Kafka Cluster API Secret.
KafkaId string
The Kafka Cluster ID.
KafkaRestEndpoint string
The Kafka Cluster REST Endpoint.
MaxRetries int
Maximum number of retries of HTTP client. Defaults to 4.
OrganizationId string
The Flink Organization ID.
SchemaRegistryApiKey string
The Schema Registry Cluster API Key.
SchemaRegistryApiSecret string
The Schema Registry Cluster API Secret.
SchemaRegistryId string
The Schema Registry Cluster ID.
SchemaRegistryRestEndpoint string
The Schema Registry Cluster REST Endpoint.
TableflowApiKey string
The Tableflow API Key.
TableflowApiSecret string
The Tableflow API Secret.
catalogRestEndpoint String
The Stream Catalog REST Endpoint.
cloudApiKey String
The Confluent Cloud API Key.
cloudApiSecret String
The Confluent Cloud API Secret.
endpoint String
The base endpoint of Confluent Cloud API.
environmentId String
The Flink Environment ID.
flinkApiKey String
The Flink API Key.
flinkApiSecret String
The Flink API Secret.
flinkComputePoolId String
The Flink Compute Pool ID.
flinkPrincipalId String
The Flink Principal ID.
flinkRestEndpoint String
The Flink REST Endpoint.
kafkaApiKey String
The Kafka Cluster API Key.
kafkaApiSecret String
The Kafka Cluster API Secret.
kafkaId String
The Kafka Cluster ID.
kafkaRestEndpoint String
The Kafka Cluster REST Endpoint.
maxRetries Integer
Maximum number of retries of HTTP client. Defaults to 4.
organizationId String
The Flink Organization ID.
schemaRegistryApiKey String
The Schema Registry Cluster API Key.
schemaRegistryApiSecret String
The Schema Registry Cluster API Secret.
schemaRegistryId String
The Schema Registry Cluster ID.
schemaRegistryRestEndpoint String
The Schema Registry Cluster REST Endpoint.
tableflowApiKey String
The Tableflow API Key.
tableflowApiSecret String
The Tableflow API Secret.
catalogRestEndpoint string
The Stream Catalog REST Endpoint.
cloudApiKey string
The Confluent Cloud API Key.
cloudApiSecret string
The Confluent Cloud API Secret.
endpoint string
The base endpoint of Confluent Cloud API.
environmentId string
The Flink Environment ID.
flinkApiKey string
The Flink API Key.
flinkApiSecret string
The Flink API Secret.
flinkComputePoolId string
The Flink Compute Pool ID.
flinkPrincipalId string
The Flink Principal ID.
flinkRestEndpoint string
The Flink REST Endpoint.
kafkaApiKey string
The Kafka Cluster API Key.
kafkaApiSecret string
The Kafka Cluster API Secret.
kafkaId string
The Kafka Cluster ID.
kafkaRestEndpoint string
The Kafka Cluster REST Endpoint.
maxRetries number
Maximum number of retries of HTTP client. Defaults to 4.
organizationId string
The Flink Organization ID.
schemaRegistryApiKey string
The Schema Registry Cluster API Key.
schemaRegistryApiSecret string
The Schema Registry Cluster API Secret.
schemaRegistryId string
The Schema Registry Cluster ID.
schemaRegistryRestEndpoint string
The Schema Registry Cluster REST Endpoint.
tableflowApiKey string
The Tableflow API Key.
tableflowApiSecret string
The Tableflow API Secret.
catalog_rest_endpoint str
The Stream Catalog REST Endpoint.
cloud_api_key str
The Confluent Cloud API Key.
cloud_api_secret str
The Confluent Cloud API Secret.
endpoint str
The base endpoint of Confluent Cloud API.
environment_id str
The Flink Environment ID.
flink_api_key str
The Flink API Key.
flink_api_secret str
The Flink API Secret.
flink_compute_pool_id str
The Flink Compute Pool ID.
flink_principal_id str
The Flink Principal ID.
flink_rest_endpoint str
The Flink REST Endpoint.
kafka_api_key str
The Kafka Cluster API Key.
kafka_api_secret str
The Kafka Cluster API Secret.
kafka_id str
The Kafka Cluster ID.
kafka_rest_endpoint str
The Kafka Cluster REST Endpoint.
max_retries int
Maximum number of retries of HTTP client. Defaults to 4.
organization_id str
The Flink Organization ID.
schema_registry_api_key str
The Schema Registry Cluster API Key.
schema_registry_api_secret str
The Schema Registry Cluster API Secret.
schema_registry_id str
The Schema Registry Cluster ID.
schema_registry_rest_endpoint str
The Schema Registry Cluster REST Endpoint.
tableflow_api_key str
The Tableflow API Key.
tableflow_api_secret str
The Tableflow API Secret.
catalogRestEndpoint String
The Stream Catalog REST Endpoint.
cloudApiKey String
The Confluent Cloud API Key.
cloudApiSecret String
The Confluent Cloud API Secret.
endpoint String
The base endpoint of Confluent Cloud API.
environmentId String
The Flink Environment ID.
flinkApiKey String
The Flink API Key.
flinkApiSecret String
The Flink API Secret.
flinkComputePoolId String
The Flink Compute Pool ID.
flinkPrincipalId String
The Flink Principal ID.
flinkRestEndpoint String
The Flink REST Endpoint.
kafkaApiKey String
The Kafka Cluster API Key.
kafkaApiSecret String
The Kafka Cluster API Secret.
kafkaId String
The Kafka Cluster ID.
kafkaRestEndpoint String
The Kafka Cluster REST Endpoint.
maxRetries Number
Maximum number of retries of HTTP client. Defaults to 4.
organizationId String
The Flink Organization ID.
schemaRegistryApiKey String
The Schema Registry Cluster API Key.
schemaRegistryApiSecret String
The Schema Registry Cluster API Secret.
schemaRegistryId String
The Schema Registry Cluster ID.
schemaRegistryRestEndpoint String
The Schema Registry Cluster REST Endpoint.
tableflowApiKey String
The Tableflow API Key.
tableflowApiSecret String
The Tableflow API Secret.

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
Confluent Cloud pulumi/pulumi-confluentcloud
License
Apache-2.0
Notes
This Pulumi package is based on the confluent Terraform Provider.
Confluent v2.23.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-confluentcloud