Create shadow link | Cloud Control Plane API documentation

Create shadow link Run in API Explorer

POST /v1/shadow-links

Auth0

Create a Redpanda shadow link for data replication.

application/json

Body Required

CreateShadowLinkRequest creates a new shadow link.

shadow_link object

ShadowLinkCreate contains fields for creating a shadow link.
Hide shadow_link attributes Show shadow_link attributes object
- client_options object
  
  ShadowLinkClientOptions configures the Kafka client connection settings.
  Hide client_options attributes Show client_options attributes object
  
  authentication_configuration object
  
  Hide authentication_configuration attribute Show authentication_configuration attribute object
  
  scram_configuration object
  
  Hide scram_configuration attributes Show scram_configuration attributes object
  
  password string
  
  scram_mechanism string
  
  SCRAM_MECHANISM_SCRAM_SHA_256: SCRAM-SHA-256
  
  SCRAM_MECHANISM_SCRAM_SHA_512: SCRAM-SHA-512
  
  Values are SCRAM_MECHANISM_SCRAM_SHA_256 or SCRAM_MECHANISM_SCRAM_SHA_512.
  
  username string
  
  bootstrap_servers array[string]
  
  Bootstrap servers for the source cluster. Required if source Redpanda ID is not provided.
  
  connection_timeout_ms integer(int32)
  
  Connection timeout in milliseconds (defaults to 1000ms if 0).
  
  fetch_max_bytes integer(int32)
  
  Maximum bytes to fetch (defaults to 20971520 bytes / 20 MiB if 0).
  
  fetch_min_bytes integer(int32)
  
  Minimum bytes to fetch (defaults to 5242880 bytes / 5 MiB if 0).
  
  fetch_partition_max_bytes integer(int32)
  
  Maximum bytes per partition to fetch (defaults to 1048576 bytes / 1 MiB if 0).
  
  fetch_wait_max_ms integer(int32)
  
  Maximum time to wait for fetch requests in milliseconds (defaults to 500ms if 0).
  
  metadata_max_age_ms integer(int32)
  
  Metadata refresh interval in milliseconds (defaults to 10000ms if 0).
  
  retry_backoff_ms integer(int32)
  
  Retry backoff in milliseconds (defaults to 100ms if 0).
  
  source_cluster_id string
  
  Source cluster ID.
  
  tls_settings object
  
  TLSSettings configures TLS encryption.
  
  Hide tls_settings attributes Show tls_settings attributes object
  
  ca string
  
  The CA certificate for TLS.
  
  cert string
  
  Cert is the certificate for TLS.
  
  Key and Cert are optional but if one is provided, then both must be provided.
  
  do_not_set_sni_hostname boolean
  
  Do not set SNI hostname.
  
  enabled boolean
  
  Enable TLS.
  
  key string
  
  The private key for TLS.
  
  Key and Cert are optional but if one is provided, then both must be provided.
- consumer_offset_sync_options object
  Hide consumer_offset_sync_options attributes Show consumer_offset_sync_options attributes object
  
  group_filters array[object]
  
  Hide group_filters attributes Show group_filters attributes object
  
  filter_type string
  
  FILTER_TYPE_INCLUDE: Include the items that match the filter
  
  FILTER_TYPE_EXCLUDE: Exclude the items that match the filter
  
  Values are FILTER_TYPE_INCLUDE or FILTER_TYPE_EXCLUDE.
  
  name string
  
  pattern_type string
  
  PATTERN_TYPE_LITERAL: Must match the filter exactly
  
  PATTERN_TYPE_PREFIX: Will match anything that starts with filter
  
  Values are PATTERN_TYPE_LITERAL or PATTERN_TYPE_PREFIX.
  
  interval string
  
  paused boolean
- name string
- schema_registry_sync_options object
  
  Options for how the Schema Registry is synced.
  Hide schema_registry_sync_options attribute Show schema_registry_sync_options attribute object
  
  shadow_schema_registry_topic object
  
  Shadow the entire source cluster's Schema Registry byte-for-byte. If set, the Shadow Link will attempt to add the _schemas topic to the list of Shadow Topics as long as:
  
  The _schemas topic exists on the source cluster
  
  The _schemas topic does not exist on the shadow cluster, or it is empty. If either of the above conditions are not met, then the _schemas topic will not be shadowed by this cluster. Unsetting this flag will not remove the _schemas topic from shadowing if it has already been added. Once made a shadow topic, the _schemas topic will be replicated byte-for-byte. To stop shadowing the _schemas topic, unset this field, then either fail-over the topic or delete it.
- security_sync_options object
  Hide security_sync_options attributes Show security_sync_options attributes object
  
  acl_filters array[object]
  
  Hide acl_filters attributes Show acl_filters attributes object
  
  access_filter object
  
  Hide access_filter attributes Show access_filter attributes object
  
  host string
  
  operation string
  
  Values are ACL_OPERATION_ANY, ACL_OPERATION_READ, ACL_OPERATION_WRITE, ACL_OPERATION_CREATE, ACL_OPERATION_REMOVE, ACL_OPERATION_ALTER, ACL_OPERATION_DESCRIBE, ACL_OPERATION_CLUSTER_ACTION, ACL_OPERATION_DESCRIBE_CONFIGS, ACL_OPERATION_ALTER_CONFIGS, or ACL_OPERATION_IDEMPOTENT_WRITE.
  
  permission_type string
  
  Values are ACL_PERMISSION_TYPE_ANY, ACL_PERMISSION_TYPE_ALLOW, or ACL_PERMISSION_TYPE_DENY.
  
  principal string
  
  resource_filter object
  
  Hide resource_filter attributes Show resource_filter attributes object
  
  name string
  
  pattern_type string
  
  ACL_PATTERN_ANY: Wildcard to match any pattern
  
  ACL_PATTERN_LITERAL: Match a literal string
  
  ACL_PATTERN_PREFIXED: Match a prefix
  
  ACL_PATTERN_MATCH: Match serves as a catch-all for all the names of a topic the principal is authorized to access
  
  Values are ACL_PATTERN_ANY, ACL_PATTERN_LITERAL, ACL_PATTERN_PREFIXED, or ACL_PATTERN_MATCH.
  
  resource_type string
  
  ACL_RESOURCE_ANY: Wildcard for selecting any ACL resource
  
  ACL_RESOURCE_CLUSTER: Cluster wide resource
  
  ACL_RESOURCE_GROUP: Consumer group resource
  
  ACL_RESOURCE_TOPIC: Topic resource
  
  ACL_RESOURCE_TXN_ID: Transaction ID resource
  
  ACL_RESOURCE_SR_SUBJECT: Schema Registry subject resource
  
  ACL_RESOURCE_SR_REGISTRY: Schema Registry wide resource
  
  ACL_RESOURCE_SR_ANY: Wildcard to match any SR ACL resource
  
  Values are ACL_RESOURCE_ANY, ACL_RESOURCE_CLUSTER, ACL_RESOURCE_GROUP, ACL_RESOURCE_TOPIC, ACL_RESOURCE_TXN_ID, ACL_RESOURCE_SR_SUBJECT, ACL_RESOURCE_SR_REGISTRY, or ACL_RESOURCE_SR_ANY.
  
  interval string
  
  paused boolean
- shadow_redpanda_id string
  
  Shadow Redpanda cluster ID where the shadow link will be created.
- source_redpanda_id string
  
  Source Redpanda cluster ID. This field is optional. If provided, fetches bootstrap server information.
- topic_metadata_sync_options object
  Hide topic_metadata_sync_options attributes Show topic_metadata_sync_options attributes object
  
  auto_create_shadow_topic_filters array[object]
  
  List of filters that indicate which topics should be automatically created as shadow topics on the shadow cluster. This only controls automatic creation of shadow topics and does not effect the state of the mirror topic once it is created. Literal filters for _consumer_offsets, _redpanda.audit_log and _schemas will be rejected as well as prefix filters to match topics prefixed with _redpanda or __redpanda. Wildcard * is permitted only for literal filters and will _not match any topics that start with _redpanda or __redpanda. If users wish to shadow topics that start with _redpanda or __redpanda, they should provide a literal filter for those topics.
  
  Hide auto_create_shadow_topic_filters attributes Show auto_create_shadow_topic_filters attributes object
  
  filter_type string
  
  FILTER_TYPE_INCLUDE: Include the items that match the filter
  
  FILTER_TYPE_EXCLUDE: Exclude the items that match the filter
  
  Values are FILTER_TYPE_INCLUDE or FILTER_TYPE_EXCLUDE.
  
  name string
  
  pattern_type string
  
  PATTERN_TYPE_LITERAL: Must match the filter exactly
  
  PATTERN_TYPE_PREFIX: Will match anything that starts with filter
  
  Values are PATTERN_TYPE_LITERAL or PATTERN_TYPE_PREFIX.
  
  exclude_default boolean
  
  If this is true, then only the properties listed in synced_shadow_topic_properties will be synced.
  
  interval string
  
  paused boolean
  
  start_at_earliest object
  
  Start at the earliest offset in the partition.
  
  start_at_latest object
  
  Start at the latest offset in the partition.
  
  start_at_timestamp string(date-time)
  
  Enables data replication from the first offset on the source topic/partition where the record's timestamp is at or after the specified timestamp.
  
  synced_shadow_topic_properties array[string]
  
  The following properties are not allowed to be replicated and adding them to this list will result in an error:
  
  redpanda.remote.readreplica
  
  redpanda.remote.recovery
  
  redpanda.remote.allowgaps
  
  redpanda.virtual.cluster.id
  
  redpanda.leaders.preference
  
  redpanda.cloud_topic.enabled
  
  This list is a list of properties in addition to the default properties that will be synced. See exclude_default.

Responses

202 application/json

Accepted
Hide response attribute Show response attribute object
- operation object
  
  Operation describes a long running operation
  
  Hide operation attributes Show operation attributes object
  
  error object
  
  Describes errors
  
  Hide error attributes Show error attributes object
  
  code string(int32)
  
  RPC status code, as described here.
  
  Values are OK, CANCELLED, UNKNOWN, INVALID_ARGUMENT, DEADLINE_EXCEEDED, NOT_FOUND, ALREADY_EXISTS, PERMISSION_DENIED, UNAUTHENTICATED, RESOURCE_EXHAUSTED, FAILED_PRECONDITION, ABORTED, OUT_OF_RANGE, UNIMPLEMENTED, INTERNAL, UNAVAILABLE, or DATA_LOSS.
  
  details array[object]
  
  A list of messages that carries the error details.
  
  Details of the error.
  
  Details of the error.
  
  One of:
  BadRequest object ErrorInfo object QuotaFailure object Help object
  
  Describes violations in a client request. This error type focuses on the syntactic aspects of the request.
  
  Hide attributes Show attributes
  
  @type string
  
  Fully qualified protobuf type name of the underlying response, prefixed with type.googleapis.com/.
  
  Value is type.googleapis.com/google.rpc.BadRequest.
  
  field_violations array[object]
  
  Describes all violations in a client request.
  
  A message type used to describe a single bad request field.
  
  Hide field_violations attributes Show field_violations attributes object
  
  description string
  
  A description of why the request element is bad.
  
  field string
  
  A path that leads to a field in the request body. The value will be a sequence of dot-separated identifiers that identify a protocol buffer field.
  
  Consider the following:
  
  message CreateContactRequest { message EmailAddress { enum Type { TYPE_UNSPECIFIED = 0; HOME = 1; WORK = 2; }
  
  optional string email = 1; repeated EmailType type = 2; }
  
  string full_name = 1; repeated EmailAddress email_addresses = 2; }
  
  In this example, in proto field could take one of the following values:
  
  full_name for a violation in the full_name value
  
  email_addresses[1].email for a violation in the email field of the first email_addresses message
  
  email_addresses[3].type[2] for a violation in the second type value in the third email_addresses message.
  
  In JSON, the same values are represented as:
  
  fullName for a violation in the fullName value
  
  emailAddresses[1].email for a violation in the email field of the first emailAddresses message
  
  emailAddresses[3].type[2] for a violation in the second type value in the third emailAddresses message.
  
  localized_message object
  
  Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
  
  Hide localized_message attributes Show localized_message attributes object
  
  locale string
  
  message string
  
  The localized error message in the above locale.
  
  reason string
  
  The reason of the field-level error. This is a constant value that identifies the proximate cause of the field-level error. It should uniquely identify the type of the FieldViolation within the scope of the google.rpc.ErrorInfo.domain. This should be at most 63 characters and match a regular expression of [A-Z][A-Z0-9_]+[A-Z0-9], which represents UPPER_SNAKE_CASE.
  
  Describes the cause of the error with structured details.
  
  Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled:
  
  { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } }
  
  This response indicates that the pubsub.googleapis.com API is not enabled.
  
  Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock:
  
  { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }
  
  Hide attributes Show attributes
  
  @type string
  
  Fully qualified protobuf type name of the underlying response, prefixed with type.googleapis.com/.
  
  Value is type.googleapis.com/google.rpc.ErrorInfo.
  
  domain string
  
  The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
  
  metadata object
  
  Additional structured details about this error.
  
  Keys must match a regular expression of [a-z][a-zA-Z0-9-_]+ but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
  
  Hide metadata attribute Show metadata attribute object
  
  * string Additional properties
  
  reason string
  
  The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of [A-Z][A-Z0-9_]+[A-Z0-9], which represents UPPER_SNAKE_CASE.
  
  Describes how a quota check failed.
  
  For example if a daily limit was exceeded for the calling project, a service could respond with a QuotaFailure detail containing the project id and the description of the quota limit that was exceeded. If the calling project hasn't enabled the service in the developer console, then a service could respond with the project id and set service_disabled to true.
  
  Also see RetryInfo and Help types for other details about handling a quota failure.
  
  Hide attributes Show attributes
  
  @type string
  
  Fully qualified protobuf type name of the underlying response, prefixed with type.googleapis.com/.
  
  Value is type.googleapis.com/google.rpc.QuotaFailure.
  
  violations array[object]
  
  Describes all quota violations.
  
  A message type used to describe a single quota violation. For example, a daily quota or a custom quota that was exceeded.
  
  Hide violations attributes Show violations attributes object
  
  api_service string
  
  The API Service from which the QuotaFailure.Violation orginates. In some cases, Quota issues originate from an API Service other than the one that was called. In other words, a dependency of the called API Service could be the cause of the QuotaFailure, and this field would have the dependency API service name.
  
  For example, if the called API is Kubernetes Engine API (container.googleapis.com), and a quota violation occurs in the Kubernetes Engine API itself, this field would be "container.googleapis.com". On the other hand, if the quota violation occurs when the Kubernetes Engine API creates VMs in the Compute Engine API (compute.googleapis.com), this field would be "compute.googleapis.com".
  
  description string
  
  A description of how the quota check failed. Clients can use this description to find more about the quota configuration in the service's public documentation, or find the relevant quota limit to adjust through developer console.
  
  For example: "Service disabled" or "Daily Limit for read operations exceeded".
  
  future_quota_value string(int64) | null
  
  The new quota value being rolled out at the time of the violation. At the completion of the rollout, this value will be enforced in place of quota_value. If no rollout is in progress at the time of the violation, this field is not set.
  
  For example, if at the time of the violation a rollout is in progress changing the number of CPUs quota from 10 to 20, 20 would be the value of this field.
  
  quota_dimensions object
  
  The dimensions of the violated quota. Every non-global quota is enforced on a set of dimensions. While quota metric defines what to count, the dimensions specify for what aspects the counter should be increased.
  
  For example, the quota "CPUs per region per VM family" enforces a limit on the metric "compute.googleapis.com/cpus_per_vm_family" on dimensions "region" and "vm_family". And if the violation occurred in region "us-central1" and for VM family "n1", the quota_dimensions would be,
  
  { "region": "us-central1", "vm_family": "n1", }
  
  When a quota is enforced globally, the quota_dimensions would always be empty.
  
  Hide quota_dimensions attribute Show quota_dimensions attribute object
  
  * string Additional properties
  
  quota_id string
  
  The id of the violated quota. Also know as "limit name", this is the unique identifier of a quota in the context of an API service.
  
  For example, "CPUS-PER-VM-FAMILY-per-project-region".
  
  quota_metric string
  
  The metric of the violated quota. A quota metric is a named counter to measure usage, such as API requests or CPUs. When an activity occurs in a service, such as Virtual Machine allocation, one or more quota metrics may be affected.
  
  For example, "compute.googleapis.com/cpus_per_vm_family", "storage.googleapis.com/internet_egress_bandwidth".
  
  quota_value string(int64)
  
  The enforced quota value at the time of the QuotaFailure.
  
  For example, if the enforced quota value at the time of the QuotaFailure on the number of CPUs is "10", then the value of this field would reflect this quantity.
  
  subject string
  
  The subject on which the quota check failed. For example, "clientip:" or "project:".
  
  Provides links to documentation or for performing an out of band action.
  
  For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.
  
  Hide attributes Show attributes
  
  @type string
  
  Fully qualified protobuf type name of the underlying response, prefixed with type.googleapis.com/.
  
  Value is type.googleapis.com/google.rpc.Help.
  
  links array[object]
  
  URL(s) pointing to additional information on handling the current error.
  
  Describes a URL link.
  
  Hide links attributes Show links attributes object
  
  description string
  
  Describes what the link offers.
  
  url string
  
  The URL of the link.
  
  message string
  
  Detailed error message. No compatibility guarantees are given for the text contained in this message.
  
  finished_at string(date-time)
  
  Timestamp when the operation has finished.
  
  id string
  
  ID of the operation.
  
  metadata object
  
  Metadata of the long-running Operation. Contains in-progress information.
  
  One of:
  CreateNetworkMetadata object object-1 object CreateClusterMetadata object UpdateClusterMetadata object DeleteClusterMetadata object
  
  Resource describing an in-progress CreateNetwork Operation.
  
  Hide attributes Show attributes
  
  @type string
  
  Fully qualified protobuf type name of the underlying response, prefixed with type.googleapis.com/.
  
  Value is type.googleapis.com/redpanda.api.controlplane.v1.CreateNetworkMetadata.
  
  network_id string
  
  ID of the network created by this Operation.
  
  Resource describing an in-progress CreateCluster Operation.
  
  Hide attributes Show attributes
  
  @type string
  
  Fully qualified protobuf type name of the underlying response, prefixed with type.googleapis.com/.
  
  Value is type.googleapis.com/redpanda.api.controlplane.v1.CreateClusterMetadata.
  
  cluster_id string
  
  ID of the Cluster created by this operation.
  
  Resource describing an in-progress UpdateCluster Operation.
  
  Hide attributes Show attributes
  
  @type string
  
  Fully qualified protobuf type name of the underlying response, prefixed with type.googleapis.com/.
  
  Value is type.googleapis.com/redpanda.api.controlplane.v1.UpdateClusterMetadata.
  
  update_type array[string]
  
  Values are UPDATE_CLUSTER_TYPE_CUSTOMER_CONFIG or UPDATE_CLUSTER_TYPE_SCALING.
  
  Resource describing an in-progress DeleteCluster Operation.
  
  Hide attributes Show attributes
  
  @type string
  
  Fully qualified protobuf type name of the underlying response, prefixed with type.googleapis.com/.
  
  Value is type.googleapis.com/redpanda.api.controlplane.v1.DeleteClusterMetadata.
  
  required_action string
  
  resource_id string | null
  
  response object
  
  Response of the long-running Operation.
  
  One of:
  CreateClusterResponse object UpdateClusterResponse object object-1 object CreateNetworkResponse object object-1 object
  
  CreateClusterResponse is the request of CreateCluster.
  
  Hide attributes Show attributes
  
  @type string
  
  Fully qualified protobuf type name of the underlying response, prefixed with type.googleapis.com/.
  
  Value is type.googleapis.com/redpanda.api.controlplane.v1.CreateClusterResponse.
  
  cluster object
  
  Resource describing a Cluster.
  
  Hide cluster attributes Show cluster attributes object
  
  api_gateway_access string
  
  Network access mode for an endpoint.
  
  Values are NETWORK_ACCESS_MODE_PRIVATE or NETWORK_ACCESS_MODE_PUBLIC.
  
  aws_private_link object
  
  Hide aws_private_link attributes Show aws_private_link attributes object
  
  allowed_principals array[string]
  
  The ARN of the principals that can access the Redpanda AWS PrivateLink Endpoint Service. To grant permissions to all principals, use an asterisk (*).
  
  connect_console boolean
  
  Whether Console is connected in Redpanda AWS Private Link Service.
  
  enabled boolean
  
  Whether Redpanda AWS Private Link Endpoint Service is enabled.
  
  http_proxy_auth_mode string
  
  Private link authentication mode.
  
  PRIVATE_LINK_AUTH_MODE_MATCH: Match the authentication methods configured for the normal API endpoint, i.e. Kafka, HTTP Proxy, or Schema Registry.
  
  PRIVATE_LINK_AUTH_MODE_SASL: SASL authentication mode only.
  
  PRIVATE_LINK_AUTH_MODE_MTLS: mTLS authentication mode only.
  
  PRIVATE_LINK_AUTH_MODE_MTLS_AND_SASL: Both SASL and mTLS authentication modes.
  
  PRIVATE_LINK_AUTH_MODE_NONE: Neither SASL or mTLS is enabled for Private Link.
  
  Values are PRIVATE_LINK_AUTH_MODE_MATCH, PRIVATE_LINK_AUTH_MODE_SASL, PRIVATE_LINK_AUTH_MODE_MTLS, PRIVATE_LINK_AUTH_MODE_MTLS_AND_SASL, or PRIVATE_LINK_AUTH_MODE_NONE.
  
  kafka_api_auth_mode string
  
  Private link authentication mode.
  
  PRIVATE_LINK_AUTH_MODE_MATCH: Match the authentication methods configured for the normal API endpoint, i.e. Kafka, HTTP Proxy, or Schema Registry.
  
  PRIVATE_LINK_AUTH_MODE_SASL: SASL authentication mode only.
  
  PRIVATE_LINK_AUTH_MODE_MTLS: mTLS authentication mode only.
  
  PRIVATE_LINK_AUTH_MODE_MTLS_AND_SASL: Both SASL and mTLS authentication modes.
  
  PRIVATE_LINK_AUTH_MODE_NONE: Neither SASL or mTLS is enabled for Private Link.
  
  Values are PRIVATE_LINK_AUTH_MODE_MATCH, PRIVATE_LINK_AUTH_MODE_SASL, PRIVATE_LINK_AUTH_MODE_MTLS, PRIVATE_LINK_AUTH_MODE_MTLS_AND_SASL, or PRIVATE_LINK_AUTH_MODE_NONE.
  
  schema_registry_auth_mode string
  
  Private link authentication mode.
  
  PRIVATE_LINK_AUTH_MODE_MATCH: Match the authentication methods configured for the normal API endpoint, i.e. Kafka, HTTP Proxy, or Schema Registry.
  
  PRIVATE_LINK_AUTH_MODE_SASL: SASL authentication mode only.
  
  PRIVATE_LINK_AUTH_MODE_MTLS: mTLS authentication mode only.
  
  PRIVATE_LINK_AUTH_MODE_MTLS_AND_SASL: Both SASL and mTLS authentication modes.
  
  PRIVATE_LINK_AUTH_MODE_NONE: Neither SASL or mTLS is enabled for Private Link.
  
  Values are PRIVATE_LINK_AUTH_MODE_MATCH, PRIVATE_LINK_AUTH_MODE_SASL, PRIVATE_LINK_AUTH_MODE_MTLS, PRIVATE_LINK_AUTH_MODE_MTLS_AND_SASL, or PRIVATE_LINK_AUTH_MODE_NONE.
  
  status object
  
  Hide status attributes Show status attributes object
  
  console_port integer(int32)
  
  The port of Redpanda Console.
  
  created_at string(date-time)
  
  Redpanda AWS PrivateLink Endpoint Service creation timestamp.
  
  deleted_at string(date-time)
  
  Redpanda AWS PrivateLink Service deletion timestamp.
  
  kafka_api_node_base_port integer(int32)
  
  Kafka API node service base port. The port for node i (0 .. node_count-1) is kafka_api_node_base_port + i.
  
  kafka_api_seed_port integer(int32)
  
  Kafka API seed service port.
  
  redpanda_proxy_node_base_port integer(int32)
  
  HTTP Proxy node service base port. The port for node i (0 .. node_count-1) is redpanda_proxy_node_base_port + i.
  
  redpanda_proxy_seed_port integer(int32)
  
  HTTP Proxy seed service port.
  
  schema_registry_seed_port integer(int32)
  
  Schema Registry seed service port.
  
  service_id string
  
  ID of Redpanda AWS PrivateLink Endpoint Service.
  
  service_name string
  
  Name of Redpanda AWS PrivateLink Endpoint Service.
  
  service_state string
  
  State of Redpanda AWS PrivateLink Endpoint Service.
  
  vpc_endpoint_connections array[object]
  
  List of VPC endpoints with established connections to Redpanda AWS PrivateLink Endpoint Service.
  
  Hide vpc_endpoint_connections attributes Show vpc_endpoint_connections attributes object
  
  connection_id string
  
  Connection ID of VPC endpoint connected to Redpanda AWS PrivateLink Endpoint Service.
  
  created_at string(date-time)
  
  VPC endpoint creation timestamp.
  
  dns_entries array[object]
  
  The list of DNS entries associated with VPC endpoint.
  
  Hide dns_entries attributes Show dns_entries attributes object
  
  dns_name string
  
  DNS entry of VPC endpoint connected to Redpanda AWS PrivateLink Endpoint Service.
  
  hosted_zone_id string
  
  The ID of Route53 DNS zone.
  
  id string
  
  The ID of VPC endpoint.
  
  load_balancer_arns array[string]
  
  List of load balancer ARNs.
  
  owner string
  
  The owner of VPC endpoint.
  
  state string
  
  The state of VPC endpoint connected to Redpanda AWS PrivateLink Endpoint Service.
  
  supported_regions array[string]
  
  List of supported regions in cross-region AWS PrivateLink.
  
  azure_private_link object
  
  Hide azure_private_link attributes Show azure_private_link attributes object
  
  allowed_subscriptions array[string]
  
  The subscriptions that can access the Redpanda Azure PrivateLink Endpoint Service. To grant permissions to all principals, use an asterisk (*).
  
  connect_console boolean
  
  Whether Console is connected in Redpanda Azure Private Link Service.
  
  enabled boolean
  
  Whether Redpanda AWS Private Link Endpoint Service is enabled.
  
  http_proxy_auth_mode string
  
  Private link authentication mode.
  
  PRIVATE_LINK_AUTH_MODE_MATCH: Match the authentication methods configured for the normal API endpoint, i.e. Kafka, HTTP Proxy, or Schema Registry.
  
  PRIVATE_LINK_AUTH_MODE_SASL: SASL authentication mode only.
  
  PRIVATE_LINK_AUTH_MODE_MTLS: mTLS authentication mode only.
  
  PRIVATE_LINK_AUTH_MODE_MTLS_AND_SASL: Both SASL and mTLS authentication modes.
  
  PRIVATE_LINK_AUTH_MODE_NONE: Neither SASL or mTLS is enabled for Private Link.
  
  Values are PRIVATE_LINK_AUTH_MODE_MATCH, PRIVATE_LINK_AUTH_MODE_SASL, PRIVATE_LINK_AUTH_MODE_MTLS, PRIVATE_LINK_AUTH_MODE_MTLS_AND_SASL, or PRIVATE_LINK_AUTH_MODE_NONE.
  
  kafka_api_auth_mode string
  
  Private link authentication mode.
  
  PRIVATE_LINK_AUTH_MODE_MATCH: Match the authentication methods configured for the normal API endpoint, i.e. Kafka, HTTP Proxy, or Schema Registry.
  
  PRIVATE_LINK_AUTH_MODE_SASL: SASL authentication mode only.
  
  PRIVATE_LINK_AUTH_MODE_MTLS: mTLS authentication mode only.
  
  PRIVATE_LINK_AUTH_MODE_MTLS_AND_SASL: Both SASL and mTLS authentication modes.
  
  PRIVATE_LINK_AUTH_MODE_NONE: Neither SASL or mTLS is enabled for Private Link.
  
  Values are PRIVATE_LINK_AUTH_MODE_MATCH, PRIVATE_LINK_AUTH_MODE_SASL, PRIVATE_LINK_AUTH_MODE_MTLS, PRIVATE_LINK_AUTH_MODE_MTLS_AND_SASL, or PRIVATE_LINK_AUTH_MODE_NONE.
  
  schema_registry_auth_mode string
  
  Private link authentication mode.
  
  PRIVATE_LINK_AUTH_MODE_MATCH: Match the authentication methods configured for the normal API endpoint, i.e. Kafka, HTTP Proxy, or Schema Registry.
  
  PRIVATE_LINK_AUTH_MODE_SASL: SASL authentication mode only.
  
  PRIVATE_LINK_AUTH_MODE_MTLS: mTLS authentication mode only.
  
  PRIVATE_LINK_AUTH_MODE_MTLS_AND_SASL: Both SASL and mTLS authentication modes.
  
  PRIVATE_LINK_AUTH_MODE_NONE: Neither SASL or mTLS is enabled for Private Link.
  
  Values are PRIVATE_LINK_AUTH_MODE_MATCH, PRIVATE_LINK_AUTH_MODE_SASL, PRIVATE_LINK_AUTH_MODE_MTLS, PRIVATE_LINK_AUTH_MODE_MTLS_AND_SASL, or PRIVATE_LINK_AUTH_MODE_NONE.
  
  status object
  
  Hide status attributes Show status attributes object
  
  approved_subscriptions array[string]
  
  console_port integer(int32)
  
  The port of Redpanda Console.
  
  created_at string(date-time)
  
  Redpanda Azure PrivateLink Endpoint Service creation timestamp.
  
  deleted_at string(date-time)
  
  Redpanda Azure PrivateLink Service deletion timestamp.
  
  dns_a_record string
  
  kafka_api_node_base_port integer(int32)
  
  Kafka API node service base port. The port for node i (0 .. node_count-1) is kafka_api_node_base_port + i.
  
  kafka_api_seed_port integer(int32)
  
  Kafka API seed service port.
  
  private_endpoint_connections array[object]
  
  List of private endpoint connections to Redpanda Azure Private Link Service.
  
  Hide private_endpoint_connections attributes Show private_endpoint_connections attributes object
  
  connection_id string
  
  connection_name string
  
  created_at string(date-time)
  
  PrivateEndpointConnection creation timestamp.
  
  private_endpoint_id string
  
  Resource ID of Private Endpoint to Redpanda Azure PrivateLink Endpoint Service.
  
  private_endpoint_name string
  
  The name of the PrivateEndpointConnection.
  
  status string
  
  The status of private endpoint connected to Redpanda Azure PrivateLink Endpoint Service.
  
  redpanda_proxy_node_base_port integer(int32)
  
  HTTP Proxy node service base port. The port for node i (0 .. node_count-1) is redpanda_proxy_node_base_port + i.
  
  redpanda_proxy_seed_port integer(int32)
  
  HTTP Proxy seed service port.
  
  schema_registry_seed_port integer(int32)
  
  Schema Registry seed service port.
  
  service_id string
  
  ID of Redpanda Azure PrivateLink Endpoint Service.
  
  service_name string
  
  Name of Redpanda Azure PrivateLink Endpoint Service.
  
  cloud_provider string
  
  Cloud provider where resources are created.
  
  Values are CLOUD_PROVIDER_AWS, CLOUD_PROVIDER_GCP, or CLOUD_PROVIDER_AZURE.
  
  cloud_provider_tags object
  
  Tags placed on cloud resources. If the cloud provider is GCP and the name of a tag has the prefix "gcp.network-tag.", the tag is a network tag that will be added to the Redpanda cluster GKE nodes. Otherwise, the tag is a normal tag. For example, if the name of a tag is "gcp.network-tag.network-tag-foo", the network tag named "network-tag-foo" will be added to the Redpanda cluster GKE nodes. Note: The value of a network tag will be ignored. See the official GCP VPC for more details on network tags.
  
  Hide cloud_provider_tags attribute Show cloud_provider_tags attribute object
  
  * string Additional properties
  
  cloud_storage object
  
  Hide cloud_storage attributes Show cloud_storage attributes object
  
  aws object
  
  Hide aws attribute Show aws attribute object
  
  arn string
  
  azure object
  
  Hide azure attributes Show azure attributes object
  
  allowed_ips array[string]
  
  List of public IP or IP ranges in CIDR Format.
  
  Only IPv4 addresses are allowed.
  
  Private IP address ranges as defined in RFC 1918 are not allowed.
  
  Private IP address ranges as defined in RFC 6598 are not allowed.
  
  Small address ranges using "/31" or "/32" prefix sizes are not supported. These ranges should be configured using individual IP address rules without prefix specified.
  
  allowed_ips have no effect on requests originating from the same Azure region as the storage account. Use allowed_subnet_ids to allow same-region requests. Services deployed in the same region as the storage account use private Azure IP addresses for communication. Thus, you cannot allow access to specific Azure services based on their public outbound IP address range.
  
  allowed_subnet_ids array[string]
  
  A list of virtual network subnet IDs that are allowed to access the storage account.
  
  container_name string
  
  resource_group_name string
  
  storage_account_name string
  
  subscription_id string
  
  gcp object
  
  Hide gcp attribute Show gcp attribute object
  
  name string
  
  skip_destroy boolean
  
  cluster_configuration object
  
  Hide cluster_configuration attributes Show cluster_configuration attributes object
  
  computed_properties object
  
  custom_properties object
  
  connection_type string
  
  Cluster connection type. Private clusters are not exposed to the internet. For BYOC clusters, Private is best-practice.
  
  Values are CONNECTION_TYPE_PUBLIC or CONNECTION_TYPE_PRIVATE.
  
  created_at string(date-time)
  
  Cluster creation timestamp.
  
  current_redpanda_version string
  
  Current Redpanda version of the cluster.
  
  customer_managed_resources object
  
  The cloud resources created by user.
  
  Hide customer_managed_resources attributes Show customer_managed_resources attributes object
  
  aws object
  
  AWS resources created and managed by user, and required to deploy the Redpanda cluster.
  
  Hide aws attributes Show aws attributes object
  
  agent_instance_profile object Required
  
  AWS instance profile.
  
  Hide agent_instance_profile attribute Show agent_instance_profile attribute object
  
  arn string Required
  
  AWS instance profile ARN.
  
  cloud_storage_bucket object Required
  
  AWS storage bucket properties by ARN.
  
  Hide cloud_storage_bucket attribute Show cloud_storage_bucket attribute object
  
  arn string Required
  
  AWS storage bucket identifier.
  
  cluster_security_group object Required
  
  Security Group identifies AWS security group.
  
  Hide cluster_security_group attribute Show cluster_security_group attribute object
  
  arn string Required
  
  AWS security group ARN.
  
  connectors_node_group_instance_profile object Required
  
  AWS instance profile.
  
  Hide connectors_node_group_instance_profile attribute Show connectors_node_group_instance_profile attribute object
  
  arn string Required
  
  AWS instance profile ARN.
  
  connectors_security_group object Required
  
  Security Group identifies AWS security group.
  
  Hide connectors_security_group attribute Show connectors_security_group attribute object
  
  arn string Required
  
  AWS security group ARN.
  
  k8s_cluster_role object Required
  
  Role identifies AWS role.
  
  Hide k8s_cluster_role attribute Show k8s_cluster_role attribute object
  
  arn string Required
  
  AWS role ARN.
  
  node_security_group object Required
  
  Security Group identifies AWS security group.
  
  Hide node_security_group attribute Show node_security_group attribute object
  
  arn string Required
  
  AWS security group ARN.
  
  permissions_boundary_policy object Required
  
  Policy identifies an AWS policy.
  
  Hide permissions_boundary_policy attribute Show permissions_boundary_policy attribute object
  
  arn string Required
  
  AWS policy ARN.
  
  redpanda_agent_security_group object Required
  
  Security Group identifies AWS security group.
  
  Hide redpanda_agent_security_group attribute Show redpanda_agent_security_group attribute object
  
  arn string Required
  
  AWS security group ARN.
  
  redpanda_connect_node_group_instance_profile object
  
  AWS instance profile.
  
  Hide redpanda_connect_node_group_instance_profile attribute Show redpanda_connect_node_group_instance_profile attribute object
  
  arn string Required
  
  AWS instance profile ARN.
  
  redpanda_connect_security_group object
  
  Security Group identifies AWS security group.
  
  Hide redpanda_connect_security_group attribute Show redpanda_connect_security_group attribute object
  
  arn string Required
  
  AWS security group ARN.
  
  redpanda_node_group_instance_profile object Required
  
  AWS instance profile.
  
  Hide redpanda_node_group_instance_profile attribute Show redpanda_node_group_instance_profile attribute object
  
  arn string Required
  
  AWS instance profile ARN.
  
  redpanda_node_group_security_group object Required
  
  Security Group identifies AWS security group.
  
  Hide redpanda_node_group_security_group attribute Show redpanda_node_group_security_group attribute object
  
  arn string Required
  
  AWS security group ARN.
  
  utility_node_group_instance_profile object Required
  
  AWS instance profile.
  
  Hide utility_node_group_instance_profile attribute Show utility_node_group_instance_profile attribute object
  
  arn string Required
  
  AWS instance profile ARN.
  
  utility_security_group object Required
  
  Security Group identifies AWS security group.
  
  Hide utility_security_group attribute Show utility_security_group attribute object
  
  arn string Required
  
  AWS security group ARN.
  
  azure object
  
  Azure resources created and managed by user, and required to deploy the Redpanda cluster.
  
  Hide azure attributes Show azure attributes object
  
  cidrs object Required
  
  Additional CIDRs allocated to Redpanda cluster.
  
  Hide cidrs attribute Show cidrs attribute object
  
  aks_service_cidr string Required
  
  CIDR used by AKS Kubernetes services.
  
  key_vaults object Required
  
  Azure key vaults used by Redpanda Cluster. All key vaults shall be in redpanda_resource_group.
  
  Hide key_vaults attributes Show key_vaults attributes object
  
  console_vault object Required
  
  Azure Key Vault.
  
  Hide console_vault attribute Show console_vault attribute object
  
  name string Required
  
  management_vault object Required
  
  Azure Key Vault.
  
  Hide management_vault attribute Show management_vault attribute object
  
  name string Required
  
  resource_groups object Required
  
  Azure resource groups holding the Redpanda cluster resources.
  
  Hide resource_groups attributes Show resource_groups attributes object
  
  iam_resource_group object Required
  
  Azure Resource Group Specification
  
  Hide iam_resource_group attribute Show iam_resource_group attribute object
  
  name string Required
  
  redpanda_resource_group object Required
  
  Azure Resource Group Specification
  
  Hide redpanda_resource_group attribute Show redpanda_resource_group attribute object
  
  name string Required
  
  storage_resource_group object Required
  
  Azure Resource Group Specification
  
  Hide storage_resource_group attribute Show storage_resource_group attribute object
  
  name string Required
  
  security_groups object Required
  
  Azure security groups for Redpanda Cluster. All security groups shall be in the network resource group.
  
  Hide security_groups attribute Show security_groups attribute object
  
  redpanda_security_group object Required
  
  Azure security group.
  
  Hide redpanda_security_group attribute Show redpanda_security_group attribute object
  
  name string Required
  
  tiered_cloud_storage object Required
  
  Azure Bucket Specification
  
  Hide tiered_cloud_storage attributes Show tiered_cloud_storage attributes object
  
  resource_group object
  
  Azure Resource Group Specification
  
  Hide resource_group attribute Show resource_group attribute object
  
  name string Required
  
  storage_account_name string Required
  
  storage_container_name string Required
  
  user_assigned_identities object Required
  
  Azure user assigned identities used by Redpanda cluster. All identities shall be in iam_resource_group.
  
  Hide user_assigned_identities attributes Show user_assigned_identities attributes object
  
  agent_user_assigned_identity object Required
  
  Azure user assigned identity.
  
  Hide agent_user_assigned_identity attribute Show agent_user_assigned_identity attribute object
  
  name string Required
  
  aks_user_assigned_identity object Required
  
  Azure user assigned identity.
  
  Hide aks_user_assigned_identity attribute Show aks_user_assigned_identity attribute object
  
  name string Required
  
  cert_manager_assigned_identity object Required
  
  Azure user assigned identity.
  
  Hide cert_manager_assigned_identity attribute Show cert_manager_assigned_identity attribute object
  
  name string Required
  
  external_dns_assigned_identity object Required
  
  Azure user assigned identity.
  
  Hide external_dns_assigned_identity attribute Show external_dns_assigned_identity attribute object
  
  name string Required
  
  kafka_connect_assigned_identity object Required
  
  Azure user assigned identity.
  
  Hide kafka_connect_assigned_identity attribute Show kafka_connect_assigned_identity attribute object
  
  name string Required
  
  redpanda_cluster_assigned_identity object Required
  
  Azure user assigned identity.
  
  Hide redpanda_cluster_assigned_identity attribute Show redpanda_cluster_assigned_identity attribute object
  
  name string Required
  
  redpanda_connect_api_assigned_identity object Required
  
  Azure user assigned identity.
  
  Hide redpanda_connect_api_assigned_identity attribute Show redpanda_connect_api_assigned_identity attribute object
  
  name string Required
  
  redpanda_connect_assigned_identity object Required
  
  Azure user assigned identity.
  
  Hide redpanda_connect_assigned_identity attribute Show redpanda_connect_assigned_identity attribute object
  
  name string Required
  
  redpanda_console_assigned_identity object Required
  
  Azure user assigned identity.
  
  Hide redpanda_console_assigned_identity attribute Show redpanda_console_assigned_identity attribute object
  
  name string Required
  
  redpanda_operator_assigned_identity object Required
  
  Azure user assigned identity.
  
  Hide redpanda_operator_assigned_identity attribute Show redpanda_operator_assigned_identity attribute object
  
  name string Required
  
  gcp object
  
  GCP resources created and managed by user, and required to deploy the Redpanda cluster. See Create a BYOVPC Cluster on GCP.
  
  Hide gcp attributes Show gcp attributes object
  
  agent_service_account object Required
  
  GCP service account.
  
  Hide agent_service_account attribute Show agent_service_account attribute object
  
  email string Required
  
  GCP service account email.
  
  connector_service_account object Required
  
  GCP service account.
  
  Hide connector_service_account attribute Show connector_service_account attribute object
  
  email string Required
  
  GCP service account email.
  
  console_service_account object Required
  
  GCP service account.
  
  Hide console_service_account attribute Show console_service_account attribute object
  
  email string Required
  
  GCP service account email.
  
  gke_service_account object Required
  
  GCP service account.
  
  Hide gke_service_account attribute Show gke_service_account attribute object
  
  email string Required
  
  GCP service account email.
  
  psc_nat_subnet_name string
  
  NAT subnet name if GCP Private Service Connect (a.k.a Private Link) is enabled. If it is used for PSC v1, use psc_v2_nat_subnet_name to set NAT subnet name for PSC v2.
  
  psc_v2_nat_subnet_name string
  
  NAT subnet name for PSC v2 if GCP Private Service Connect (a.k.a Private Link) is enabled and psc_nat_subnet_name is used for PSC v1.
  
  redpanda_cluster_service_account object Required
  
  GCP service account.
  
  Hide redpanda_cluster_service_account attribute Show redpanda_cluster_service_account attribute object
  
  email string Required
  
  GCP service account email.
  
  redpanda_connect_api_service_account object Required
  
  GCP service account.
  
  Hide redpanda_connect_api_service_account attribute Show redpanda_connect_api_service_account attribute object
  
  email string Required
  
  GCP service account email.
  
  redpanda_connect_service_account object Required
  
  GCP service account.
  
  Hide redpanda_connect_service_account attribute Show redpanda_connect_service_account attribute object
  
  email string Required
  
  GCP service account email.
  
  redpanda_operator_service_account object
  
  GCP service account.
  
  Hide redpanda_operator_service_account attribute Show redpanda_operator_service_account attribute object
  
  email string Required
  
  GCP service account email.
  
  subnet object Required
  
  GCP subnet properties. See the official GCP API reference.
  
  Hide subnet attributes Show subnet attributes object
  
  k8s_master_ipv4_range string Required
  
  Kubernetes Master IPv4 range, e.g. 10.0.0.0/24.
  
  name string Required
  
  Subnet name.
  
  secondary_ipv4_range_pods object Required
  
  Secondary IPv4 range.
  
  Hide secondary_ipv4_range_pods attribute Show secondary_ipv4_range_pods attribute object
  
  name string
  
  secondary_ipv4_range_services object Required
  
  Secondary IPv4 range.
  
  Hide secondary_ipv4_range_services attribute Show secondary_ipv4_range_services attribute object
  
  name string
  
  tiered_storage_bucket object Required
  
  GCP storage bucket properties.
  
  Hide tiered_storage_bucket attribute Show tiered_storage_bucket attribute object
  
  name string Required
  
  Name of GCP storage bucket. See the official GCP documentation for naming restrictions.
  
  dataplane_api object
  
  Cluster's Data Plane API properties.
  
  Hide dataplane_api attribute Show dataplane_api attribute object
  
  url string
  
  Data Plane API URL.
  
  desired_redpanda_version string
  
  Desired Redpanda version of the cluster.
  
  gcp_global_access_enabled boolean | null
  
  gcp_private_service_connect object
  
  Hide gcp_private_service_connect attributes Show gcp_private_service_connect attributes object
  
  consumer_accept_list array[object]
  
  List of consumers that are allowed to connect to Redpanda GCP PSC (Private Service Connect) service attachment.
  
  GCP Private Service Connect consumer specifications.
  
  Hide consumer_accept_list attribute Show consumer_accept_list attribute object
  
  source string
  
  Either the GCP project number or its alphanumeric ID.
  
  enabled boolean
  
  Whether Redpanda GCP Private Service Connect is enabled.
  
  global_access_enabled boolean
  
  Whether global access is enabled.
  
  http_proxy_auth_mode string
  
  Private link authentication mode.
  
  PRIVATE_LINK_AUTH_MODE_MATCH: Match the authentication methods configured for the normal API endpoint, i.e. Kafka, HTTP Proxy, or Schema Registry.
  
  PRIVATE_LINK_AUTH_MODE_SASL: SASL authentication mode only.
  
  PRIVATE_LINK_AUTH_MODE_MTLS: mTLS authentication mode only.
  
  PRIVATE_LINK_AUTH_MODE_MTLS_AND_SASL: Both SASL and mTLS authentication modes.
  
  PRIVATE_LINK_AUTH_MODE_NONE: Neither SASL or mTLS is enabled for Private Link.
  
  Values are PRIVATE_LINK_AUTH_MODE_MATCH, PRIVATE_LINK_AUTH_MODE_SASL, PRIVATE_LINK_AUTH_MODE_MTLS, PRIVATE_LINK_AUTH_MODE_MTLS_AND_SASL, or PRIVATE_LINK_AUTH_MODE_NONE.
  
  kafka_api_auth_mode string
  
  Private link authentication mode.
  
  PRIVATE_LINK_AUTH_MODE_MATCH: Match the authentication methods configured for the normal API endpoint, i.e. Kafka, HTTP Proxy, or Schema Registry.
  
  PRIVATE_LINK_AUTH_MODE_SASL: SASL authentication mode only.
  
  PRIVATE_LINK_AUTH_MODE_MTLS: mTLS authentication mode only.
  
  PRIVATE_LINK_AUTH_MODE_MTLS_AND_SASL: Both SASL and mTLS authentication modes.
  
  PRIVATE_LINK_AUTH_MODE_NONE: Neither SASL or mTLS is enabled for Private Link.
  
  Values are PRIVATE_LINK_AUTH_MODE_MATCH, PRIVATE_LINK_AUTH_MODE_SASL, PRIVATE_LINK_AUTH_MODE_MTLS, PRIVATE_LINK_AUTH_MODE_MTLS_AND_SASL, or PRIVATE_LINK_AUTH_MODE_NONE.
  
  schema_registry_auth_mode string
  
  Private link authentication mode.
  
  PRIVATE_LINK_AUTH_MODE_MATCH: Match the authentication methods configured for the normal API endpoint, i.e. Kafka, HTTP Proxy, or Schema Registry.
  
  PRIVATE_LINK_AUTH_MODE_SASL: SASL authentication mode only.
  
  PRIVATE_LINK_AUTH_MODE_MTLS: mTLS authentication mode only.
  
  PRIVATE_LINK_AUTH_MODE_MTLS_AND_SASL: Both SASL and mTLS authentication modes.
  
  PRIVATE_LINK_AUTH_MODE_NONE: Neither SASL or mTLS is enabled for Private Link.
  
  Values are PRIVATE_LINK_AUTH_MODE_MATCH, PRIVATE_LINK_AUTH_MODE_SASL, PRIVATE_LINK_AUTH_MODE_MTLS, PRIVATE_LINK_AUTH_MODE_MTLS_AND_SASL, or PRIVATE_LINK_AUTH_MODE_NONE.
  
  status object
  
  Hide status attributes Show status attributes object
  
  connected_endpoints array[object]
  
  List of VPC endpoints with established connections to GCP Private Service Connect.
  
  ConnectedEndpoint defines endpoint connection connected to Redpanda GCP PSC (Private Service Connect) service.
  
  Hide connected_endpoints attributes Show connected_endpoints attributes object
  
  connection_id string
  
  Connection ID of the endpoint.
  
  consumer_network string
  
  Network of the consumer connecting to Redpanda GCP Private Service Connect service. See the official GCP documentation for Private Service Connect.
  
  endpoint string
  
  Connection endpoint. See the official GCP API reference for Private Service Connect.
  
  status string
  
  Endpoint status (ACCEPTED | REJECTED).
  
  The ServiceAttachment API resource (https://cloud.google.com/compute/docs/reference/rest/v1/serviceAttachments) does have more fields, such as connection ID & consumer network, but the Terraform provider (https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/compute_service_attachment#nested_connected_endpoints) doesn't return them as outputs.
  
  created_at string(date-time)
  
  Redpanda GCP Private Service Connect service creation timestamp.
  
  deleted_at string(date-time)
  
  Redpanda GCP Private Service Connect service deletion timestamp.
  
  dns_a_records array[string]
  
  Customer-created DNS A records that point at the PSC endpoint on the consumer side.
  
  kafka_api_node_base_port integer(int32)
  
  Kafka API node service base port. The port for node i (0 .. node_count-1) is kafka_api_node_base_port + i.
  
  kafka_api_seed_port integer(int32)
  
  Kafka API seed service port.
  
  redpanda_proxy_node_base_port integer(int32)
  
  HTTP Proxy node service base port. The port for node i (0 .. node_count-1) is redpanda_proxy_node_base_port + i.
  
  redpanda_proxy_seed_port integer(int32)
  
  HTTP Proxy seed service port.
  
  schema_registry_seed_port integer(int32)
  
  Schema Registry seed service port.
  
  seed_hostname string
  
  Hostname for clients to initiate connections to the APIs exposed through Private Service Connect.
  
  service_attachment string
  
  Service attachment used by consumers to create endpoint connections to Redpanda GCP Private Service Connect service.
  
  http_proxy object
  
  HTTP Proxy properties.
  
  Hide http_proxy attributes Show http_proxy attributes object
  
  all_urls object
  
  The endpoints of Redpanda HTTP Proxy or Schema Registry.
  
  Hide all_urls attributes Show all_urls attributes object
  
  mtls string
  
  URL of the seed broker for mTLS. If mTLS is not enabled, the field is empty.
  
  private_link_mtls string
  
  URL of the seed broker for private link with mTLS. If private link with mTLS is not enabled, the field is empty.
  
  private_link_sasl string
  
  URL of the seed broker for private link with SASL. If private link with SASL is not enabled, the field is empty.
  
  sasl string
  
  URL of the seed broker for SASL. If SASL is not enabled, the field is empty.
  
  mtls object
  
  mTLS configuration.
  
  Hide mtls attributes Show mtls attributes object
  
  ca_certificates_pem array[string]
  
  CA certificate in PEM format.
  
  enabled boolean
  
  Whether mTLS is enabled.
  
  principal_mapping_rules array[string]
  
  Principal mapping rules for mTLS authentication. Only valid for Kafka API. See the Redpanda documentation on configuring authentication.
  
  sasl object
  
  Hide sasl attribute Show sasl attribute object
  
  enabled boolean
  
  Whether SASL is enabled.
  
  url string
  
  HTTP Proxy URL of cluster.
  
  id string
  
  ID of the cluster. ID is an output from the Create Cluster endpoint and cannot be set by the caller.
  
  kafka_api object
  
  Cluster's Kafka API properties.
  
  Hide kafka_api attributes Show kafka_api attributes object
  
  all_seed_brokers object
  
  Seed brokers of Redpanda Kafka API.
  
  Hide all_seed_brokers attributes Show all_seed_brokers attributes object
  
  mtls string
  
  URL of the seed broker for mTLS. If mTLS is not enabled, the field is empty.
  
  private_link_mtls string
  
  URL of the seed broker for private link with mTLS. If private link with mTLS is not enabled, the field is empty.
  
  private_link_sasl string
  
  URL of the seed broker for private link with SASL. If private link with SASL is not enabled, the field is empty.
  
  sasl string
  
  URL of the seed broker for SASL. If SASL is not enabled, the field is empty.
  
  mtls object
  
  mTLS configuration.
  
  Hide mtls attributes Show mtls attributes object
  
  ca_certificates_pem array[string]
  
  CA certificate in PEM format.
  
  enabled boolean
  
  Whether mTLS is enabled.
  
  principal_mapping_rules array[string]
  
  Principal mapping rules for mTLS authentication. Only valid for Kafka API. See the Redpanda documentation on configuring authentication.
  
  sasl object
  
  Hide sasl attribute Show sasl attribute object
  
  enabled boolean
  
  Whether SASL is enabled.
  
  seed_brokers array[string]
  
  Kafka API Seed Brokers (also known as Bootstrap servers).
  
  kafka_connect object
  
  Hide kafka_connect attribute Show kafka_connect attribute object
  
  enabled boolean
  
  maintenance_window_config object
  
  Resource describing the maintenance window configuration of a cluster.
  
  Hide maintenance_window_config attributes Show maintenance_window_config attributes object
  
  anytime object
  
  day_hour object
  
  Hide day_hour attributes Show day_hour attributes object
  
  day_of_week string
  
  Represents a day of the week.
  
  MONDAY: Monday
  
  TUESDAY: Tuesday
  
  WEDNESDAY: Wednesday
  
  THURSDAY: Thursday
  
  FRIDAY: Friday
  
  SATURDAY: Saturday
  
  SUNDAY: Sunday
  
  Values are MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, or SUNDAY.
  
  hour_of_day integer(int32)
  
  unspecified object
  
  name string
  
  Unique name of the cluster.
  
  nat_gateways array[string]
  
  NAT gateway information for the cluster.
  
  network_id string
  
  Network ID where cluster is placed.
  
  prometheus object
  
  Prometheus metrics endpoint properties.
  
  Hide prometheus attribute Show prometheus attribute object
  
  url string
  
  Prometheus API URL.
  
  read_replica_cluster_ids array[string]
  
  IDs of clusters which may create read-only topics from this cluster.
  
  redpanda_console object
  
  Cluster's Redpanda Console properties.
  
  Hide redpanda_console attribute Show redpanda_console attribute object
  
  url string
  
  Redpanda Console API URL.
  
  redpanda_node_count integer(int32)
  
  region string
  
  Region represents the name of the region where the cluster will be provisioned.
  
  resource_group_id string
  
  Resource group ID of the cluster.
  
  schema_registry object
  
  Cluster's Schema Registry properties.
  
  Hide schema_registry attributes Show schema_registry attributes object
  
  all_urls object
  
  The endpoints of Redpanda HTTP Proxy or Schema Registry.
  
  Hide all_urls attributes Show all_urls attributes object
  
  mtls string
  
  URL of the seed broker for mTLS. If mTLS is not enabled, the field is empty.
  
  private_link_mtls string
  
  URL of the seed broker for private link with mTLS. If private link with mTLS is not enabled, the field is empty.
  
  private_link_sasl string
  
  URL of the seed broker for private link with SASL. If private link with SASL is not enabled, the field is empty.
  
  sasl string
  
  URL of the seed broker for SASL. If SASL is not enabled, the field is empty.
  
  mtls object
  
  mTLS configuration.
  
  Hide mtls attributes Show mtls attributes object
  
  ca_certificates_pem array[string]
  
  CA certificate in PEM format.
  
  enabled boolean
  
  Whether mTLS is enabled.
  
  principal_mapping_rules array[string]
  
  Principal mapping rules for mTLS authentication. Only valid for Kafka API. See the Redpanda documentation on configuring authentication.
  
  sasl object
  
  Hide sasl attribute Show sasl attribute object
  
  enabled boolean
  
  Whether SASL is enabled.
  
  url string
  
  Schema Registry URL.
  
  state string
  
  State describes the state of the cluster.
  
  Values are STATE_CREATING_AGENT, STATE_CREATING, STATE_READY, STATE_DELETING, STATE_DELETING_AGENT, STATE_UPGRADING, STATE_FAILED, or STATE_SUSPENDED.
  
  state_description object
  
  Describes errors
  
  Hide state_description attributes Show state_description attributes object
  
  code string(int32)
  
  RPC status code, as described here.
  
  Values are OK, CANCELLED, UNKNOWN, INVALID_ARGUMENT, DEADLINE_EXCEEDED, NOT_FOUND, ALREADY_EXISTS, PERMISSION_DENIED, UNAUTHENTICATED, RESOURCE_EXHAUSTED, FAILED_PRECONDITION, ABORTED, OUT_OF_RANGE, UNIMPLEMENTED, INTERNAL, UNAVAILABLE, or DATA_LOSS.
  
  details array[object]
  
  A list of messages that carries the error details.
  
  Details of the error.
  
  Details of the error.
  
  One of:
  BadRequest object ErrorInfo object QuotaFailure object Help object
  
  Describes violations in a client request. This error type focuses on the syntactic aspects of the request.
  
  Hide attributes Show attributes
  
  @type string
  
  Fully qualified protobuf type name of the underlying response, prefixed with type.googleapis.com/.
  
  Value is type.googleapis.com/google.rpc.BadRequest.
  
  field_violations array[object]
  
  Describes all violations in a client request.
  
  A message type used to describe a single bad request field.
  
  Hide field_violations attributes Show field_violations attributes object
  
  description string
  
  A description of why the request element is bad.
  
  field string
  
  A path that leads to a field in the request body. The value will be a sequence of dot-separated identifiers that identify a protocol buffer field.
  
  Consider the following:
  
  message CreateContactRequest { message EmailAddress { enum Type { TYPE_UNSPECIFIED = 0; HOME = 1; WORK = 2; }
  
  optional string email = 1; repeated EmailType type = 2; }
  
  string full_name = 1; repeated EmailAddress email_addresses = 2; }
  
  In this example, in proto field could take one of the following values:
  
  full_name for a violation in the full_name value
  
  email_addresses[1].email for a violation in the email field of the first email_addresses message
  
  email_addresses[3].type[2] for a violation in the second type value in the third email_addresses message.
  
  In JSON, the same values are represented as:
  
  fullName for a violation in the fullName value
  
  emailAddresses[1].email for a violation in the email field of the first emailAddresses message
  
  emailAddresses[3].type[2] for a violation in the second type value in the third emailAddresses message.
  
  localized_message object
  
  Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
  
  Hide localized_message attributes Show localized_message attributes object
  
  locale string
  
  message string
  
  The localized error message in the above locale.
  
  reason string
  
  The reason of the field-level error. This is a constant value that identifies the proximate cause of the field-level error. It should uniquely identify the type of the FieldViolation within the scope of the google.rpc.ErrorInfo.domain. This should be at most 63 characters and match a regular expression of [A-Z][A-Z0-9_]+[A-Z0-9], which represents UPPER_SNAKE_CASE.
  
  Describes the cause of the error with structured details.
  
  Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled:
  
  { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } }
  
  This response indicates that the pubsub.googleapis.com API is not enabled.
  
  Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock:
  
  { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }
  
  Hide attributes Show attributes
  
  @type string
  
  Fully qualified protobuf type name of the underlying response, prefixed with type.googleapis.com/.
  
  Value is type.googleapis.com/google.rpc.ErrorInfo.
  
  domain string
  
  The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
  
  metadata object
  
  Additional structured details about this error.
  
  Keys must match a regular expression of [a-z][a-zA-Z0-9-_]+ but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
  
  Hide metadata attribute Show metadata attribute object
  
  * string Additional properties
  
  reason string
  
  The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of [A-Z][A-Z0-9_]+[A-Z0-9], which represents UPPER_SNAKE_CASE.
  
  Describes how a quota check failed.
  
  For example if a daily limit was exceeded for the calling project, a service could respond with a QuotaFailure detail containing the project id and the description of the quota limit that was exceeded. If the calling project hasn't enabled the service in the developer console, then a service could respond with the project id and set service_disabled to true.
  
  Also see RetryInfo and Help types for other details about handling a quota failure.
  
  Hide attributes Show attributes
  
  @type string
  
  Fully qualified protobuf type name of the underlying response, prefixed with type.googleapis.com/.
  
  Value is type.googleapis.com/google.rpc.QuotaFailure.
  
  violations array[object]
  
  Describes all quota violations.
  
  A message type used to describe a single quota violation. For example, a daily quota or a custom quota that was exceeded.
  
  Hide violations attributes Show violations attributes object
  
  api_service string
  
  The API Service from which the QuotaFailure.Violation orginates. In some cases, Quota issues originate from an API Service other than the one that was called. In other words, a dependency of the called API Service could be the cause of the QuotaFailure, and this field would have the dependency API service name.
  
  For example, if the called API is Kubernetes Engine API (container.googleapis.com), and a quota violation occurs in the Kubernetes Engine API itself, this field would be "container.googleapis.com". On the other hand, if the quota violation occurs when the Kubernetes Engine API creates VMs in the Compute Engine API (compute.googleapis.com), this field would be "compute.googleapis.com".
  
  description string
  
  A description of how the quota check failed. Clients can use this description to find more about the quota configuration in the service's public documentation, or find the relevant quota limit to adjust through developer console.
  
  For example: "Service disabled" or "Daily Limit for read operations exceeded".
  
  future_quota_value string(int64) | null
  
  The new quota value being rolled out at the time of the violation. At the completion of the rollout, this value will be enforced in place of quota_value. If no rollout is in progress at the time of the violation, this field is not set.
  
  For example, if at the time of the violation a rollout is in progress changing the number of CPUs quota from 10 to 20, 20 would be the value of this field.
  
  quota_dimensions object
  
  The dimensions of the violated quota. Every non-global quota is enforced on a set of dimensions. While quota metric defines what to count, the dimensions specify for what aspects the counter should be increased.
  
  For example, the quota "CPUs per region per VM family" enforces a limit on the metric "compute.googleapis.com/cpus_per_vm_family" on dimensions "region" and "vm_family". And if the violation occurred in region "us-central1" and for VM family "n1", the quota_dimensions would be,
  
  { "region": "us-central1", "vm_family": "n1", }
  
  When a quota is enforced globally, the quota_dimensions would always be empty.
  
  Hide quota_dimensions attribute Show quota_dimensions attribute object
  
  * string Additional properties
  
  quota_id string
  
  The id of the violated quota. Also know as "limit name", this is the unique identifier of a quota in the context of an API service.
  
  For example, "CPUS-PER-VM-FAMILY-per-project-region".
  
  quota_metric string
  
  The metric of the violated quota. A quota metric is a named counter to measure usage, such as API requests or CPUs. When an activity occurs in a service, such as Virtual Machine allocation, one or more quota metrics may be affected.
  
  For example, "compute.googleapis.com/cpus_per_vm_family", "storage.googleapis.com/internet_egress_bandwidth".
  
  quota_value string(int64)
  
  The enforced quota value at the time of the QuotaFailure.
  
  For example, if the enforced quota value at the time of the QuotaFailure on the number of CPUs is "10", then the value of this field would reflect this quantity.
  
  subject string
  
  The subject on which the quota check failed. For example, "clientip:" or "project:".
  
  Provides links to documentation or for performing an out of band action.
  
  For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.
  
  Hide attributes Show attributes
  
  @type string
  
  Fully qualified protobuf type name of the underlying response, prefixed with type.googleapis.com/.
  
  Value is type.googleapis.com/google.rpc.Help.
  
  links array[object]
  
  URL(s) pointing to additional information on handling the current error.
  
  Describes a URL link.
  
  Hide links attributes Show links attributes object
  
  description string
  
  Describes what the link offers.
  
  url string
  
  The URL of the link.
  
  message string
  
  Detailed error message. No compatibility guarantees are given for the text contained in this message.
  
  throughput_tier string
  
  Throughput tier of the cluster.
  
  type string
  
  Cluster type. Type is immutable and can only be set on cluster creation.
  
  Values are TYPE_DEDICATED or TYPE_BYOC.
  
  updated_at string(date-time)
  
  Cluster update timestamp.
  
  zones array[string]
  
  Zones of the cluster. Must be valid zones within the selected region. If multiple zones are used, the cluster is a multi-AZ cluster.
  
  UpdateClusterResponse is the resposne of UpdateCluster. It is provided by the Operation returned by UpdateCluster once the Operation is done.
  
  Hide attributes Show attributes
  
  @type string
  
  Fully qualified protobuf type name of the underlying response, prefixed with type.googleapis.com/.
  
  Value is type.googleapis.com/redpanda.api.controlplane.v1.UpdateClusterResponse.
  
  cluster object
  
  Resource describing a Cluster.
  
  Hide cluster attributes Show cluster attributes object
  
  api_gateway_access string
  
  Network access mode for an endpoint.
  
  Values are NETWORK_ACCESS_MODE_PRIVATE or NETWORK_ACCESS_MODE_PUBLIC.
  
  aws_private_link object
  
  Hide aws_private_link attributes Show aws_private_link attributes object
  
  allowed_principals array[string]
  
  The ARN of the principals that can access the Redpanda AWS PrivateLink Endpoint Service. To grant permissions to all principals, use an asterisk (*).
  
  connect_console boolean
  
  Whether Console is connected in Redpanda AWS Private Link Service.
  
  enabled boolean
  
  Whether Redpanda AWS Private Link Endpoint Service is enabled.
  
  http_proxy_auth_mode string
  
  Private link authentication mode.
  
  PRIVATE_LINK_AUTH_MODE_MATCH: Match the authentication methods configured for the normal API endpoint, i.e. Kafka, HTTP Proxy, or Schema Registry.
  
  PRIVATE_LINK_AUTH_MODE_SASL: SASL authentication mode only.
  
  PRIVATE_LINK_AUTH_MODE_MTLS: mTLS authentication mode only.
  
  PRIVATE_LINK_AUTH_MODE_MTLS_AND_SASL: Both SASL and mTLS authentication modes.
  
  PRIVATE_LINK_AUTH_MODE_NONE: Neither SASL or mTLS is enabled for Private Link.
  
  Values are PRIVATE_LINK_AUTH_MODE_MATCH, PRIVATE_LINK_AUTH_MODE_SASL, PRIVATE_LINK_AUTH_MODE_MTLS, PRIVATE_LINK_AUTH_MODE_MTLS_AND_SASL, or PRIVATE_LINK_AUTH_MODE_NONE.
  
  kafka_api_auth_mode string
  
  Private link authentication mode.
  
  PRIVATE_LINK_AUTH_MODE_MATCH: Match the authentication methods configured for the normal API endpoint, i.e. Kafka, HTTP Proxy, or Schema Registry.
  
  PRIVATE_LINK_AUTH_MODE_SASL: SASL authentication mode only.
  
  PRIVATE_LINK_AUTH_MODE_MTLS: mTLS authentication mode only.
  
  PRIVATE_LINK_AUTH_MODE_MTLS_AND_SASL: Both SASL and mTLS authentication modes.
  
  PRIVATE_LINK_AUTH_MODE_NONE: Neither SASL or mTLS is enabled for Private Link.
  
  Values are PRIVATE_LINK_AUTH_MODE_MATCH, PRIVATE_LINK_AUTH_MODE_SASL, PRIVATE_LINK_AUTH_MODE_MTLS, PRIVATE_LINK_AUTH_MODE_MTLS_AND_SASL, or PRIVATE_LINK_AUTH_MODE_NONE.
  
  schema_registry_auth_mode string
  
  Private link authentication mode.
  
  PRIVATE_LINK_AUTH_MODE_MATCH: Match the authentication methods configured for the normal API endpoint, i.e. Kafka, HTTP Proxy, or Schema Registry.
  
  PRIVATE_LINK_AUTH_MODE_SASL: SASL authentication mode only.
  
  PRIVATE_LINK_AUTH_MODE_MTLS: mTLS authentication mode only.
  
  PRIVATE_LINK_AUTH_MODE_MTLS_AND_SASL: Both SASL and mTLS authentication modes.
  
  PRIVATE_LINK_AUTH_MODE_NONE: Neither SASL or mTLS is enabled for Private Link.
  
  Values are PRIVATE_LINK_AUTH_MODE_MATCH, PRIVATE_LINK_AUTH_MODE_SASL, PRIVATE_LINK_AUTH_MODE_MTLS, PRIVATE_LINK_AUTH_MODE_MTLS_AND_SASL, or PRIVATE_LINK_AUTH_MODE_NONE.
  
  status object
  
  Hide status attributes Show status attributes object
  
  console_port integer(int32)
  
  The port of Redpanda Console.
  
  created_at string(date-time)
  
  Redpanda AWS PrivateLink Endpoint Service creation timestamp.
  
  deleted_at string(date-time)
  
  Redpanda AWS PrivateLink Service deletion timestamp.
  
  kafka_api_node_base_port integer(int32)
  
  Kafka API node service base port. The port for node i (0 .. node_count-1) is kafka_api_node_base_port + i.
  
  kafka_api_seed_port integer(int32)
  
  Kafka API seed service port.
  
  redpanda_proxy_node_base_port integer(int32)
  
  HTTP Proxy node service base port. The port for node i (0 .. node_count-1) is redpanda_proxy_node_base_port + i.
  
  redpanda_proxy_seed_port integer(int32)
  
  HTTP Proxy seed service port.
  
  schema_registry_seed_port integer(int32)
  
  Schema Registry seed service port.
  
  service_id string
  
  ID of Redpanda AWS PrivateLink Endpoint Service.
  
  service_name string
  
  Name of Redpanda AWS PrivateLink Endpoint Service.
  
  service_state string
  
  State of Redpanda AWS PrivateLink Endpoint Service.
  
  vpc_endpoint_connections array[object]
  
  List of VPC endpoints with established connections to Redpanda AWS PrivateLink Endpoint Service.
  
  Hide vpc_endpoint_connections attributes Show vpc_endpoint_connections attributes object
  
  connection_id string
  
  Connection ID of VPC endpoint connected to Redpanda AWS PrivateLink Endpoint Service.
  
  created_at string(date-time)
  
  VPC endpoint creation timestamp.
  
  dns_entries array[object]
  
  The list of DNS entries associated with VPC endpoint.
  
  Hide dns_entries attributes Show dns_entries attributes object
  
  dns_name string
  
  DNS entry of VPC endpoint connected to Redpanda AWS PrivateLink Endpoint Service.
  
  hosted_zone_id string
  
  The ID of Route53 DNS zone.
  
  id string
  
  The ID of VPC endpoint.
  
  load_balancer_arns array[string]
  
  List of load balancer ARNs.
  
  owner string
  
  The owner of VPC endpoint.
  
  state string
  
  The state of VPC endpoint connected to Redpanda AWS PrivateLink Endpoint Service.
  
  supported_regions array[string]
  
  List of supported regions in cross-region AWS PrivateLink.
  
  azure_private_link object
  
  Hide azure_private_link attributes Show azure_private_link attributes object
  
  allowed_subscriptions array[string]
  
  The subscriptions that can access the Redpanda Azure PrivateLink Endpoint Service. To grant permissions to all principals, use an asterisk (*).
  
  connect_console boolean
  
  Whether Console is connected in Redpanda Azure Private Link Service.
  
  enabled boolean
  
  Whether Redpanda AWS Private Link Endpoint Service is enabled.
  
  http_proxy_auth_mode string
  
  Private link authentication mode.
  
  PRIVATE_LINK_AUTH_MODE_MATCH: Match the authentication methods configured for the normal API endpoint, i.e. Kafka, HTTP Proxy, or Schema Registry.
  
  PRIVATE_LINK_AUTH_MODE_SASL: SASL authentication mode only.
  
  PRIVATE_LINK_AUTH_MODE_MTLS: mTLS authentication mode only.
  
  PRIVATE_LINK_AUTH_MODE_MTLS_AND_SASL: Both SASL and mTLS authentication modes.
  
  PRIVATE_LINK_AUTH_MODE_NONE: Neither SASL or mTLS is enabled for Private Link.
  
  Values are PRIVATE_LINK_AUTH_MODE_MATCH, PRIVATE_LINK_AUTH_MODE_SASL, PRIVATE_LINK_AUTH_MODE_MTLS, PRIVATE_LINK_AUTH_MODE_MTLS_AND_SASL, or PRIVATE_LINK_AUTH_MODE_NONE.
  
  kafka_api_auth_mode string
  
  Private link authentication mode.
  
  PRIVATE_LINK_AUTH_MODE_MATCH: Match the authentication methods configured for the normal API endpoint, i.e. Kafka, HTTP Proxy, or Schema Registry.
  
  PRIVATE_LINK_AUTH_MODE_SASL: SASL authentication mode only.
  
  PRIVATE_LINK_AUTH_MODE_MTLS: mTLS authentication mode only.
  
  PRIVATE_LINK_AUTH_MODE_MTLS_AND_SASL: Both SASL and mTLS authentication modes.
  
  PRIVATE_LINK_AUTH_MODE_NONE: Neither SASL or mTLS is enabled for Private Link.
  
  Values are PRIVATE_LINK_AUTH_MODE_MATCH, PRIVATE_LINK_AUTH_MODE_SASL, PRIVATE_LINK_AUTH_MODE_MTLS, PRIVATE_LINK_AUTH_MODE_MTLS_AND_SASL, or PRIVATE_LINK_AUTH_MODE_NONE.
  
  schema_registry_auth_mode string
  
  Private link authentication mode.
  
  PRIVATE_LINK_AUTH_MODE_MATCH: Match the authentication methods configured for the normal API endpoint, i.e. Kafka, HTTP Proxy, or Schema Registry.
  
  PRIVATE_LINK_AUTH_MODE_SASL: SASL authentication mode only.
  
  PRIVATE_LINK_AUTH_MODE_MTLS: mTLS authentication mode only.
  
  PRIVATE_LINK_AUTH_MODE_MTLS_AND_SASL: Both SASL and mTLS authentication modes.
  
  PRIVATE_LINK_AUTH_MODE_NONE: Neither SASL or mTLS is enabled for Private Link.
  
  Values are PRIVATE_LINK_AUTH_MODE_MATCH, PRIVATE_LINK_AUTH_MODE_SASL, PRIVATE_LINK_AUTH_MODE_MTLS, PRIVATE_LINK_AUTH_MODE_MTLS_AND_SASL, or PRIVATE_LINK_AUTH_MODE_NONE.
  
  status object
  
  Hide status attributes Show status attributes object
  
  approved_subscriptions array[string]
  
  console_port integer(int32)
  
  The port of Redpanda Console.
  
  created_at string(date-time)
  
  Redpanda Azure PrivateLink Endpoint Service creation timestamp.
  
  deleted_at string(date-time)
  
  Redpanda Azure PrivateLink Service deletion timestamp.
  
  dns_a_record string
  
  kafka_api_node_base_port integer(int32)
  
  Kafka API node service base port. The port for node i (0 .. node_count-1) is kafka_api_node_base_port + i.
  
  kafka_api_seed_port integer(int32)
  
  Kafka API seed service port.
  
  private_endpoint_connections array[object]
  
  List of private endpoint connections to Redpanda Azure Private Link Service.
  
  Hide private_endpoint_connections attributes Show private_endpoint_connections attributes object
  
  connection_id string
  
  connection_name string
  
  created_at string(date-time)
  
  PrivateEndpointConnection creation timestamp.
  
  private_endpoint_id string
  
  Resource ID of Private Endpoint to Redpanda Azure PrivateLink Endpoint Service.
  
  private_endpoint_name string
  
  The name of the PrivateEndpointConnection.
  
  status string
  
  The status of private endpoint connected to Redpanda Azure PrivateLink Endpoint Service.
  
  redpanda_proxy_node_base_port integer(int32)
  
  HTTP Proxy node service base port. The port for node i (0 .. node_count-1) is redpanda_proxy_node_base_port + i.
  
  redpanda_proxy_seed_port integer(int32)
  
  HTTP Proxy seed service port.
  
  schema_registry_seed_port integer(int32)
  
  Schema Registry seed service port.
  
  service_id string
  
  ID of Redpanda Azure PrivateLink Endpoint Service.
  
  service_name string
  
  Name of Redpanda Azure PrivateLink Endpoint Service.
  
  cloud_provider string
  
  Cloud provider where resources are created.
  
  Values are CLOUD_PROVIDER_AWS, CLOUD_PROVIDER_GCP, or CLOUD_PROVIDER_AZURE.
  
  cloud_provider_tags object
  
  Tags placed on cloud resources. If the cloud provider is GCP and the name of a tag has the prefix "gcp.network-tag.", the tag is a network tag that will be added to the Redpanda cluster GKE nodes. Otherwise, the tag is a normal tag. For example, if the name of a tag is "gcp.network-tag.network-tag-foo", the network tag named "network-tag-foo" will be added to the Redpanda cluster GKE nodes. Note: The value of a network tag will be ignored. See the official GCP VPC for more details on network tags.
  
  Hide cloud_provider_tags attribute Show cloud_provider_tags attribute object
  
  * string Additional properties
  
  cloud_storage object
  
  Hide cloud_storage attributes Show cloud_storage attributes object
  
  aws object
  
  Hide aws attribute Show aws attribute object
  
  arn string
  
  azure object
  
  Hide azure attributes Show azure attributes object
  
  allowed_ips array[string]
  
  List of public IP or IP ranges in CIDR Format.
  
  Only IPv4 addresses are allowed.
  
  Private IP address ranges as defined in RFC 1918 are not allowed.
  
  Private IP address ranges as defined in RFC 6598 are not allowed.
  
  Small address ranges using "/31" or "/32" prefix sizes are not supported. These ranges should be configured using individual IP address rules without prefix specified.
  
  allowed_ips have no effect on requests originating from the same Azure region as the storage account. Use allowed_subnet_ids to allow same-region requests. Services deployed in the same region as the storage account use private Azure IP addresses for communication. Thus, you cannot allow access to specific Azure services based on their public outbound IP address range.
  
  allowed_subnet_ids array[string]
  
  A list of virtual network subnet IDs that are allowed to access the storage account.
  
  container_name string
  
  resource_group_name string
  
  storage_account_name string
  
  subscription_id string
  
  gcp object
  
  Hide gcp attribute Show gcp attribute object
  
  name string
  
  skip_destroy boolean
  
  cluster_configuration object
  
  Hide cluster_configuration attributes Show cluster_configuration attributes object
  
  computed_properties object
  
  custom_properties object
  
  connection_type string
  
  Cluster connection type. Private clusters are not exposed to the internet. For BYOC clusters, Private is best-practice.
  
  Values are CONNECTION_TYPE_PUBLIC or CONNECTION_TYPE_PRIVATE.
  
  created_at string(date-time)
  
  Cluster creation timestamp.
  
  current_redpanda_version string
  
  Current Redpanda version of the cluster.
  
  customer_managed_resources object
  
  The cloud resources created by user.
  
  Hide customer_managed_resources attributes Show customer_managed_resources attributes object
  
  aws object
  
  AWS resources created and managed by user, and required to deploy the Redpanda cluster.
  
  Hide aws attributes Show aws attributes object
  
  agent_instance_profile object Required
  
  AWS instance profile.
  
  Hide agent_instance_profile attribute Show agent_instance_profile attribute object
  
  arn string Required
  
  AWS instance profile ARN.
  
  cloud_storage_bucket object Required
  
  AWS storage bucket properties by ARN.
  
  Hide cloud_storage_bucket attribute Show cloud_storage_bucket attribute object
  
  arn string Required
  
  AWS storage bucket identifier.
  
  cluster_security_group object Required
  
  Security Group identifies AWS security group.
  
  Hide cluster_security_group attribute Show cluster_security_group attribute object
  
  arn string Required
  
  AWS security group ARN.
  
  connectors_node_group_instance_profile object Required
  
  AWS instance profile.
  
  Hide connectors_node_group_instance_profile attribute Show connectors_node_group_instance_profile attribute object
  
  arn string Required
  
  AWS instance profile ARN.
  
  connectors_security_group object Required
  
  Security Group identifies AWS security group.
  
  Hide connectors_security_group attribute Show connectors_security_group attribute object
  
  arn string Required
  
  AWS security group ARN.
  
  k8s_cluster_role object Required
  
  Role identifies AWS role.
  
  Hide k8s_cluster_role attribute Show k8s_cluster_role attribute object
  
  arn string Required
  
  AWS role ARN.
  
  node_security_group object Required
  
  Security Group identifies AWS security group.
  
  Hide node_security_group attribute Show node_security_group attribute object
  
  arn string Required
  
  AWS security group ARN.
  
  permissions_boundary_policy object Required
  
  Policy identifies an AWS policy.
  
  Hide permissions_boundary_policy attribute Show permissions_boundary_policy attribute object
  
  arn string Required
  
  AWS policy ARN.
  
  redpanda_agent_security_group object Required
  
  Security Group identifies AWS security group.
  
  Hide redpanda_agent_security_group attribute Show redpanda_agent_security_group attribute object
  
  arn string Required
  
  AWS security group ARN.
  
  redpanda_connect_node_group_instance_profile object
  
  AWS instance profile.
  
  Hide redpanda_connect_node_group_instance_profile attribute Show redpanda_connect_node_group_instance_profile attribute object
  
  arn string Required
  
  AWS instance profile ARN.
  
  redpanda_connect_security_group object
  
  Security Group identifies AWS security group.
  
  Hide redpanda_connect_security_group attribute Show redpanda_connect_security_group attribute object
  
  arn string Required
  
  AWS security group ARN.
  
  redpanda_node_group_instance_profile object Required
  
  AWS instance profile.
  
  Hide redpanda_node_group_instance_profile attribute Show redpanda_node_group_instance_profile attribute object
  
  arn string Required
  
  AWS instance profile ARN.
  
  redpanda_node_group_security_group object Required
  
  Security Group identifies AWS security group.
  
  Hide redpanda_node_group_security_group attribute Show redpanda_node_group_security_group attribute object
  
  arn string Required
  
  AWS security group ARN.
  
  utility_node_group_instance_profile object Required
  
  AWS instance profile.
  
  Hide utility_node_group_instance_profile attribute Show utility_node_group_instance_profile attribute object
  
  arn string Required
  
  AWS instance profile ARN.
  
  utility_security_group object Required
  
  Security Group identifies AWS security group.
  
  Hide utility_security_group attribute Show utility_security_group attribute object
  
  arn string Required
  
  AWS security group ARN.
  
  azure object
  
  Azure resources created and managed by user, and required to deploy the Redpanda cluster.
  
  Hide azure attributes Show azure attributes object
  
  cidrs object Required
  
  Additional CIDRs allocated to Redpanda cluster.
  
  Hide cidrs attribute Show cidrs attribute object
  
  aks_service_cidr string Required
  
  CIDR used by AKS Kubernetes services.
  
  key_vaults object Required
  
  Azure key vaults used by Redpanda Cluster. All key vaults shall be in redpanda_resource_group.
  
  Hide key_vaults attributes Show key_vaults attributes object
  
  console_vault object Required
  
  Azure Key Vault.
  
  Hide console_vault attribute Show console_vault attribute object
  
  name string Required
  
  management_vault object Required
  
  Azure Key Vault.
  
  Hide management_vault attribute Show management_vault attribute object
  
  name string Required
  
  resource_groups object Required
  
  Azure resource groups holding the Redpanda cluster resources.
  
  Hide resource_groups attributes Show resource_groups attributes object
  
  iam_resource_group object Required
  
  Azure Resource Group Specification
  
  Hide iam_resource_group attribute Show iam_resource_group attribute object
  
  name string Required
  
  redpanda_resource_group object Required
  
  Azure Resource Group Specification
  
  Hide redpanda_resource_group attribute Show redpanda_resource_group attribute object
  
  name string Required
  
  storage_resource_group object Required
  
  Azure Resource Group Specification
  
  Hide storage_resource_group attribute Show storage_resource_group attribute object
  
  name string Required
  
  security_groups object Required
  
  Azure security groups for Redpanda Cluster. All security groups shall be in the network resource group.
  
  Hide security_groups attribute Show security_groups attribute object
  
  redpanda_security_group object Required
  
  Azure security group.
  
  Hide redpanda_security_group attribute Show redpanda_security_group attribute object
  
  name string Required
  
  tiered_cloud_storage object Required
  
  Azure Bucket Specification
  
  Hide tiered_cloud_storage attributes Show tiered_cloud_storage attributes object
  
  resource_group object
  
  Azure Resource Group Specification
  
  Hide resource_group attribute Show resource_group attribute object
  
  name string Required
  
  storage_account_name string Required
  
  storage_container_name string Required
  
  user_assigned_identities object Required
  
  Azure user assigned identities used by Redpanda cluster. All identities shall be in iam_resource_group.
  
  Hide user_assigned_identities attributes Show user_assigned_identities attributes object
  
  agent_user_assigned_identity object Required
  
  Azure user assigned identity.
  
  Hide agent_user_assigned_identity attribute Show agent_user_assigned_identity attribute object
  
  name string Required
  
  aks_user_assigned_identity object Required
  
  Azure user assigned identity.
  
  Hide aks_user_assigned_identity attribute Show aks_user_assigned_identity attribute object
  
  name string Required
  
  cert_manager_assigned_identity object Required
  
  Azure user assigned identity.
  
  Hide cert_manager_assigned_identity attribute Show cert_manager_assigned_identity attribute object
  
  name string Required
  
  external_dns_assigned_identity object Required
  
  Azure user assigned identity.
  
  Hide external_dns_assigned_identity attribute Show external_dns_assigned_identity attribute object
  
  name string Required
  
  kafka_connect_assigned_identity object Required
  
  Azure user assigned identity.
  
  Hide kafka_connect_assigned_identity attribute Show kafka_connect_assigned_identity attribute object
  
  name string Required
  
  redpanda_cluster_assigned_identity object Required
  
  Azure user assigned identity.
  
  Hide redpanda_cluster_assigned_identity attribute Show redpanda_cluster_assigned_identity attribute object
  
  name string Required
  
  redpanda_connect_api_assigned_identity object Required
  
  Azure user assigned identity.
  
  Hide redpanda_connect_api_assigned_identity attribute Show redpanda_connect_api_assigned_identity attribute object
  
  name string Required
  
  redpanda_connect_assigned_identity object Required
  
  Azure user assigned identity.
  
  Hide redpanda_connect_assigned_identity attribute Show redpanda_connect_assigned_identity attribute object
  
  name string Required
  
  redpanda_console_assigned_identity object Required
  
  Azure user assigned identity.
  
  Hide redpanda_console_assigned_identity attribute Show redpanda_console_assigned_identity attribute object
  
  name string Required
  
  redpanda_operator_assigned_identity object Required
  
  Azure user assigned identity.
  
  Hide redpanda_operator_assigned_identity attribute Show redpanda_operator_assigned_identity attribute object
  
  name string Required
  
  gcp object
  
  GCP resources created and managed by user, and required to deploy the Redpanda cluster. See Create a BYOVPC Cluster on GCP.
  
  Hide gcp attributes Show gcp attributes object
  
  agent_service_account object Required
  
  GCP service account.
  
  Hide agent_service_account attribute Show agent_service_account attribute object
  
  email string Required
  
  GCP service account email.
  
  connector_service_account object Required
  
  GCP service account.
  
  Hide connector_service_account attribute Show connector_service_account attribute object
  
  email string Required
  
  GCP service account email.
  
  console_service_account object Required
  
  GCP service account.
  
  Hide console_service_account attribute Show console_service_account attribute object
  
  email string Required
  
  GCP service account email.
  
  gke_service_account object Required
  
  GCP service account.
  
  Hide gke_service_account attribute Show gke_service_account attribute object
  
  email string Required
  
  GCP service account email.
  
  psc_nat_subnet_name string
  
  NAT subnet name if GCP Private Service Connect (a.k.a Private Link) is enabled. If it is used for PSC v1, use psc_v2_nat_subnet_name to set NAT subnet name for PSC v2.
  
  psc_v2_nat_subnet_name string
  
  NAT subnet name for PSC v2 if GCP Private Service Connect (a.k.a Private Link) is enabled and psc_nat_subnet_name is used for PSC v1.
  
  redpanda_cluster_service_account object Required
  
  GCP service account.
  
  Hide redpanda_cluster_service_account attribute Show redpanda_cluster_service_account attribute object
  
  email string Required
  
  GCP service account email.
  
  redpanda_connect_api_service_account object Required
  
  GCP service account.
  
  Hide redpanda_connect_api_service_account attribute Show redpanda_connect_api_service_account attribute object
  
  email string Required
  
  GCP service account email.
  
  redpanda_connect_service_account object Required
  
  GCP service account.
  
  Hide redpanda_connect_service_account attribute Show redpanda_connect_service_account attribute object
  
  email string Required
  
  GCP service account email.
  
  redpanda_operator_service_account object
  
  GCP service account.
  
  Hide redpanda_operator_service_account attribute Show redpanda_operator_service_account attribute object
  
  email string Required
  
  GCP service account email.
  
  subnet object Required
  
  GCP subnet properties. See the official GCP API reference.
  
  Hide subnet attributes Show subnet attributes object
  
  k8s_master_ipv4_range string Required
  
  Kubernetes Master IPv4 range, e.g. 10.0.0.0/24.
  
  name string Required
  
  Subnet name.
  
  secondary_ipv4_range_pods object Required
  
  Secondary IPv4 range.
  
  Hide secondary_ipv4_range_pods attribute Show secondary_ipv4_range_pods attribute object
  
  name string
  
  secondary_ipv4_range_services object Required
  
  Secondary IPv4 range.
  
  Hide secondary_ipv4_range_services attribute Show secondary_ipv4_range_services attribute object
  
  name string
  
  tiered_storage_bucket object Required
  
  GCP storage bucket properties.
  
  Hide tiered_storage_bucket attribute Show tiered_storage_bucket attribute object
  
  name string Required
  
  Name of GCP storage bucket. See the official GCP documentation for naming restrictions.
  
  dataplane_api object
  
  Cluster's Data Plane API properties.
  
  Hide dataplane_api attribute Show dataplane_api attribute object
  
  url string
  
  Data Plane API URL.
  
  desired_redpanda_version string
  
  Desired Redpanda version of the cluster.
  
  gcp_global_access_enabled boolean | null
  
  gcp_private_service_connect object
  
  Hide gcp_private_service_connect attributes Show gcp_private_service_connect attributes object
  
  consumer_accept_list array[object]
  
  List of consumers that are allowed to connect to Redpanda GCP PSC (Private Service Connect) service attachment.
  
  GCP Private Service Connect consumer specifications.
  
  Hide consumer_accept_list attribute Show consumer_accept_list attribute object
  
  source string
  
  Either the GCP project number or its alphanumeric ID.
  
  enabled boolean
  
  Whether Redpanda GCP Private Service Connect is enabled.
  
  global_access_enabled boolean
  
  Whether global access is enabled.
  
  http_proxy_auth_mode string
  
  Private link authentication mode.
  
  PRIVATE_LINK_AUTH_MODE_MATCH: Match the authentication methods configured for the normal API endpoint, i.e. Kafka, HTTP Proxy, or Schema Registry.
  
  PRIVATE_LINK_AUTH_MODE_SASL: SASL authentication mode only.
  
  PRIVATE_LINK_AUTH_MODE_MTLS: mTLS authentication mode only.
  
  PRIVATE_LINK_AUTH_MODE_MTLS_AND_SASL: Both SASL and mTLS authentication modes.
  
  PRIVATE_LINK_AUTH_MODE_NONE: Neither SASL or mTLS is enabled for Private Link.
  
  Values are PRIVATE_LINK_AUTH_MODE_MATCH, PRIVATE_LINK_AUTH_MODE_SASL, PRIVATE_LINK_AUTH_MODE_MTLS, PRIVATE_LINK_AUTH_MODE_MTLS_AND_SASL, or PRIVATE_LINK_AUTH_MODE_NONE.
  
  kafka_api_auth_mode string
  
  Private link authentication mode.
  
  PRIVATE_LINK_AUTH_MODE_MATCH: Match the authentication methods configured for the normal API endpoint, i.e. Kafka, HTTP Proxy, or Schema Registry.
  
  PRIVATE_LINK_AUTH_MODE_SASL: SASL authentication mode only.
  
  PRIVATE_LINK_AUTH_MODE_MTLS: mTLS authentication mode only.
  
  PRIVATE_LINK_AUTH_MODE_MTLS_AND_SASL: Both SASL and mTLS authentication modes.
  
  PRIVATE_LINK_AUTH_MODE_NONE: Neither SASL or mTLS is enabled for Private Link.
  
  Values are PRIVATE_LINK_AUTH_MODE_MATCH, PRIVATE_LINK_AUTH_MODE_SASL, PRIVATE_LINK_AUTH_MODE_MTLS, PRIVATE_LINK_AUTH_MODE_MTLS_AND_SASL, or PRIVATE_LINK_AUTH_MODE_NONE.
  
  schema_registry_auth_mode string
  
  Private link authentication mode.
  
  PRIVATE_LINK_AUTH_MODE_MATCH: Match the authentication methods configured for the normal API endpoint, i.e. Kafka, HTTP Proxy, or Schema Registry.
  
  PRIVATE_LINK_AUTH_MODE_SASL: SASL authentication mode only.
  
  PRIVATE_LINK_AUTH_MODE_MTLS: mTLS authentication mode only.
  
  PRIVATE_LINK_AUTH_MODE_MTLS_AND_SASL: Both SASL and mTLS authentication modes.
  
  PRIVATE_LINK_AUTH_MODE_NONE: Neither SASL or mTLS is enabled for Private Link.
  
  Values are PRIVATE_LINK_AUTH_MODE_MATCH, PRIVATE_LINK_AUTH_MODE_SASL, PRIVATE_LINK_AUTH_MODE_MTLS, PRIVATE_LINK_AUTH_MODE_MTLS_AND_SASL, or PRIVATE_LINK_AUTH_MODE_NONE.
  
  status object
  
  Hide status attributes Show status attributes object
  
  connected_endpoints array[object]
  
  List of VPC endpoints with established connections to GCP Private Service Connect.
  
  ConnectedEndpoint defines endpoint connection connected to Redpanda GCP PSC (Private Service Connect) service.
  
  Hide connected_endpoints attributes Show connected_endpoints attributes object
  
  connection_id string
  
  Connection ID of the endpoint.
  
  consumer_network string
  
  Network of the consumer connecting to Redpanda GCP Private Service Connect service. See the official GCP documentation for Private Service Connect.
  
  endpoint string
  
  Connection endpoint. See the official GCP API reference for Private Service Connect.
  
  status string
  
  Endpoint status (ACCEPTED | REJECTED).
  
  The ServiceAttachment API resource (https://cloud.google.com/compute/docs/reference/rest/v1/serviceAttachments) does have more fields, such as connection ID & consumer network, but the Terraform provider (https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/compute_service_attachment#nested_connected_endpoints) doesn't return them as outputs.
  
  created_at string(date-time)
  
  Redpanda GCP Private Service Connect service creation timestamp.
  
  deleted_at string(date-time)
  
  Redpanda GCP Private Service Connect service deletion timestamp.
  
  dns_a_records array[string]
  
  Customer-created DNS A records that point at the PSC endpoint on the consumer side.
  
  kafka_api_node_base_port integer(int32)
  
  Kafka API node service base port. The port for node i (0 .. node_count-1) is kafka_api_node_base_port + i.
  
  kafka_api_seed_port integer(int32)
  
  Kafka API seed service port.
  
  redpanda_proxy_node_base_port integer(int32)
  
  HTTP Proxy node service base port. The port for node i (0 .. node_count-1) is redpanda_proxy_node_base_port + i.
  
  redpanda_proxy_seed_port integer(int32)
  
  HTTP Proxy seed service port.
  
  schema_registry_seed_port integer(int32)
  
  Schema Registry seed service port.
  
  seed_hostname string
  
  Hostname for clients to initiate connections to the APIs exposed through Private Service Connect.
  
  service_attachment string
  
  Service attachment used by consumers to create endpoint connections to Redpanda GCP Private Service Connect service.
  
  http_proxy object
  
  HTTP Proxy properties.
  
  Hide http_proxy attributes Show http_proxy attributes object
  
  all_urls object
  
  The endpoints of Redpanda HTTP Proxy or Schema Registry.
  
  Hide all_urls attributes Show all_urls attributes object
  
  mtls string
  
  URL of the seed broker for mTLS. If mTLS is not enabled, the field is empty.
  
  private_link_mtls string
  
  URL of the seed broker for private link with mTLS. If private link with mTLS is not enabled, the field is empty.
  
  private_link_sasl string
  
  URL of the seed broker for private link with SASL. If private link with SASL is not enabled, the field is empty.
  
  sasl string
  
  URL of the seed broker for SASL. If SASL is not enabled, the field is empty.
  
  mtls object
  
  mTLS configuration.
  
  Hide mtls attributes Show mtls attributes object
  
  ca_certificates_pem array[string]
  
  CA certificate in PEM format.
  
  enabled boolean
  
  Whether mTLS is enabled.
  
  principal_mapping_rules array[string]
  
  Principal mapping rules for mTLS authentication. Only valid for Kafka API. See the Redpanda documentation on configuring authentication.
  
  sasl object
  
  Hide sasl attribute Show sasl attribute object
  
  enabled boolean
  
  Whether SASL is enabled.
  
  url string
  
  HTTP Proxy URL of cluster.
  
  id string
  
  ID of the cluster. ID is an output from the Create Cluster endpoint and cannot be set by the caller.
  
  kafka_api object
  
  Cluster's Kafka API properties.
  
  Hide kafka_api attributes Show kafka_api attributes object
  
  all_seed_brokers object
  
  Seed brokers of Redpanda Kafka API.
  
  Hide all_seed_brokers attributes Show all_seed_brokers attributes object
  
  mtls string
  
  URL of the seed broker for mTLS. If mTLS is not enabled, the field is empty.
  
  private_link_mtls string
  
  URL of the seed broker for private link with mTLS. If private link with mTLS is not enabled, the field is empty.
  
  private_link_sasl string
  
  URL of the seed broker for private link with SASL. If private link with SASL is not enabled, the field is empty.
  
  sasl string
  
  URL of the seed broker for SASL. If SASL is not enabled, the field is empty.
  
  mtls object
  
  mTLS configuration.
  
  Hide mtls attributes Show mtls attributes object
  
  ca_certificates_pem array[string]
  
  CA certificate in PEM format.
  
  enabled boolean
  
  Whether mTLS is enabled.
  
  principal_mapping_rules array[string]
  
  Principal mapping rules for mTLS authentication. Only valid for Kafka API. See the Redpanda documentation on configuring authentication.
  
  sasl object
  
  Hide sasl attribute Show sasl attribute object
  
  enabled boolean
  
  Whether SASL is enabled.
  
  seed_brokers array[string]
  
  Kafka API Seed Brokers (also known as Bootstrap servers).
  
  kafka_connect object
  
  Hide kafka_connect attribute Show kafka_connect attribute object
  
  enabled boolean
  
  maintenance_window_config object
  
  Resource describing the maintenance window configuration of a cluster.
  
  Hide maintenance_window_config attributes Show maintenance_window_config attributes object
  
  anytime object
  
  day_hour object
  
  Hide day_hour attributes Show day_hour attributes object
  
  day_of_week string
  
  Represents a day of the week.
  
  MONDAY: Monday
  
  TUESDAY: Tuesday
  
  WEDNESDAY: Wednesday
  
  THURSDAY: Thursday
  
  FRIDAY: Friday
  
  SATURDAY: Saturday
  
  SUNDAY: Sunday
  
  Values are MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, or SUNDAY.
  
  hour_of_day integer(int32)
  
  unspecified object
  
  name string
  
  Unique name of the cluster.
  
  nat_gateways array[string]
  
  NAT gateway information for the cluster.
  
  network_id string
  
  Network ID where cluster is placed.
  
  prometheus object
  
  Prometheus metrics endpoint properties.
  
  Hide prometheus attribute Show prometheus attribute object
  
  url string
  
  Prometheus API URL.
  
  read_replica_cluster_ids array[string]
  
  IDs of clusters which may create read-only topics from this cluster.
  
  redpanda_console object
  
  Cluster's Redpanda Console properties.
  
  Hide redpanda_console attribute Show redpanda_console attribute object
  
  url string
  
  Redpanda Console API URL.
  
  redpanda_node_count integer(int32)
  
  region string
  
  Region represents the name of the region where the cluster will be provisioned.
  
  resource_group_id string
  
  Resource group ID of the cluster.
  
  schema_registry object
  
  Cluster's Schema Registry properties.
  
  Hide schema_registry attributes Show schema_registry attributes object
  
  all_urls object
  
  The endpoints of Redpanda HTTP Proxy or Schema Registry.
  
  Hide all_urls attributes Show all_urls attributes object
  
  mtls string
  
  URL of the seed broker for mTLS. If mTLS is not enabled, the field is empty.
  
  private_link_mtls string
  
  URL of the seed broker for private link with mTLS. If private link with mTLS is not enabled, the field is empty.
  
  private_link_sasl string
  
  URL of the seed broker for private link with SASL. If private link with SASL is not enabled, the field is empty.
  
  sasl string
  
  URL of the seed broker for SASL. If SASL is not enabled, the field is empty.
  
  mtls object
  
  mTLS configuration.
  
  Hide mtls attributes Show mtls attributes object
  
  ca_certificates_pem array[string]
  
  CA certificate in PEM format.
  
  enabled boolean
  
  Whether mTLS is enabled.
  
  principal_mapping_rules array[string]
  
  Principal mapping rules for mTLS authentication. Only valid for Kafka API. See the Redpanda documentation on configuring authentication.
  
  sasl object
  
  Hide sasl attribute Show sasl attribute object
  
  enabled boolean
  
  Whether SASL is enabled.
  
  url string
  
  Schema Registry URL.
  
  state string
  
  State describes the state of the cluster.
  
  Values are STATE_CREATING_AGENT, STATE_CREATING, STATE_READY, STATE_DELETING, STATE_DELETING_AGENT, STATE_UPGRADING, STATE_FAILED, or STATE_SUSPENDED.
  
  state_description object
  
  Describes errors
  
  Hide state_description attributes Show state_description attributes object
  
  code string(int32)
  
  RPC status code, as described here.
  
  Values are OK, CANCELLED, UNKNOWN, INVALID_ARGUMENT, DEADLINE_EXCEEDED, NOT_FOUND, ALREADY_EXISTS, PERMISSION_DENIED, UNAUTHENTICATED, RESOURCE_EXHAUSTED, FAILED_PRECONDITION, ABORTED, OUT_OF_RANGE, UNIMPLEMENTED, INTERNAL, UNAVAILABLE, or DATA_LOSS.
  
  details array[object]
  
  A list of messages that carries the error details.
  
  Details of the error.
  
  Details of the error.
  
  One of:
  BadRequest object ErrorInfo object QuotaFailure object Help object
  
  Describes violations in a client request. This error type focuses on the syntactic aspects of the request.
  
  Hide attributes Show attributes
  
  @type string
  
  Fully qualified protobuf type name of the underlying response, prefixed with type.googleapis.com/.
  
  Value is type.googleapis.com/google.rpc.BadRequest.
  
  field_violations array[object]
  
  Describes all violations in a client request.
  
  A message type used to describe a single bad request field.
  
  Hide field_violations attributes Show field_violations attributes object
  
  description string
  
  A description of why the request element is bad.
  
  field string
  
  A path that leads to a field in the request body. The value will be a sequence of dot-separated identifiers that identify a protocol buffer field.
  
  Consider the following:
  
  message CreateContactRequest { message EmailAddress { enum Type { TYPE_UNSPECIFIED = 0; HOME = 1; WORK = 2; }
  
  optional string email = 1; repeated EmailType type = 2; }
  
  string full_name = 1; repeated EmailAddress email_addresses = 2; }
  
  In this example, in proto field could take one of the following values:
  
  full_name for a violation in the full_name value
  
  email_addresses[1].email for a violation in the email field of the first email_addresses message
  
  email_addresses[3].type[2] for a violation in the second type value in the third email_addresses message.
  
  In JSON, the same values are represented as:
  
  fullName for a violation in the fullName value
  
  emailAddresses[1].email for a violation in the email field of the first emailAddresses message
  
  emailAddresses[3].type[2] for a violation in the second type value in the third emailAddresses message.
  
  localized_message object
  
  Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
  
  Hide localized_message attributes Show localized_message attributes object
  
  locale string
  
  message string
  
  The localized error message in the above locale.
  
  reason string
  
  The reason of the field-level error. This is a constant value that identifies the proximate cause of the field-level error. It should uniquely identify the type of the FieldViolation within the scope of the google.rpc.ErrorInfo.domain. This should be at most 63 characters and match a regular expression of [A-Z][A-Z0-9_]+[A-Z0-9], which represents UPPER_SNAKE_CASE.
  
  Describes the cause of the error with structured details.
  
  Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled:
  
  { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } }
  
  This response indicates that the pubsub.googleapis.com API is not enabled.
  
  Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock:
  
  { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }
  
  Hide attributes Show attributes
  
  @type string
  
  Fully qualified protobuf type name of the underlying response, prefixed with type.googleapis.com/.
  
  Value is type.googleapis.com/google.rpc.ErrorInfo.
  
  domain string
  
  The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
  
  metadata object
  
  Additional structured details about this error.
  
  Keys must match a regular expression of [a-z][a-zA-Z0-9-_]+ but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
  
  Hide metadata attribute Show metadata attribute object
  
  * string Additional properties
  
  reason string
  
  The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of [A-Z][A-Z0-9_]+[A-Z0-9], which represents UPPER_SNAKE_CASE.
  
  Describes how a quota check failed.
  
  For example if a daily limit was exceeded for the calling project, a service could respond with a QuotaFailure detail containing the project id and the description of the quota limit that was exceeded. If the calling project hasn't enabled the service in the developer console, then a service could respond with the project id and set service_disabled to true.
  
  Also see RetryInfo and Help types for other details about handling a quota failure.
  
  Hide attributes Show attributes
  
  @type string
  
  Fully qualified protobuf type name of the underlying response, prefixed with type.googleapis.com/.
  
  Value is type.googleapis.com/google.rpc.QuotaFailure.
  
  violations array[object]
  
  Describes all quota violations.
  
  A message type used to describe a single quota violation. For example, a daily quota or a custom quota that was exceeded.
  
  Hide violations attributes Show violations attributes object
  
  api_service string
  
  The API Service from which the QuotaFailure.Violation orginates. In some cases, Quota issues originate from an API Service other than the one that was called. In other words, a dependency of the called API Service could be the cause of the QuotaFailure, and this field would have the dependency API service name.
  
  For example, if the called API is Kubernetes Engine API (container.googleapis.com), and a quota violation occurs in the Kubernetes Engine API itself, this field would be "container.googleapis.com". On the other hand, if the quota violation occurs when the Kubernetes Engine API creates VMs in the Compute Engine API (compute.googleapis.com), this field would be "compute.googleapis.com".
  
  description string
  
  A description of how the quota check failed. Clients can use this description to find more about the quota configuration in the service's public documentation, or find the relevant quota limit to adjust through developer console.
  
  For example: "Service disabled" or "Daily Limit for read operations exceeded".
  
  future_quota_value string(int64) | null
  
  The new quota value being rolled out at the time of the violation. At the completion of the rollout, this value will be enforced in place of quota_value. If no rollout is in progress at the time of the violation, this field is not set.
  
  For example, if at the time of the violation a rollout is in progress changing the number of CPUs quota from 10 to 20, 20 would be the value of this field.
  
  quota_dimensions object
  
  The dimensions of the violated quota. Every non-global quota is enforced on a set of dimensions. While quota metric defines what to count, the dimensions specify for what aspects the counter should be increased.
  
  For example, the quota "CPUs per region per VM family" enforces a limit on the metric "compute.googleapis.com/cpus_per_vm_family" on dimensions "region" and "vm_family". And if the violation occurred in region "us-central1" and for VM family "n1", the quota_dimensions would be,
  
  { "region": "us-central1", "vm_family": "n1", }
  
  When a quota is enforced globally, the quota_dimensions would always be empty.
  
  Hide quota_dimensions attribute Show quota_dimensions attribute object
  
  * string Additional properties
  
  quota_id string
  
  The id of the violated quota. Also know as "limit name", this is the unique identifier of a quota in the context of an API service.
  
  For example, "CPUS-PER-VM-FAMILY-per-project-region".
  
  quota_metric string
  
  The metric of the violated quota. A quota metric is a named counter to measure usage, such as API requests or CPUs. When an activity occurs in a service, such as Virtual Machine allocation, one or more quota metrics may be affected.
  
  For example, "compute.googleapis.com/cpus_per_vm_family", "storage.googleapis.com/internet_egress_bandwidth".
  
  quota_value string(int64)
  
  The enforced quota value at the time of the QuotaFailure.
  
  For example, if the enforced quota value at the time of the QuotaFailure on the number of CPUs is "10", then the value of this field would reflect this quantity.
  
  subject string
  
  The subject on which the quota check failed. For example, "clientip:" or "project:".
  
  Provides links to documentation or for performing an out of band action.
  
  For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.
  
  Hide attributes Show attributes
  
  @type string
  
  Fully qualified protobuf type name of the underlying response, prefixed with type.googleapis.com/.
  
  Value is type.googleapis.com/google.rpc.Help.
  
  links array[object]
  
  URL(s) pointing to additional information on handling the current error.
  
  Describes a URL link.
  
  Hide links attributes Show links attributes object
  
  description string
  
  Describes what the link offers.
  
  url string
  
  The URL of the link.
  
  message string
  
  Detailed error message. No compatibility guarantees are given for the text contained in this message.
  
  throughput_tier string
  
  Throughput tier of the cluster.
  
  type string
  
  Cluster type. Type is immutable and can only be set on cluster creation.
  
  Values are TYPE_DEDICATED or TYPE_BYOC.
  
  updated_at string(date-time)
  
  Cluster update timestamp.
  
  zones array[string]
  
  Zones of the cluster. Must be valid zones within the selected region. If multiple zones are used, the cluster is a multi-AZ cluster.
  
  CreateNetworkResponse is the request of CreateNetwork.
  
  Hide attributes Show attributes
  
  @type string
  
  Fully qualified protobuf type name of the underlying response, prefixed with type.googleapis.com/.
  
  Value is type.googleapis.com/redpanda.api.controlplane.v1.CreateNetworkResponse.
  
  network object
  
  Resource describing a Network.
  
  Hide network attributes Show network attributes object
  
  cidr_block string
  
  Network CIDR from where public and private subnets are derived. At least a 21 bits CIDR is required.
  
  cloud_provider string Required
  
  Cloud provider where resources are created.
  
  Values are CLOUD_PROVIDER_AWS, CLOUD_PROVIDER_GCP, or CLOUD_PROVIDER_AZURE.
  
  cluster_type string
  
  Cluster type. Type is immutable and can only be set on cluster creation.
  
  Values are TYPE_DEDICATED or TYPE_BYOC.
  
  created_at string(date-time)
  
  Network creation timestamp.
  
  customer_managed_resources object
  
  Cloud resources created by user.
  
  Hide customer_managed_resources attributes Show customer_managed_resources attributes object
  
  aws object
  
  The AWS resources managed by user.
  
  Hide aws attributes Show aws attributes object
  
  dynamodb_table object Required
  
  AWS DynamoDB table specification.
  
  Hide dynamodb_table attribute Show dynamodb_table attribute object
  
  arn string Required
  
  AWS DynamoDB table identifier.
  
  management_bucket object Required
  
  AWS storage bucket properties by ARN.
  
  Hide management_bucket attribute Show management_bucket attribute object
  
  arn string Required
  
  AWS storage bucket identifier.
  
  private_subnets object Required
  
  AWS Subnets Specification
  
  Hide private_subnets attribute Show private_subnets attribute object
  
  arns array[string] Required
  
  AWS subnet identifiers.
  
  vpc object Required
  
  AWS VPC Specification
  
  Hide vpc attribute Show vpc attribute object
  
  arn string Required
  
  AWS VPC identifier.
  
  azure object
  
  The Azure resources managed by user.
  
  Hide azure attributes Show azure attributes object
  
  management_bucket object Required
  
  Azure Bucket Specification
  
  Hide management_bucket attributes Show management_bucket attributes object
  
  resource_group object
  
  Azure Resource Group Specification
  
  Hide resource_group attribute Show resource_group attribute object
  
  name string Required
  
  storage_account_name string Required
  
  storage_container_name string Required
  
  subnets object Required
  
  Azure subnets used by Redpand cluster deployment.
  
  Hide subnets attributes Show subnets attributes object
  
  kafka_connect_pods object Required
  
  Azure subnet.
  
  Hide kafka_connect_pods attribute Show kafka_connect_pods attribute object
  
  name string Required
  
  kafka_connect_vnet object Required
  
  Azure subnet.
  
  Hide kafka_connect_vnet attribute Show kafka_connect_vnet attribute object
  
  name string Required
  
  rp_0_pods object Required
  
  Azure subnet.
  
  Hide rp_0_pods attribute Show rp_0_pods attribute object
  
  name string Required
  
  rp_0_vnet object Required
  
  Azure subnet.
  
  Hide rp_0_vnet attribute Show rp_0_vnet attribute object
  
  name string Required
  
  rp_1_pods object Required
  
  Azure subnet.
  
  Hide rp_1_pods attribute Show rp_1_pods attribute object
  
  name string Required
  
  rp_1_vnet object Required
  
  Azure subnet.
  
  Hide rp_1_vnet attribute Show rp_1_vnet attribute object
  
  name string Required
  
  rp_2_pods object Required
  
  Azure subnet.
  
  Hide rp_2_pods attribute Show rp_2_pods attribute object
  
  name string Required
  
  rp_2_vnet object Required
  
  Azure subnet.
  
  Hide rp_2_vnet attribute Show rp_2_vnet attribute object
  
  name string Required
  
  rp_agent object Required
  
  Azure subnet.
  
  Hide rp_agent attribute Show rp_agent attribute object
  
  name string Required
  
  rp_connect_pods object Required
  
  Azure subnet.
  
  Hide rp_connect_pods attribute Show rp_connect_pods attribute object
  
  name string Required
  
  rp_connect_vnet object Required
  
  Azure subnet.
  
  Hide rp_connect_vnet attribute Show rp_connect_vnet attribute object
  
  name string Required
  
  rp_egress_vnet object Required
  
  Azure subnet.
  
  Hide rp_egress_vnet attribute Show rp_egress_vnet attribute object
  
  name string Required
  
  sys_pods object Required
  
  Azure subnet.
  
  Hide sys_pods attribute Show sys_pods attribute object
  
  name string Required
  
  sys_vnet object Required
  
  Azure subnet.
  
  Hide sys_vnet attribute Show sys_vnet attribute object
  
  name string Required
  
  vnet object Required
  
  Azure VNET.
  
  Hide vnet attributes Show vnet attributes object
  
  name string Required
  
  resource_group object Required
  
  Azure Resource Group Specification
  
  Hide resource_group attribute Show resource_group attribute object
  
  name string Required
  
  gcp object
  
  GCP resources created and managed by user, and required to deploy the Redpanda cluster. See Create a BYOVPC Cluster on GCP for details.
  
  Hide gcp attributes Show gcp attributes object
  
  management_bucket object Required
  
  GCP storage bucket properties.
  
  Hide management_bucket attribute Show management_bucket attribute object
  
  name string Required
  
  Name of GCP storage bucket. See the official GCP documentation for naming restrictions.
  
  network_name string Required
  
  Name of user-created network where the Redpanda cluster is deployed to. See the official GCP API reference.
  
  network_project_id string Required
  
  GCP project ID where the network is created.
  
  id string
  
  Network ID. The ID is an output of the Create Network request and cannot be set by the caller.
  
  name string Required
  
  The unique name of the network.
  
  region string Required
  
  Region where network is placed.
  
  resource_group_id string Required
  
  Resource group ID of the network
  
  state string
  
  Values are STATE_CREATING, STATE_READY, STATE_DELETING, or STATE_FAILED.
  
  updated_at string(date-time)
  
  Network update timestamp.
  
  zones array[string]
  
  Network availability zones.
  
  started_at string(date-time)
  
  Timestamp when the operation has started.
  
  state string
  
  describes if the operation has finished, or is still in progress. Only if done is true, either error or result become available.
  
  Values are STATE_IN_PROGRESS, STATE_COMPLETED, or STATE_FAILED.
  
  type string
  
  Values are TYPE_CREATE_CLUSTER, TYPE_UPDATE_CLUSTER, TYPE_DELETE_CLUSTER, TYPE_CREATE_NETWORK, TYPE_DELETE_NETWORK, TYPE_CREATE_SERVERLESS_CLUSTER, TYPE_DELETE_SERVERLESS_CLUSTER, TYPE_CREATE_CLUSTER_WITH_DEPENDENCIES, TYPE_DELETE_CLUSTER_WITH_DEPENDENCIES, TYPE_CREATE_SERVERLESS_PRIVATE_LINK, TYPE_UPDATE_SERVERLESS_PRIVATE_LINK, TYPE_DELETE_SERVERLESS_PRIVATE_LINK, TYPE_CREATE_NETWORK_PEERING, TYPE_DELETE_NETWORK_PEERING, TYPE_CREATE_SHADOW_LINK, TYPE_UPDATE_SHADOW_LINK, or TYPE_DELETE_SHADOW_LINK.
400 application/json

Bad Request
Hide response attributes Show response attributes object
- code string(int32)
  
  RPC status code, as described here.
  
  Values are OK, CANCELLED, UNKNOWN, INVALID_ARGUMENT, DEADLINE_EXCEEDED, NOT_FOUND, ALREADY_EXISTS, PERMISSION_DENIED, UNAUTHENTICATED, RESOURCE_EXHAUSTED, FAILED_PRECONDITION, ABORTED, OUT_OF_RANGE, UNIMPLEMENTED, INTERNAL, UNAVAILABLE, or DATA_LOSS.
- details array[object]
  
  A list of messages that carries the error details.
  
  Details of the error.
  
  Details of the error.
  
  One of:
  BadRequest object ErrorInfo object QuotaFailure object Help object
  
  Describes violations in a client request. This error type focuses on the syntactic aspects of the request.
  
  Hide attributes Show attributes
  
  @type string
  
  Fully qualified protobuf type name of the underlying response, prefixed with type.googleapis.com/.
  
  Value is type.googleapis.com/google.rpc.BadRequest.
  
  field_violations array[object]
  
  Describes all violations in a client request.
  
  A message type used to describe a single bad request field.
  
  Hide field_violations attributes Show field_violations attributes object
  
  description string
  
  A description of why the request element is bad.
  
  field string
  
  A path that leads to a field in the request body. The value will be a sequence of dot-separated identifiers that identify a protocol buffer field.
  
  Consider the following:
  
  message CreateContactRequest { message EmailAddress { enum Type { TYPE_UNSPECIFIED = 0; HOME = 1; WORK = 2; }
  
  optional string email = 1; repeated EmailType type = 2; }
  
  string full_name = 1; repeated EmailAddress email_addresses = 2; }
  
  In this example, in proto field could take one of the following values:
  
  full_name for a violation in the full_name value
  
  email_addresses[1].email for a violation in the email field of the first email_addresses message
  
  email_addresses[3].type[2] for a violation in the second type value in the third email_addresses message.
  
  In JSON, the same values are represented as:
  
  fullName for a violation in the fullName value
  
  emailAddresses[1].email for a violation in the email field of the first emailAddresses message
  
  emailAddresses[3].type[2] for a violation in the second type value in the third emailAddresses message.
  
  localized_message object
  
  Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
  
  Hide localized_message attributes Show localized_message attributes object
  
  locale string
  
  message string
  
  The localized error message in the above locale.
  
  reason string
  
  The reason of the field-level error. This is a constant value that identifies the proximate cause of the field-level error. It should uniquely identify the type of the FieldViolation within the scope of the google.rpc.ErrorInfo.domain. This should be at most 63 characters and match a regular expression of [A-Z][A-Z0-9_]+[A-Z0-9], which represents UPPER_SNAKE_CASE.
  
  Describes the cause of the error with structured details.
  
  Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled:
  
  { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } }
  
  This response indicates that the pubsub.googleapis.com API is not enabled.
  
  Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock:
  
  { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }
  
  Hide attributes Show attributes
  
  @type string
  
  Fully qualified protobuf type name of the underlying response, prefixed with type.googleapis.com/.
  
  Value is type.googleapis.com/google.rpc.ErrorInfo.
  
  domain string
  
  The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
  
  metadata object
  
  Additional structured details about this error.
  
  Keys must match a regular expression of [a-z][a-zA-Z0-9-_]+ but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
  
  Hide metadata attribute Show metadata attribute object
  
  * string Additional properties
  
  reason string
  
  The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of [A-Z][A-Z0-9_]+[A-Z0-9], which represents UPPER_SNAKE_CASE.
  
  Describes how a quota check failed.
  
  For example if a daily limit was exceeded for the calling project, a service could respond with a QuotaFailure detail containing the project id and the description of the quota limit that was exceeded. If the calling project hasn't enabled the service in the developer console, then a service could respond with the project id and set service_disabled to true.
  
  Also see RetryInfo and Help types for other details about handling a quota failure.
  
  Hide attributes Show attributes
  
  @type string
  
  Fully qualified protobuf type name of the underlying response, prefixed with type.googleapis.com/.
  
  Value is type.googleapis.com/google.rpc.QuotaFailure.
  
  violations array[object]
  
  Describes all quota violations.
  
  A message type used to describe a single quota violation. For example, a daily quota or a custom quota that was exceeded.
  
  Hide violations attributes Show violations attributes object
  
  api_service string
  
  The API Service from which the QuotaFailure.Violation orginates. In some cases, Quota issues originate from an API Service other than the one that was called. In other words, a dependency of the called API Service could be the cause of the QuotaFailure, and this field would have the dependency API service name.
  
  For example, if the called API is Kubernetes Engine API (container.googleapis.com), and a quota violation occurs in the Kubernetes Engine API itself, this field would be "container.googleapis.com". On the other hand, if the quota violation occurs when the Kubernetes Engine API creates VMs in the Compute Engine API (compute.googleapis.com), this field would be "compute.googleapis.com".
  
  description string
  
  A description of how the quota check failed. Clients can use this description to find more about the quota configuration in the service's public documentation, or find the relevant quota limit to adjust through developer console.
  
  For example: "Service disabled" or "Daily Limit for read operations exceeded".
  
  future_quota_value string(int64) | null
  
  The new quota value being rolled out at the time of the violation. At the completion of the rollout, this value will be enforced in place of quota_value. If no rollout is in progress at the time of the violation, this field is not set.
  
  For example, if at the time of the violation a rollout is in progress changing the number of CPUs quota from 10 to 20, 20 would be the value of this field.
  
  quota_dimensions object
  
  The dimensions of the violated quota. Every non-global quota is enforced on a set of dimensions. While quota metric defines what to count, the dimensions specify for what aspects the counter should be increased.
  
  For example, the quota "CPUs per region per VM family" enforces a limit on the metric "compute.googleapis.com/cpus_per_vm_family" on dimensions "region" and "vm_family". And if the violation occurred in region "us-central1" and for VM family "n1", the quota_dimensions would be,
  
  { "region": "us-central1", "vm_family": "n1", }
  
  When a quota is enforced globally, the quota_dimensions would always be empty.
  
  Hide quota_dimensions attribute Show quota_dimensions attribute object
  
  * string Additional properties
  
  quota_id string
  
  The id of the violated quota. Also know as "limit name", this is the unique identifier of a quota in the context of an API service.
  
  For example, "CPUS-PER-VM-FAMILY-per-project-region".
  
  quota_metric string
  
  The metric of the violated quota. A quota metric is a named counter to measure usage, such as API requests or CPUs. When an activity occurs in a service, such as Virtual Machine allocation, one or more quota metrics may be affected.
  
  For example, "compute.googleapis.com/cpus_per_vm_family", "storage.googleapis.com/internet_egress_bandwidth".
  
  quota_value string(int64)
  
  The enforced quota value at the time of the QuotaFailure.
  
  For example, if the enforced quota value at the time of the QuotaFailure on the number of CPUs is "10", then the value of this field would reflect this quantity.
  
  subject string
  
  The subject on which the quota check failed. For example, "clientip:" or "project:".
  
  Provides links to documentation or for performing an out of band action.
  
  For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.
  
  Hide attributes Show attributes
  
  @type string
  
  Fully qualified protobuf type name of the underlying response, prefixed with type.googleapis.com/.
  
  Value is type.googleapis.com/google.rpc.Help.
  
  links array[object]
  
  URL(s) pointing to additional information on handling the current error.
  
  Describes a URL link.
  
  Hide links attributes Show links attributes object
  
  description string
  
  Describes what the link offers.
  
  url string
  
  The URL of the link.
- message string
  
  Detailed error message. No compatibility guarantees are given for the text contained in this message.
409 application/json

Conflict - Shadow link with given name already exists
Hide response attributes Show response attributes object
- code string(int32)
  
  RPC status code, as described here.
  
  Values are OK, CANCELLED, UNKNOWN, INVALID_ARGUMENT, DEADLINE_EXCEEDED, NOT_FOUND, ALREADY_EXISTS, PERMISSION_DENIED, UNAUTHENTICATED, RESOURCE_EXHAUSTED, FAILED_PRECONDITION, ABORTED, OUT_OF_RANGE, UNIMPLEMENTED, INTERNAL, UNAVAILABLE, or DATA_LOSS.
- details array[object]
  
  A list of messages that carries the error details.
  
  Details of the error.
  
  Details of the error.
  
  One of:
  BadRequest object ErrorInfo object QuotaFailure object Help object
  
  Describes violations in a client request. This error type focuses on the syntactic aspects of the request.
  
  Hide attributes Show attributes
  
  @type string
  
  Fully qualified protobuf type name of the underlying response, prefixed with type.googleapis.com/.
  
  Value is type.googleapis.com/google.rpc.BadRequest.
  
  field_violations array[object]
  
  Describes all violations in a client request.
  
  A message type used to describe a single bad request field.
  
  Hide field_violations attributes Show field_violations attributes object
  
  description string
  
  A description of why the request element is bad.
  
  field string
  
  A path that leads to a field in the request body. The value will be a sequence of dot-separated identifiers that identify a protocol buffer field.
  
  Consider the following:
  
  message CreateContactRequest { message EmailAddress { enum Type { TYPE_UNSPECIFIED = 0; HOME = 1; WORK = 2; }
  
  optional string email = 1; repeated EmailType type = 2; }
  
  string full_name = 1; repeated EmailAddress email_addresses = 2; }
  
  In this example, in proto field could take one of the following values:
  
  full_name for a violation in the full_name value
  
  email_addresses[1].email for a violation in the email field of the first email_addresses message
  
  email_addresses[3].type[2] for a violation in the second type value in the third email_addresses message.
  
  In JSON, the same values are represented as:
  
  fullName for a violation in the fullName value
  
  emailAddresses[1].email for a violation in the email field of the first emailAddresses message
  
  emailAddresses[3].type[2] for a violation in the second type value in the third emailAddresses message.
  
  localized_message object
  
  Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
  
  Hide localized_message attributes Show localized_message attributes object
  
  locale string
  
  message string
  
  The localized error message in the above locale.
  
  reason string
  
  The reason of the field-level error. This is a constant value that identifies the proximate cause of the field-level error. It should uniquely identify the type of the FieldViolation within the scope of the google.rpc.ErrorInfo.domain. This should be at most 63 characters and match a regular expression of [A-Z][A-Z0-9_]+[A-Z0-9], which represents UPPER_SNAKE_CASE.
  
  Describes the cause of the error with structured details.
  
  Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled:
  
  { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } }
  
  This response indicates that the pubsub.googleapis.com API is not enabled.
  
  Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock:
  
  { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }
  
  Hide attributes Show attributes
  
  @type string
  
  Fully qualified protobuf type name of the underlying response, prefixed with type.googleapis.com/.
  
  Value is type.googleapis.com/google.rpc.ErrorInfo.
  
  domain string
  
  The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
  
  metadata object
  
  Additional structured details about this error.
  
  Keys must match a regular expression of [a-z][a-zA-Z0-9-_]+ but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
  
  Hide metadata attribute Show metadata attribute object
  
  * string Additional properties
  
  reason string
  
  The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of [A-Z][A-Z0-9_]+[A-Z0-9], which represents UPPER_SNAKE_CASE.
  
  Describes how a quota check failed.
  
  For example if a daily limit was exceeded for the calling project, a service could respond with a QuotaFailure detail containing the project id and the description of the quota limit that was exceeded. If the calling project hasn't enabled the service in the developer console, then a service could respond with the project id and set service_disabled to true.
  
  Also see RetryInfo and Help types for other details about handling a quota failure.
  
  Hide attributes Show attributes
  
  @type string
  
  Fully qualified protobuf type name of the underlying response, prefixed with type.googleapis.com/.
  
  Value is type.googleapis.com/google.rpc.QuotaFailure.
  
  violations array[object]
  
  Describes all quota violations.
  
  A message type used to describe a single quota violation. For example, a daily quota or a custom quota that was exceeded.
  
  Hide violations attributes Show violations attributes object
  
  api_service string
  
  The API Service from which the QuotaFailure.Violation orginates. In some cases, Quota issues originate from an API Service other than the one that was called. In other words, a dependency of the called API Service could be the cause of the QuotaFailure, and this field would have the dependency API service name.
  
  For example, if the called API is Kubernetes Engine API (container.googleapis.com), and a quota violation occurs in the Kubernetes Engine API itself, this field would be "container.googleapis.com". On the other hand, if the quota violation occurs when the Kubernetes Engine API creates VMs in the Compute Engine API (compute.googleapis.com), this field would be "compute.googleapis.com".
  
  description string
  
  A description of how the quota check failed. Clients can use this description to find more about the quota configuration in the service's public documentation, or find the relevant quota limit to adjust through developer console.
  
  For example: "Service disabled" or "Daily Limit for read operations exceeded".
  
  future_quota_value string(int64) | null
  
  The new quota value being rolled out at the time of the violation. At the completion of the rollout, this value will be enforced in place of quota_value. If no rollout is in progress at the time of the violation, this field is not set.
  
  For example, if at the time of the violation a rollout is in progress changing the number of CPUs quota from 10 to 20, 20 would be the value of this field.
  
  quota_dimensions object
  
  The dimensions of the violated quota. Every non-global quota is enforced on a set of dimensions. While quota metric defines what to count, the dimensions specify for what aspects the counter should be increased.
  
  For example, the quota "CPUs per region per VM family" enforces a limit on the metric "compute.googleapis.com/cpus_per_vm_family" on dimensions "region" and "vm_family". And if the violation occurred in region "us-central1" and for VM family "n1", the quota_dimensions would be,
  
  { "region": "us-central1", "vm_family": "n1", }
  
  When a quota is enforced globally, the quota_dimensions would always be empty.
  
  Hide quota_dimensions attribute Show quota_dimensions attribute object
  
  * string Additional properties
  
  quota_id string
  
  The id of the violated quota. Also know as "limit name", this is the unique identifier of a quota in the context of an API service.
  
  For example, "CPUS-PER-VM-FAMILY-per-project-region".
  
  quota_metric string
  
  The metric of the violated quota. A quota metric is a named counter to measure usage, such as API requests or CPUs. When an activity occurs in a service, such as Virtual Machine allocation, one or more quota metrics may be affected.
  
  For example, "compute.googleapis.com/cpus_per_vm_family", "storage.googleapis.com/internet_egress_bandwidth".
  
  quota_value string(int64)
  
  The enforced quota value at the time of the QuotaFailure.
  
  For example, if the enforced quota value at the time of the QuotaFailure on the number of CPUs is "10", then the value of this field would reflect this quantity.
  
  subject string
  
  The subject on which the quota check failed. For example, "clientip:" or "project:".
  
  Provides links to documentation or for performing an out of band action.
  
  For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.
  
  Hide attributes Show attributes
  
  @type string
  
  Fully qualified protobuf type name of the underlying response, prefixed with type.googleapis.com/.
  
  Value is type.googleapis.com/google.rpc.Help.
  
  links array[object]
  
  URL(s) pointing to additional information on handling the current error.
  
  Describes a URL link.
  
  Hide links attributes Show links attributes object
  
  description string
  
  Describes what the link offers.
  
  url string
  
  The URL of the link.
- message string
  
  Detailed error message. No compatibility guarantees are given for the text contained in this message.
500 application/json

Internal Server Error. Please reach out to support.
Hide response attributes Show response attributes object
- code string(int32)
  
  RPC status code, as described here.
  
  Values are OK, CANCELLED, UNKNOWN, INVALID_ARGUMENT, DEADLINE_EXCEEDED, NOT_FOUND, ALREADY_EXISTS, PERMISSION_DENIED, UNAUTHENTICATED, RESOURCE_EXHAUSTED, FAILED_PRECONDITION, ABORTED, OUT_OF_RANGE, UNIMPLEMENTED, INTERNAL, UNAVAILABLE, or DATA_LOSS.
- details array[object]
  
  A list of messages that carries the error details.
  
  Details of the error.
  
  Details of the error.
  
  One of:
  BadRequest object ErrorInfo object QuotaFailure object Help object
  
  Describes violations in a client request. This error type focuses on the syntactic aspects of the request.
  
  Hide attributes Show attributes
  
  @type string
  
  Fully qualified protobuf type name of the underlying response, prefixed with type.googleapis.com/.
  
  Value is type.googleapis.com/google.rpc.BadRequest.
  
  field_violations array[object]
  
  Describes all violations in a client request.
  
  A message type used to describe a single bad request field.
  
  Hide field_violations attributes Show field_violations attributes object
  
  description string
  
  A description of why the request element is bad.
  
  field string
  
  A path that leads to a field in the request body. The value will be a sequence of dot-separated identifiers that identify a protocol buffer field.
  
  Consider the following:
  
  message CreateContactRequest { message EmailAddress { enum Type { TYPE_UNSPECIFIED = 0; HOME = 1; WORK = 2; }
  
  optional string email = 1; repeated EmailType type = 2; }
  
  string full_name = 1; repeated EmailAddress email_addresses = 2; }
  
  In this example, in proto field could take one of the following values:
  
  full_name for a violation in the full_name value
  
  email_addresses[1].email for a violation in the email field of the first email_addresses message
  
  email_addresses[3].type[2] for a violation in the second type value in the third email_addresses message.
  
  In JSON, the same values are represented as:
  
  fullName for a violation in the fullName value
  
  emailAddresses[1].email for a violation in the email field of the first emailAddresses message
  
  emailAddresses[3].type[2] for a violation in the second type value in the third emailAddresses message.
  
  localized_message object
  
  Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
  
  Hide localized_message attributes Show localized_message attributes object
  
  locale string
  
  message string
  
  The localized error message in the above locale.
  
  reason string
  
  The reason of the field-level error. This is a constant value that identifies the proximate cause of the field-level error. It should uniquely identify the type of the FieldViolation within the scope of the google.rpc.ErrorInfo.domain. This should be at most 63 characters and match a regular expression of [A-Z][A-Z0-9_]+[A-Z0-9], which represents UPPER_SNAKE_CASE.
  
  Describes the cause of the error with structured details.
  
  Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled:
  
  { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } }
  
  This response indicates that the pubsub.googleapis.com API is not enabled.
  
  Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock:
  
  { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }
  
  Hide attributes Show attributes
  
  @type string
  
  Fully qualified protobuf type name of the underlying response, prefixed with type.googleapis.com/.
  
  Value is type.googleapis.com/google.rpc.ErrorInfo.
  
  domain string
  
  The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
  
  metadata object
  
  Additional structured details about this error.
  
  Keys must match a regular expression of [a-z][a-zA-Z0-9-_]+ but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
  
  Hide metadata attribute Show metadata attribute object
  
  * string Additional properties
  
  reason string
  
  The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of [A-Z][A-Z0-9_]+[A-Z0-9], which represents UPPER_SNAKE_CASE.
  
  Describes how a quota check failed.
  
  For example if a daily limit was exceeded for the calling project, a service could respond with a QuotaFailure detail containing the project id and the description of the quota limit that was exceeded. If the calling project hasn't enabled the service in the developer console, then a service could respond with the project id and set service_disabled to true.
  
  Also see RetryInfo and Help types for other details about handling a quota failure.
  
  Hide attributes Show attributes
  
  @type string
  
  Fully qualified protobuf type name of the underlying response, prefixed with type.googleapis.com/.
  
  Value is type.googleapis.com/google.rpc.QuotaFailure.
  
  violations array[object]
  
  Describes all quota violations.
  
  A message type used to describe a single quota violation. For example, a daily quota or a custom quota that was exceeded.
  
  Hide violations attributes Show violations attributes object
  
  api_service string
  
  The API Service from which the QuotaFailure.Violation orginates. In some cases, Quota issues originate from an API Service other than the one that was called. In other words, a dependency of the called API Service could be the cause of the QuotaFailure, and this field would have the dependency API service name.
  
  For example, if the called API is Kubernetes Engine API (container.googleapis.com), and a quota violation occurs in the Kubernetes Engine API itself, this field would be "container.googleapis.com". On the other hand, if the quota violation occurs when the Kubernetes Engine API creates VMs in the Compute Engine API (compute.googleapis.com), this field would be "compute.googleapis.com".
  
  description string
  
  A description of how the quota check failed. Clients can use this description to find more about the quota configuration in the service's public documentation, or find the relevant quota limit to adjust through developer console.
  
  For example: "Service disabled" or "Daily Limit for read operations exceeded".
  
  future_quota_value string(int64) | null
  
  The new quota value being rolled out at the time of the violation. At the completion of the rollout, this value will be enforced in place of quota_value. If no rollout is in progress at the time of the violation, this field is not set.
  
  For example, if at the time of the violation a rollout is in progress changing the number of CPUs quota from 10 to 20, 20 would be the value of this field.
  
  quota_dimensions object
  
  The dimensions of the violated quota. Every non-global quota is enforced on a set of dimensions. While quota metric defines what to count, the dimensions specify for what aspects the counter should be increased.
  
  For example, the quota "CPUs per region per VM family" enforces a limit on the metric "compute.googleapis.com/cpus_per_vm_family" on dimensions "region" and "vm_family". And if the violation occurred in region "us-central1" and for VM family "n1", the quota_dimensions would be,
  
  { "region": "us-central1", "vm_family": "n1", }
  
  When a quota is enforced globally, the quota_dimensions would always be empty.
  
  Hide quota_dimensions attribute Show quota_dimensions attribute object
  
  * string Additional properties
  
  quota_id string
  
  The id of the violated quota. Also know as "limit name", this is the unique identifier of a quota in the context of an API service.
  
  For example, "CPUS-PER-VM-FAMILY-per-project-region".
  
  quota_metric string
  
  The metric of the violated quota. A quota metric is a named counter to measure usage, such as API requests or CPUs. When an activity occurs in a service, such as Virtual Machine allocation, one or more quota metrics may be affected.
  
  For example, "compute.googleapis.com/cpus_per_vm_family", "storage.googleapis.com/internet_egress_bandwidth".
  
  quota_value string(int64)
  
  The enforced quota value at the time of the QuotaFailure.
  
  For example, if the enforced quota value at the time of the QuotaFailure on the number of CPUs is "10", then the value of this field would reflect this quantity.
  
  subject string
  
  The subject on which the quota check failed. For example, "clientip:" or "project:".
  
  Provides links to documentation or for performing an out of band action.
  
  For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.
  
  Hide attributes Show attributes
  
  @type string
  
  Fully qualified protobuf type name of the underlying response, prefixed with type.googleapis.com/.
  
  Value is type.googleapis.com/google.rpc.Help.
  
  links array[object]
  
  URL(s) pointing to additional information on handling the current error.
  
  Describes a URL link.
  
  Hide links attributes Show links attributes object
  
  description string
  
  Describes what the link offers.
  
  url string
  
  The URL of the link.
- message string
  
  Detailed error message. No compatibility guarantees are given for the text contained in this message.
default application/json

An unexpected error response.
Hide response attributes Show response attributes object
- code string(int32)
  
  RPC status code, as described here.
  
  Values are OK, CANCELLED, UNKNOWN, INVALID_ARGUMENT, DEADLINE_EXCEEDED, NOT_FOUND, ALREADY_EXISTS, PERMISSION_DENIED, UNAUTHENTICATED, RESOURCE_EXHAUSTED, FAILED_PRECONDITION, ABORTED, OUT_OF_RANGE, UNIMPLEMENTED, INTERNAL, UNAVAILABLE, or DATA_LOSS.
- details array[object]
  
  A list of messages that carries the error details.
  
  Details of the error.
  
  Details of the error.
  
  One of:
  BadRequest object ErrorInfo object QuotaFailure object Help object
  
  Describes violations in a client request. This error type focuses on the syntactic aspects of the request.
  
  Hide attributes Show attributes
  
  @type string
  
  Fully qualified protobuf type name of the underlying response, prefixed with type.googleapis.com/.
  
  Value is type.googleapis.com/google.rpc.BadRequest.
  
  field_violations array[object]
  
  Describes all violations in a client request.
  
  A message type used to describe a single bad request field.
  
  Hide field_violations attributes Show field_violations attributes object
  
  description string
  
  A description of why the request element is bad.
  
  field string
  
  A path that leads to a field in the request body. The value will be a sequence of dot-separated identifiers that identify a protocol buffer field.
  
  Consider the following:
  
  message CreateContactRequest { message EmailAddress { enum Type { TYPE_UNSPECIFIED = 0; HOME = 1; WORK = 2; }
  
  optional string email = 1; repeated EmailType type = 2; }
  
  string full_name = 1; repeated EmailAddress email_addresses = 2; }
  
  In this example, in proto field could take one of the following values:
  
  full_name for a violation in the full_name value
  
  email_addresses[1].email for a violation in the email field of the first email_addresses message
  
  email_addresses[3].type[2] for a violation in the second type value in the third email_addresses message.
  
  In JSON, the same values are represented as:
  
  fullName for a violation in the fullName value
  
  emailAddresses[1].email for a violation in the email field of the first emailAddresses message
  
  emailAddresses[3].type[2] for a violation in the second type value in the third emailAddresses message.
  
  localized_message object
  
  Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
  
  Hide localized_message attributes Show localized_message attributes object
  
  locale string
  
  message string
  
  The localized error message in the above locale.
  
  reason string
  
  The reason of the field-level error. This is a constant value that identifies the proximate cause of the field-level error. It should uniquely identify the type of the FieldViolation within the scope of the google.rpc.ErrorInfo.domain. This should be at most 63 characters and match a regular expression of [A-Z][A-Z0-9_]+[A-Z0-9], which represents UPPER_SNAKE_CASE.
  
  Describes the cause of the error with structured details.
  
  Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled:
  
  { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } }
  
  This response indicates that the pubsub.googleapis.com API is not enabled.
  
  Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock:
  
  { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }
  
  Hide attributes Show attributes
  
  @type string
  
  Fully qualified protobuf type name of the underlying response, prefixed with type.googleapis.com/.
  
  Value is type.googleapis.com/google.rpc.ErrorInfo.
  
  domain string
  
  The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
  
  metadata object
  
  Additional structured details about this error.
  
  Keys must match a regular expression of [a-z][a-zA-Z0-9-_]+ but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
  
  Hide metadata attribute Show metadata attribute object
  
  * string Additional properties
  
  reason string
  
  The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of [A-Z][A-Z0-9_]+[A-Z0-9], which represents UPPER_SNAKE_CASE.
  
  Describes how a quota check failed.
  
  For example if a daily limit was exceeded for the calling project, a service could respond with a QuotaFailure detail containing the project id and the description of the quota limit that was exceeded. If the calling project hasn't enabled the service in the developer console, then a service could respond with the project id and set service_disabled to true.
  
  Also see RetryInfo and Help types for other details about handling a quota failure.
  
  Hide attributes Show attributes
  
  @type string
  
  Fully qualified protobuf type name of the underlying response, prefixed with type.googleapis.com/.
  
  Value is type.googleapis.com/google.rpc.QuotaFailure.
  
  violations array[object]
  
  Describes all quota violations.
  
  A message type used to describe a single quota violation. For example, a daily quota or a custom quota that was exceeded.
  
  Hide violations attributes Show violations attributes object
  
  api_service string
  
  The API Service from which the QuotaFailure.Violation orginates. In some cases, Quota issues originate from an API Service other than the one that was called. In other words, a dependency of the called API Service could be the cause of the QuotaFailure, and this field would have the dependency API service name.
  
  For example, if the called API is Kubernetes Engine API (container.googleapis.com), and a quota violation occurs in the Kubernetes Engine API itself, this field would be "container.googleapis.com". On the other hand, if the quota violation occurs when the Kubernetes Engine API creates VMs in the Compute Engine API (compute.googleapis.com), this field would be "compute.googleapis.com".
  
  description string
  
  A description of how the quota check failed. Clients can use this description to find more about the quota configuration in the service's public documentation, or find the relevant quota limit to adjust through developer console.
  
  For example: "Service disabled" or "Daily Limit for read operations exceeded".
  
  future_quota_value string(int64) | null
  
  The new quota value being rolled out at the time of the violation. At the completion of the rollout, this value will be enforced in place of quota_value. If no rollout is in progress at the time of the violation, this field is not set.
  
  For example, if at the time of the violation a rollout is in progress changing the number of CPUs quota from 10 to 20, 20 would be the value of this field.
  
  quota_dimensions object
  
  The dimensions of the violated quota. Every non-global quota is enforced on a set of dimensions. While quota metric defines what to count, the dimensions specify for what aspects the counter should be increased.
  
  For example, the quota "CPUs per region per VM family" enforces a limit on the metric "compute.googleapis.com/cpus_per_vm_family" on dimensions "region" and "vm_family". And if the violation occurred in region "us-central1" and for VM family "n1", the quota_dimensions would be,
  
  { "region": "us-central1", "vm_family": "n1", }
  
  When a quota is enforced globally, the quota_dimensions would always be empty.
  
  Hide quota_dimensions attribute Show quota_dimensions attribute object
  
  * string Additional properties
  
  quota_id string
  
  The id of the violated quota. Also know as "limit name", this is the unique identifier of a quota in the context of an API service.
  
  For example, "CPUS-PER-VM-FAMILY-per-project-region".
  
  quota_metric string
  
  The metric of the violated quota. A quota metric is a named counter to measure usage, such as API requests or CPUs. When an activity occurs in a service, such as Virtual Machine allocation, one or more quota metrics may be affected.
  
  For example, "compute.googleapis.com/cpus_per_vm_family", "storage.googleapis.com/internet_egress_bandwidth".
  
  quota_value string(int64)
  
  The enforced quota value at the time of the QuotaFailure.
  
  For example, if the enforced quota value at the time of the QuotaFailure on the number of CPUs is "10", then the value of this field would reflect this quantity.
  
  subject string
  
  The subject on which the quota check failed. For example, "clientip:" or "project:".
  
  Provides links to documentation or for performing an out of band action.
  
  For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.
  
  Hide attributes Show attributes
  
  @type string
  
  Fully qualified protobuf type name of the underlying response, prefixed with type.googleapis.com/.
  
  Value is type.googleapis.com/google.rpc.Help.
  
  links array[object]
  
  URL(s) pointing to additional information on handling the current error.
  
  Describes a URL link.
  
  Hide links attributes Show links attributes object
  
  description string
  
  Describes what the link offers.
  
  url string
  
  The URL of the link.
- message string
  
  Detailed error message. No compatibility guarantees are given for the text contained in this message.

POST /v1/shadow-links

curl \
 --request POST 'https://api.redpanda.com/v1/shadow-links' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"shadow_link":{"client_options":{"authentication_configuration":{"scram_configuration":{"password":"string","scram_mechanism":"SCRAM_MECHANISM_SCRAM_SHA_256","username":"string"}},"bootstrap_servers":["string"],"connection_timeout_ms":42,"fetch_max_bytes":42,"fetch_min_bytes":42,"fetch_partition_max_bytes":42,"fetch_wait_max_ms":42,"metadata_max_age_ms":42,"retry_backoff_ms":42,"source_cluster_id":"string","tls_settings":{"ca":"string","cert":"string","do_not_set_sni_hostname":true,"enabled":true,"key":"string"}},"consumer_offset_sync_options":{"group_filters":[{"filter_type":"FILTER_TYPE_INCLUDE","name":"string","pattern_type":"PATTERN_TYPE_LITERAL"}],"interval":"string","paused":true},"name":"string","schema_registry_sync_options":{"shadow_schema_registry_topic":{}},"security_sync_options":{"acl_filters":[{"access_filter":{"host":"string","operation":"ACL_OPERATION_ANY","permission_type":"ACL_PERMISSION_TYPE_ANY","principal":"string"},"resource_filter":{"name":"string","pattern_type":"ACL_PATTERN_ANY","resource_type":"ACL_RESOURCE_ANY"}}],"interval":"string","paused":true},"shadow_redpanda_id":"string","source_redpanda_id":"string","topic_metadata_sync_options":{"auto_create_shadow_topic_filters":[{"filter_type":"FILTER_TYPE_INCLUDE","name":"string","pattern_type":"PATTERN_TYPE_LITERAL"}],"exclude_default":true,"interval":"string","paused":true,"start_at_earliest":{},"start_at_latest":{},"start_at_timestamp":"2025-05-04T09:42:00Z","synced_shadow_topic_properties":["string"]}}}'

Request examples

{
  "shadow_link": {
    "client_options": {
      "authentication_configuration": {
        "scram_configuration": {
          "password": "string",
          "scram_mechanism": "SCRAM_MECHANISM_SCRAM_SHA_256",
          "username": "string"
        }
      },
      "bootstrap_servers": [
        "string"
      ],
      "connection_timeout_ms": 42,
      "fetch_max_bytes": 42,
      "fetch_min_bytes": 42,
      "fetch_partition_max_bytes": 42,
      "fetch_wait_max_ms": 42,
      "metadata_max_age_ms": 42,
      "retry_backoff_ms": 42,
      "source_cluster_id": "string",
      "tls_settings": {
        "ca": "string",
        "cert": "string",
        "do_not_set_sni_hostname": true,
        "enabled": true,
        "key": "string"
      }
    },
    "consumer_offset_sync_options": {
      "group_filters": [
        {
          "filter_type": "FILTER_TYPE_INCLUDE",
          "name": "string",
          "pattern_type": "PATTERN_TYPE_LITERAL"
        }
      ],
      "interval": "string",
      "paused": true
    },
    "name": "string",
    "schema_registry_sync_options": {
      "shadow_schema_registry_topic": {}
    },
    "security_sync_options": {
      "acl_filters": [
        {
          "access_filter": {
            "host": "string",
            "operation": "ACL_OPERATION_ANY",
            "permission_type": "ACL_PERMISSION_TYPE_ANY",
            "principal": "string"
          },
          "resource_filter": {
            "name": "string",
            "pattern_type": "ACL_PATTERN_ANY",
            "resource_type": "ACL_RESOURCE_ANY"
          }
        }
      ],
      "interval": "string",
      "paused": true
    },
    "shadow_redpanda_id": "string",
    "source_redpanda_id": "string",
    "topic_metadata_sync_options": {
      "auto_create_shadow_topic_filters": [
        {
          "filter_type": "FILTER_TYPE_INCLUDE",
          "name": "string",
          "pattern_type": "PATTERN_TYPE_LITERAL"
        }
      ],
      "exclude_default": true,
      "interval": "string",
      "paused": true,
      "start_at_earliest": {},
      "start_at_latest": {},
      "start_at_timestamp": "2025-05-04T09:42:00Z",
      "synced_shadow_topic_properties": [
        "string"
      ]
    }
  }
}

Response examples (202)

{
  "operation": {
    "error": {
      "code": "OK",
      "details": [
        {
          "@type": "type.googleapis.com/google.rpc.BadRequest",
          "field_violations": [
            {
              "description": "string",
              "field": "string",
              "localized_message": {
                "locale": "string",
                "message": "string"
              },
              "reason": "string"
            }
          ]
        }
      ],
      "message": "string"
    },
    "finished_at": "2025-05-04T09:42:00Z",
    "id": "string",
    "metadata": {
      "@type": "type.googleapis.com/redpanda.api.controlplane.v1.CreateNetworkMetadata",
      "network_id": "string"
    },
    "resource_id": "string",
    "response": {
      "@type": "type.googleapis.com/redpanda.api.controlplane.v1.CreateClusterResponse",
      "cluster": {
        "api_gateway_access": "NETWORK_ACCESS_MODE_PRIVATE",
        "aws_private_link": {
          "allowed_principals": [
            "arn:aws:iam::account-number-without-hyphens:user/username or arn:aws:iam::account-number-without-hyphens:root"
          ],
          "connect_console": true,
          "enabled": true,
          "http_proxy_auth_mode": "PRIVATE_LINK_AUTH_MODE_MATCH",
          "kafka_api_auth_mode": "PRIVATE_LINK_AUTH_MODE_MATCH",
          "schema_registry_auth_mode": "PRIVATE_LINK_AUTH_MODE_MATCH",
          "status": {
            "console_port": 42,
            "created_at": "2025-05-04T09:42:00Z",
            "deleted_at": "2025-05-04T09:42:00Z",
            "kafka_api_node_base_port": 42,
            "kafka_api_seed_port": 42,
            "redpanda_proxy_node_base_port": 42,
            "redpanda_proxy_seed_port": 42,
            "schema_registry_seed_port": 42,
            "service_id": "vpce-svc-05fff2117d648da35",
            "service_name": "com.amazonaws.vpce.us-west-2.vpce-svc-05fff2117d648da35",
            "service_state": "Pending | Available | Deleting | Deleted | Failed",
            "vpc_endpoint_connections": [
              {
                "connection_id": "vpce-con-00b9cba3360fe4aec",
                "created_at": "2025-05-04T09:42:00Z",
                "dns_entries": [
                  {
                    "dns_name": "vpce-0751b7ad8a51777f2-1hpievf5.vpce-svc-0d489fa89f24e3802.us-east-2.vpce.amazonaws.com",
                    "hosted_zone_id": "string"
                  }
                ],
                "id": "string",
                "load_balancer_arns": [
                  "string"
                ],
                "owner": "string",
                "state": "pendingAcceptance | pending | available | deleting | deleted | rejected | failed"
              }
            ]
          },
          "supported_regions": [
            "string"
          ]
        },
        "azure_private_link": {
          "allowed_subscriptions": [
            "4a73b02e-90c1-4d76-af36-5c935dd41e7c"
          ],
          "connect_console": true,
          "enabled": true,
          "http_proxy_auth_mode": "PRIVATE_LINK_AUTH_MODE_MATCH",
          "kafka_api_auth_mode": "PRIVATE_LINK_AUTH_MODE_MATCH",
          "schema_registry_auth_mode": "PRIVATE_LINK_AUTH_MODE_MATCH",
          "status": {
            "approved_subscriptions": [
              "string"
            ],
            "console_port": 42,
            "created_at": "2025-05-04T09:42:00Z",
            "deleted_at": "2025-05-04T09:42:00Z",
            "dns_a_record": "string",
            "kafka_api_node_base_port": 42,
            "kafka_api_seed_port": 42,
            "private_endpoint_connections": [
              {
                "connection_id": "string",
                "connection_name": "string",
                "created_at": "2025-05-04T09:42:00Z",
                "private_endpoint_id": "/subscriptions/<sub-id>/resourceGroups/<rg-id>/providers/Microsoft.Network/privateEndpoints/<name>",
                "private_endpoint_name": "string",
                "status": "Approved | Rejected"
              }
            ],
            "redpanda_proxy_node_base_port": 42,
            "redpanda_proxy_seed_port": 42,
            "schema_registry_seed_port": 42,
            "service_id": "/subscriptions/<sub-id>/resourceGroups/<rg-id>/providers/Microsoft.Network/privateLinkServices/<name>",
            "service_name": "pls-name"
          }
        },
        "cloud_provider": "CLOUD_PROVIDER_AWS",
        "cloud_provider_tags": {
          "additionalProperty1": "string",
          "additionalProperty2": "string"
        },
        "cloud_storage": {
          "aws": {
            "arn": "string"
          },
          "azure": {
            "allowed_ips": [
              "string"
            ],
            "allowed_subnet_ids": [
              "string"
            ],
            "container_name": "string",
            "resource_group_name": "string",
            "storage_account_name": "string",
            "subscription_id": "string"
          },
          "gcp": {
            "name": "string"
          },
          "skip_destroy": true
        },
        "cluster_configuration": {
          "computed_properties": {},
          "custom_properties": {}
        },
        "connection_type": "CONNECTION_TYPE_PUBLIC",
        "created_at": "2025-05-04T09:42:00Z",
        "current_redpanda_version": "string",
        "customer_managed_resources": {
          "aws": {
            "agent_instance_profile": {
              "arn": "string"
            },
            "cloud_storage_bucket": {
              "arn": "string"
            },
            "cluster_security_group": {
              "arn": "string"
            },
            "connectors_node_group_instance_profile": {
              "arn": "string"
            },
            "connectors_security_group": {
              "arn": "string"
            },
            "k8s_cluster_role": {
              "arn": "string"
            },
            "node_security_group": {
              "arn": "string"
            },
            "permissions_boundary_policy": {
              "arn": "string"
            },
            "redpanda_agent_security_group": {
              "arn": "string"
            },
            "redpanda_connect_node_group_instance_profile": {
              "arn": "string"
            },
            "redpanda_connect_security_group": {
              "arn": "string"
            },
            "redpanda_node_group_instance_profile": {
              "arn": "string"
            },
            "redpanda_node_group_security_group": {
              "arn": "string"
            },
            "utility_node_group_instance_profile": {
              "arn": "string"
            },
            "utility_security_group": {
              "arn": "string"
            }
          },
          "azure": {
            "cidrs": {
              "aks_service_cidr": "string"
            },
            "key_vaults": {
              "console_vault": {
                "name": "string"
              },
              "management_vault": {
                "name": "string"
              }
            },
            "resource_groups": {
              "iam_resource_group": {
                "name": "string"
              },
              "redpanda_resource_group": {
                "name": "string"
              },
              "storage_resource_group": {
                "name": "string"
              }
            },
            "security_groups": {
              "redpanda_security_group": {
                "name": "string"
              }
            },
            "tiered_cloud_storage": {
              "resource_group": {
                "name": "string"
              },
              "storage_account_name": "string",
              "storage_container_name": "string"
            },
            "user_assigned_identities": {
              "agent_user_assigned_identity": {
                "name": "string"
              },
              "aks_user_assigned_identity": {
                "name": "string"
              },
              "cert_manager_assigned_identity": {
                "name": "string"
              },
              "external_dns_assigned_identity": {
                "name": "string"
              },
              "kafka_connect_assigned_identity": {
                "name": "string"
              },
              "redpanda_cluster_assigned_identity": {
                "name": "string"
              },
              "redpanda_connect_api_assigned_identity": {
                "name": "string"
              },
              "redpanda_connect_assigned_identity": {
                "name": "string"
              },
              "redpanda_console_assigned_identity": {
                "name": "string"
              },
              "redpanda_operator_assigned_identity": {
                "name": "string"
              }
            }
          },
          "gcp": {
            "agent_service_account": {
              "email": "string"
            },
            "connector_service_account": {
              "email": "string"
            },
            "console_service_account": {
              "email": "string"
            },
            "gke_service_account": {
              "email": "string"
            },
            "psc_nat_subnet_name": "string",
            "psc_v2_nat_subnet_name": "string",
            "redpanda_cluster_service_account": {
              "email": "string"
            },
            "redpanda_connect_api_service_account": {
              "email": "string"
            },
            "redpanda_connect_service_account": {
              "email": "string"
            },
            "redpanda_operator_service_account": {
              "email": "string"
            },
            "subnet": {
              "k8s_master_ipv4_range": "string",
              "name": "string",
              "secondary_ipv4_range_pods": {
                "name": "string"
              },
              "secondary_ipv4_range_services": {
                "name": "string"
              }
            },
            "tiered_storage_bucket": {
              "name": "string"
            }
          }
        },
        "dataplane_api": {
          "url": "https://api-ab1234l0.cjb69h1c4vs42pca89s0.fmc.prd.cloud.redpanda.com"
        },
        "desired_redpanda_version": "string",
        "gcp_global_access_enabled": true,
        "gcp_private_service_connect": {
          "consumer_accept_list": [
            {
              "source": "gcp-project-1"
            }
          ],
          "enabled": true,
          "global_access_enabled": true,
          "http_proxy_auth_mode": "PRIVATE_LINK_AUTH_MODE_MATCH",
          "kafka_api_auth_mode": "PRIVATE_LINK_AUTH_MODE_MATCH",
          "schema_registry_auth_mode": "PRIVATE_LINK_AUTH_MODE_MATCH",
          "status": {
            "connected_endpoints": [
              {
                "connection_id": "string",
                "consumer_network": "string",
                "endpoint": "string",
                "status": "string"
              }
            ],
            "created_at": "2025-05-04T09:42:00Z",
            "deleted_at": "2025-05-04T09:42:00Z",
            "dns_a_records": [
              "string"
            ],
            "kafka_api_node_base_port": 42,
            "kafka_api_seed_port": 42,
            "redpanda_proxy_node_base_port": 42,
            "redpanda_proxy_seed_port": 42,
            "schema_registry_seed_port": 42,
            "seed_hostname": "string",
            "service_attachment": "string"
          }
        },
        "http_proxy": {
          "all_urls": {
            "mtls": "string",
            "private_link_mtls": "string",
            "private_link_sasl": "string",
            "sasl": "string"
          },
          "mtls": {
            "ca_certificates_pem": [
              "-----BEGIN CERTIFICATE-----\nMII........\n-----END CERTIFICATE-----"
            ],
            "enabled": true,
            "principal_mapping_rules": [
              "RULE:.*CN=([^,]+).*/$1/"
            ]
          },
          "sasl": {
            "enabled": true
          },
          "url": "https://pandaproxy-aa0000l0.cjb69h1c4vs42pca89s0.fmc.prd.cloud.redpanda.com:9092"
        },
        "id": "string",
        "kafka_api": {
          "all_seed_brokers": {
            "mtls": "string",
            "private_link_mtls": "string",
            "private_link_sasl": "string",
            "sasl": "string"
          },
          "mtls": {
            "ca_certificates_pem": [
              "-----BEGIN CERTIFICATE-----\nMII........\n-----END CERTIFICATE-----"
            ],
            "enabled": true,
            "principal_mapping_rules": [
              "RULE:.*CN=([^,]+).*/$1/"
            ]
          },
          "sasl": {
            "enabled": true
          },
          "seed_brokers": [
            "string"
          ]
        },
        "kafka_connect": {
          "enabled": true
        },
        "maintenance_window_config": {
          "anytime": {},
          "day_hour": {
            "day_of_week": "MONDAY",
            "hour_of_day": 42
          },
          "unspecified": {}
        },
        "name": "development-cluster",
        "nat_gateways": [
          "string"
        ],
        "network_id": "cjcuq79c4vs94fcufc2g",
        "prometheus": {
          "url": "https://console-aa0000l0.cjb69h1c4vs42pca89s0.fmc.prd.cloud.redpanda.com/api/cloud/prometheus/public_metrics"
        },
        "read_replica_cluster_ids": [
          "string"
        ],
        "redpanda_console": {
          "url": "https://console-aa0000l0.cjb69h1c4vs42pca89s0.fmc.prd.cloud.redpanda.com/api"
        },
        "redpanda_node_count": 42,
        "region": "us-central1",
        "resource_group_id": "a0b40af9-0250-48ca-9417-783ed127ce42",
        "schema_registry": {
          "all_urls": {
            "mtls": "string",
            "private_link_mtls": "string",
            "private_link_sasl": "string",
            "sasl": "string"
          },
          "mtls": {
            "ca_certificates_pem": [
              "-----BEGIN CERTIFICATE-----\nMII........\n-----END CERTIFICATE-----"
            ],
            "enabled": true,
            "principal_mapping_rules": [
              "RULE:.*CN=([^,]+).*/$1/"
            ]
          },
          "sasl": {
            "enabled": true
          },
          "url": "string"
        },
        "state": "STATE_CREATING_AGENT",
        "state_description": {
          "code": "OK",
          "details": [
            {
              "@type": "type.googleapis.com/google.rpc.BadRequest",
              "field_violations": [
                {
                  "description": "string",
                  "field": "string",
                  "localized_message": {
                    "locale": "string",
                    "message": "string"
                  },
                  "reason": "string"
                }
              ]
            }
          ],
          "message": "string"
        },
        "throughput_tier": "string",
        "type": "TYPE_DEDICATED",
        "updated_at": "2025-05-04T09:42:00Z",
        "zones": [
          "string"
        ]
      }
    },
    "started_at": "2025-05-04T09:42:00Z",
    "state": "STATE_IN_PROGRESS",
    "type": "TYPE_CREATE_CLUSTER"
  }
}

Response examples (400)

{
  "code": "OK",
  "details": [
    {
      "@type": "type.googleapis.com/google.rpc.BadRequest",
      "field_violations": [
        {
          "description": "string",
          "field": "string",
          "localized_message": {
            "locale": "string",
            "message": "string"
          },
          "reason": "string"
        }
      ]
    }
  ],
  "message": "string"
}

Response examples (409)

{
  "code": "OK",
  "details": [
    {
      "@type": "type.googleapis.com/google.rpc.BadRequest",
      "field_violations": [
        {
          "description": "string",
          "field": "string",
          "localized_message": {
            "locale": "string",
            "message": "string"
          },
          "reason": "string"
        }
      ]
    }
  ],
  "message": "string"
}

Response examples (500)

{
  "code": "OK",
  "details": [
    {
      "@type": "type.googleapis.com/google.rpc.BadRequest",
      "field_violations": [
        {
          "description": "string",
          "field": "string",
          "localized_message": {
            "locale": "string",
            "message": "string"
          },
          "reason": "string"
        }
      ]
    }
  ],
  "message": "string"
}

Response examples (default)

{
  "code": "OK",
  "details": [
    {
      "@type": "type.googleapis.com/google.rpc.BadRequest",
      "field_violations": [
        {
          "description": "string",
          "field": "string",
          "localized_message": {
            "locale": "string",
            "message": "string"
          },
          "reason": "string"
        }
      ]
    }
  ],
  "message": "string"
}

Create shadow link Run in API Explorer

Body Required

Responses

metadata object

response object