confluent_schema_registry_cluster.md

page_title	subcategory	description
confluent_schema_registry_cluster Data Source - terraform-provider-confluent

confluent_schema_registry_cluster Data Source

data.confluent_schema_registry_cluster describes a Schema Registry cluster data source.

Example Usage

provider "confluent" {
  cloud_api_key    = var.confluent_cloud_api_key    # optionally use CONFLUENT_CLOUD_API_KEY env var
  cloud_api_secret = var.confluent_cloud_api_secret # optionally use CONFLUENT_CLOUD_API_SECRET env var
}

# Loads the only Schema Registry cluster in the target environment
data "confluent_schema_registry_cluster" "example_using_env_id" {
  environment {
    id = "env-xyz456"
  }
}

output "example_using_env_id" {
  value = data.confluent_schema_registry_cluster.example_using_env_id
}

data "confluent_schema_registry_cluster" "example_using_id" {
  id = "lsrc-abc123"
  environment {
    id = "env-xyz456"
  }
}

output "example_using_id" {
  value = data.confluent_schema_registry_cluster.example_using_id
}

data "confluent_schema_registry_cluster" "example_using_name" {
  display_name = "Stream Governance Package"
  environment {
    id = "env-xyz456"
  }
}

output "example_using_name" {
  value = data.confluent_schema_registry_cluster.example_using_name
}

Argument Reference

The following arguments are supported:

• id - (Required String) The ID of the Schema Registry cluster (for example, lsrc-abc123).
• display_name - (Optional String) The name for the Schema Registry cluster.
• environment (Required Configuration Block) supports the following:
  • id - (Required String) The ID of the Environment that the Schema Registry cluster belongs to, for example, env-xyz456.

Attributes Reference

In addition to the preceding arguments, the following attributes are exported:

• id - (Required String) The ID of the Schema Registry cluster, for example, lsrc-abc123.
• package - (Required String) The type of the billing package. Accepted values are: ESSENTIALS and ADVANCED.
• region - (Required String) The ID of the Schema Registry region that the Schema Registry cluster belongs to, for example, us-east4.
• api_version - (Required String) An API Version of the schema version of the Schema Registry cluster, for example, stream-governance/v2.
• kind - (Required String) A kind of the Schema Registry cluster, for example, Cluster.
• rest_endpoint - (Required String) The HTTP endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-west-2.aws.confluent.cloud.
• private_rest_endpoint - (Required String) The private HTTP endpoint of the Schema Registry cluster, for example, https://lsrc.us-west-2.aws.private.confluent.cloud.
• catalog_endpoint - (Required String) The Catalog endpoint of the Schema Registry cluster, for example, https://psrc-y1113.us-west-2.aws.confluent.cloud.
• display_name - (Required String) The name of the Schema Registry cluster, for example, Stream Governance Package.
• resource_name - (Required String) The Confluent Resource Name of the Schema Registry cluster, for example, crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa/environment=env-abc123/schema-registry=lsrc-abc123.
• cloud - (Required String) The cloud service provider that that the Schema Registry cluster belongs to, for example, AWS.

-> Note: Use the environment[0] prefix for referencing these attributes, for example, data.confluent_schema_registry_cluster.example_using_name.environment[0].id.

-> Note: Only one of rest_endpoint and private_rest_endpoint will contain a non-empty value at one time.