pulumi-confluentcloud 2.10.0a1731389320__py3-none-any.whl → 2.54.0a1766503424__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (134) hide show
  1. pulumi_confluentcloud/__init__.py +102 -1
  2. pulumi_confluentcloud/_inputs.py +4870 -2499
  3. pulumi_confluentcloud/_utilities.py +9 -5
  4. pulumi_confluentcloud/access_point.py +188 -33
  5. pulumi_confluentcloud/api_key.py +178 -144
  6. pulumi_confluentcloud/business_metadata.py +76 -73
  7. pulumi_confluentcloud/business_metadata_binding.py +101 -98
  8. pulumi_confluentcloud/byok_key.py +12 -11
  9. pulumi_confluentcloud/catalog_entity_attributes.py +133 -92
  10. pulumi_confluentcloud/catalog_integration.py +544 -0
  11. pulumi_confluentcloud/certificate_authority.py +158 -157
  12. pulumi_confluentcloud/certificate_pool.py +76 -75
  13. pulumi_confluentcloud/cluster_link.py +168 -91
  14. pulumi_confluentcloud/config/__init__.py +2 -1
  15. pulumi_confluentcloud/config/__init__.pyi +23 -2
  16. pulumi_confluentcloud/config/outputs.py +110 -0
  17. pulumi_confluentcloud/config/vars.py +50 -21
  18. pulumi_confluentcloud/connect_artifact.py +478 -0
  19. pulumi_confluentcloud/connector.py +399 -87
  20. pulumi_confluentcloud/custom_connector_plugin.py +142 -141
  21. pulumi_confluentcloud/custom_connector_plugin_version.py +614 -0
  22. pulumi_confluentcloud/dns_forwarder.py +136 -45
  23. pulumi_confluentcloud/dns_record.py +46 -45
  24. pulumi_confluentcloud/environment.py +74 -73
  25. pulumi_confluentcloud/flink_artifact.py +254 -198
  26. pulumi_confluentcloud/flink_compute_pool.py +101 -100
  27. pulumi_confluentcloud/flink_connection.py +935 -0
  28. pulumi_confluentcloud/flink_statement.py +218 -124
  29. pulumi_confluentcloud/gateway.py +88 -28
  30. pulumi_confluentcloud/get_access_point.py +51 -17
  31. pulumi_confluentcloud/get_business_metadata.py +27 -25
  32. pulumi_confluentcloud/get_business_metadata_binding.py +36 -34
  33. pulumi_confluentcloud/get_byok_key.py +13 -13
  34. pulumi_confluentcloud/get_catalog_integration.py +248 -0
  35. pulumi_confluentcloud/get_certificate_authority.py +42 -42
  36. pulumi_confluentcloud/get_certificate_pool.py +21 -21
  37. pulumi_confluentcloud/get_cluster_link.py +274 -0
  38. pulumi_confluentcloud/get_connect_artifact.py +191 -0
  39. pulumi_confluentcloud/get_dns_record.py +17 -17
  40. pulumi_confluentcloud/get_environment.py +19 -19
  41. pulumi_confluentcloud/get_environments.py +8 -8
  42. pulumi_confluentcloud/get_flink_artifact.py +61 -43
  43. pulumi_confluentcloud/get_flink_compute_pool.py +29 -29
  44. pulumi_confluentcloud/get_flink_connection.py +267 -0
  45. pulumi_confluentcloud/get_flink_region.py +26 -26
  46. pulumi_confluentcloud/get_gateway.py +60 -18
  47. pulumi_confluentcloud/get_group_mapping.py +20 -20
  48. pulumi_confluentcloud/get_identity_pool.py +23 -23
  49. pulumi_confluentcloud/get_identity_provider.py +37 -23
  50. pulumi_confluentcloud/get_invitation.py +22 -22
  51. pulumi_confluentcloud/get_ip_addresses.py +8 -8
  52. pulumi_confluentcloud/get_ip_filter.py +175 -0
  53. pulumi_confluentcloud/get_ip_group.py +133 -0
  54. pulumi_confluentcloud/get_kafka_client_quota.py +19 -19
  55. pulumi_confluentcloud/get_kafka_cluster.py +57 -43
  56. pulumi_confluentcloud/get_kafka_clusters.py +136 -0
  57. pulumi_confluentcloud/get_kafka_topic.py +24 -24
  58. pulumi_confluentcloud/get_ksql_cluster.py +35 -35
  59. pulumi_confluentcloud/get_network.py +56 -42
  60. pulumi_confluentcloud/get_network_link_endpoint.py +19 -19
  61. pulumi_confluentcloud/get_network_link_service.py +25 -19
  62. pulumi_confluentcloud/get_organization.py +8 -8
  63. pulumi_confluentcloud/get_peering.py +21 -21
  64. pulumi_confluentcloud/get_private_link_access.py +21 -21
  65. pulumi_confluentcloud/get_private_link_attachment.py +31 -29
  66. pulumi_confluentcloud/get_private_link_attachment_connection.py +26 -23
  67. pulumi_confluentcloud/get_provider_integration.py +30 -20
  68. pulumi_confluentcloud/get_provider_integration_authorization.py +142 -0
  69. pulumi_confluentcloud/get_provider_integration_setup.py +270 -0
  70. pulumi_confluentcloud/get_role_binding.py +16 -16
  71. pulumi_confluentcloud/get_schema.py +42 -42
  72. pulumi_confluentcloud/get_schema_registry_cluster.py +53 -38
  73. pulumi_confluentcloud/get_schema_registry_cluster_config.py +31 -17
  74. pulumi_confluentcloud/get_schema_registry_cluster_mode.py +16 -16
  75. pulumi_confluentcloud/get_schema_registry_clusters.py +8 -8
  76. pulumi_confluentcloud/get_schema_registry_dek.py +44 -44
  77. pulumi_confluentcloud/get_schema_registry_kek.py +32 -32
  78. pulumi_confluentcloud/get_schemas.py +16 -16
  79. pulumi_confluentcloud/get_service_account.py +22 -22
  80. pulumi_confluentcloud/get_subject_config.py +37 -23
  81. pulumi_confluentcloud/get_subject_mode.py +22 -22
  82. pulumi_confluentcloud/get_tableflow_topic.py +374 -0
  83. pulumi_confluentcloud/get_tag.py +28 -26
  84. pulumi_confluentcloud/get_tag_binding.py +34 -32
  85. pulumi_confluentcloud/get_transit_gateway_attachment.py +19 -19
  86. pulumi_confluentcloud/get_user.py +26 -26
  87. pulumi_confluentcloud/get_users.py +8 -8
  88. pulumi_confluentcloud/group_mapping.py +54 -53
  89. pulumi_confluentcloud/identity_pool.py +74 -73
  90. pulumi_confluentcloud/identity_provider.py +138 -76
  91. pulumi_confluentcloud/invitation.py +81 -80
  92. pulumi_confluentcloud/ip_filter.py +420 -0
  93. pulumi_confluentcloud/ip_group.py +264 -0
  94. pulumi_confluentcloud/kafka_acl.py +173 -172
  95. pulumi_confluentcloud/kafka_client_quota.py +63 -62
  96. pulumi_confluentcloud/kafka_cluster.py +227 -207
  97. pulumi_confluentcloud/kafka_cluster_config.py +43 -42
  98. pulumi_confluentcloud/kafka_mirror_topic.py +46 -45
  99. pulumi_confluentcloud/kafka_topic.py +132 -131
  100. pulumi_confluentcloud/ksql_cluster.py +117 -120
  101. pulumi_confluentcloud/network.py +235 -198
  102. pulumi_confluentcloud/network_link_endpoint.py +62 -68
  103. pulumi_confluentcloud/network_link_service.py +62 -68
  104. pulumi_confluentcloud/outputs.py +4735 -2224
  105. pulumi_confluentcloud/peering.py +128 -48
  106. pulumi_confluentcloud/plugin.py +428 -0
  107. pulumi_confluentcloud/private_link_access.py +54 -60
  108. pulumi_confluentcloud/private_link_attachment.py +93 -88
  109. pulumi_confluentcloud/private_link_attachment_connection.py +70 -47
  110. pulumi_confluentcloud/provider.py +318 -192
  111. pulumi_confluentcloud/provider_integration.py +45 -34
  112. pulumi_confluentcloud/provider_integration_authorization.py +320 -0
  113. pulumi_confluentcloud/provider_integration_setup.py +448 -0
  114. pulumi_confluentcloud/pulumi-plugin.json +1 -1
  115. pulumi_confluentcloud/role_binding.py +153 -56
  116. pulumi_confluentcloud/schema.py +416 -212
  117. pulumi_confluentcloud/schema_exporter.py +217 -164
  118. pulumi_confluentcloud/schema_registry_cluster_config.py +96 -44
  119. pulumi_confluentcloud/schema_registry_cluster_mode.py +90 -42
  120. pulumi_confluentcloud/schema_registry_dek.py +140 -146
  121. pulumi_confluentcloud/schema_registry_kek.py +148 -154
  122. pulumi_confluentcloud/service_account.py +97 -96
  123. pulumi_confluentcloud/subject_config.py +142 -62
  124. pulumi_confluentcloud/subject_mode.py +107 -59
  125. pulumi_confluentcloud/tableflow_topic.py +883 -0
  126. pulumi_confluentcloud/tag.py +82 -79
  127. pulumi_confluentcloud/tag_binding.py +121 -84
  128. pulumi_confluentcloud/tf_importer.py +39 -36
  129. pulumi_confluentcloud/transit_gateway_attachment.py +38 -44
  130. {pulumi_confluentcloud-2.10.0a1731389320.dist-info → pulumi_confluentcloud-2.54.0a1766503424.dist-info}/METADATA +7 -7
  131. pulumi_confluentcloud-2.54.0a1766503424.dist-info/RECORD +134 -0
  132. {pulumi_confluentcloud-2.10.0a1731389320.dist-info → pulumi_confluentcloud-2.54.0a1766503424.dist-info}/WHEEL +1 -1
  133. pulumi_confluentcloud-2.10.0a1731389320.dist-info/RECORD +0 -113
  134. {pulumi_confluentcloud-2.10.0a1731389320.dist-info → pulumi_confluentcloud-2.54.0a1766503424.dist-info}/top_level.txt +0 -0
pulumi_confluentcloud/schema.py CHANGED
@@ -1,8 +1,8 @@
1
1
  # coding=utf-8
2
- # *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
2
+ # *** WARNING: this file was generated by pulumi-language-python. ***
3
3
  # *** Do not edit by hand unless you're certain you know what you are doing! ***
4
4
 
5
- import copy
5
+ import builtins as _builtins
6
6
  import warnings
7
7
  import sys
8
8
  import pulumi
@@ -21,31 +21,30 @@ __all__ = ['SchemaArgs', 'Schema']
21
21
  @pulumi.input_type
22
22
  class SchemaArgs:
23
23
  def __init__(__self__, *,
24
- format: pulumi.Input[str],
25
- subject_name: pulumi.Input[str],
24
+ format: pulumi.Input[_builtins.str],
25
+ subject_name: pulumi.Input[_builtins.str],
26
26
  credentials: Optional[pulumi.Input['SchemaCredentialsArgs']] = None,
27
- hard_delete: Optional[pulumi.Input[bool]] = None,
27
+ hard_delete: Optional[pulumi.Input[_builtins.bool]] = None,
28
28
  metadata: Optional[pulumi.Input['SchemaMetadataArgs']] = None,
29
- recreate_on_update: Optional[pulumi.Input[bool]] = None,
30
- rest_endpoint: Optional[pulumi.Input[str]] = None,
29
+ recreate_on_update: Optional[pulumi.Input[_builtins.bool]] = None,
30
+ rest_endpoint: Optional[pulumi.Input[_builtins.str]] = None,
31
31
  ruleset: Optional[pulumi.Input['SchemaRulesetArgs']] = None,
32
- schema: Optional[pulumi.Input[str]] = None,
32
+ schema: Optional[pulumi.Input[_builtins.str]] = None,
33
33
  schema_references: Optional[pulumi.Input[Sequence[pulumi.Input['SchemaSchemaReferenceArgs']]]] = None,
34
34
  schema_registry_cluster: Optional[pulumi.Input['SchemaSchemaRegistryClusterArgs']] = None,
35
- skip_validation_during_plan: Optional[pulumi.Input[bool]] = None):
35
+ skip_validation_during_plan: Optional[pulumi.Input[_builtins.bool]] = None):
36
36
  """
37
37
  The set of arguments for constructing a Schema resource.
38
- :param pulumi.Input[str] format: The format of the schema. Accepted values are: `AVRO`, `PROTOBUF`, and `JSON`.
39
- :param pulumi.Input[str] subject_name: The name of the subject (in other words, the namespace), representing the subject under which the schema will be registered, for example, `test-subject`. Schemas evolve safely, following a compatibility mode defined, under a subject name.
38
+ :param pulumi.Input[_builtins.str] format: The format of the Schema.
39
+ :param pulumi.Input[_builtins.str] subject_name: The name of the subject (in other words, the namespace), representing the subject under which the schema will be registered, for example, `test-subject`. Schemas evolve safely, following a compatibility mode defined, under a subject name.
40
40
  :param pulumi.Input['SchemaCredentialsArgs'] credentials: The Cluster API Credentials.
41
- :param pulumi.Input[bool] hard_delete: An optional flag to control whether a schema should be soft or hard deleted. Set it to `true` if you want to hard delete a schema on destroy (see [Schema Deletion Guidelines](https://docs.confluent.io/platform/current/schema-registry/schema-deletion-guidelines.html#schema-deletion-guidelines) for more details). Must be unset when importing. Defaults to `false` (soft delete).
42
- :param pulumi.Input['SchemaMetadataArgs'] metadata: See [here](https://docs.confluent.io/platform/7.5/schema-registry/fundamentals/data-contracts.html) for more details. Supports the following:
43
- :param pulumi.Input[bool] recreate_on_update: An optional flag to control whether a schema should be recreated on an update. Set it to `true` if you want to manage different schema versions using different resource instances. Must be set to the target value when importing. Defaults to `false`, which manages the latest schema version only. The resource instance always points to the latest schema version by supporting in-place updates.
44
- :param pulumi.Input[str] rest_endpoint: The REST endpoint of the Schema Registry cluster, for example, `https://psrc-00000.us-central1.gcp.confluent.cloud:443`).
45
- :param pulumi.Input['SchemaRulesetArgs'] ruleset: The list of schema rules. See [Data Contracts for Schema Registry](https://docs.confluent.io/platform/7.5/schema-registry/fundamentals/data-contracts.html#rules) for more details. For example, these rules can enforce that a field that contains sensitive information must be encrypted, or that a message containing an invalid age must be sent to a dead letter queue.
46
- :param pulumi.Input[str] schema: The schema string, for example, `file("./schema_version_1.avsc")`.
47
- :param pulumi.Input[Sequence[pulumi.Input['SchemaSchemaReferenceArgs']]] schema_references: The list of referenced schemas (see [Schema References](https://docs.confluent.io/platform/current/schema-registry/serdes-develop/index.html#schema-references) for more details):
48
- :param pulumi.Input[bool] skip_validation_during_plan: An optional flag to control whether a schema should be validated during `pulumi preview`. Set it to `true` if you want to skip schema validation during `pulumi preview`. Defaults to `false`. Regardless of `true` or `false` for this flag, schema validation will be performed during `pulumi up`.
41
+ :param pulumi.Input[_builtins.bool] hard_delete: Controls whether a schema should be soft or hard deleted. Set it to `true` if you want to hard delete a schema on destroy. Defaults to `false` (soft delete).
42
+ :param pulumi.Input[_builtins.bool] recreate_on_update: Controls whether a schema should be recreated on update.
43
+ :param pulumi.Input[_builtins.str] rest_endpoint: The REST endpoint of the Schema Registry cluster. For example, for public networking: `https://psrc-00000.us-central1.gcp.confluent.cloud`. In the case of private networking, the endpoint might look like `https://lsrc-abc123.pr1jy6.us-east-2.aws.confluent.cloud`. You can construct it using either:
44
+ - `data.confluent_schema_registry_cluster.essentials.private_regional_rest_endpoints["us-east-2"]`, or
45
+ - `https://${data.confluent_schema_registry_cluster.essentials.id}${data.confluent_network.main.endpoint_suffix}`
46
+ :param pulumi.Input[_builtins.str] schema: The definition of the Schema.
47
+ :param pulumi.Input[Sequence[pulumi.Input['SchemaSchemaReferenceArgs']]] schema_references: The list of references to other Schemas.
49
48
  """
50
49
  pulumi.set(__self__, "format", format)
51
50
  pulumi.set(__self__, "subject_name", subject_name)
@@ -70,31 +69,31 @@ class SchemaArgs:
70
69
  if skip_validation_during_plan is not None:
71
70
  pulumi.set(__self__, "skip_validation_during_plan", skip_validation_during_plan)
72
71
 
73
- @property
72
+ @_builtins.property
74
73
  @pulumi.getter
75
- def format(self) -> pulumi.Input[str]:
74
+ def format(self) -> pulumi.Input[_builtins.str]:
76
75
  """
77
- The format of the schema. Accepted values are: `AVRO`, `PROTOBUF`, and `JSON`.
76
+ The format of the Schema.
78
77
  """
79
78
  return pulumi.get(self, "format")
80
79
 
81
80
  @format.setter
82
- def format(self, value: pulumi.Input[str]):
81
+ def format(self, value: pulumi.Input[_builtins.str]):
83
82
  pulumi.set(self, "format", value)
84
83
 
85
- @property
84
+ @_builtins.property
86
85
  @pulumi.getter(name="subjectName")
87
- def subject_name(self) -> pulumi.Input[str]:
86
+ def subject_name(self) -> pulumi.Input[_builtins.str]:
88
87
  """
89
88
  The name of the subject (in other words, the namespace), representing the subject under which the schema will be registered, for example, `test-subject`. Schemas evolve safely, following a compatibility mode defined, under a subject name.
90
89
  """
91
90
  return pulumi.get(self, "subject_name")
92
91
 
93
92
  @subject_name.setter
94
- def subject_name(self, value: pulumi.Input[str]):
93
+ def subject_name(self, value: pulumi.Input[_builtins.str]):
95
94
  pulumi.set(self, "subject_name", value)
96
95
 
97
- @property
96
+ @_builtins.property
98
97
  @pulumi.getter
99
98
  def credentials(self) -> Optional[pulumi.Input['SchemaCredentialsArgs']]:
100
99
  """
@@ -106,83 +105,79 @@ class SchemaArgs:
106
105
  def credentials(self, value: Optional[pulumi.Input['SchemaCredentialsArgs']]):
107
106
  pulumi.set(self, "credentials", value)
108
107
 
109
- @property
108
+ @_builtins.property
110
109
  @pulumi.getter(name="hardDelete")
111
- def hard_delete(self) -> Optional[pulumi.Input[bool]]:
110
+ def hard_delete(self) -> Optional[pulumi.Input[_builtins.bool]]:
112
111
  """
113
- An optional flag to control whether a schema should be soft or hard deleted. Set it to `true` if you want to hard delete a schema on destroy (see [Schema Deletion Guidelines](https://docs.confluent.io/platform/current/schema-registry/schema-deletion-guidelines.html#schema-deletion-guidelines) for more details). Must be unset when importing. Defaults to `false` (soft delete).
112
+ Controls whether a schema should be soft or hard deleted. Set it to `true` if you want to hard delete a schema on destroy. Defaults to `false` (soft delete).
114
113
  """
115
114
  return pulumi.get(self, "hard_delete")
116
115
 
117
116
  @hard_delete.setter
118
- def hard_delete(self, value: Optional[pulumi.Input[bool]]):
117
+ def hard_delete(self, value: Optional[pulumi.Input[_builtins.bool]]):
119
118
  pulumi.set(self, "hard_delete", value)
120
119
 
121
- @property
120
+ @_builtins.property
122
121
  @pulumi.getter
123
122
  def metadata(self) -> Optional[pulumi.Input['SchemaMetadataArgs']]:
124
- """
125
- See [here](https://docs.confluent.io/platform/7.5/schema-registry/fundamentals/data-contracts.html) for more details. Supports the following:
126
- """
127
123
  return pulumi.get(self, "metadata")
128
124
 
129
125
  @metadata.setter
130
126
  def metadata(self, value: Optional[pulumi.Input['SchemaMetadataArgs']]):
131
127
  pulumi.set(self, "metadata", value)
132
128
 
133
- @property
129
+ @_builtins.property
134
130
  @pulumi.getter(name="recreateOnUpdate")
135
- def recreate_on_update(self) -> Optional[pulumi.Input[bool]]:
131
+ def recreate_on_update(self) -> Optional[pulumi.Input[_builtins.bool]]:
136
132
  """
137
- An optional flag to control whether a schema should be recreated on an update. Set it to `true` if you want to manage different schema versions using different resource instances. Must be set to the target value when importing. Defaults to `false`, which manages the latest schema version only. The resource instance always points to the latest schema version by supporting in-place updates.
133
+ Controls whether a schema should be recreated on update.
138
134
  """
139
135
  return pulumi.get(self, "recreate_on_update")
140
136
 
141
137
  @recreate_on_update.setter
142
- def recreate_on_update(self, value: Optional[pulumi.Input[bool]]):
138
+ def recreate_on_update(self, value: Optional[pulumi.Input[_builtins.bool]]):
143
139
  pulumi.set(self, "recreate_on_update", value)
144
140
 
145
- @property
141
+ @_builtins.property
146
142
  @pulumi.getter(name="restEndpoint")
147
- def rest_endpoint(self) -> Optional[pulumi.Input[str]]:
143
+ def rest_endpoint(self) -> Optional[pulumi.Input[_builtins.str]]:
148
144
  """
149
- The REST endpoint of the Schema Registry cluster, for example, `https://psrc-00000.us-central1.gcp.confluent.cloud:443`).
145
+ The REST endpoint of the Schema Registry cluster. For example, for public networking: `https://psrc-00000.us-central1.gcp.confluent.cloud`. In the case of private networking, the endpoint might look like `https://lsrc-abc123.pr1jy6.us-east-2.aws.confluent.cloud`. You can construct it using either:
146
+ - `data.confluent_schema_registry_cluster.essentials.private_regional_rest_endpoints["us-east-2"]`, or
147
+ - `https://${data.confluent_schema_registry_cluster.essentials.id}${data.confluent_network.main.endpoint_suffix}`
150
148
  """
151
149
  return pulumi.get(self, "rest_endpoint")
152
150
 
153
151
  @rest_endpoint.setter
154
- def rest_endpoint(self, value: Optional[pulumi.Input[str]]):
152
+ def rest_endpoint(self, value: Optional[pulumi.Input[_builtins.str]]):
155
153
  pulumi.set(self, "rest_endpoint", value)
156
154
 
157
- @property
155
+ @_builtins.property
158
156
  @pulumi.getter
159
157
  def ruleset(self) -> Optional[pulumi.Input['SchemaRulesetArgs']]:
160
- """
161
- The list of schema rules. See [Data Contracts for Schema Registry](https://docs.confluent.io/platform/7.5/schema-registry/fundamentals/data-contracts.html#rules) for more details. For example, these rules can enforce that a field that contains sensitive information must be encrypted, or that a message containing an invalid age must be sent to a dead letter queue.
162
- """
163
158
  return pulumi.get(self, "ruleset")
164
159
 
165
160
  @ruleset.setter
166
161
  def ruleset(self, value: Optional[pulumi.Input['SchemaRulesetArgs']]):
167
162
  pulumi.set(self, "ruleset", value)
168
163
 
169
- @property
164
+ @_builtins.property
170
165
  @pulumi.getter
171
- def schema(self) -> Optional[pulumi.Input[str]]:
166
+ def schema(self) -> Optional[pulumi.Input[_builtins.str]]:
172
167
  """
173
- The schema string, for example, `file("./schema_version_1.avsc")`.
168
+ The definition of the Schema.
174
169
  """
175
170
  return pulumi.get(self, "schema")
176
171
 
177
172
  @schema.setter
178
- def schema(self, value: Optional[pulumi.Input[str]]):
173
+ def schema(self, value: Optional[pulumi.Input[_builtins.str]]):
179
174
  pulumi.set(self, "schema", value)
180
175
 
181
- @property
176
+ @_builtins.property
182
177
  @pulumi.getter(name="schemaReferences")
183
178
  def schema_references(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['SchemaSchemaReferenceArgs']]]]:
184
179
  """
185
- The list of referenced schemas (see [Schema References](https://docs.confluent.io/platform/current/schema-registry/serdes-develop/index.html#schema-references) for more details):
180
+ The list of references to other Schemas.
186
181
  """
187
182
  return pulumi.get(self, "schema_references")
188
183
 
@@ -190,7 +185,7 @@ class SchemaArgs:
190
185
  def schema_references(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['SchemaSchemaReferenceArgs']]]]):
191
186
  pulumi.set(self, "schema_references", value)
192
187
 
193
- @property
188
+ @_builtins.property
194
189
  @pulumi.getter(name="schemaRegistryCluster")
195
190
  def schema_registry_cluster(self) -> Optional[pulumi.Input['SchemaSchemaRegistryClusterArgs']]:
196
191
  return pulumi.get(self, "schema_registry_cluster")
@@ -199,16 +194,13 @@ class SchemaArgs:
199
194
  def schema_registry_cluster(self, value: Optional[pulumi.Input['SchemaSchemaRegistryClusterArgs']]):
200
195
  pulumi.set(self, "schema_registry_cluster", value)
201
196
 
202
- @property
197
+ @_builtins.property
203
198
  @pulumi.getter(name="skipValidationDuringPlan")
204
- def skip_validation_during_plan(self) -> Optional[pulumi.Input[bool]]:
205
- """
206
- An optional flag to control whether a schema should be validated during `pulumi preview`. Set it to `true` if you want to skip schema validation during `pulumi preview`. Defaults to `false`. Regardless of `true` or `false` for this flag, schema validation will be performed during `pulumi up`.
207
- """
199
+ def skip_validation_during_plan(self) -> Optional[pulumi.Input[_builtins.bool]]:
208
200
  return pulumi.get(self, "skip_validation_during_plan")
209
201
 
210
202
  @skip_validation_during_plan.setter
211
- def skip_validation_during_plan(self, value: Optional[pulumi.Input[bool]]):
203
+ def skip_validation_during_plan(self, value: Optional[pulumi.Input[_builtins.bool]]):
212
204
  pulumi.set(self, "skip_validation_during_plan", value)
213
205
 
214
206
 
@@ -216,34 +208,33 @@ class SchemaArgs:
216
208
  class _SchemaState:
217
209
  def __init__(__self__, *,
218
210
  credentials: Optional[pulumi.Input['SchemaCredentialsArgs']] = None,
219
- format: Optional[pulumi.Input[str]] = None,
220
- hard_delete: Optional[pulumi.Input[bool]] = None,
211
+ format: Optional[pulumi.Input[_builtins.str]] = None,
212
+ hard_delete: Optional[pulumi.Input[_builtins.bool]] = None,
221
213
  metadata: Optional[pulumi.Input['SchemaMetadataArgs']] = None,
222
- recreate_on_update: Optional[pulumi.Input[bool]] = None,
223
- rest_endpoint: Optional[pulumi.Input[str]] = None,
214
+ recreate_on_update: Optional[pulumi.Input[_builtins.bool]] = None,
215
+ rest_endpoint: Optional[pulumi.Input[_builtins.str]] = None,
224
216
  ruleset: Optional[pulumi.Input['SchemaRulesetArgs']] = None,
225
- schema: Optional[pulumi.Input[str]] = None,
226
- schema_identifier: Optional[pulumi.Input[int]] = None,
217
+ schema: Optional[pulumi.Input[_builtins.str]] = None,
218
+ schema_identifier: Optional[pulumi.Input[_builtins.int]] = None,
227
219
  schema_references: Optional[pulumi.Input[Sequence[pulumi.Input['SchemaSchemaReferenceArgs']]]] = None,
228
220
  schema_registry_cluster: Optional[pulumi.Input['SchemaSchemaRegistryClusterArgs']] = None,
229
- skip_validation_during_plan: Optional[pulumi.Input[bool]] = None,
230
- subject_name: Optional[pulumi.Input[str]] = None,
231
- version: Optional[pulumi.Input[int]] = None):
221
+ skip_validation_during_plan: Optional[pulumi.Input[_builtins.bool]] = None,
222
+ subject_name: Optional[pulumi.Input[_builtins.str]] = None,
223
+ version: Optional[pulumi.Input[_builtins.int]] = None):
232
224
  """
233
225
  Input properties used for looking up and filtering Schema resources.
234
226
  :param pulumi.Input['SchemaCredentialsArgs'] credentials: The Cluster API Credentials.
235
- :param pulumi.Input[str] format: The format of the schema. Accepted values are: `AVRO`, `PROTOBUF`, and `JSON`.
236
- :param pulumi.Input[bool] hard_delete: An optional flag to control whether a schema should be soft or hard deleted. Set it to `true` if you want to hard delete a schema on destroy (see [Schema Deletion Guidelines](https://docs.confluent.io/platform/current/schema-registry/schema-deletion-guidelines.html#schema-deletion-guidelines) for more details). Must be unset when importing. Defaults to `false` (soft delete).
237
- :param pulumi.Input['SchemaMetadataArgs'] metadata: See [here](https://docs.confluent.io/platform/7.5/schema-registry/fundamentals/data-contracts.html) for more details. Supports the following:
238
- :param pulumi.Input[bool] recreate_on_update: An optional flag to control whether a schema should be recreated on an update. Set it to `true` if you want to manage different schema versions using different resource instances. Must be set to the target value when importing. Defaults to `false`, which manages the latest schema version only. The resource instance always points to the latest schema version by supporting in-place updates.
239
- :param pulumi.Input[str] rest_endpoint: The REST endpoint of the Schema Registry cluster, for example, `https://psrc-00000.us-central1.gcp.confluent.cloud:443`).
240
- :param pulumi.Input['SchemaRulesetArgs'] ruleset: The list of schema rules. See [Data Contracts for Schema Registry](https://docs.confluent.io/platform/7.5/schema-registry/fundamentals/data-contracts.html#rules) for more details. For example, these rules can enforce that a field that contains sensitive information must be encrypted, or that a message containing an invalid age must be sent to a dead letter queue.
241
- :param pulumi.Input[str] schema: The schema string, for example, `file("./schema_version_1.avsc")`.
242
- :param pulumi.Input[int] schema_identifier: (Required Integer) The globally unique ID of the Schema, for example, `100003`. If the same schema is registered under a different subject, the same identifier will be returned. However, the `version` of the schema may be different under different subjects.
243
- :param pulumi.Input[Sequence[pulumi.Input['SchemaSchemaReferenceArgs']]] schema_references: The list of referenced schemas (see [Schema References](https://docs.confluent.io/platform/current/schema-registry/serdes-develop/index.html#schema-references) for more details):
244
- :param pulumi.Input[bool] skip_validation_during_plan: An optional flag to control whether a schema should be validated during `pulumi preview`. Set it to `true` if you want to skip schema validation during `pulumi preview`. Defaults to `false`. Regardless of `true` or `false` for this flag, schema validation will be performed during `pulumi up`.
245
- :param pulumi.Input[str] subject_name: The name of the subject (in other words, the namespace), representing the subject under which the schema will be registered, for example, `test-subject`. Schemas evolve safely, following a compatibility mode defined, under a subject name.
246
- :param pulumi.Input[int] version: (Required Integer) The version of the Schema, for example, `4`.
227
+ :param pulumi.Input[_builtins.str] format: The format of the Schema.
228
+ :param pulumi.Input[_builtins.bool] hard_delete: Controls whether a schema should be soft or hard deleted. Set it to `true` if you want to hard delete a schema on destroy. Defaults to `false` (soft delete).
229
+ :param pulumi.Input[_builtins.bool] recreate_on_update: Controls whether a schema should be recreated on update.
230
+ :param pulumi.Input[_builtins.str] rest_endpoint: The REST endpoint of the Schema Registry cluster. For example, for public networking: `https://psrc-00000.us-central1.gcp.confluent.cloud`. In the case of private networking, the endpoint might look like `https://lsrc-abc123.pr1jy6.us-east-2.aws.confluent.cloud`. You can construct it using either:
231
+ - `data.confluent_schema_registry_cluster.essentials.private_regional_rest_endpoints["us-east-2"]`, or
232
+ - `https://${data.confluent_schema_registry_cluster.essentials.id}${data.confluent_network.main.endpoint_suffix}`
233
+ :param pulumi.Input[_builtins.str] schema: The definition of the Schema.
234
+ :param pulumi.Input[_builtins.int] schema_identifier: (Required Integer) The globally unique ID of the Schema, for example, `100003`. If the same schema is registered under a different subject, the same identifier will be returned. However, the `version` of the schema may be different under different subjects.
235
+ :param pulumi.Input[Sequence[pulumi.Input['SchemaSchemaReferenceArgs']]] schema_references: The list of references to other Schemas.
236
+ :param pulumi.Input[_builtins.str] subject_name: The name of the subject (in other words, the namespace), representing the subject under which the schema will be registered, for example, `test-subject`. Schemas evolve safely, following a compatibility mode defined, under a subject name.
237
+ :param pulumi.Input[_builtins.int] version: (Required Integer) The version of the Schema, for example, `4`.
247
238
  """
248
239
  if credentials is not None:
249
240
  pulumi.set(__self__, "credentials", credentials)
@@ -274,7 +265,7 @@ class _SchemaState:
274
265
  if version is not None:
275
266
  pulumi.set(__self__, "version", version)
276
267
 
277
- @property
268
+ @_builtins.property
278
269
  @pulumi.getter
279
270
  def credentials(self) -> Optional[pulumi.Input['SchemaCredentialsArgs']]:
280
271
  """
@@ -286,107 +277,103 @@ class _SchemaState:
286
277
  def credentials(self, value: Optional[pulumi.Input['SchemaCredentialsArgs']]):
287
278
  pulumi.set(self, "credentials", value)
288
279
 
289
- @property
280
+ @_builtins.property
290
281
  @pulumi.getter
291
- def format(self) -> Optional[pulumi.Input[str]]:
282
+ def format(self) -> Optional[pulumi.Input[_builtins.str]]:
292
283
  """
293
- The format of the schema. Accepted values are: `AVRO`, `PROTOBUF`, and `JSON`.
284
+ The format of the Schema.
294
285
  """
295
286
  return pulumi.get(self, "format")
296
287
 
297
288
  @format.setter
298
- def format(self, value: Optional[pulumi.Input[str]]):
289
+ def format(self, value: Optional[pulumi.Input[_builtins.str]]):
299
290
  pulumi.set(self, "format", value)
300
291
 
301
- @property
292
+ @_builtins.property
302
293
  @pulumi.getter(name="hardDelete")
303
- def hard_delete(self) -> Optional[pulumi.Input[bool]]:
294
+ def hard_delete(self) -> Optional[pulumi.Input[_builtins.bool]]:
304
295
  """
305
- An optional flag to control whether a schema should be soft or hard deleted. Set it to `true` if you want to hard delete a schema on destroy (see [Schema Deletion Guidelines](https://docs.confluent.io/platform/current/schema-registry/schema-deletion-guidelines.html#schema-deletion-guidelines) for more details). Must be unset when importing. Defaults to `false` (soft delete).
296
+ Controls whether a schema should be soft or hard deleted. Set it to `true` if you want to hard delete a schema on destroy. Defaults to `false` (soft delete).
306
297
  """
307
298
  return pulumi.get(self, "hard_delete")
308
299
 
309
300
  @hard_delete.setter
310
- def hard_delete(self, value: Optional[pulumi.Input[bool]]):
301
+ def hard_delete(self, value: Optional[pulumi.Input[_builtins.bool]]):
311
302
  pulumi.set(self, "hard_delete", value)
312
303
 
313
- @property
304
+ @_builtins.property
314
305
  @pulumi.getter
315
306
  def metadata(self) -> Optional[pulumi.Input['SchemaMetadataArgs']]:
316
- """
317
- See [here](https://docs.confluent.io/platform/7.5/schema-registry/fundamentals/data-contracts.html) for more details. Supports the following:
318
- """
319
307
  return pulumi.get(self, "metadata")
320
308
 
321
309
  @metadata.setter
322
310
  def metadata(self, value: Optional[pulumi.Input['SchemaMetadataArgs']]):
323
311
  pulumi.set(self, "metadata", value)
324
312
 
325
- @property
313
+ @_builtins.property
326
314
  @pulumi.getter(name="recreateOnUpdate")
327
- def recreate_on_update(self) -> Optional[pulumi.Input[bool]]:
315
+ def recreate_on_update(self) -> Optional[pulumi.Input[_builtins.bool]]:
328
316
  """
329
- An optional flag to control whether a schema should be recreated on an update. Set it to `true` if you want to manage different schema versions using different resource instances. Must be set to the target value when importing. Defaults to `false`, which manages the latest schema version only. The resource instance always points to the latest schema version by supporting in-place updates.
317
+ Controls whether a schema should be recreated on update.
330
318
  """
331
319
  return pulumi.get(self, "recreate_on_update")
332
320
 
333
321
  @recreate_on_update.setter
334
- def recreate_on_update(self, value: Optional[pulumi.Input[bool]]):
322
+ def recreate_on_update(self, value: Optional[pulumi.Input[_builtins.bool]]):
335
323
  pulumi.set(self, "recreate_on_update", value)
336
324
 
337
- @property
325
+ @_builtins.property
338
326
  @pulumi.getter(name="restEndpoint")
339
- def rest_endpoint(self) -> Optional[pulumi.Input[str]]:
327
+ def rest_endpoint(self) -> Optional[pulumi.Input[_builtins.str]]:
340
328
  """
341
- The REST endpoint of the Schema Registry cluster, for example, `https://psrc-00000.us-central1.gcp.confluent.cloud:443`).
329
+ The REST endpoint of the Schema Registry cluster. For example, for public networking: `https://psrc-00000.us-central1.gcp.confluent.cloud`. In the case of private networking, the endpoint might look like `https://lsrc-abc123.pr1jy6.us-east-2.aws.confluent.cloud`. You can construct it using either:
330
+ - `data.confluent_schema_registry_cluster.essentials.private_regional_rest_endpoints["us-east-2"]`, or
331
+ - `https://${data.confluent_schema_registry_cluster.essentials.id}${data.confluent_network.main.endpoint_suffix}`
342
332
  """
343
333
  return pulumi.get(self, "rest_endpoint")
344
334
 
345
335
  @rest_endpoint.setter
346
- def rest_endpoint(self, value: Optional[pulumi.Input[str]]):
336
+ def rest_endpoint(self, value: Optional[pulumi.Input[_builtins.str]]):
347
337
  pulumi.set(self, "rest_endpoint", value)
348
338
 
349
- @property
339
+ @_builtins.property
350
340
  @pulumi.getter
351
341
  def ruleset(self) -> Optional[pulumi.Input['SchemaRulesetArgs']]:
352
- """
353
- The list of schema rules. See [Data Contracts for Schema Registry](https://docs.confluent.io/platform/7.5/schema-registry/fundamentals/data-contracts.html#rules) for more details. For example, these rules can enforce that a field that contains sensitive information must be encrypted, or that a message containing an invalid age must be sent to a dead letter queue.
354
- """
355
342
  return pulumi.get(self, "ruleset")
356
343
 
357
344
  @ruleset.setter
358
345
  def ruleset(self, value: Optional[pulumi.Input['SchemaRulesetArgs']]):
359
346
  pulumi.set(self, "ruleset", value)
360
347
 
361
- @property
348
+ @_builtins.property
362
349
  @pulumi.getter
363
- def schema(self) -> Optional[pulumi.Input[str]]:
350
+ def schema(self) -> Optional[pulumi.Input[_builtins.str]]:
364
351
  """
365
- The schema string, for example, `file("./schema_version_1.avsc")`.
352
+ The definition of the Schema.
366
353
  """
367
354
  return pulumi.get(self, "schema")
368
355
 
369
356
  @schema.setter
370
- def schema(self, value: Optional[pulumi.Input[str]]):
357
+ def schema(self, value: Optional[pulumi.Input[_builtins.str]]):
371
358
  pulumi.set(self, "schema", value)
372
359
 
373
- @property
360
+ @_builtins.property
374
361
  @pulumi.getter(name="schemaIdentifier")
375
- def schema_identifier(self) -> Optional[pulumi.Input[int]]:
362
+ def schema_identifier(self) -> Optional[pulumi.Input[_builtins.int]]:
376
363
  """
377
364
  (Required Integer) The globally unique ID of the Schema, for example, `100003`. If the same schema is registered under a different subject, the same identifier will be returned. However, the `version` of the schema may be different under different subjects.
378
365
  """
379
366
  return pulumi.get(self, "schema_identifier")
380
367
 
381
368
  @schema_identifier.setter
382
- def schema_identifier(self, value: Optional[pulumi.Input[int]]):
369
+ def schema_identifier(self, value: Optional[pulumi.Input[_builtins.int]]):
383
370
  pulumi.set(self, "schema_identifier", value)
384
371
 
385
- @property
372
+ @_builtins.property
386
373
  @pulumi.getter(name="schemaReferences")
387
374
  def schema_references(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['SchemaSchemaReferenceArgs']]]]:
388
375
  """
389
- The list of referenced schemas (see [Schema References](https://docs.confluent.io/platform/current/schema-registry/serdes-develop/index.html#schema-references) for more details):
376
+ The list of references to other Schemas.
390
377
  """
391
378
  return pulumi.get(self, "schema_references")
392
379
 
@@ -394,7 +381,7 @@ class _SchemaState:
394
381
  def schema_references(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['SchemaSchemaReferenceArgs']]]]):
395
382
  pulumi.set(self, "schema_references", value)
396
383
 
397
- @property
384
+ @_builtins.property
398
385
  @pulumi.getter(name="schemaRegistryCluster")
399
386
  def schema_registry_cluster(self) -> Optional[pulumi.Input['SchemaSchemaRegistryClusterArgs']]:
400
387
  return pulumi.get(self, "schema_registry_cluster")
@@ -403,64 +390,176 @@ class _SchemaState:
403
390
  def schema_registry_cluster(self, value: Optional[pulumi.Input['SchemaSchemaRegistryClusterArgs']]):
404
391
  pulumi.set(self, "schema_registry_cluster", value)
405
392
 
406
- @property
393
+ @_builtins.property
407
394
  @pulumi.getter(name="skipValidationDuringPlan")
408
- def skip_validation_during_plan(self) -> Optional[pulumi.Input[bool]]:
409
- """
410
- An optional flag to control whether a schema should be validated during `pulumi preview`. Set it to `true` if you want to skip schema validation during `pulumi preview`. Defaults to `false`. Regardless of `true` or `false` for this flag, schema validation will be performed during `pulumi up`.
411
- """
395
+ def skip_validation_during_plan(self) -> Optional[pulumi.Input[_builtins.bool]]:
412
396
  return pulumi.get(self, "skip_validation_during_plan")
413
397
 
414
398
  @skip_validation_during_plan.setter
415
- def skip_validation_during_plan(self, value: Optional[pulumi.Input[bool]]):
399
+ def skip_validation_during_plan(self, value: Optional[pulumi.Input[_builtins.bool]]):
416
400
  pulumi.set(self, "skip_validation_during_plan", value)
417
401
 
418
- @property
402
+ @_builtins.property
419
403
  @pulumi.getter(name="subjectName")
420
- def subject_name(self) -> Optional[pulumi.Input[str]]:
404
+ def subject_name(self) -> Optional[pulumi.Input[_builtins.str]]:
421
405
  """
422
406
  The name of the subject (in other words, the namespace), representing the subject under which the schema will be registered, for example, `test-subject`. Schemas evolve safely, following a compatibility mode defined, under a subject name.
423
407
  """
424
408
  return pulumi.get(self, "subject_name")
425
409
 
426
410
  @subject_name.setter
427
- def subject_name(self, value: Optional[pulumi.Input[str]]):
411
+ def subject_name(self, value: Optional[pulumi.Input[_builtins.str]]):
428
412
  pulumi.set(self, "subject_name", value)
429
413
 
430
- @property
414
+ @_builtins.property
431
415
  @pulumi.getter
432
- def version(self) -> Optional[pulumi.Input[int]]:
416
+ def version(self) -> Optional[pulumi.Input[_builtins.int]]:
433
417
  """
434
418
  (Required Integer) The version of the Schema, for example, `4`.
435
419
  """
436
420
  return pulumi.get(self, "version")
437
421
 
438
422
  @version.setter
439
- def version(self, value: Optional[pulumi.Input[int]]):
423
+ def version(self, value: Optional[pulumi.Input[_builtins.int]]):
440
424
  pulumi.set(self, "version", value)
441
425
 
442
426
 
427
+ @pulumi.type_token("confluentcloud:index/schema:Schema")
443
428
  class Schema(pulumi.CustomResource):
444
429
  @overload
445
430
  def __init__(__self__,
446
431
  resource_name: str,
447
432
  opts: Optional[pulumi.ResourceOptions] = None,
448
433
  credentials: Optional[pulumi.Input[Union['SchemaCredentialsArgs', 'SchemaCredentialsArgsDict']]] = None,
449
- format: Optional[pulumi.Input[str]] = None,
450
- hard_delete: Optional[pulumi.Input[bool]] = None,
434
+ format: Optional[pulumi.Input[_builtins.str]] = None,
435
+ hard_delete: Optional[pulumi.Input[_builtins.bool]] = None,
451
436
  metadata: Optional[pulumi.Input[Union['SchemaMetadataArgs', 'SchemaMetadataArgsDict']]] = None,
452
- recreate_on_update: Optional[pulumi.Input[bool]] = None,
453
- rest_endpoint: Optional[pulumi.Input[str]] = None,
437
+ recreate_on_update: Optional[pulumi.Input[_builtins.bool]] = None,
438
+ rest_endpoint: Optional[pulumi.Input[_builtins.str]] = None,
454
439
  ruleset: Optional[pulumi.Input[Union['SchemaRulesetArgs', 'SchemaRulesetArgsDict']]] = None,
455
- schema: Optional[pulumi.Input[str]] = None,
440
+ schema: Optional[pulumi.Input[_builtins.str]] = None,
456
441
  schema_references: Optional[pulumi.Input[Sequence[pulumi.Input[Union['SchemaSchemaReferenceArgs', 'SchemaSchemaReferenceArgsDict']]]]] = None,
457
442
  schema_registry_cluster: Optional[pulumi.Input[Union['SchemaSchemaRegistryClusterArgs', 'SchemaSchemaRegistryClusterArgsDict']]] = None,
458
- skip_validation_during_plan: Optional[pulumi.Input[bool]] = None,
459
- subject_name: Optional[pulumi.Input[str]] = None,
443
+ skip_validation_during_plan: Optional[pulumi.Input[_builtins.bool]] = None,
444
+ subject_name: Optional[pulumi.Input[_builtins.str]] = None,
460
445
  __props__=None):
461
446
  """
462
447
  ## Example Usage
463
448
 
449
+ ### Option #1: Manage multiple Schema Registry clusters in the same Pulumi Stack
450
+
451
+ ```python
452
+ import pulumi
453
+ import pulumi_confluentcloud as confluentcloud
454
+ import pulumi_std as std
455
+
456
+ avro_purchase = confluentcloud.Schema("avro-purchase",
457
+ schema_registry_cluster={
458
+ "id": essentials["id"],
459
+ },
460
+ rest_endpoint=essentials["restEndpoint"],
461
+ subject_name="avro-purchase-value",
462
+ format="AVRO",
463
+ schema=std.index.file(input="./schemas/avro/purchase.avsc")["result"],
464
+ credentials={
465
+ "key": "<Schema Registry API Key for data.confluent_schema_registry_cluster.essentials>",
466
+ "secret": "<Schema Registry API Secret for data.confluent_schema_registry_cluster.essentials>",
467
+ })
468
+ ```
469
+
470
+ ### Option #2: Manage a single Schema Registry cluster in the same Pulumi Stack
471
+
472
+ ```python
473
+ import pulumi
474
+ import pulumi_confluentcloud as confluentcloud
475
+ import pulumi_std as std
476
+
477
+ avro_purchase = confluentcloud.Schema("avro-purchase",
478
+ subject_name="avro-purchase-value",
479
+ format="AVRO",
480
+ schema=std.index.file(input="./schemas/avro/purchase.avsc")["result"])
481
+ ```
482
+
483
+ ## Getting Started
484
+
485
+ The following end-to-end examples might help to get started with `Schema` resource:
486
+ * single-event-types-avro-schema
487
+ * single-event-types-proto-schema
488
+ * single-event-types-proto-schema-with-alias
489
+ * multiple-event-types-avro-schema
490
+ * multiple-event-types-proto-schema
491
+ * field-level-encryption-schema
492
+
493
+ ## Additional Examples
494
+
495
+ ### Default Option A: Manage the latest schema version only. The resource instance always points to the latest schema version by supporting in-place updates
496
+
497
+ ```python
498
+ import pulumi
499
+ import pulumi_confluentcloud as confluentcloud
500
+ import pulumi_std as std
501
+
502
+ # confluent_schema.avro-purchase points to v1.
503
+ avro_purchase = confluentcloud.Schema("avro-purchase",
504
+ subject_name="avro-purchase-value",
505
+ format="AVRO",
506
+ schema=std.index.file(input="./schemas/avro/purchase.avsc")["result"],
507
+ metadata={
508
+ "properties": {
509
+ "owner": "Bob Jones",
510
+ "email": "bob@acme.com",
511
+ },
512
+ "sensitives": [
513
+ "s1",
514
+ "s2",
515
+ ],
516
+ "tags": [
517
+ {
518
+ "key": "tag1",
519
+ "values": ["PII"],
520
+ },
521
+ {
522
+ "key": "tag2",
523
+ "values": ["PIIIII"],
524
+ },
525
+ ],
526
+ },
527
+ ruleset={
528
+ "domain_rules": [
529
+ {
530
+ "name": "encryptPII",
531
+ "kind": "TRANSFORM",
532
+ "type": "ENCRYPT",
533
+ "mode": "WRITEREAD",
534
+ "tags": ["PII"],
535
+ "params": {
536
+ "encrypt.kek.name": "testkek2",
537
+ },
538
+ },
539
+ {
540
+ "name": "encrypt",
541
+ "kind": "TRANSFORM",
542
+ "type": "ENCRYPT",
543
+ "mode": "WRITEREAD",
544
+ "tags": ["PIIIII"],
545
+ "params": {
546
+ "encrypt.kek.name": "testkek2",
547
+ },
548
+ },
549
+ ],
550
+ "migration_rules": [{
551
+ "name": "encrypt",
552
+ "kind": "TRANSFORM",
553
+ "type": "ENCRYPT",
554
+ "mode": "WRITEREAD",
555
+ "tags": ["PIM"],
556
+ "params": {
557
+ "encrypt.kek.name": "testkekM",
558
+ },
559
+ }],
560
+ })
561
+ ```
562
+
464
563
  ## Import
465
564
 
466
565
  You can import a Schema by using the Schema Registry cluster ID, Subject name, and unique identifier (or `latest` when `recreate_on_update = false`) of the Schema in the format `<Schema Registry cluster ID>/<Subject name>/<Schema identifier>`, for example:
@@ -494,16 +593,15 @@ class Schema(pulumi.CustomResource):
494
593
  :param str resource_name: The name of the resource.
495
594
  :param pulumi.ResourceOptions opts: Options for the resource.
496
595
  :param pulumi.Input[Union['SchemaCredentialsArgs', 'SchemaCredentialsArgsDict']] credentials: The Cluster API Credentials.
497
- :param pulumi.Input[str] format: The format of the schema. Accepted values are: `AVRO`, `PROTOBUF`, and `JSON`.
498
- :param pulumi.Input[bool] hard_delete: An optional flag to control whether a schema should be soft or hard deleted. Set it to `true` if you want to hard delete a schema on destroy (see [Schema Deletion Guidelines](https://docs.confluent.io/platform/current/schema-registry/schema-deletion-guidelines.html#schema-deletion-guidelines) for more details). Must be unset when importing. Defaults to `false` (soft delete).
499
- :param pulumi.Input[Union['SchemaMetadataArgs', 'SchemaMetadataArgsDict']] metadata: See [here](https://docs.confluent.io/platform/7.5/schema-registry/fundamentals/data-contracts.html) for more details. Supports the following:
500
- :param pulumi.Input[bool] recreate_on_update: An optional flag to control whether a schema should be recreated on an update. Set it to `true` if you want to manage different schema versions using different resource instances. Must be set to the target value when importing. Defaults to `false`, which manages the latest schema version only. The resource instance always points to the latest schema version by supporting in-place updates.
501
- :param pulumi.Input[str] rest_endpoint: The REST endpoint of the Schema Registry cluster, for example, `https://psrc-00000.us-central1.gcp.confluent.cloud:443`).
502
- :param pulumi.Input[Union['SchemaRulesetArgs', 'SchemaRulesetArgsDict']] ruleset: The list of schema rules. See [Data Contracts for Schema Registry](https://docs.confluent.io/platform/7.5/schema-registry/fundamentals/data-contracts.html#rules) for more details. For example, these rules can enforce that a field that contains sensitive information must be encrypted, or that a message containing an invalid age must be sent to a dead letter queue.
503
- :param pulumi.Input[str] schema: The schema string, for example, `file("./schema_version_1.avsc")`.
504
- :param pulumi.Input[Sequence[pulumi.Input[Union['SchemaSchemaReferenceArgs', 'SchemaSchemaReferenceArgsDict']]]] schema_references: The list of referenced schemas (see [Schema References](https://docs.confluent.io/platform/current/schema-registry/serdes-develop/index.html#schema-references) for more details):
505
- :param pulumi.Input[bool] skip_validation_during_plan: An optional flag to control whether a schema should be validated during `pulumi preview`. Set it to `true` if you want to skip schema validation during `pulumi preview`. Defaults to `false`. Regardless of `true` or `false` for this flag, schema validation will be performed during `pulumi up`.
506
- :param pulumi.Input[str] subject_name: The name of the subject (in other words, the namespace), representing the subject under which the schema will be registered, for example, `test-subject`. Schemas evolve safely, following a compatibility mode defined, under a subject name.
596
+ :param pulumi.Input[_builtins.str] format: The format of the Schema.
597
+ :param pulumi.Input[_builtins.bool] hard_delete: Controls whether a schema should be soft or hard deleted. Set it to `true` if you want to hard delete a schema on destroy. Defaults to `false` (soft delete).
598
+ :param pulumi.Input[_builtins.bool] recreate_on_update: Controls whether a schema should be recreated on update.
599
+ :param pulumi.Input[_builtins.str] rest_endpoint: The REST endpoint of the Schema Registry cluster. For example, for public networking: `https://psrc-00000.us-central1.gcp.confluent.cloud`. In the case of private networking, the endpoint might look like `https://lsrc-abc123.pr1jy6.us-east-2.aws.confluent.cloud`. You can construct it using either:
600
+ - `data.confluent_schema_registry_cluster.essentials.private_regional_rest_endpoints["us-east-2"]`, or
601
+ - `https://${data.confluent_schema_registry_cluster.essentials.id}${data.confluent_network.main.endpoint_suffix}`
602
+ :param pulumi.Input[_builtins.str] schema: The definition of the Schema.
603
+ :param pulumi.Input[Sequence[pulumi.Input[Union['SchemaSchemaReferenceArgs', 'SchemaSchemaReferenceArgsDict']]]] schema_references: The list of references to other Schemas.
604
+ :param pulumi.Input[_builtins.str] subject_name: The name of the subject (in other words, the namespace), representing the subject under which the schema will be registered, for example, `test-subject`. Schemas evolve safely, following a compatibility mode defined, under a subject name.
507
605
  """
508
606
  ...
509
607
  @overload
@@ -514,6 +612,120 @@ class Schema(pulumi.CustomResource):
514
612
  """
515
613
  ## Example Usage
516
614
 
615
+ ### Option #1: Manage multiple Schema Registry clusters in the same Pulumi Stack
616
+
617
+ ```python
618
+ import pulumi
619
+ import pulumi_confluentcloud as confluentcloud
620
+ import pulumi_std as std
621
+
622
+ avro_purchase = confluentcloud.Schema("avro-purchase",
623
+ schema_registry_cluster={
624
+ "id": essentials["id"],
625
+ },
626
+ rest_endpoint=essentials["restEndpoint"],
627
+ subject_name="avro-purchase-value",
628
+ format="AVRO",
629
+ schema=std.index.file(input="./schemas/avro/purchase.avsc")["result"],
630
+ credentials={
631
+ "key": "<Schema Registry API Key for data.confluent_schema_registry_cluster.essentials>",
632
+ "secret": "<Schema Registry API Secret for data.confluent_schema_registry_cluster.essentials>",
633
+ })
634
+ ```
635
+
636
+ ### Option #2: Manage a single Schema Registry cluster in the same Pulumi Stack
637
+
638
+ ```python
639
+ import pulumi
640
+ import pulumi_confluentcloud as confluentcloud
641
+ import pulumi_std as std
642
+
643
+ avro_purchase = confluentcloud.Schema("avro-purchase",
644
+ subject_name="avro-purchase-value",
645
+ format="AVRO",
646
+ schema=std.index.file(input="./schemas/avro/purchase.avsc")["result"])
647
+ ```
648
+
649
+ ## Getting Started
650
+
651
+ The following end-to-end examples might help to get started with `Schema` resource:
652
+ * single-event-types-avro-schema
653
+ * single-event-types-proto-schema
654
+ * single-event-types-proto-schema-with-alias
655
+ * multiple-event-types-avro-schema
656
+ * multiple-event-types-proto-schema
657
+ * field-level-encryption-schema
658
+
659
+ ## Additional Examples
660
+
661
+ ### Default Option A: Manage the latest schema version only. The resource instance always points to the latest schema version by supporting in-place updates
662
+
663
+ ```python
664
+ import pulumi
665
+ import pulumi_confluentcloud as confluentcloud
666
+ import pulumi_std as std
667
+
668
+ # confluent_schema.avro-purchase points to v1.
669
+ avro_purchase = confluentcloud.Schema("avro-purchase",
670
+ subject_name="avro-purchase-value",
671
+ format="AVRO",
672
+ schema=std.index.file(input="./schemas/avro/purchase.avsc")["result"],
673
+ metadata={
674
+ "properties": {
675
+ "owner": "Bob Jones",
676
+ "email": "bob@acme.com",
677
+ },
678
+ "sensitives": [
679
+ "s1",
680
+ "s2",
681
+ ],
682
+ "tags": [
683
+ {
684
+ "key": "tag1",
685
+ "values": ["PII"],
686
+ },
687
+ {
688
+ "key": "tag2",
689
+ "values": ["PIIIII"],
690
+ },
691
+ ],
692
+ },
693
+ ruleset={
694
+ "domain_rules": [
695
+ {
696
+ "name": "encryptPII",
697
+ "kind": "TRANSFORM",
698
+ "type": "ENCRYPT",
699
+ "mode": "WRITEREAD",
700
+ "tags": ["PII"],
701
+ "params": {
702
+ "encrypt.kek.name": "testkek2",
703
+ },
704
+ },
705
+ {
706
+ "name": "encrypt",
707
+ "kind": "TRANSFORM",
708
+ "type": "ENCRYPT",
709
+ "mode": "WRITEREAD",
710
+ "tags": ["PIIIII"],
711
+ "params": {
712
+ "encrypt.kek.name": "testkek2",
713
+ },
714
+ },
715
+ ],
716
+ "migration_rules": [{
717
+ "name": "encrypt",
718
+ "kind": "TRANSFORM",
719
+ "type": "ENCRYPT",
720
+ "mode": "WRITEREAD",
721
+ "tags": ["PIM"],
722
+ "params": {
723
+ "encrypt.kek.name": "testkekM",
724
+ },
725
+ }],
726
+ })
727
+ ```
728
+
517
729
  ## Import
518
730
 
519
731
  You can import a Schema by using the Schema Registry cluster ID, Subject name, and unique identifier (or `latest` when `recreate_on_update = false`) of the Schema in the format `<Schema Registry cluster ID>/<Subject name>/<Schema identifier>`, for example:
@@ -560,17 +772,17 @@ class Schema(pulumi.CustomResource):
560
772
  resource_name: str,
561
773
  opts: Optional[pulumi.ResourceOptions] = None,
562
774
  credentials: Optional[pulumi.Input[Union['SchemaCredentialsArgs', 'SchemaCredentialsArgsDict']]] = None,
563
- format: Optional[pulumi.Input[str]] = None,
564
- hard_delete: Optional[pulumi.Input[bool]] = None,
775
+ format: Optional[pulumi.Input[_builtins.str]] = None,
776
+ hard_delete: Optional[pulumi.Input[_builtins.bool]] = None,
565
777
  metadata: Optional[pulumi.Input[Union['SchemaMetadataArgs', 'SchemaMetadataArgsDict']]] = None,
566
- recreate_on_update: Optional[pulumi.Input[bool]] = None,
567
- rest_endpoint: Optional[pulumi.Input[str]] = None,
778
+ recreate_on_update: Optional[pulumi.Input[_builtins.bool]] = None,
779
+ rest_endpoint: Optional[pulumi.Input[_builtins.str]] = None,
568
780
  ruleset: Optional[pulumi.Input[Union['SchemaRulesetArgs', 'SchemaRulesetArgsDict']]] = None,
569
- schema: Optional[pulumi.Input[str]] = None,
781
+ schema: Optional[pulumi.Input[_builtins.str]] = None,
570
782
  schema_references: Optional[pulumi.Input[Sequence[pulumi.Input[Union['SchemaSchemaReferenceArgs', 'SchemaSchemaReferenceArgsDict']]]]] = None,
571
783
  schema_registry_cluster: Optional[pulumi.Input[Union['SchemaSchemaRegistryClusterArgs', 'SchemaSchemaRegistryClusterArgsDict']]] = None,
572
- skip_validation_during_plan: Optional[pulumi.Input[bool]] = None,
573
- subject_name: Optional[pulumi.Input[str]] = None,
784
+ skip_validation_during_plan: Optional[pulumi.Input[_builtins.bool]] = None,
785
+ subject_name: Optional[pulumi.Input[_builtins.str]] = None,
574
786
  __props__=None):
575
787
  opts = pulumi.ResourceOptions.merge(_utilities.get_resource_opts_defaults(), opts)
576
788
  if not isinstance(opts, pulumi.ResourceOptions):
@@ -611,19 +823,19 @@ class Schema(pulumi.CustomResource):
611
823
  id: pulumi.Input[str],
612
824
  opts: Optional[pulumi.ResourceOptions] = None,
613
825
  credentials: Optional[pulumi.Input[Union['SchemaCredentialsArgs', 'SchemaCredentialsArgsDict']]] = None,
614
- format: Optional[pulumi.Input[str]] = None,
615
- hard_delete: Optional[pulumi.Input[bool]] = None,
826
+ format: Optional[pulumi.Input[_builtins.str]] = None,
827
+ hard_delete: Optional[pulumi.Input[_builtins.bool]] = None,
616
828
  metadata: Optional[pulumi.Input[Union['SchemaMetadataArgs', 'SchemaMetadataArgsDict']]] = None,
617
- recreate_on_update: Optional[pulumi.Input[bool]] = None,
618
- rest_endpoint: Optional[pulumi.Input[str]] = None,
829
+ recreate_on_update: Optional[pulumi.Input[_builtins.bool]] = None,
830
+ rest_endpoint: Optional[pulumi.Input[_builtins.str]] = None,
619
831
  ruleset: Optional[pulumi.Input[Union['SchemaRulesetArgs', 'SchemaRulesetArgsDict']]] = None,
620
- schema: Optional[pulumi.Input[str]] = None,
621
- schema_identifier: Optional[pulumi.Input[int]] = None,
832
+ schema: Optional[pulumi.Input[_builtins.str]] = None,
833
+ schema_identifier: Optional[pulumi.Input[_builtins.int]] = None,
622
834
  schema_references: Optional[pulumi.Input[Sequence[pulumi.Input[Union['SchemaSchemaReferenceArgs', 'SchemaSchemaReferenceArgsDict']]]]] = None,
623
835
  schema_registry_cluster: Optional[pulumi.Input[Union['SchemaSchemaRegistryClusterArgs', 'SchemaSchemaRegistryClusterArgsDict']]] = None,
624
- skip_validation_during_plan: Optional[pulumi.Input[bool]] = None,
625
- subject_name: Optional[pulumi.Input[str]] = None,
626
- version: Optional[pulumi.Input[int]] = None) -> 'Schema':
836
+ skip_validation_during_plan: Optional[pulumi.Input[_builtins.bool]] = None,
837
+ subject_name: Optional[pulumi.Input[_builtins.str]] = None,
838
+ version: Optional[pulumi.Input[_builtins.int]] = None) -> 'Schema':
627
839
  """
628
840
  Get an existing Schema resource's state with the given name, id, and optional extra
629
841
  properties used to qualify the lookup.
@@ -632,18 +844,17 @@ class Schema(pulumi.CustomResource):
632
844
  :param pulumi.Input[str] id: The unique provider ID of the resource to lookup.
633
845
  :param pulumi.ResourceOptions opts: Options for the resource.
634
846
  :param pulumi.Input[Union['SchemaCredentialsArgs', 'SchemaCredentialsArgsDict']] credentials: The Cluster API Credentials.
635
- :param pulumi.Input[str] format: The format of the schema. Accepted values are: `AVRO`, `PROTOBUF`, and `JSON`.
636
- :param pulumi.Input[bool] hard_delete: An optional flag to control whether a schema should be soft or hard deleted. Set it to `true` if you want to hard delete a schema on destroy (see [Schema Deletion Guidelines](https://docs.confluent.io/platform/current/schema-registry/schema-deletion-guidelines.html#schema-deletion-guidelines) for more details). Must be unset when importing. Defaults to `false` (soft delete).
637
- :param pulumi.Input[Union['SchemaMetadataArgs', 'SchemaMetadataArgsDict']] metadata: See [here](https://docs.confluent.io/platform/7.5/schema-registry/fundamentals/data-contracts.html) for more details. Supports the following:
638
- :param pulumi.Input[bool] recreate_on_update: An optional flag to control whether a schema should be recreated on an update. Set it to `true` if you want to manage different schema versions using different resource instances. Must be set to the target value when importing. Defaults to `false`, which manages the latest schema version only. The resource instance always points to the latest schema version by supporting in-place updates.
639
- :param pulumi.Input[str] rest_endpoint: The REST endpoint of the Schema Registry cluster, for example, `https://psrc-00000.us-central1.gcp.confluent.cloud:443`).
640
- :param pulumi.Input[Union['SchemaRulesetArgs', 'SchemaRulesetArgsDict']] ruleset: The list of schema rules. See [Data Contracts for Schema Registry](https://docs.confluent.io/platform/7.5/schema-registry/fundamentals/data-contracts.html#rules) for more details. For example, these rules can enforce that a field that contains sensitive information must be encrypted, or that a message containing an invalid age must be sent to a dead letter queue.
641
- :param pulumi.Input[str] schema: The schema string, for example, `file("./schema_version_1.avsc")`.
642
- :param pulumi.Input[int] schema_identifier: (Required Integer) The globally unique ID of the Schema, for example, `100003`. If the same schema is registered under a different subject, the same identifier will be returned. However, the `version` of the schema may be different under different subjects.
643
- :param pulumi.Input[Sequence[pulumi.Input[Union['SchemaSchemaReferenceArgs', 'SchemaSchemaReferenceArgsDict']]]] schema_references: The list of referenced schemas (see [Schema References](https://docs.confluent.io/platform/current/schema-registry/serdes-develop/index.html#schema-references) for more details):
644
- :param pulumi.Input[bool] skip_validation_during_plan: An optional flag to control whether a schema should be validated during `pulumi preview`. Set it to `true` if you want to skip schema validation during `pulumi preview`. Defaults to `false`. Regardless of `true` or `false` for this flag, schema validation will be performed during `pulumi up`.
645
- :param pulumi.Input[str] subject_name: The name of the subject (in other words, the namespace), representing the subject under which the schema will be registered, for example, `test-subject`. Schemas evolve safely, following a compatibility mode defined, under a subject name.
646
- :param pulumi.Input[int] version: (Required Integer) The version of the Schema, for example, `4`.
847
+ :param pulumi.Input[_builtins.str] format: The format of the Schema.
848
+ :param pulumi.Input[_builtins.bool] hard_delete: Controls whether a schema should be soft or hard deleted. Set it to `true` if you want to hard delete a schema on destroy. Defaults to `false` (soft delete).
849
+ :param pulumi.Input[_builtins.bool] recreate_on_update: Controls whether a schema should be recreated on update.
850
+ :param pulumi.Input[_builtins.str] rest_endpoint: The REST endpoint of the Schema Registry cluster. For example, for public networking: `https://psrc-00000.us-central1.gcp.confluent.cloud`. In the case of private networking, the endpoint might look like `https://lsrc-abc123.pr1jy6.us-east-2.aws.confluent.cloud`. You can construct it using either:
851
+ - `data.confluent_schema_registry_cluster.essentials.private_regional_rest_endpoints["us-east-2"]`, or
852
+ - `https://${data.confluent_schema_registry_cluster.essentials.id}${data.confluent_network.main.endpoint_suffix}`
853
+ :param pulumi.Input[_builtins.str] schema: The definition of the Schema.
854
+ :param pulumi.Input[_builtins.int] schema_identifier: (Required Integer) The globally unique ID of the Schema, for example, `100003`. If the same schema is registered under a different subject, the same identifier will be returned. However, the `version` of the schema may be different under different subjects.
855
+ :param pulumi.Input[Sequence[pulumi.Input[Union['SchemaSchemaReferenceArgs', 'SchemaSchemaReferenceArgsDict']]]] schema_references: The list of references to other Schemas.
856
+ :param pulumi.Input[_builtins.str] subject_name: The name of the subject (in other words, the namespace), representing the subject under which the schema will be registered, for example, `test-subject`. Schemas evolve safely, following a compatibility mode defined, under a subject name.
857
+ :param pulumi.Input[_builtins.int] version: (Required Integer) The version of the Schema, for example, `4`.
647
858
  """
648
859
  opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
649
860
 
@@ -665,7 +876,7 @@ class Schema(pulumi.CustomResource):
665
876
  __props__.__dict__["version"] = version
666
877
  return Schema(resource_name, opts=opts, __props__=__props__)
667
878
 
668
- @property
879
+ @_builtins.property
669
880
  @pulumi.getter
670
881
  def credentials(self) -> pulumi.Output[Optional['outputs.SchemaCredentials']]:
671
882
  """
@@ -673,102 +884,95 @@ class Schema(pulumi.CustomResource):
673
884
  """
674
885
  return pulumi.get(self, "credentials")
675
886
 
676
- @property
887
+ @_builtins.property
677
888
  @pulumi.getter
678
- def format(self) -> pulumi.Output[str]:
889
+ def format(self) -> pulumi.Output[_builtins.str]:
679
890
  """
680
- The format of the schema. Accepted values are: `AVRO`, `PROTOBUF`, and `JSON`.
891
+ The format of the Schema.
681
892
  """
682
893
  return pulumi.get(self, "format")
683
894
 
684
- @property
895
+ @_builtins.property
685
896
  @pulumi.getter(name="hardDelete")
686
- def hard_delete(self) -> pulumi.Output[Optional[bool]]:
897
+ def hard_delete(self) -> pulumi.Output[Optional[_builtins.bool]]:
687
898
  """
688
- An optional flag to control whether a schema should be soft or hard deleted. Set it to `true` if you want to hard delete a schema on destroy (see [Schema Deletion Guidelines](https://docs.confluent.io/platform/current/schema-registry/schema-deletion-guidelines.html#schema-deletion-guidelines) for more details). Must be unset when importing. Defaults to `false` (soft delete).
899
+ Controls whether a schema should be soft or hard deleted. Set it to `true` if you want to hard delete a schema on destroy. Defaults to `false` (soft delete).
689
900
  """
690
901
  return pulumi.get(self, "hard_delete")
691
902
 
692
- @property
903
+ @_builtins.property
693
904
  @pulumi.getter
694
905
  def metadata(self) -> pulumi.Output['outputs.SchemaMetadata']:
695
- """
696
- See [here](https://docs.confluent.io/platform/7.5/schema-registry/fundamentals/data-contracts.html) for more details. Supports the following:
697
- """
698
906
  return pulumi.get(self, "metadata")
699
907
 
700
- @property
908
+ @_builtins.property
701
909
  @pulumi.getter(name="recreateOnUpdate")
702
- def recreate_on_update(self) -> pulumi.Output[Optional[bool]]:
910
+ def recreate_on_update(self) -> pulumi.Output[Optional[_builtins.bool]]:
703
911
  """
704
- An optional flag to control whether a schema should be recreated on an update. Set it to `true` if you want to manage different schema versions using different resource instances. Must be set to the target value when importing. Defaults to `false`, which manages the latest schema version only. The resource instance always points to the latest schema version by supporting in-place updates.
912
+ Controls whether a schema should be recreated on update.
705
913
  """
706
914
  return pulumi.get(self, "recreate_on_update")
707
915
 
708
- @property
916
+ @_builtins.property
709
917
  @pulumi.getter(name="restEndpoint")
710
- def rest_endpoint(self) -> pulumi.Output[Optional[str]]:
918
+ def rest_endpoint(self) -> pulumi.Output[Optional[_builtins.str]]:
711
919
  """
712
- The REST endpoint of the Schema Registry cluster, for example, `https://psrc-00000.us-central1.gcp.confluent.cloud:443`).
920
+ The REST endpoint of the Schema Registry cluster. For example, for public networking: `https://psrc-00000.us-central1.gcp.confluent.cloud`. In the case of private networking, the endpoint might look like `https://lsrc-abc123.pr1jy6.us-east-2.aws.confluent.cloud`. You can construct it using either:
921
+ - `data.confluent_schema_registry_cluster.essentials.private_regional_rest_endpoints["us-east-2"]`, or
922
+ - `https://${data.confluent_schema_registry_cluster.essentials.id}${data.confluent_network.main.endpoint_suffix}`
713
923
  """
714
924
  return pulumi.get(self, "rest_endpoint")
715
925
 
716
- @property
926
+ @_builtins.property
717
927
  @pulumi.getter
718
- def ruleset(self) -> pulumi.Output['outputs.SchemaRuleset']:
719
- """
720
- The list of schema rules. See [Data Contracts for Schema Registry](https://docs.confluent.io/platform/7.5/schema-registry/fundamentals/data-contracts.html#rules) for more details. For example, these rules can enforce that a field that contains sensitive information must be encrypted, or that a message containing an invalid age must be sent to a dead letter queue.
721
- """
928
+ def ruleset(self) -> pulumi.Output[Optional['outputs.SchemaRuleset']]:
722
929
  return pulumi.get(self, "ruleset")
723
930
 
724
- @property
931
+ @_builtins.property
725
932
  @pulumi.getter
726
- def schema(self) -> pulumi.Output[str]:
933
+ def schema(self) -> pulumi.Output[_builtins.str]:
727
934
  """
728
- The schema string, for example, `file("./schema_version_1.avsc")`.
935
+ The definition of the Schema.
729
936
  """
730
937
  return pulumi.get(self, "schema")
731
938
 
732
- @property
939
+ @_builtins.property
733
940
  @pulumi.getter(name="schemaIdentifier")
734
- def schema_identifier(self) -> pulumi.Output[int]:
941
+ def schema_identifier(self) -> pulumi.Output[_builtins.int]:
735
942
  """
736
943
  (Required Integer) The globally unique ID of the Schema, for example, `100003`. If the same schema is registered under a different subject, the same identifier will be returned. However, the `version` of the schema may be different under different subjects.
737
944
  """
738
945
  return pulumi.get(self, "schema_identifier")
739
946
 
740
- @property
947
+ @_builtins.property
741
948
  @pulumi.getter(name="schemaReferences")
742
949
  def schema_references(self) -> pulumi.Output[Optional[Sequence['outputs.SchemaSchemaReference']]]:
743
950
  """
744
- The list of referenced schemas (see [Schema References](https://docs.confluent.io/platform/current/schema-registry/serdes-develop/index.html#schema-references) for more details):
951
+ The list of references to other Schemas.
745
952
  """
746
953
  return pulumi.get(self, "schema_references")
747
954
 
748
- @property
955
+ @_builtins.property
749
956
  @pulumi.getter(name="schemaRegistryCluster")
750
957
  def schema_registry_cluster(self) -> pulumi.Output[Optional['outputs.SchemaSchemaRegistryCluster']]:
751
958
  return pulumi.get(self, "schema_registry_cluster")
752
959
 
753
- @property
960
+ @_builtins.property
754
961
  @pulumi.getter(name="skipValidationDuringPlan")
755
- def skip_validation_during_plan(self) -> pulumi.Output[Optional[bool]]:
756
- """
757
- An optional flag to control whether a schema should be validated during `pulumi preview`. Set it to `true` if you want to skip schema validation during `pulumi preview`. Defaults to `false`. Regardless of `true` or `false` for this flag, schema validation will be performed during `pulumi up`.
758
- """
962
+ def skip_validation_during_plan(self) -> pulumi.Output[Optional[_builtins.bool]]:
759
963
  return pulumi.get(self, "skip_validation_during_plan")
760
964
 
761
- @property
965
+ @_builtins.property
762
966
  @pulumi.getter(name="subjectName")
763
- def subject_name(self) -> pulumi.Output[str]:
967
+ def subject_name(self) -> pulumi.Output[_builtins.str]:
764
968
  """
765
969
  The name of the subject (in other words, the namespace), representing the subject under which the schema will be registered, for example, `test-subject`. Schemas evolve safely, following a compatibility mode defined, under a subject name.
766
970
  """
767
971
  return pulumi.get(self, "subject_name")
768
972
 
769
- @property
973
+ @_builtins.property
770
974
  @pulumi.getter
771
- def version(self) -> pulumi.Output[int]:
975
+ def version(self) -> pulumi.Output[_builtins.int]:
772
976
  """
773
977
  (Required Integer) The version of the Schema, for example, `4`.
774
978
  """