@aws-cdk/aws-msk-alpha 2.4.0-alpha.0 → 2.8.0-alpha.0
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.
- package/.jsii +19 -16
- package/.jsii.tabl.json +409 -321
- package/README.md +59 -51
- package/lib/cluster-version.js +1 -1
- package/lib/cluster.js +2 -2
- package/package.json +17 -10
- package/rosetta/default.ts-fixture +12 -0
package/.jsii
CHANGED
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
"url": "https://aws.amazon.com"
|
|
9
9
|
},
|
|
10
10
|
"dependencies": {
|
|
11
|
-
"aws-cdk-lib": "^2.
|
|
11
|
+
"aws-cdk-lib": "^2.8.0",
|
|
12
12
|
"constructs": "^10.0.0"
|
|
13
13
|
},
|
|
14
14
|
"dependencyClosure": {
|
|
@@ -2855,7 +2855,7 @@
|
|
|
2855
2855
|
"stability": "experimental"
|
|
2856
2856
|
},
|
|
2857
2857
|
"homepage": "https://github.com/aws/aws-cdk",
|
|
2858
|
-
"jsiiVersion": "1.
|
|
2858
|
+
"jsiiVersion": "1.52.1 (build 5ccc8f6)",
|
|
2859
2859
|
"keywords": [
|
|
2860
2860
|
"aws",
|
|
2861
2861
|
"cdk",
|
|
@@ -2869,12 +2869,15 @@
|
|
|
2869
2869
|
"compiledWithDeprecationWarnings": true,
|
|
2870
2870
|
"pacmak": {
|
|
2871
2871
|
"hasDefaultInterfaces": true
|
|
2872
|
+
},
|
|
2873
|
+
"rosetta": {
|
|
2874
|
+
"strict": true
|
|
2872
2875
|
}
|
|
2873
2876
|
}
|
|
2874
2877
|
},
|
|
2875
2878
|
"name": "@aws-cdk/aws-msk-alpha",
|
|
2876
2879
|
"readme": {
|
|
2877
|
-
"markdown": "# Amazon Managed Streaming for Apache Kafka Construct Library\n<!--BEGIN STABILITY BANNER-->\n\n---\n\n\n\n> The APIs of higher level constructs in this module are experimental and under active development.\n> They are subject to non-backward compatible changes or removal in any future version. These are\n> not subject to the [Semantic Versioning](https://semver.org/) model and breaking changes will be\n> announced in the release notes. This means that while you may use them, you may need to update\n> your source code when upgrading to a newer version of this package.\n\n---\n\n<!--END STABILITY BANNER-->\n\n[Amazon MSK](https://aws.amazon.com/msk/) is a fully managed service that makes it easy for you to build and run applications that use Apache Kafka to process streaming data.\n\nThe following example creates an MSK Cluster.\n\n```ts\
|
|
2880
|
+
"markdown": "# Amazon Managed Streaming for Apache Kafka Construct Library\n<!--BEGIN STABILITY BANNER-->\n\n---\n\n\n\n> The APIs of higher level constructs in this module are experimental and under active development.\n> They are subject to non-backward compatible changes or removal in any future version. These are\n> not subject to the [Semantic Versioning](https://semver.org/) model and breaking changes will be\n> announced in the release notes. This means that while you may use them, you may need to update\n> your source code when upgrading to a newer version of this package.\n\n---\n\n<!--END STABILITY BANNER-->\n\n[Amazon MSK](https://aws.amazon.com/msk/) is a fully managed service that makes it easy for you to build and run applications that use Apache Kafka to process streaming data.\n\nThe following example creates an MSK Cluster.\n\n```ts\ndeclare const vpc: ec2.Vpc;\nconst cluster = new msk.Cluster(this, 'Cluster', {\n clusterName: 'myCluster',\n kafkaVersion: msk.KafkaVersion.V2_8_1,\n vpc,\n});\n```\n\n## Allowing Connections\n\nTo control who can access the Cluster, use the `.connections` attribute. For a list of ports used by MSK, refer to the [MSK documentation](https://docs.aws.amazon.com/msk/latest/developerguide/client-access.html#port-info).\n\n```ts\ndeclare const vpc: ec2.Vpc;\nconst cluster = new msk.Cluster(this, 'Cluster', {\n clusterName: 'myCluster',\n kafkaVersion: msk.KafkaVersion.V2_8_1,\n vpc,\n});\n\ncluster.connections.allowFrom(\n ec2.Peer.ipv4('1.2.3.4/8'),\n ec2.Port.tcp(2181),\n);\ncluster.connections.allowFrom(\n ec2.Peer.ipv4('1.2.3.4/8'),\n ec2.Port.tcp(9094),\n);\n```\n\n## Cluster Endpoints\n\nYou can use the following attributes to get a list of the Kafka broker or ZooKeeper node endpoints\n\n```ts\ndeclare const cluster: msk.Cluster;\nnew CfnOutput(this, 'BootstrapBrokers', { value: cluster.bootstrapBrokers });\nnew CfnOutput(this, 'BootstrapBrokersTls', { value: cluster.bootstrapBrokersTls });\nnew CfnOutput(this, 'BootstrapBrokersSaslScram', { value: cluster.bootstrapBrokersSaslScram });\nnew CfnOutput(this, 'ZookeeperConnection', { value: cluster.zookeeperConnectionString });\nnew CfnOutput(this, 'ZookeeperConnectionTls', { value: cluster.zookeeperConnectionStringTls });\n```\n\n## Importing an existing Cluster\n\nTo import an existing MSK cluster into your CDK app use the `.fromClusterArn()` method.\n\n```ts\nconst cluster = msk.Cluster.fromClusterArn(this, 'Cluster',\n 'arn:aws:kafka:us-west-2:1234567890:cluster/a-cluster/11111111-1111-1111-1111-111111111111-1',\n);\n```\n\n## Client Authentication\n\n[MSK supports](https://docs.aws.amazon.com/msk/latest/developerguide/kafka_apis_iam.html) the following authentication mechanisms.\n\n> Only one authentication method can be enabled.\n\n### TLS\n\nTo enable client authentication with TLS set the `certificateAuthorityArns` property to reference your ACM Private CA. [More info on Private CAs.](https://docs.aws.amazon.com/msk/latest/developerguide/msk-authentication.html)\n\n```ts\nimport * as acmpca from 'aws-cdk-lib/aws-acmpca';\n\ndeclare const vpc: ec2.Vpc;\nconst cluster = new msk.Cluster(this, 'Cluster', {\n clusterName: 'myCluster',\n kafkaVersion: msk.KafkaVersion.V2_8_1,\n vpc,\n encryptionInTransit: {\n clientBroker: msk.ClientBrokerEncryption.TLS,\n },\n clientAuthentication: msk.ClientAuthentication.tls({\n certificateAuthorities: [\n acmpca.CertificateAuthority.fromCertificateAuthorityArn(\n this,\n 'CertificateAuthority',\n 'arn:aws:acm-pca:us-west-2:1234567890:certificate-authority/11111111-1111-1111-1111-111111111111',\n ),\n ],\n }),\n});\n```\n\n### SASL/SCRAM\n\nEnable client authentication with [SASL/SCRAM](https://docs.aws.amazon.com/msk/latest/developerguide/msk-password.html):\n\n```ts\ndeclare const vpc: ec2.Vpc;\nconst cluster = new msk.Cluster(this, 'cluster', {\n clusterName: 'myCluster',\n kafkaVersion: msk.KafkaVersion.V2_8_1,\n vpc,\n encryptionInTransit: {\n clientBroker: msk.ClientBrokerEncryption.TLS,\n },\n clientAuthentication: msk.ClientAuthentication.sasl({\n scram: true,\n }),\n});\n```\n\n### SASL/IAM\n\nEnable client authentication with [IAM](https://docs.aws.amazon.com/msk/latest/developerguide/iam-access-control.html):\n\n```ts\ndeclare const vpc: ec2.Vpc;\nconst cluster = new msk.Cluster(this, 'cluster', {\n clusterName: 'myCluster',\n kafkaVersion: msk.KafkaVersion.V2_8_1,\n vpc,\n encryptionInTransit: {\n clientBroker: msk.ClientBrokerEncryption.TLS,\n },\n clientAuthentication: msk.ClientAuthentication.sasl({\n iam: true,\n }),\n});\n```\n"
|
|
2878
2881
|
},
|
|
2879
2882
|
"repository": {
|
|
2880
2883
|
"directory": "packages/individual-packages/aws-msk",
|
|
@@ -2994,7 +2997,7 @@
|
|
|
2994
2997
|
"custom": {
|
|
2995
2998
|
"exampleMetadata": "infused"
|
|
2996
2999
|
},
|
|
2997
|
-
"example": "
|
|
3000
|
+
"example": "declare const vpc: ec2.Vpc;\nconst cluster = new msk.Cluster(this, 'cluster', {\n clusterName: 'myCluster',\n kafkaVersion: msk.KafkaVersion.V2_8_1,\n vpc,\n encryptionInTransit: {\n clientBroker: msk.ClientBrokerEncryption.TLS,\n },\n clientAuthentication: msk.ClientAuthentication.sasl({\n scram: true,\n }),\n});",
|
|
2998
3001
|
"stability": "experimental",
|
|
2999
3002
|
"summary": "Configuration properties for client authentication."
|
|
3000
3003
|
},
|
|
@@ -3099,7 +3102,7 @@
|
|
|
3099
3102
|
"custom": {
|
|
3100
3103
|
"exampleMetadata": "infused"
|
|
3101
3104
|
},
|
|
3102
|
-
"example": "
|
|
3105
|
+
"example": "declare const vpc: ec2.Vpc;\nconst cluster = new msk.Cluster(this, 'cluster', {\n clusterName: 'myCluster',\n kafkaVersion: msk.KafkaVersion.V2_8_1,\n vpc,\n encryptionInTransit: {\n clientBroker: msk.ClientBrokerEncryption.TLS,\n },\n clientAuthentication: msk.ClientAuthentication.sasl({\n scram: true,\n }),\n});",
|
|
3103
3106
|
"stability": "experimental",
|
|
3104
3107
|
"summary": "Indicates the encryption setting for data in transit between clients and brokers."
|
|
3105
3108
|
},
|
|
@@ -3143,7 +3146,7 @@
|
|
|
3143
3146
|
"exampleMetadata": "infused",
|
|
3144
3147
|
"resource": "AWS::MSK::Cluster"
|
|
3145
3148
|
},
|
|
3146
|
-
"example": "
|
|
3149
|
+
"example": "declare const vpc: ec2.Vpc;\nconst cluster = new msk.Cluster(this, 'cluster', {\n clusterName: 'myCluster',\n kafkaVersion: msk.KafkaVersion.V2_8_1,\n vpc,\n encryptionInTransit: {\n clientBroker: msk.ClientBrokerEncryption.TLS,\n },\n clientAuthentication: msk.ClientAuthentication.sasl({\n scram: true,\n }),\n});",
|
|
3147
3150
|
"stability": "experimental",
|
|
3148
3151
|
"summary": "Create a MSK Cluster."
|
|
3149
3152
|
},
|
|
@@ -3512,7 +3515,7 @@
|
|
|
3512
3515
|
"custom": {
|
|
3513
3516
|
"exampleMetadata": "infused"
|
|
3514
3517
|
},
|
|
3515
|
-
"example": "
|
|
3518
|
+
"example": "declare const vpc: ec2.Vpc;\nconst cluster = new msk.Cluster(this, 'cluster', {\n clusterName: 'myCluster',\n kafkaVersion: msk.KafkaVersion.V2_8_1,\n vpc,\n encryptionInTransit: {\n clientBroker: msk.ClientBrokerEncryption.TLS,\n },\n clientAuthentication: msk.ClientAuthentication.sasl({\n scram: true,\n }),\n});",
|
|
3516
3519
|
"stability": "experimental",
|
|
3517
3520
|
"summary": "Properties for a MSK Cluster."
|
|
3518
3521
|
},
|
|
@@ -3844,13 +3847,13 @@
|
|
|
3844
3847
|
"assembly": "@aws-cdk/aws-msk-alpha",
|
|
3845
3848
|
"datatype": true,
|
|
3846
3849
|
"docs": {
|
|
3850
|
+
"custom": {
|
|
3851
|
+
"exampleMetadata": "infused"
|
|
3852
|
+
},
|
|
3853
|
+
"example": "declare const vpc: ec2.Vpc;\nconst cluster = new msk.Cluster(this, 'cluster', {\n clusterName: 'myCluster',\n kafkaVersion: msk.KafkaVersion.V2_8_1,\n vpc,\n encryptionInTransit: {\n clientBroker: msk.ClientBrokerEncryption.TLS,\n },\n clientAuthentication: msk.ClientAuthentication.sasl({\n scram: true,\n }),\n});",
|
|
3847
3854
|
"see": "https://docs.aws.amazon.com/msk/latest/developerguide/msk-encryption.html#msk-encryption-in-transit",
|
|
3848
3855
|
"stability": "experimental",
|
|
3849
|
-
"summary": "The settings for encrypting data in transit."
|
|
3850
|
-
"example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as msk_alpha from '@aws-cdk/aws-msk-alpha';\nconst encryptionInTransitConfig: msk_alpha.EncryptionInTransitConfig = {\n clientBroker: msk_alpha.ClientBrokerEncryption.TLS,\n enableInCluster: false,\n};",
|
|
3851
|
-
"custom": {
|
|
3852
|
-
"exampleMetadata": "fixture=_generated"
|
|
3853
|
-
}
|
|
3856
|
+
"summary": "The settings for encrypting data in transit."
|
|
3854
3857
|
},
|
|
3855
3858
|
"fqn": "@aws-cdk/aws-msk-alpha.EncryptionInTransitConfig",
|
|
3856
3859
|
"kind": "interface",
|
|
@@ -3964,7 +3967,7 @@
|
|
|
3964
3967
|
"custom": {
|
|
3965
3968
|
"exampleMetadata": "infused"
|
|
3966
3969
|
},
|
|
3967
|
-
"example": "
|
|
3970
|
+
"example": "declare const vpc: ec2.Vpc;\nconst cluster = new msk.Cluster(this, 'cluster', {\n clusterName: 'myCluster',\n kafkaVersion: msk.KafkaVersion.V2_8_1,\n vpc,\n encryptionInTransit: {\n clientBroker: msk.ClientBrokerEncryption.TLS,\n },\n clientAuthentication: msk.ClientAuthentication.sasl({\n scram: true,\n }),\n});",
|
|
3968
3971
|
"stability": "experimental",
|
|
3969
3972
|
"summary": "Kafka cluster version."
|
|
3970
3973
|
},
|
|
@@ -4402,7 +4405,7 @@
|
|
|
4402
4405
|
"custom": {
|
|
4403
4406
|
"exampleMetadata": "infused"
|
|
4404
4407
|
},
|
|
4405
|
-
"example": "
|
|
4408
|
+
"example": "declare const vpc: ec2.Vpc;\nconst cluster = new msk.Cluster(this, 'cluster', {\n clusterName: 'myCluster',\n kafkaVersion: msk.KafkaVersion.V2_8_1,\n vpc,\n encryptionInTransit: {\n clientBroker: msk.ClientBrokerEncryption.TLS,\n },\n clientAuthentication: msk.ClientAuthentication.sasl({\n scram: true,\n }),\n});",
|
|
4406
4409
|
"stability": "experimental",
|
|
4407
4410
|
"summary": "SASL authentication properties."
|
|
4408
4411
|
},
|
|
@@ -4479,7 +4482,7 @@
|
|
|
4479
4482
|
"custom": {
|
|
4480
4483
|
"exampleMetadata": "infused"
|
|
4481
4484
|
},
|
|
4482
|
-
"example": "import * as
|
|
4485
|
+
"example": "import * as acmpca from 'aws-cdk-lib/aws-acmpca';\n\ndeclare const vpc: ec2.Vpc;\nconst cluster = new msk.Cluster(this, 'Cluster', {\n clusterName: 'myCluster',\n kafkaVersion: msk.KafkaVersion.V2_8_1,\n vpc,\n encryptionInTransit: {\n clientBroker: msk.ClientBrokerEncryption.TLS,\n },\n clientAuthentication: msk.ClientAuthentication.tls({\n certificateAuthorities: [\n acmpca.CertificateAuthority.fromCertificateAuthorityArn(\n this,\n 'CertificateAuthority',\n 'arn:aws:acm-pca:us-west-2:1234567890:certificate-authority/11111111-1111-1111-1111-111111111111',\n ),\n ],\n }),\n});",
|
|
4483
4486
|
"stability": "experimental",
|
|
4484
4487
|
"summary": "TLS authentication properties."
|
|
4485
4488
|
},
|
|
@@ -4518,6 +4521,6 @@
|
|
|
4518
4521
|
"symbolId": "lib/cluster:TlsAuthProps"
|
|
4519
4522
|
}
|
|
4520
4523
|
},
|
|
4521
|
-
"version": "2.
|
|
4524
|
+
"version": "2.8.0-alpha.0",
|
|
4522
4525
|
"fingerprint": "**********"
|
|
4523
4526
|
}
|