@pulumi/confluentcloud 1.32.0 → 1.33.0-alpha.1706307303

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 (54) hide show
  1. package/apiKey.d.ts +128 -0
  2. package/apiKey.js +128 -0
  3. package/apiKey.js.map +1 -1
  4. package/byokKey.d.ts +35 -0
  5. package/byokKey.js +35 -0
  6. package/byokKey.js.map +1 -1
  7. package/clusterLink.d.ts +56 -0
  8. package/clusterLink.js +56 -0
  9. package/clusterLink.js.map +1 -1
  10. package/connector.d.ts +191 -0
  11. package/connector.js +170 -0
  12. package/connector.js.map +1 -1
  13. package/environment.d.ts +25 -0
  14. package/environment.js +25 -0
  15. package/environment.js.map +1 -1
  16. package/kafkaCluster.d.ts +137 -0
  17. package/kafkaCluster.js +137 -0
  18. package/kafkaCluster.js.map +1 -1
  19. package/kafkaMirrorTopic.d.ts +31 -0
  20. package/kafkaMirrorTopic.js +31 -0
  21. package/kafkaMirrorTopic.js.map +1 -1
  22. package/ksqlCluster.d.ts +14 -0
  23. package/ksqlCluster.js +14 -0
  24. package/ksqlCluster.js.map +1 -1
  25. package/network.d.ts +99 -0
  26. package/network.js +99 -0
  27. package/network.js.map +1 -1
  28. package/networkLinkEndpoint.d.ts +26 -0
  29. package/networkLinkEndpoint.js +26 -0
  30. package/networkLinkEndpoint.js.map +1 -1
  31. package/networkLinkService.d.ts +45 -0
  32. package/networkLinkService.js +45 -0
  33. package/networkLinkService.js.map +1 -1
  34. package/package.json +1 -1
  35. package/peering.d.ts +79 -0
  36. package/peering.js +79 -0
  37. package/peering.js.map +1 -1
  38. package/privateLinkAccess.d.ts +108 -0
  39. package/privateLinkAccess.js +108 -0
  40. package/privateLinkAccess.js.map +1 -1
  41. package/roleBinding.d.ts +20 -0
  42. package/roleBinding.js +20 -0
  43. package/roleBinding.js.map +1 -1
  44. package/serviceAccount.d.ts +37 -0
  45. package/serviceAccount.js +37 -0
  46. package/serviceAccount.js.map +1 -1
  47. package/tfImporter.d.ts +60 -0
  48. package/tfImporter.js +18 -0
  49. package/tfImporter.js.map +1 -1
  50. package/transitGatewayAttachment.d.ts +44 -0
  51. package/transitGatewayAttachment.js +44 -0
  52. package/transitGatewayAttachment.js.map +1 -1
  53. package/types/input.d.ts +9 -0
  54. package/types/output.d.ts +9 -0
package/connector.d.ts CHANGED
@@ -2,6 +2,176 @@ import * as pulumi from "@pulumi/pulumi";
2
2
  import * as inputs from "./types/input";
3
3
  import * as outputs from "./types/output";
4
4
  /**
5
+ * ## Example Usage
6
+ * ### Example Managed [Datagen Source Connector](https://docs.confluent.io/cloud/current/connectors/cc-datagen-source.html) that uses a service account to communicate with your Kafka cluster
7
+ * ```typescript
8
+ * import * as pulumi from "@pulumi/pulumi";
9
+ * import * as confluentcloud from "@pulumi/confluentcloud";
10
+ *
11
+ * const source = new confluentcloud.Connector("source", {
12
+ * environment: {
13
+ * id: confluent_environment.staging.id,
14
+ * },
15
+ * kafkaCluster: {
16
+ * id: confluent_kafka_cluster.basic.id,
17
+ * },
18
+ * configSensitive: {},
19
+ * configNonsensitive: {
20
+ * "connector.class": "DatagenSource",
21
+ * name: "DatagenSourceConnector_0",
22
+ * "kafka.auth.mode": "SERVICE_ACCOUNT",
23
+ * "kafka.service.account.id": confluent_service_account["app-connector"].id,
24
+ * "kafka.topic": confluent_kafka_topic.orders.topic_name,
25
+ * "output.data.format": "JSON",
26
+ * quickstart: "ORDERS",
27
+ * "tasks.max": "1",
28
+ * },
29
+ * }, {
30
+ * dependsOn: [
31
+ * confluent_kafka_acl["app-connector-describe-on-cluster"],
32
+ * confluent_kafka_acl["app-connector-write-on-target-topic"],
33
+ * confluent_kafka_acl["app-connector-create-on-data-preview-topics"],
34
+ * confluent_kafka_acl["app-connector-write-on-data-preview-topics"],
35
+ * ],
36
+ * });
37
+ * ```
38
+ * ### Example Managed [Amazon S3 Sink Connector](https://docs.confluent.io/cloud/current/connectors/cc-s3-sink.html) that uses a service account to communicate with your Kafka cluster
39
+ * ```typescript
40
+ * import * as pulumi from "@pulumi/pulumi";
41
+ * import * as confluentcloud from "@pulumi/confluentcloud";
42
+ *
43
+ * const sink = new confluentcloud.Connector("sink", {
44
+ * environment: {
45
+ * id: confluent_environment.staging.id,
46
+ * },
47
+ * kafkaCluster: {
48
+ * id: confluent_kafka_cluster.basic.id,
49
+ * },
50
+ * configSensitive: {
51
+ * "aws.access.key.id": "***REDACTED***",
52
+ * "aws.secret.access.key": "***REDACTED***",
53
+ * },
54
+ * configNonsensitive: {
55
+ * topics: confluent_kafka_topic.orders.topic_name,
56
+ * "input.data.format": "JSON",
57
+ * "connector.class": "S3_SINK",
58
+ * name: "S3_SINKConnector_0",
59
+ * "kafka.auth.mode": "SERVICE_ACCOUNT",
60
+ * "kafka.service.account.id": confluent_service_account["app-connector"].id,
61
+ * "s3.bucket.name": "<s3-bucket-name>",
62
+ * "output.data.format": "JSON",
63
+ * "time.interval": "DAILY",
64
+ * "flush.size": "1000",
65
+ * "tasks.max": "1",
66
+ * },
67
+ * }, {
68
+ * dependsOn: [
69
+ * confluent_kafka_acl["app-connector-describe-on-cluster"],
70
+ * confluent_kafka_acl["app-connector-read-on-target-topic"],
71
+ * confluent_kafka_acl["app-connector-create-on-dlq-lcc-topics"],
72
+ * confluent_kafka_acl["app-connector-write-on-dlq-lcc-topics"],
73
+ * confluent_kafka_acl["app-connector-create-on-success-lcc-topics"],
74
+ * confluent_kafka_acl["app-connector-write-on-success-lcc-topics"],
75
+ * confluent_kafka_acl["app-connector-create-on-error-lcc-topics"],
76
+ * confluent_kafka_acl["app-connector-write-on-error-lcc-topics"],
77
+ * confluent_kafka_acl["app-connector-read-on-connect-lcc-group"],
78
+ * ],
79
+ * });
80
+ * ```
81
+ * ### Example Managed [Amazon DynamoDB Connector](https://docs.confluent.io/cloud/current/connectors/cc-amazon-dynamo-db-sink.html) that uses a service account to communicate with your Kafka cluster
82
+ * ```typescript
83
+ * import * as pulumi from "@pulumi/pulumi";
84
+ * import * as confluentcloud from "@pulumi/confluentcloud";
85
+ *
86
+ * const sink = new confluentcloud.Connector("sink", {
87
+ * environment: {
88
+ * id: confluent_environment.staging.id,
89
+ * },
90
+ * kafkaCluster: {
91
+ * id: confluent_kafka_cluster.basic.id,
92
+ * },
93
+ * configSensitive: {
94
+ * "aws.access.key.id": "***REDACTED***",
95
+ * "aws.secret.access.key": "***REDACTED***",
96
+ * },
97
+ * configNonsensitive: {
98
+ * topics: confluent_kafka_topic.orders.topic_name,
99
+ * "input.data.format": "JSON",
100
+ * "connector.class": "DynamoDbSink",
101
+ * name: "DynamoDbSinkConnector_0",
102
+ * "kafka.auth.mode": "SERVICE_ACCOUNT",
103
+ * "kafka.service.account.id": confluent_service_account["app-connector"].id,
104
+ * "aws.dynamodb.pk.hash": "value.userid",
105
+ * "aws.dynamodb.pk.sort": "value.pageid",
106
+ * "tasks.max": "1",
107
+ * },
108
+ * }, {
109
+ * dependsOn: [
110
+ * confluent_kafka_acl["app-connector-describe-on-cluster"],
111
+ * confluent_kafka_acl["app-connector-read-on-target-topic"],
112
+ * confluent_kafka_acl["app-connector-create-on-dlq-lcc-topics"],
113
+ * confluent_kafka_acl["app-connector-write-on-dlq-lcc-topics"],
114
+ * confluent_kafka_acl["app-connector-create-on-success-lcc-topics"],
115
+ * confluent_kafka_acl["app-connector-write-on-success-lcc-topics"],
116
+ * confluent_kafka_acl["app-connector-create-on-error-lcc-topics"],
117
+ * confluent_kafka_acl["app-connector-write-on-error-lcc-topics"],
118
+ * confluent_kafka_acl["app-connector-read-on-connect-lcc-group"],
119
+ * ],
120
+ * });
121
+ * ```
122
+ * ### Example Custom [Datagen Source Connector](https://www.confluent.io/hub/confluentinc/kafka-connect-datagen) that uses a Kafka API Key to communicate with your Kafka cluster
123
+ *
124
+ * ```typescript
125
+ * import * as pulumi from "@pulumi/pulumi";
126
+ * import * as confluentcloud from "@pulumi/confluentcloud";
127
+ *
128
+ * const source = new confluentcloud.Connector("source", {
129
+ * environment: {
130
+ * id: confluent_environment.staging.id,
131
+ * },
132
+ * kafkaCluster: {
133
+ * id: confluent_kafka_cluster.basic.id,
134
+ * },
135
+ * configSensitive: {
136
+ * "kafka.api.key": "***REDACTED***",
137
+ * "kafka.api.secret": "***REDACTED***",
138
+ * },
139
+ * configNonsensitive: {
140
+ * "confluent.connector.type": "CUSTOM",
141
+ * "connector.class": confluent_custom_connector_plugin.source.connector_class,
142
+ * name: "DatagenConnectorExampleName",
143
+ * "kafka.auth.mode": "KAFKA_API_KEY",
144
+ * "kafka.topic": confluent_kafka_topic.orders.topic_name,
145
+ * "output.data.format": "JSON",
146
+ * quickstart: "ORDERS",
147
+ * "confluent.custom.plugin.id": confluent_custom_connector_plugin.source.id,
148
+ * "min.interval": "1000",
149
+ * "max.interval": "2000",
150
+ * "tasks.max": "1",
151
+ * },
152
+ * }, {
153
+ * dependsOn: [confluent_role_binding["app-manager-kafka-cluster-admin"]],
154
+ * });
155
+ * ```
156
+ *
157
+ * > **Note:** Custom connectors are available in **Preview** for early adopters. Preview features are introduced to gather customer feedback. This feature should be used only for evaluation and non-production testing purposes or to provide feedback to Confluent, particularly as it becomes more widely available in follow-on editions.\
158
+ * **Preview** features are intended for evaluation use in development and testing environments only, and not for production use. The warranty, SLA, and Support Services provisions of your agreement with Confluent do not apply to Preview features. Preview features are considered to be a Proof of Concept as defined in the Confluent Cloud Terms of Service. Confluent may discontinue providing preview releases of the Preview features at any time in Confluent’s sole discretion.
159
+ * ## Getting Started
160
+ *
161
+ * The following end-to-end examples might help to get started with `confluentcloud.Connector` resource:
162
+ * * `s3-sink-connector`
163
+ * * `snowflake-sink-connector`
164
+ * * `managed-datagen-source-connector`
165
+ * * `elasticsearch-sink-connector`
166
+ * * `dynamo-db-sink-connector`
167
+ * * `mongo-db-source-connector`
168
+ * * `mongo-db-sink-connector`
169
+ * * `sql-server-cdc-debezium-source-connector`
170
+ * * `postgre-sql-cdc-debezium-source-connector`
171
+ * * `custom-datagen-source-connector`
172
+ *
173
+ * > **Note:** Certain connectors require additional ACL entries. See [Additional ACL entries](https://docs.confluent.io/cloud/current/connectors/service-account.html#additional-acl-entries) for more details.
174
+ *
5
175
  * ## Import
6
176
  *
7
177
  * You can import a connector by using Environment ID, Kafka cluster ID, and connector's name, in the format `<Environment ID>/<Kafka cluster ID>/<Connector name>`, for example$ export CONFLUENT_CLOUD_API_KEY="<cloud_api_key>" $ export CONFLUENT_CLOUD_API_SECRET="<cloud_api_secret>"
@@ -43,6 +213,13 @@ export declare class Connector extends pulumi.CustomResource {
43
213
  */
44
214
  readonly environment: pulumi.Output<outputs.ConnectorEnvironment>;
45
215
  readonly kafkaCluster: pulumi.Output<outputs.ConnectorKafkaCluster>;
216
+ /**
217
+ * The status of the connector (one of `"NONE"`, `"PROVISIONING"`, `"RUNNING"`, `"DEGRADED"`, `"FAILED"`, `"PAUSED"`, `"DELETED"`). Pausing (`"RUNNING" > "PAUSED"`) and resuming (`"PAUSED" > "RUNNING"`) a connector is supported via an update operation.
218
+ *
219
+ * > **Note:** If there are no _sensitive_ configuration settings for your connector, set `configSensitive = {}` explicitly.
220
+ *
221
+ * > **Note:** You may declare sensitive variables for secrets `configSensitive` block and set them using environment variables (for example, `export TF_VAR_aws_access_key_id="foo"`).
222
+ */
46
223
  readonly status: pulumi.Output<string>;
47
224
  /**
48
225
  * Create a Connector resource with the given unique name, arguments, and options.
@@ -74,6 +251,13 @@ export interface ConnectorState {
74
251
  */
75
252
  environment?: pulumi.Input<inputs.ConnectorEnvironment>;
76
253
  kafkaCluster?: pulumi.Input<inputs.ConnectorKafkaCluster>;
254
+ /**
255
+ * The status of the connector (one of `"NONE"`, `"PROVISIONING"`, `"RUNNING"`, `"DEGRADED"`, `"FAILED"`, `"PAUSED"`, `"DELETED"`). Pausing (`"RUNNING" > "PAUSED"`) and resuming (`"PAUSED" > "RUNNING"`) a connector is supported via an update operation.
256
+ *
257
+ * > **Note:** If there are no _sensitive_ configuration settings for your connector, set `configSensitive = {}` explicitly.
258
+ *
259
+ * > **Note:** You may declare sensitive variables for secrets `configSensitive` block and set them using environment variables (for example, `export TF_VAR_aws_access_key_id="foo"`).
260
+ */
77
261
  status?: pulumi.Input<string>;
78
262
  }
79
263
  /**
@@ -97,5 +281,12 @@ export interface ConnectorArgs {
97
281
  */
98
282
  environment: pulumi.Input<inputs.ConnectorEnvironment>;
99
283
  kafkaCluster: pulumi.Input<inputs.ConnectorKafkaCluster>;
284
+ /**
285
+ * The status of the connector (one of `"NONE"`, `"PROVISIONING"`, `"RUNNING"`, `"DEGRADED"`, `"FAILED"`, `"PAUSED"`, `"DELETED"`). Pausing (`"RUNNING" > "PAUSED"`) and resuming (`"PAUSED" > "RUNNING"`) a connector is supported via an update operation.
286
+ *
287
+ * > **Note:** If there are no _sensitive_ configuration settings for your connector, set `configSensitive = {}` explicitly.
288
+ *
289
+ * > **Note:** You may declare sensitive variables for secrets `configSensitive` block and set them using environment variables (for example, `export TF_VAR_aws_access_key_id="foo"`).
290
+ */
100
291
  status?: pulumi.Input<string>;
101
292
  }
package/connector.js CHANGED
@@ -6,6 +6,176 @@ exports.Connector = void 0;
6
6
  const pulumi = require("@pulumi/pulumi");
7
7
  const utilities = require("./utilities");
8
8
  /**
9
+ * ## Example Usage
10
+ * ### Example Managed [Datagen Source Connector](https://docs.confluent.io/cloud/current/connectors/cc-datagen-source.html) that uses a service account to communicate with your Kafka cluster
11
+ * ```typescript
12
+ * import * as pulumi from "@pulumi/pulumi";
13
+ * import * as confluentcloud from "@pulumi/confluentcloud";
14
+ *
15
+ * const source = new confluentcloud.Connector("source", {
16
+ * environment: {
17
+ * id: confluent_environment.staging.id,
18
+ * },
19
+ * kafkaCluster: {
20
+ * id: confluent_kafka_cluster.basic.id,
21
+ * },
22
+ * configSensitive: {},
23
+ * configNonsensitive: {
24
+ * "connector.class": "DatagenSource",
25
+ * name: "DatagenSourceConnector_0",
26
+ * "kafka.auth.mode": "SERVICE_ACCOUNT",
27
+ * "kafka.service.account.id": confluent_service_account["app-connector"].id,
28
+ * "kafka.topic": confluent_kafka_topic.orders.topic_name,
29
+ * "output.data.format": "JSON",
30
+ * quickstart: "ORDERS",
31
+ * "tasks.max": "1",
32
+ * },
33
+ * }, {
34
+ * dependsOn: [
35
+ * confluent_kafka_acl["app-connector-describe-on-cluster"],
36
+ * confluent_kafka_acl["app-connector-write-on-target-topic"],
37
+ * confluent_kafka_acl["app-connector-create-on-data-preview-topics"],
38
+ * confluent_kafka_acl["app-connector-write-on-data-preview-topics"],
39
+ * ],
40
+ * });
41
+ * ```
42
+ * ### Example Managed [Amazon S3 Sink Connector](https://docs.confluent.io/cloud/current/connectors/cc-s3-sink.html) that uses a service account to communicate with your Kafka cluster
43
+ * ```typescript
44
+ * import * as pulumi from "@pulumi/pulumi";
45
+ * import * as confluentcloud from "@pulumi/confluentcloud";
46
+ *
47
+ * const sink = new confluentcloud.Connector("sink", {
48
+ * environment: {
49
+ * id: confluent_environment.staging.id,
50
+ * },
51
+ * kafkaCluster: {
52
+ * id: confluent_kafka_cluster.basic.id,
53
+ * },
54
+ * configSensitive: {
55
+ * "aws.access.key.id": "***REDACTED***",
56
+ * "aws.secret.access.key": "***REDACTED***",
57
+ * },
58
+ * configNonsensitive: {
59
+ * topics: confluent_kafka_topic.orders.topic_name,
60
+ * "input.data.format": "JSON",
61
+ * "connector.class": "S3_SINK",
62
+ * name: "S3_SINKConnector_0",
63
+ * "kafka.auth.mode": "SERVICE_ACCOUNT",
64
+ * "kafka.service.account.id": confluent_service_account["app-connector"].id,
65
+ * "s3.bucket.name": "<s3-bucket-name>",
66
+ * "output.data.format": "JSON",
67
+ * "time.interval": "DAILY",
68
+ * "flush.size": "1000",
69
+ * "tasks.max": "1",
70
+ * },
71
+ * }, {
72
+ * dependsOn: [
73
+ * confluent_kafka_acl["app-connector-describe-on-cluster"],
74
+ * confluent_kafka_acl["app-connector-read-on-target-topic"],
75
+ * confluent_kafka_acl["app-connector-create-on-dlq-lcc-topics"],
76
+ * confluent_kafka_acl["app-connector-write-on-dlq-lcc-topics"],
77
+ * confluent_kafka_acl["app-connector-create-on-success-lcc-topics"],
78
+ * confluent_kafka_acl["app-connector-write-on-success-lcc-topics"],
79
+ * confluent_kafka_acl["app-connector-create-on-error-lcc-topics"],
80
+ * confluent_kafka_acl["app-connector-write-on-error-lcc-topics"],
81
+ * confluent_kafka_acl["app-connector-read-on-connect-lcc-group"],
82
+ * ],
83
+ * });
84
+ * ```
85
+ * ### Example Managed [Amazon DynamoDB Connector](https://docs.confluent.io/cloud/current/connectors/cc-amazon-dynamo-db-sink.html) that uses a service account to communicate with your Kafka cluster
86
+ * ```typescript
87
+ * import * as pulumi from "@pulumi/pulumi";
88
+ * import * as confluentcloud from "@pulumi/confluentcloud";
89
+ *
90
+ * const sink = new confluentcloud.Connector("sink", {
91
+ * environment: {
92
+ * id: confluent_environment.staging.id,
93
+ * },
94
+ * kafkaCluster: {
95
+ * id: confluent_kafka_cluster.basic.id,
96
+ * },
97
+ * configSensitive: {
98
+ * "aws.access.key.id": "***REDACTED***",
99
+ * "aws.secret.access.key": "***REDACTED***",
100
+ * },
101
+ * configNonsensitive: {
102
+ * topics: confluent_kafka_topic.orders.topic_name,
103
+ * "input.data.format": "JSON",
104
+ * "connector.class": "DynamoDbSink",
105
+ * name: "DynamoDbSinkConnector_0",
106
+ * "kafka.auth.mode": "SERVICE_ACCOUNT",
107
+ * "kafka.service.account.id": confluent_service_account["app-connector"].id,
108
+ * "aws.dynamodb.pk.hash": "value.userid",
109
+ * "aws.dynamodb.pk.sort": "value.pageid",
110
+ * "tasks.max": "1",
111
+ * },
112
+ * }, {
113
+ * dependsOn: [
114
+ * confluent_kafka_acl["app-connector-describe-on-cluster"],
115
+ * confluent_kafka_acl["app-connector-read-on-target-topic"],
116
+ * confluent_kafka_acl["app-connector-create-on-dlq-lcc-topics"],
117
+ * confluent_kafka_acl["app-connector-write-on-dlq-lcc-topics"],
118
+ * confluent_kafka_acl["app-connector-create-on-success-lcc-topics"],
119
+ * confluent_kafka_acl["app-connector-write-on-success-lcc-topics"],
120
+ * confluent_kafka_acl["app-connector-create-on-error-lcc-topics"],
121
+ * confluent_kafka_acl["app-connector-write-on-error-lcc-topics"],
122
+ * confluent_kafka_acl["app-connector-read-on-connect-lcc-group"],
123
+ * ],
124
+ * });
125
+ * ```
126
+ * ### Example Custom [Datagen Source Connector](https://www.confluent.io/hub/confluentinc/kafka-connect-datagen) that uses a Kafka API Key to communicate with your Kafka cluster
127
+ *
128
+ * ```typescript
129
+ * import * as pulumi from "@pulumi/pulumi";
130
+ * import * as confluentcloud from "@pulumi/confluentcloud";
131
+ *
132
+ * const source = new confluentcloud.Connector("source", {
133
+ * environment: {
134
+ * id: confluent_environment.staging.id,
135
+ * },
136
+ * kafkaCluster: {
137
+ * id: confluent_kafka_cluster.basic.id,
138
+ * },
139
+ * configSensitive: {
140
+ * "kafka.api.key": "***REDACTED***",
141
+ * "kafka.api.secret": "***REDACTED***",
142
+ * },
143
+ * configNonsensitive: {
144
+ * "confluent.connector.type": "CUSTOM",
145
+ * "connector.class": confluent_custom_connector_plugin.source.connector_class,
146
+ * name: "DatagenConnectorExampleName",
147
+ * "kafka.auth.mode": "KAFKA_API_KEY",
148
+ * "kafka.topic": confluent_kafka_topic.orders.topic_name,
149
+ * "output.data.format": "JSON",
150
+ * quickstart: "ORDERS",
151
+ * "confluent.custom.plugin.id": confluent_custom_connector_plugin.source.id,
152
+ * "min.interval": "1000",
153
+ * "max.interval": "2000",
154
+ * "tasks.max": "1",
155
+ * },
156
+ * }, {
157
+ * dependsOn: [confluent_role_binding["app-manager-kafka-cluster-admin"]],
158
+ * });
159
+ * ```
160
+ *
161
+ * > **Note:** Custom connectors are available in **Preview** for early adopters. Preview features are introduced to gather customer feedback. This feature should be used only for evaluation and non-production testing purposes or to provide feedback to Confluent, particularly as it becomes more widely available in follow-on editions.\
162
+ * **Preview** features are intended for evaluation use in development and testing environments only, and not for production use. The warranty, SLA, and Support Services provisions of your agreement with Confluent do not apply to Preview features. Preview features are considered to be a Proof of Concept as defined in the Confluent Cloud Terms of Service. Confluent may discontinue providing preview releases of the Preview features at any time in Confluent’s sole discretion.
163
+ * ## Getting Started
164
+ *
165
+ * The following end-to-end examples might help to get started with `confluentcloud.Connector` resource:
166
+ * * `s3-sink-connector`
167
+ * * `snowflake-sink-connector`
168
+ * * `managed-datagen-source-connector`
169
+ * * `elasticsearch-sink-connector`
170
+ * * `dynamo-db-sink-connector`
171
+ * * `mongo-db-source-connector`
172
+ * * `mongo-db-sink-connector`
173
+ * * `sql-server-cdc-debezium-source-connector`
174
+ * * `postgre-sql-cdc-debezium-source-connector`
175
+ * * `custom-datagen-source-connector`
176
+ *
177
+ * > **Note:** Certain connectors require additional ACL entries. See [Additional ACL entries](https://docs.confluent.io/cloud/current/connectors/service-account.html#additional-acl-entries) for more details.
178
+ *
9
179
  * ## Import
10
180
  *
11
181
  * You can import a connector by using Environment ID, Kafka cluster ID, and connector's name, in the format `<Environment ID>/<Kafka cluster ID>/<Connector name>`, for example$ export CONFLUENT_CLOUD_API_KEY="<cloud_api_key>" $ export CONFLUENT_CLOUD_API_SECRET="<cloud_api_secret>"
package/connector.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"connector.js","sourceRoot":"","sources":["../connector.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AAGzC,yCAAyC;AAEzC;;;;;;;;GAQG;AACH,MAAa,SAAU,SAAQ,MAAM,CAAC,cAAc;IAChD;;;;;;;;OAQG;IACI,MAAM,CAAC,GAAG,CAAC,IAAY,EAAE,EAA2B,EAAE,KAAsB,EAAE,IAAmC;QACpH,OAAO,IAAI,SAAS,CAAC,IAAI,EAAO,KAAK,kCAAO,IAAI,KAAE,EAAE,EAAE,EAAE,IAAG,CAAC;IAChE,CAAC;IAKD;;;OAGG;IACI,MAAM,CAAC,UAAU,CAAC,GAAQ;QAC7B,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI,EAAE;YACnC,OAAO,KAAK,CAAC;SAChB;QACD,OAAO,GAAG,CAAC,cAAc,CAAC,KAAK,SAAS,CAAC,YAAY,CAAC;IAC1D,CAAC;IAyBD,YAAY,IAAY,EAAE,WAA4C,EAAE,IAAmC;QACvG,IAAI,cAAc,GAAkB,EAAE,CAAC;QACvC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAClB,IAAI,IAAI,CAAC,EAAE,EAAE;YACT,MAAM,KAAK,GAAG,WAAyC,CAAC;YACxD,cAAc,CAAC,oBAAoB,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC,CAAC,SAAS,CAAC;YACpF,cAAc,CAAC,iBAAiB,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC,SAAS,CAAC;YAC9E,cAAc,CAAC,aAAa,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;YACtE,cAAc,CAAC,cAAc,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC;YACxE,cAAc,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;SAC/D;aAAM;YACH,MAAM,IAAI,GAAG,WAAwC,CAAC;YACtD,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,kBAAkB,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBAC/D,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC;aACrE;YACD,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,WAAW,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACxD,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;aAC9D;YACD,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,YAAY,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACzD,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC;aAC/D;YACD,cAAc,CAAC,oBAAoB,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,CAAC,SAAS,CAAC;YAClF,cAAc,CAAC,iBAAiB,CAAC,GAAG,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,eAAe,EAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YAC5G,cAAc,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;YACpE,cAAc,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC;YACtE,cAAc,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;SAC7D;QACD,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,CAAC;QACnE,MAAM,UAAU,GAAG,EAAE,uBAAuB,EAAE,CAAC,iBAAiB,CAAC,EAAE,CAAC;QACpE,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;QAC7C,KAAK,CAAC,SAAS,CAAC,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,CAAC;IAC9D,CAAC;;AAlFL,8BAmFC;AArEG,gBAAgB;AACO,sBAAY,GAAG,0CAA0C,CAAC"}
1
+ {"version":3,"file":"connector.js","sourceRoot":"","sources":["../connector.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AAGzC,yCAAyC;AAEzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkLG;AACH,MAAa,SAAU,SAAQ,MAAM,CAAC,cAAc;IAChD;;;;;;;;OAQG;IACI,MAAM,CAAC,GAAG,CAAC,IAAY,EAAE,EAA2B,EAAE,KAAsB,EAAE,IAAmC;QACpH,OAAO,IAAI,SAAS,CAAC,IAAI,EAAO,KAAK,kCAAO,IAAI,KAAE,EAAE,EAAE,EAAE,IAAG,CAAC;IAChE,CAAC;IAKD;;;OAGG;IACI,MAAM,CAAC,UAAU,CAAC,GAAQ;QAC7B,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI,EAAE;YACnC,OAAO,KAAK,CAAC;SAChB;QACD,OAAO,GAAG,CAAC,cAAc,CAAC,KAAK,SAAS,CAAC,YAAY,CAAC;IAC1D,CAAC;IAgCD,YAAY,IAAY,EAAE,WAA4C,EAAE,IAAmC;QACvG,IAAI,cAAc,GAAkB,EAAE,CAAC;QACvC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAClB,IAAI,IAAI,CAAC,EAAE,EAAE;YACT,MAAM,KAAK,GAAG,WAAyC,CAAC;YACxD,cAAc,CAAC,oBAAoB,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC,CAAC,SAAS,CAAC;YACpF,cAAc,CAAC,iBAAiB,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC,SAAS,CAAC;YAC9E,cAAc,CAAC,aAAa,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;YACtE,cAAc,CAAC,cAAc,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC;YACxE,cAAc,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;SAC/D;aAAM;YACH,MAAM,IAAI,GAAG,WAAwC,CAAC;YACtD,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,kBAAkB,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBAC/D,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC;aACrE;YACD,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,WAAW,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACxD,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;aAC9D;YACD,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,YAAY,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACzD,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC;aAC/D;YACD,cAAc,CAAC,oBAAoB,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,CAAC,SAAS,CAAC;YAClF,cAAc,CAAC,iBAAiB,CAAC,GAAG,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,eAAe,EAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YAC5G,cAAc,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;YACpE,cAAc,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC;YACtE,cAAc,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;SAC7D;QACD,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,CAAC;QACnE,MAAM,UAAU,GAAG,EAAE,uBAAuB,EAAE,CAAC,iBAAiB,CAAC,EAAE,CAAC;QACpE,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;QAC7C,KAAK,CAAC,SAAS,CAAC,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,CAAC;IAC9D,CAAC;;AAzFL,8BA0FC;AA5EG,gBAAgB;AACO,sBAAY,GAAG,0CAA0C,CAAC"}
package/environment.d.ts CHANGED
@@ -1,5 +1,30 @@
1
1
  import * as pulumi from "@pulumi/pulumi";
2
2
  /**
3
+ * ## Getting Started
4
+ *
5
+ * The following end-to-end examples might help to get started with `confluentcloud.Environment` resource:
6
+ * * `basic-kafka-acls`: _Basic_ Kafka cluster with authorization using ACLs
7
+ * * `basic-kafka-acls-with-alias`: _Basic_ Kafka cluster with authorization using ACLs
8
+ * * `standard-kafka-acls`: _Standard_ Kafka cluster with authorization using ACLs
9
+ * * `standard-kafka-rbac`: _Standard_ Kafka cluster with authorization using RBAC
10
+ * * `dedicated-public-kafka-acls`: _Dedicated_ Kafka cluster that is accessible over the public internet with authorization using ACLs
11
+ * * `dedicated-public-kafka-rbac`: _Dedicated_ Kafka cluster that is accessible over the public internet with authorization using RBAC
12
+ * * `dedicated-privatelink-aws-kafka-acls`: _Dedicated_ Kafka cluster on AWS that is accessible via PrivateLink connections with authorization using ACLs
13
+ * * `dedicated-privatelink-aws-kafka-rbac`: _Dedicated_ Kafka cluster on AWS that is accessible via PrivateLink connections with authorization using RBAC
14
+ * * `dedicated-privatelink-azure-kafka-rbac`: _Dedicated_ Kafka cluster on Azure that is accessible via PrivateLink connections with authorization using RBAC
15
+ * * `dedicated-privatelink-azure-kafka-acls`: _Dedicated_ Kafka cluster on Azure that is accessible via PrivateLink connections with authorization using ACLs
16
+ * * `dedicated-private-service-connect-gcp-kafka-acls`: _Dedicated_ Kafka cluster on GCP that is accessible via Private Service Connect connections with authorization using ACLs
17
+ * * `dedicated-private-service-connect-gcp-kafka-rbac`: _Dedicated_ Kafka cluster on GCP that is accessible via Private Service Connect connections with authorization using RBAC
18
+ * * `dedicated-vnet-peering-azure-kafka-acls`: _Dedicated_ Kafka cluster on Azure that is accessible via VPC Peering connections with authorization using ACLs
19
+ * * `dedicated-vnet-peering-azure-kafka-rbac`: _Dedicated_ Kafka cluster on Azure that is accessible via VPC Peering connections with authorization using RBAC
20
+ * * `dedicated-vpc-peering-aws-kafka-acls`: _Dedicated_ Kafka cluster on AWS that is accessible via VPC Peering connections with authorization using ACLs
21
+ * * `dedicated-vpc-peering-aws-kafka-rbac`: _Dedicated_ Kafka cluster on AWS that is accessible via VPC Peering connections with authorization using RBAC
22
+ * * `dedicated-vpc-peering-gcp-kafka-acls`: _Dedicated_ Kafka cluster on GCP that is accessible via VPC Peering connections with authorization using ACLs
23
+ * * `dedicated-vpc-peering-gcp-kafka-rbac`: _Dedicated_ Kafka cluster on GCP that is accessible via VPC Peering connections with authorization using RBAC
24
+ * * `dedicated-transit-gateway-attachment-aws-kafka-acls`: _Dedicated_ Kafka cluster on AWS that is accessible via Transit Gateway Endpoint with authorization using ACLs
25
+ * * `dedicated-transit-gateway-attachment-aws-kafka-rbac`: _Dedicated_ Kafka cluster on AWS that is accessible via Transit Gateway Endpoint with authorization using RBAC
26
+ * * `enterprise-privatelinkattachment-aws-kafka-acls`: _Enterprise_ Kafka cluster on AWS that is accessible via PrivateLink connections with authorization using ACLs
27
+ *
3
28
  * ## Import
4
29
  *
5
30
  * You can import an Environment by using Environment ID, for example$ export CONFLUENT_CLOUD_API_KEY="<cloud_api_key>" $ export CONFLUENT_CLOUD_API_SECRET="<cloud_api_secret>"
package/environment.js CHANGED
@@ -6,6 +6,31 @@ exports.Environment = void 0;
6
6
  const pulumi = require("@pulumi/pulumi");
7
7
  const utilities = require("./utilities");
8
8
  /**
9
+ * ## Getting Started
10
+ *
11
+ * The following end-to-end examples might help to get started with `confluentcloud.Environment` resource:
12
+ * * `basic-kafka-acls`: _Basic_ Kafka cluster with authorization using ACLs
13
+ * * `basic-kafka-acls-with-alias`: _Basic_ Kafka cluster with authorization using ACLs
14
+ * * `standard-kafka-acls`: _Standard_ Kafka cluster with authorization using ACLs
15
+ * * `standard-kafka-rbac`: _Standard_ Kafka cluster with authorization using RBAC
16
+ * * `dedicated-public-kafka-acls`: _Dedicated_ Kafka cluster that is accessible over the public internet with authorization using ACLs
17
+ * * `dedicated-public-kafka-rbac`: _Dedicated_ Kafka cluster that is accessible over the public internet with authorization using RBAC
18
+ * * `dedicated-privatelink-aws-kafka-acls`: _Dedicated_ Kafka cluster on AWS that is accessible via PrivateLink connections with authorization using ACLs
19
+ * * `dedicated-privatelink-aws-kafka-rbac`: _Dedicated_ Kafka cluster on AWS that is accessible via PrivateLink connections with authorization using RBAC
20
+ * * `dedicated-privatelink-azure-kafka-rbac`: _Dedicated_ Kafka cluster on Azure that is accessible via PrivateLink connections with authorization using RBAC
21
+ * * `dedicated-privatelink-azure-kafka-acls`: _Dedicated_ Kafka cluster on Azure that is accessible via PrivateLink connections with authorization using ACLs
22
+ * * `dedicated-private-service-connect-gcp-kafka-acls`: _Dedicated_ Kafka cluster on GCP that is accessible via Private Service Connect connections with authorization using ACLs
23
+ * * `dedicated-private-service-connect-gcp-kafka-rbac`: _Dedicated_ Kafka cluster on GCP that is accessible via Private Service Connect connections with authorization using RBAC
24
+ * * `dedicated-vnet-peering-azure-kafka-acls`: _Dedicated_ Kafka cluster on Azure that is accessible via VPC Peering connections with authorization using ACLs
25
+ * * `dedicated-vnet-peering-azure-kafka-rbac`: _Dedicated_ Kafka cluster on Azure that is accessible via VPC Peering connections with authorization using RBAC
26
+ * * `dedicated-vpc-peering-aws-kafka-acls`: _Dedicated_ Kafka cluster on AWS that is accessible via VPC Peering connections with authorization using ACLs
27
+ * * `dedicated-vpc-peering-aws-kafka-rbac`: _Dedicated_ Kafka cluster on AWS that is accessible via VPC Peering connections with authorization using RBAC
28
+ * * `dedicated-vpc-peering-gcp-kafka-acls`: _Dedicated_ Kafka cluster on GCP that is accessible via VPC Peering connections with authorization using ACLs
29
+ * * `dedicated-vpc-peering-gcp-kafka-rbac`: _Dedicated_ Kafka cluster on GCP that is accessible via VPC Peering connections with authorization using RBAC
30
+ * * `dedicated-transit-gateway-attachment-aws-kafka-acls`: _Dedicated_ Kafka cluster on AWS that is accessible via Transit Gateway Endpoint with authorization using ACLs
31
+ * * `dedicated-transit-gateway-attachment-aws-kafka-rbac`: _Dedicated_ Kafka cluster on AWS that is accessible via Transit Gateway Endpoint with authorization using RBAC
32
+ * * `enterprise-privatelinkattachment-aws-kafka-acls`: _Enterprise_ Kafka cluster on AWS that is accessible via PrivateLink connections with authorization using ACLs
33
+ *
9
34
  * ## Import
10
35
  *
11
36
  * You can import an Environment by using Environment ID, for example$ export CONFLUENT_CLOUD_API_KEY="<cloud_api_key>" $ export CONFLUENT_CLOUD_API_SECRET="<cloud_api_secret>"
@@ -1 +1 @@
1
- {"version":3,"file":"environment.js","sourceRoot":"","sources":["../environment.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC;;;;;;;;;;GAUG;AACH,MAAa,WAAY,SAAQ,MAAM,CAAC,cAAc;IAClD;;;;;;;;OAQG;IACI,MAAM,CAAC,GAAG,CAAC,IAAY,EAAE,EAA2B,EAAE,KAAwB,EAAE,IAAmC;QACtH,OAAO,IAAI,WAAW,CAAC,IAAI,EAAO,KAAK,kCAAO,IAAI,KAAE,EAAE,EAAE,EAAE,IAAG,CAAC;IAClE,CAAC;IAKD;;;OAGG;IACI,MAAM,CAAC,UAAU,CAAC,GAAQ;QAC7B,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI,EAAE;YACnC,OAAO,KAAK,CAAC;SAChB;QACD,OAAO,GAAG,CAAC,cAAc,CAAC,KAAK,WAAW,CAAC,YAAY,CAAC;IAC5D,CAAC;IAmBD,YAAY,IAAY,EAAE,WAAgD,EAAE,IAAmC;QAC3G,IAAI,cAAc,GAAkB,EAAE,CAAC;QACvC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAClB,IAAI,IAAI,CAAC,EAAE,EAAE;YACT,MAAM,KAAK,GAAG,WAA2C,CAAC;YAC1D,cAAc,CAAC,aAAa,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;YACtE,cAAc,CAAC,cAAc,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC;SAC3E;aAAM;YACH,MAAM,IAAI,GAAG,WAA0C,CAAC;YACxD,cAAc,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;YACpE,cAAc,CAAC,cAAc,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;SACtD;QACD,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,CAAC;QACnE,KAAK,CAAC,WAAW,CAAC,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,CAAC;IAChE,CAAC;;AA3DL,kCA4DC;AA9CG,gBAAgB;AACO,wBAAY,GAAG,8CAA8C,CAAC"}
1
+ {"version":3,"file":"environment.js","sourceRoot":"","sources":["../environment.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,MAAa,WAAY,SAAQ,MAAM,CAAC,cAAc;IAClD;;;;;;;;OAQG;IACI,MAAM,CAAC,GAAG,CAAC,IAAY,EAAE,EAA2B,EAAE,KAAwB,EAAE,IAAmC;QACtH,OAAO,IAAI,WAAW,CAAC,IAAI,EAAO,KAAK,kCAAO,IAAI,KAAE,EAAE,EAAE,EAAE,IAAG,CAAC;IAClE,CAAC;IAKD;;;OAGG;IACI,MAAM,CAAC,UAAU,CAAC,GAAQ;QAC7B,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI,EAAE;YACnC,OAAO,KAAK,CAAC;SAChB;QACD,OAAO,GAAG,CAAC,cAAc,CAAC,KAAK,WAAW,CAAC,YAAY,CAAC;IAC5D,CAAC;IAmBD,YAAY,IAAY,EAAE,WAAgD,EAAE,IAAmC;QAC3G,IAAI,cAAc,GAAkB,EAAE,CAAC;QACvC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAClB,IAAI,IAAI,CAAC,EAAE,EAAE;YACT,MAAM,KAAK,GAAG,WAA2C,CAAC;YAC1D,cAAc,CAAC,aAAa,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;YACtE,cAAc,CAAC,cAAc,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC;SAC3E;aAAM;YACH,MAAM,IAAI,GAAG,WAA0C,CAAC;YACxD,cAAc,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;YACpE,cAAc,CAAC,cAAc,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;SACtD;QACD,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,CAAC;QACnE,KAAK,CAAC,WAAW,CAAC,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,CAAC;IAChE,CAAC;;AA3DL,kCA4DC;AA9CG,gBAAgB;AACO,wBAAY,GAAG,8CAA8C,CAAC"}
package/kafkaCluster.d.ts CHANGED
@@ -2,6 +2,143 @@ import * as pulumi from "@pulumi/pulumi";
2
2
  import * as inputs from "./types/input";
3
3
  import * as outputs from "./types/output";
4
4
  /**
5
+ * ## Example Usage
6
+ * ### Example Kafka clusters on AWS
7
+ *
8
+ * ```typescript
9
+ * import * as pulumi from "@pulumi/pulumi";
10
+ * import * as confluentcloud from "@pulumi/confluentcloud";
11
+ *
12
+ * const development = new confluentcloud.Environment("development", {});
13
+ * const basic = new confluentcloud.KafkaCluster("basic", {
14
+ * availability: "SINGLE_ZONE",
15
+ * cloud: "AWS",
16
+ * region: "us-east-2",
17
+ * basic: {},
18
+ * environment: {
19
+ * id: development.id,
20
+ * },
21
+ * });
22
+ * const standard = new confluentcloud.KafkaCluster("standard", {
23
+ * availability: "SINGLE_ZONE",
24
+ * cloud: "AWS",
25
+ * region: "us-east-2",
26
+ * standard: {},
27
+ * environment: {
28
+ * id: development.id,
29
+ * },
30
+ * });
31
+ * const dedicated = new confluentcloud.KafkaCluster("dedicated", {
32
+ * availability: "MULTI_ZONE",
33
+ * cloud: "AWS",
34
+ * region: "us-east-2",
35
+ * dedicated: {
36
+ * cku: 2,
37
+ * },
38
+ * environment: {
39
+ * id: development.id,
40
+ * },
41
+ * });
42
+ * ```
43
+ * ### Example Kafka clusters on Azure
44
+ *
45
+ * ```typescript
46
+ * import * as pulumi from "@pulumi/pulumi";
47
+ * import * as confluentcloud from "@pulumi/confluentcloud";
48
+ *
49
+ * const development = new confluentcloud.Environment("development", {});
50
+ * const basic = new confluentcloud.KafkaCluster("basic", {
51
+ * availability: "SINGLE_ZONE",
52
+ * cloud: "AZURE",
53
+ * region: "centralus",
54
+ * basic: {},
55
+ * environment: {
56
+ * id: development.id,
57
+ * },
58
+ * });
59
+ * const standard = new confluentcloud.KafkaCluster("standard", {
60
+ * availability: "SINGLE_ZONE",
61
+ * cloud: "AZURE",
62
+ * region: "centralus",
63
+ * standard: {},
64
+ * environment: {
65
+ * id: development.id,
66
+ * },
67
+ * });
68
+ * const dedicated = new confluentcloud.KafkaCluster("dedicated", {
69
+ * availability: "MULTI_ZONE",
70
+ * cloud: "AZURE",
71
+ * region: "centralus",
72
+ * dedicated: {
73
+ * cku: 2,
74
+ * },
75
+ * environment: {
76
+ * id: development.id,
77
+ * },
78
+ * });
79
+ * ```
80
+ * ### Example Kafka clusters on GCP
81
+ *
82
+ * ```typescript
83
+ * import * as pulumi from "@pulumi/pulumi";
84
+ * import * as confluentcloud from "@pulumi/confluentcloud";
85
+ *
86
+ * const development = new confluentcloud.Environment("development", {});
87
+ * const basic = new confluentcloud.KafkaCluster("basic", {
88
+ * availability: "SINGLE_ZONE",
89
+ * cloud: "GCP",
90
+ * region: "us-central1",
91
+ * basic: {},
92
+ * environment: {
93
+ * id: development.id,
94
+ * },
95
+ * });
96
+ * const standard = new confluentcloud.KafkaCluster("standard", {
97
+ * availability: "SINGLE_ZONE",
98
+ * cloud: "GCP",
99
+ * region: "us-central1",
100
+ * standard: {},
101
+ * environment: {
102
+ * id: development.id,
103
+ * },
104
+ * });
105
+ * const dedicated = new confluentcloud.KafkaCluster("dedicated", {
106
+ * availability: "MULTI_ZONE",
107
+ * cloud: "GCP",
108
+ * region: "us-central1",
109
+ * dedicated: {
110
+ * cku: 2,
111
+ * },
112
+ * environment: {
113
+ * id: development.id,
114
+ * },
115
+ * });
116
+ * ```
117
+ * ## Getting Started
118
+ *
119
+ * The following end-to-end examples might help to get started with `confluentcloud.KafkaCluster` resource:
120
+ * * `basic-kafka-acls`: _Basic_ Kafka cluster with authorization using ACLs
121
+ * * `basic-kafka-acls-with-alias`: _Basic_ Kafka cluster with authorization using ACLs
122
+ * * `standard-kafka-acls`: _Standard_ Kafka cluster with authorization using ACLs
123
+ * * `standard-kafka-rbac`: _Standard_ Kafka cluster with authorization using RBAC
124
+ * * `dedicated-public-kafka-acls`: _Dedicated_ Kafka cluster that is accessible over the public internet with authorization using ACLs
125
+ * * `dedicated-public-kafka-rbac`: _Dedicated_ Kafka cluster that is accessible over the public internet with authorization using RBAC
126
+ * * `dedicated-privatelink-aws-kafka-acls`: _Dedicated_ Kafka cluster on AWS that is accessible via PrivateLink connections with authorization using ACLs
127
+ * * `dedicated-privatelink-aws-kafka-rbac`: _Dedicated_ Kafka cluster on AWS that is accessible via PrivateLink connections with authorization using RBAC
128
+ * * `dedicated-privatelink-azure-kafka-rbac`: _Dedicated_ Kafka cluster on Azure that is accessible via PrivateLink connections with authorization using RBAC
129
+ * * `dedicated-privatelink-azure-kafka-acls`: _Dedicated_ Kafka cluster on Azure that is accessible via PrivateLink connections with authorization using ACLs
130
+ * * `dedicated-private-service-connect-gcp-kafka-acls`: _Dedicated_ Kafka cluster on GCP that is accessible via Private Service Connect connections with authorization using ACLs
131
+ * * `dedicated-private-service-connect-gcp-kafka-rbac`: _Dedicated_ Kafka cluster on GCP that is accessible via Private Service Connect connections with authorization using RBAC
132
+ * * `dedicated-vnet-peering-azure-kafka-acls`: _Dedicated_ Kafka cluster on Azure that is accessible via VPC Peering connections with authorization using ACLs
133
+ * * `dedicated-vnet-peering-azure-kafka-rbac`: _Dedicated_ Kafka cluster on Azure that is accessible via VPC Peering connections with authorization using RBAC
134
+ * * `dedicated-vpc-peering-aws-kafka-acls`: _Dedicated_ Kafka cluster on AWS that is accessible via VPC Peering connections with authorization using ACLs
135
+ * * `dedicated-vpc-peering-aws-kafka-rbac`: _Dedicated_ Kafka cluster on AWS that is accessible via VPC Peering connections with authorization using RBAC
136
+ * * `dedicated-vpc-peering-gcp-kafka-acls`: _Dedicated_ Kafka cluster on GCP that is accessible via VPC Peering connections with authorization using ACLs
137
+ * * `dedicated-vpc-peering-gcp-kafka-rbac`: _Dedicated_ Kafka cluster on GCP that is accessible via VPC Peering connections with authorization using RBAC
138
+ * * `dedicated-transit-gateway-attachment-aws-kafka-acls`: _Dedicated_ Kafka cluster on AWS that is accessible via Transit Gateway Endpoint with authorization using ACLs
139
+ * * `dedicated-transit-gateway-attachment-aws-kafka-rbac`: _Dedicated_ Kafka cluster on AWS that is accessible via Transit Gateway Endpoint with authorization using RBAC
140
+ * * `enterprise-privatelinkattachment-aws-kafka-acls`: _Enterprise_ Kafka cluster on AWS that is accessible via PrivateLink connections with authorization using ACLs
141
+ *
5
142
  * ## Import
6
143
  *
7
144
  * You can import a Kafka cluster by using Environment ID and Kafka cluster ID, in the format `<Environment ID>/<Kafka cluster ID>`, e.g. $ export CONFLUENT_CLOUD_API_KEY="<cloud_api_key>" $ export CONFLUENT_CLOUD_API_SECRET="<cloud_api_secret>"