Skip to content

Commit 5d40af5

Browse files
author
AWS
committed
Managed Streaming for Kafka Update: Amazon MSK has added a new API that allows you to update the connectivity settings for an existing cluster to enable public accessibility.
1 parent b554421 commit 5d40af5

File tree

2 files changed

+158
-25
lines changed

2 files changed

+158
-25
lines changed

‎.changes/next-release/feature-ManagedStreamingforKafka-b5ae6bd.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "Managed Streaming for Kafka",
4+
"contributor": "",
5+
"description": "Amazon MSK has added a new API that allows you to update the connectivity settings for an existing cluster to enable public accessibility."
6+
}

‎services/kafka/src/main/resources/codegen-resources/service-2.json

Lines changed: 152 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -671,7 +671,7 @@
671671
"documentation": "\n <p>Access forbidden. Check your credentials and then retry your request.</p>\n "
672672
}
673673
],
674-
"documentation": "\n <p>Returns a list of Kafka versions.</p>\n "
674+
"documentation": "\n <p>Returns a list of Apache Kafka versions.</p>\n "
675675
},
676676
"ListNodes": {
677677
"name": "ListNodes",
@@ -1037,6 +1037,48 @@
10371037
],
10381038
"documentation": "\n <p>Updates an MSK configuration.</p>\n "
10391039
},
1040+
"UpdateConnectivity" : {
1041+
"name" : "UpdateConnectivity",
1042+
"http" : {
1043+
"method" : "PUT",
1044+
"requestUri" : "/v1/clusters/{clusterArn}/connectivity",
1045+
"responseCode" : 200
1046+
},
1047+
"input" : {
1048+
"shape" : "UpdateConnectivityRequest"
1049+
},
1050+
"output" : {
1051+
"shape" : "UpdateConnectivityResponse",
1052+
"documentation": "\n <p>Successful response.</p>\n "
1053+
},
1054+
"errors": [
1055+
{
1056+
"shape": "BadRequestException",
1057+
"documentation": "\n <p>The request isn't valid because the input is incorrect. Correct your input and then submit it again.</p>\n "
1058+
},
1059+
{
1060+
"shape": "UnauthorizedException",
1061+
"documentation": "\n <p>The request is not authorized. The provided credentials couldn't be validated.</p>\n "
1062+
},
1063+
{
1064+
"shape": "InternalServerErrorException",
1065+
"documentation": "\n <p>There was an unexpected internal server error. Retrying your request might resolve the issue.</p>\n "
1066+
},
1067+
{
1068+
"shape": "ForbiddenException",
1069+
"documentation": "\n <p>Access forbidden. Check your credentials and then retry your request.</p>\n "
1070+
},
1071+
{
1072+
"shape": "NotFoundException",
1073+
"documentation": "\n <p>The resource could not be found due to incorrect input. Correct the input, then retry the request.</p>\n "
1074+
},
1075+
{
1076+
"shape": "ServiceUnavailableException",
1077+
"documentation": "\n <p>503 response</p>\n "
1078+
}
1079+
],
1080+
"documentation" : "\n <p>Updates the cluster's connectivity configuration.</p>\n "
1081+
},
10401082
"UpdateClusterConfiguration": {
10411083
"name": "UpdateClusterConfiguration",
10421084
"http": {
@@ -1309,7 +1351,7 @@
13091351
"InstanceType": {
13101352
"shape": "__stringMin5Max32",
13111353
"locationName": "instanceType",
1312-
"documentation": "\n <p>The type of Amazon EC2 instances to use for Kafka brokers. The following instance types are allowed: kafka.m5.large, kafka.m5.xlarge, kafka.m5.2xlarge,\nkafka.m5.4xlarge, kafka.m5.12xlarge, and kafka.m5.24xlarge.</p>\n "
1354+
"documentation": "\n <p>The type of Amazon EC2 instances to use for Apache Kafka brokers. The following instance types are allowed: kafka.m5.large, kafka.m5.xlarge, kafka.m5.2xlarge,\nkafka.m5.4xlarge, kafka.m5.12xlarge, and kafka.m5.24xlarge.</p>\n "
13131355
},
13141356
"SecurityGroups": {
13151357
"shape": "__listOf__string",
@@ -1320,9 +1362,14 @@
13201362
"shape": "StorageInfo",
13211363
"locationName": "storageInfo",
13221364
"documentation": "\n <p>Contains information about storage volumes attached to MSK broker nodes.</p>\n "
1365+
},
1366+
"ConnectivityInfo" : {
1367+
"shape" : "ConnectivityInfo",
1368+
"locationName" : "connectivityInfo",
1369+
"documentation" : "\n <p>Information about the broker access configuration.</p>\n "
13231370
}
13241371
},
1325-
"documentation": "\n <p>Describes the setup to be used for Kafka broker nodes in the cluster.</p>\n ",
1372+
"documentation": "\n <p>Describes the setup to be used for Apache Kafka broker nodes in the cluster.</p>\n ",
13261373
"required": [
13271374
"ClientSubnets",
13281375
"InstanceType"
@@ -1354,7 +1401,7 @@
13541401
"CurrentBrokerSoftwareInfo": {
13551402
"shape": "BrokerSoftwareInfo",
13561403
"locationName": "currentBrokerSoftwareInfo",
1357-
"documentation": "\n <p>Information about the version of software currently deployed on the Kafka brokers in the cluster.</p>\n "
1404+
"documentation": "\n <p>Information about the version of software currently deployed on the Apache Kafka brokers in the cluster.</p>\n "
13581405
},
13591406
"Endpoints": {
13601407
"shape": "__listOf__string",
@@ -1465,7 +1512,7 @@
14651512
"CurrentBrokerSoftwareInfo": {
14661513
"shape": "BrokerSoftwareInfo",
14671514
"locationName": "currentBrokerSoftwareInfo",
1468-
"documentation": "\n <p>Information about the version of software currently deployed on the Kafka brokers in the cluster.</p>\n "
1515+
"documentation": "\n <p>Information about the version of software currently deployed on the Apache Kafka brokers in the cluster.</p>\n "
14691516
},
14701517
"CurrentVersion": {
14711518
"shape": "__string",
@@ -1613,7 +1660,7 @@
16131660
},
16141661
"ClusterState": {
16151662
"type": "string",
1616-
"documentation": "\n <p>The state of a Kafka cluster.</p>\n ",
1663+
"documentation": "\n <p>The state of the Apache Kafka cluster.</p>\n ",
16171664
"enum": [
16181665
"ACTIVE",
16191666
"CREATING",
@@ -1631,15 +1678,15 @@
16311678
"SourceVersion" : {
16321679
"shape" : "__string",
16331680
"locationName" : "sourceVersion",
1634-
"documentation": "\n <p>A Kafka version.</p>\n "
1681+
"documentation": "\n <p>An Apache Kafka version.</p>\n "
16351682
},
16361683
"TargetVersions" : {
16371684
"shape" : "__listOf__string",
16381685
"locationName" : "targetVersions",
1639-
"documentation": "\n <p>A list of Kafka versions.</p>\n "
1686+
"documentation": "\n <p>A list of Apache Kafka versions.</p>\n "
16401687
}
16411688
},
1642-
"documentation": "\n <p>Contains source Kafka versions and compatible target Kafka versions.</p>\n "
1689+
"documentation": "\n <p>Contains source Apache Kafka versions and compatible target Apache Kafka versions.</p>\n "
16431690
},
16441691
"Configuration": {
16451692
"type": "structure",
@@ -1765,6 +1812,17 @@
17651812
"httpStatusCode": 409
17661813
}
17671814
},
1815+
"ConnectivityInfo" : {
1816+
"type" : "structure",
1817+
"members" : {
1818+
"PublicAccess" : {
1819+
"shape" : "PublicAccess",
1820+
"locationName" : "publicAccess",
1821+
"documentation" : "\n <p>Public access control for brokers.</p>\n "
1822+
}
1823+
},
1824+
"documentation" : "\n <p>Information about the broker access configuration.</p>\n "
1825+
},
17681826
"CreateClusterRequest": {
17691827
"type": "structure",
17701828
"members": {
@@ -2168,7 +2226,7 @@
21682226
"documentation": "\n <p>The size in GiB of the EBS volume for the data drive on each broker node.</p>\n "
21692227
}
21702228
},
2171-
"documentation": "\n <p>Contains information about the EBS storage volumes attached to Kafka broker nodes.</p>\n "
2229+
"documentation": "\n <p>Contains information about the EBS storage volumes attached to Apache Kafka broker nodes.</p>\n "
21722230
},
21732231
"EncryptionAtRest": {
21742232
"type": "structure",
@@ -2328,6 +2386,21 @@
23282386
"shape": "__string",
23292387
"locationName": "bootstrapBrokerStringSaslIam",
23302388
"documentation": "\n <p>A string that contains one or more DNS names (or IP addresses) and SASL IAM port pairs.</p>\n "
2389+
},
2390+
"BootstrapBrokerStringPublicTls": {
2391+
"shape": "__string",
2392+
"locationName": "bootstrapBrokerStringPublicTls",
2393+
"documentation": "\n <p>A string containing one or more DNS names (or IP) and TLS port pairs.</p>\n "
2394+
},
2395+
"BootstrapBrokerStringPublicSaslScram": {
2396+
"shape": "__string",
2397+
"locationName": "bootstrapBrokerStringPublicSaslScram",
2398+
"documentation": "\n <p>A string containing one or more DNS names (or IP) and Sasl Scram port pairs.</p>\n "
2399+
},
2400+
"BootstrapBrokerStringPublicSaslIam": {
2401+
"shape": "__string",
2402+
"locationName": "bootstrapBrokerStringPublicSaslIam",
2403+
"documentation": "\n <p>A string that contains one or more DNS names (or IP addresses) and SASL IAM port pairs.</p>\n "
23312404
}
23322405
}
23332406
},
@@ -2724,7 +2797,7 @@
27242797
"KafkaVersion" : {
27252798
"shape" : "__string",
27262799
"locationName" : "kafkaVersion",
2727-
"documentation" : "\n <p>The Kafka version.</p>\n "
2800+
"documentation" : "\n <p>The Apache Kafka version.</p>\n "
27282801
},
27292802
"LoggingInfo": {
27302803
"shape": "LoggingInfo",
@@ -2745,6 +2818,11 @@
27452818
"shape" : "EncryptionInfo",
27462819
"locationName" : "encryptionInfo",
27472820
"documentation": "\n <p>Includes all encryption-related information.</p>\n "
2821+
},
2822+
"ConnectivityInfo" : {
2823+
"shape" : "ConnectivityInfo",
2824+
"locationName" : "connectivityInfo",
2825+
"documentation" : "\n <p>Information about the broker access configuration.</p>\n "
27482826
}
27492827
},
27502828
"documentation": "\n <p>Information about cluster attributes that can be updated via update APIs.</p>\n "
@@ -2755,10 +2833,10 @@
27552833
"EnabledInBroker" : {
27562834
"shape" : "__boolean",
27572835
"locationName" : "enabledInBroker",
2758-
"documentation" : "\n <p>Indicates whether you want to enable or disable the Node Exporter.</p>\n "
2836+
"documentation" : "\n <p>Indicates whether you want to turn on or turn off the Node Exporter.</p>\n "
27592837
}
27602838
},
2761-
"documentation" : "\n <p>Indicates whether you want to enable or disable the Node Exporter.</p>\n ",
2839+
"documentation" : "\n <p>Indicates whether you want to turn on or turn off the Node Exporter.</p>\n ",
27622840
"required" : [ "EnabledInBroker" ]
27632841
},
27642842
"NodeExporterInfo" : {
@@ -2767,10 +2845,10 @@
27672845
"EnabledInBroker" : {
27682846
"shape" : "__boolean",
27692847
"locationName" : "enabledInBroker",
2770-
"documentation" : "\n <p>Indicates whether you want to enable or disable the Node Exporter.</p>\n "
2848+
"documentation" : "\n <p>Indicates whether you want to turn on or turn off the Node Exporter.</p>\n "
27712849
}
27722850
},
2773-
"documentation" : "\n <p>Indicates whether you want to enable or disable the Node Exporter.</p>\n ",
2851+
"documentation" : "\n <p>Indicates whether you want to turn on or turn off the Node Exporter.</p>\n ",
27742852
"required" : [ "EnabledInBroker" ]
27752853
},
27762854
"JmxExporter" : {
@@ -2779,10 +2857,10 @@
27792857
"EnabledInBroker" : {
27802858
"shape" : "__boolean",
27812859
"locationName" : "enabledInBroker",
2782-
"documentation" : "\n <p>Indicates whether you want to enable or disable the JMX Exporter.</p>\n "
2860+
"documentation" : "\n <p>Indicates whether you want to turn on or turn off the JMX Exporter.</p>\n "
27832861
}
27842862
},
2785-
"documentation" : "\n <p>Indicates whether you want to enable or disable the JMX Exporter.</p>\n ",
2863+
"documentation" : "\n <p>Indicates whether you want to turn on or turn off the JMX Exporter.</p>\n ",
27862864
"required" : [ "EnabledInBroker" ]
27872865
},
27882866
"JmxExporterInfo" : {
@@ -2791,10 +2869,10 @@
27912869
"EnabledInBroker" : {
27922870
"shape" : "__boolean",
27932871
"locationName" : "enabledInBroker",
2794-
"documentation" : "\n <p>Indicates whether you want to enable or disable the JMX Exporter.</p>\n "
2872+
"documentation" : "\n <p>Indicates whether you want to turn on or turn off the JMX Exporter.</p>\n "
27952873
}
27962874
},
2797-
"documentation" : "\n <p>Indicates whether you want to enable or disable the JMX Exporter.</p>\n ",
2875+
"documentation" : "\n <p>Indicates whether you want to turn on or turn off the JMX Exporter.</p>\n ",
27982876
"required" : [ "EnabledInBroker" ]
27992877
},
28002878
"OpenMonitoring" : {
@@ -2827,12 +2905,12 @@
28272905
"JmxExporter" : {
28282906
"shape" : "JmxExporter",
28292907
"locationName" : "jmxExporter",
2830-
"documentation" : "\n <p>Indicates whether you want to enable or disable the JMX Exporter.</p>\n "
2908+
"documentation" : "\n <p>Indicates whether you want to turn on or turn off the JMX Exporter.</p>\n "
28312909
},
28322910
"NodeExporter" : {
28332911
"shape" : "NodeExporter",
28342912
"locationName" : "nodeExporter",
2835-
"documentation" : "\n <p>Indicates whether you want to enable or disable the Node Exporter.</p>\n "
2913+
"documentation" : "\n <p>Indicates whether you want to turn on or turn off the Node Exporter.</p>\n "
28362914
}
28372915
},
28382916
"documentation" : "\n <p>Prometheus settings.</p>\n "
@@ -2843,16 +2921,27 @@
28432921
"JmxExporter" : {
28442922
"shape" : "JmxExporterInfo",
28452923
"locationName" : "jmxExporter",
2846-
"documentation" : "\n <p>Indicates whether you want to enable or disable the JMX Exporter.</p>\n "
2924+
"documentation" : "\n <p>Indicates whether you want to turn on or turn off the JMX Exporter.</p>\n "
28472925
},
28482926
"NodeExporter" : {
28492927
"shape" : "NodeExporterInfo",
28502928
"locationName" : "nodeExporter",
2851-
"documentation" : "\n <p>Indicates whether you want to enable or disable the Node Exporter.</p>\n "
2929+
"documentation" : "\n <p>Indicates whether you want to turn on or turn off the Node Exporter.</p>\n "
28522930
}
28532931
},
28542932
"documentation" : "\n <p>Prometheus settings.</p>\n "
28552933
},
2934+
"PublicAccess" : {
2935+
"type" : "structure",
2936+
"members" : {
2937+
"Type" : {
2938+
"shape" : "__string",
2939+
"locationName" : "type",
2940+
"documentation" : "\n <p>The value DISABLED indicates that public access is turned off. SERVICE_PROVIDED_EIPS indicates that public access is turned on.</p>\n "
2941+
}
2942+
},
2943+
"documentation" : "Public access control for brokers."
2944+
},
28562945
"RebootBrokerRequest" : {
28572946
"type" : "structure",
28582947
"members" : {
@@ -3080,7 +3169,7 @@
30803169
"Enabled" : {
30813170
"shape" : "__boolean",
30823171
"locationName" : "enabled",
3083-
"documentation" : "\n <p>Specifies whether you want to enable or disable TLS authentication.</p>\n "
3172+
"documentation" : "\n <p>Specifies whether you want to turn on or turn off TLS authentication.</p>\n "
30843173
}
30853174
},
30863175
"documentation": "\n <p>Details for client authentication using TLS.</p>\n "
@@ -3111,7 +3200,7 @@
31113200
"Enabled" : {
31123201
"shape" : "__boolean",
31133202
"locationName" : "enabled",
3114-
"documentation" : "\n <p>Specifies whether you want to enable or disable unauthenticated traffic to your cluster.</p>\n "
3203+
"documentation" : "\n <p>Specifies whether you want to turn on or turn off unauthenticated traffic to your cluster.</p>\n "
31153204
}
31163205
}
31173206
},
@@ -3512,6 +3601,44 @@
35123601
}
35133602
}
35143603
},
3604+
"UpdateConnectivityRequest" : {
3605+
"type" : "structure",
3606+
"members" : {
3607+
"ClusterArn" : {
3608+
"shape" : "__string",
3609+
"location" : "uri",
3610+
"locationName" : "clusterArn",
3611+
"documentation": "\n <p>The Amazon Resource Name (ARN) of the configuration.</p>\n "
3612+
},
3613+
"ConnectivityInfo" : {
3614+
"shape" : "ConnectivityInfo",
3615+
"locationName" : "connectivityInfo",
3616+
"documentation" : "\n <p>Information about the broker access configuration.</p>\n "
3617+
},
3618+
"CurrentVersion" : {
3619+
"shape" : "__string",
3620+
"locationName" : "currentVersion",
3621+
"documentation" : "\n <p>The version of the MSK cluster to update. Cluster versions aren't simple numbers. You can describe an MSK cluster to find its version. When this update operation is successful, it generates a new cluster version.</p>\n "
3622+
}
3623+
},
3624+
"documentation" : "Request body for UpdateConnectivity.",
3625+
"required" : [ "ClusterArn", "ConnectivityInfo", "CurrentVersion" ]
3626+
},
3627+
"UpdateConnectivityResponse" : {
3628+
"type" : "structure",
3629+
"members" : {
3630+
"ClusterArn" : {
3631+
"shape" : "__string",
3632+
"locationName" : "clusterArn",
3633+
"documentation" : "\n <p>The Amazon Resource Name (ARN) of the cluster.</p>\n "
3634+
},
3635+
"ClusterOperationArn" : {
3636+
"shape" : "__string",
3637+
"locationName" : "clusterOperationArn",
3638+
"documentation" : "\n <p>The Amazon Resource Name (ARN) of the cluster operation.</p>\n "
3639+
}
3640+
}
3641+
},
35153642
"ZookeeperNodeInfo": {
35163643
"type": "structure",
35173644
"members": {

0 commit comments

Comments
 (0)