Class: Aws::Kafka::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::Kafka::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb
Overview
An API client for Kafka. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::Kafka::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#batch_associate_scram_secret(params = {}) ⇒ Types::BatchAssociateScramSecretResponse
Associates one or more Scram Secrets with an Amazon MSK cluster.
-
#batch_disassociate_scram_secret(params = {}) ⇒ Types::BatchDisassociateScramSecretResponse
Disassociates one or more Scram Secrets from an Amazon MSK cluster.
-
#create_cluster(params = {}) ⇒ Types::CreateClusterResponse
Creates a new MSK cluster.
-
#create_cluster_v2(params = {}) ⇒ Types::CreateClusterV2Response
Creates a new Amazon MSK cluster of either the provisioned or the serverless type.
-
#create_configuration(params = {}) ⇒ Types::CreateConfigurationResponse
Creates a new MSK configuration.
-
#create_replicator(params = {}) ⇒ Types::CreateReplicatorResponse
Creates a new Kafka Replicator.
-
#create_vpc_connection(params = {}) ⇒ Types::CreateVpcConnectionResponse
Creates a new Amazon MSK VPC connection.
-
#delete_cluster(params = {}) ⇒ Types::DeleteClusterResponse
Deletes the MSK cluster specified by the Amazon Resource Name (ARN) in the request.
-
#delete_cluster_policy(params = {}) ⇒ Struct
Deletes the MSK cluster policy specified by the Amazon Resource Name (ARN) in your request.
-
#delete_configuration(params = {}) ⇒ Types::DeleteConfigurationResponse
Deletes the specified MSK configuration.
-
#delete_replicator(params = {}) ⇒ Types::DeleteReplicatorResponse
Deletes a replicator.
-
#delete_vpc_connection(params = {}) ⇒ Types::DeleteVpcConnectionResponse
Deletes the Amazon MSK VPC connection specified in your request.
-
#describe_cluster(params = {}) ⇒ Types::DescribeClusterResponse
Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request.
-
#describe_cluster_operation(params = {}) ⇒ Types::DescribeClusterOperationResponse
Returns a description of the cluster operation specified by the ARN.
-
#describe_cluster_operation_v2(params = {}) ⇒ Types::DescribeClusterOperationV2Response
Returns a description of the cluster operation specified by the ARN.
-
#describe_cluster_v2(params = {}) ⇒ Types::DescribeClusterV2Response
Returns a description of the MSK cluster of either the provisioned or the serverless type whose Amazon Resource Name (ARN) is specified in the request.
-
#describe_configuration(params = {}) ⇒ Types::DescribeConfigurationResponse
Returns a description of this MSK configuration.
-
#describe_configuration_revision(params = {}) ⇒ Types::DescribeConfigurationRevisionResponse
Returns a description of this revision of the configuration.
-
#describe_replicator(params = {}) ⇒ Types::DescribeReplicatorResponse
Returns a description of the Kafka Replicator whose Amazon Resource Name (ARN) is specified in the request.
-
#describe_vpc_connection(params = {}) ⇒ Types::DescribeVpcConnectionResponse
Displays information about the specified Amazon MSK VPC connection.
-
#get_bootstrap_brokers(params = {}) ⇒ Types::GetBootstrapBrokersResponse
A list of brokers that a client application can use to bootstrap.
-
#get_cluster_policy(params = {}) ⇒ Types::GetClusterPolicyResponse
Retrieves the contents of the specified MSK cluster policy.
-
#get_compatible_kafka_versions(params = {}) ⇒ Types::GetCompatibleKafkaVersionsResponse
Gets the Apache Kafka versions to which you can update the MSK cluster.
-
#list_client_vpc_connections(params = {}) ⇒ Types::ListClientVpcConnectionsResponse
Displays a list of client VPC connections.
-
#list_cluster_operations(params = {}) ⇒ Types::ListClusterOperationsResponse
Returns a list of all the operations that have been performed on the specified MSK cluster.
-
#list_cluster_operations_v2(params = {}) ⇒ Types::ListClusterOperationsV2Response
Returns a list of all the operations that have been performed on the specified MSK cluster.
-
#list_clusters(params = {}) ⇒ Types::ListClustersResponse
Returns a list of all the MSK clusters in the current Region.
-
#list_clusters_v2(params = {}) ⇒ Types::ListClustersV2Response
Returns a list of all the MSK clusters in the current Region.
-
#list_configuration_revisions(params = {}) ⇒ Types::ListConfigurationRevisionsResponse
Returns a list of all the revisions of an MSK configuration.
-
#list_configurations(params = {}) ⇒ Types::ListConfigurationsResponse
Returns a list of all the MSK configurations in this Region.
-
#list_kafka_versions(params = {}) ⇒ Types::ListKafkaVersionsResponse
Returns a list of Apache Kafka versions.
-
#list_nodes(params = {}) ⇒ Types::ListNodesResponse
Returns a list of the broker nodes in the cluster.
-
#list_replicators(params = {}) ⇒ Types::ListReplicatorsResponse
Lists the replicators.
-
#list_scram_secrets(params = {}) ⇒ Types::ListScramSecretsResponse
Returns a list of the Scram Secrets associated with an Amazon MSK cluster.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Returns a list of the tags associated with the specified resource.
-
#list_vpc_connections(params = {}) ⇒ Types::ListVpcConnectionsResponse
Displays a list of Amazon MSK VPC connections.
-
#put_cluster_policy(params = {}) ⇒ Types::PutClusterPolicyResponse
Creates or updates the specified MSK cluster policy.
-
#reboot_broker(params = {}) ⇒ Types::RebootBrokerResponse
Executes a reboot on a broker.
-
#reject_client_vpc_connection(params = {}) ⇒ Struct
Returns an empty response.
-
#tag_resource(params = {}) ⇒ Struct
Adds tags to the specified MSK resource.
-
#untag_resource(params = {}) ⇒ Struct
Removes the tags associated with the keys that are provided in the query.
-
#update_broker_count(params = {}) ⇒ Types::UpdateBrokerCountResponse
Updates the number of broker nodes in the cluster.
-
#update_broker_storage(params = {}) ⇒ Types::UpdateBrokerStorageResponse
Updates the EBS storage associated with MSK brokers.
-
#update_broker_type(params = {}) ⇒ Types::UpdateBrokerTypeResponse
Updates all the brokers in the cluster to the specified type.
-
#update_cluster_configuration(params = {}) ⇒ Types::UpdateClusterConfigurationResponse
Updates the cluster with the configuration that is specified in the request body.
-
#update_cluster_kafka_version(params = {}) ⇒ Types::UpdateClusterKafkaVersionResponse
Updates the Apache Kafka version for the cluster.
-
#update_configuration(params = {}) ⇒ Types::UpdateConfigurationResponse
Updates an existing MSK configuration.
-
#update_connectivity(params = {}) ⇒ Types::UpdateConnectivityResponse
Updates the connectivity configuration for the MSK cluster.
-
#update_monitoring(params = {}) ⇒ Types::UpdateMonitoringResponse
Updates the monitoring settings for the cluster.
-
#update_replication_info(params = {}) ⇒ Types::UpdateReplicationInfoResponse
Updates replication info of a replicator.
-
#update_security(params = {}) ⇒ Types::UpdateSecurityResponse
You can use this operation to update the encrypting and authentication settings for an existing cluster.
-
#update_storage(params = {}) ⇒ Types::UpdateStorageResponse
Updates cluster broker volume size (or) sets cluster storage mode to TIERED.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
385 386 387 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 385 def initialize(*args) super end |
Instance Method Details
#batch_associate_scram_secret(params = {}) ⇒ Types::BatchAssociateScramSecretResponse
Associates one or more Scram Secrets with an Amazon MSK cluster.
422 423 424 425 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 422 def batch_associate_scram_secret(params = {}, = {}) req = build_request(:batch_associate_scram_secret, params) req.send_request() end |
#batch_disassociate_scram_secret(params = {}) ⇒ Types::BatchDisassociateScramSecretResponse
Disassociates one or more Scram Secrets from an Amazon MSK cluster.
1712 1713 1714 1715 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 1712 def batch_disassociate_scram_secret(params = {}, = {}) req = build_request(:batch_disassociate_scram_secret, params) req.send_request() end |
#create_cluster(params = {}) ⇒ Types::CreateClusterResponse
Creates a new MSK cluster.
589 590 591 592 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 589 def create_cluster(params = {}, = {}) req = build_request(:create_cluster, params) req.send_request() end |
#create_cluster_v2(params = {}) ⇒ Types::CreateClusterV2Response
Creates a new Amazon MSK cluster of either the provisioned or the serverless type.
750 751 752 753 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 750 def create_cluster_v2(params = {}, = {}) req = build_request(:create_cluster_v2, params) req.send_request() end |
#create_configuration(params = {}) ⇒ Types::CreateConfigurationResponse
Creates a new MSK configuration.
801 802 803 804 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 801 def create_configuration(params = {}, = {}) req = build_request(:create_configuration, params) req.send_request() end |
#create_replicator(params = {}) ⇒ Types::CreateReplicatorResponse
Creates a new Kafka Replicator.
890 891 892 893 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 890 def create_replicator(params = {}, = {}) req = build_request(:create_replicator, params) req.send_request() end |
#create_vpc_connection(params = {}) ⇒ Types::CreateVpcConnectionResponse
Creates a new Amazon MSK VPC connection.
956 957 958 959 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 956 def create_vpc_connection(params = {}, = {}) req = build_request(:create_vpc_connection, params) req.send_request() end |
#delete_cluster(params = {}) ⇒ Types::DeleteClusterResponse
Deletes the MSK cluster specified by the Amazon Resource Name (ARN) in the request.
989 990 991 992 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 989 def delete_cluster(params = {}, = {}) req = build_request(:delete_cluster, params) req.send_request() end |
#delete_cluster_policy(params = {}) ⇒ Struct
Deletes the MSK cluster policy specified by the Amazon Resource Name (ARN) in your request.
2571 2572 2573 2574 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 2571 def delete_cluster_policy(params = {}, = {}) req = build_request(:delete_cluster_policy, params) req.send_request() end |
#delete_configuration(params = {}) ⇒ Types::DeleteConfigurationResponse
Deletes the specified MSK configuration. The configuration must be in the ACTIVE or DELETE_FAILED state.
1020 1021 1022 1023 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 1020 def delete_configuration(params = {}, = {}) req = build_request(:delete_configuration, params) req.send_request() end |
#delete_replicator(params = {}) ⇒ Types::DeleteReplicatorResponse
Deletes a replicator.
1052 1053 1054 1055 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 1052 def delete_replicator(params = {}, = {}) req = build_request(:delete_replicator, params) req.send_request() end |
#delete_vpc_connection(params = {}) ⇒ Types::DeleteVpcConnectionResponse
Deletes the Amazon MSK VPC connection specified in your request.
1081 1082 1083 1084 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 1081 def delete_vpc_connection(params = {}, = {}) req = build_request(:delete_vpc_connection, params) req.send_request() end |
#describe_cluster(params = {}) ⇒ Types::DescribeClusterResponse
Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request.
1160 1161 1162 1163 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 1160 def describe_cluster(params = {}, = {}) req = build_request(:describe_cluster, params) req.send_request() end |
#describe_cluster_operation(params = {}) ⇒ Types::DescribeClusterOperationResponse
Returns a description of the cluster operation specified by the ARN.
1359 1360 1361 1362 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 1359 def describe_cluster_operation(params = {}, = {}) req = build_request(:describe_cluster_operation, params) req.send_request() end |
#describe_cluster_operation_v2(params = {}) ⇒ Types::DescribeClusterOperationV2Response
Returns a description of the cluster operation specified by the ARN.
1473 1474 1475 1476 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 1473 def describe_cluster_operation_v2(params = {}, = {}) req = build_request(:describe_cluster_operation_v2, params) req.send_request() end |
#describe_cluster_v2(params = {}) ⇒ Types::DescribeClusterV2Response
Returns a description of the MSK cluster of either the provisioned or the serverless type whose Amazon Resource Name (ARN) is specified in the request.
1248 1249 1250 1251 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 1248 def describe_cluster_v2(params = {}, = {}) req = build_request(:describe_cluster_v2, params) req.send_request() end |
#describe_configuration(params = {}) ⇒ Types::DescribeConfigurationResponse
Returns a description of this MSK configuration.
1515 1516 1517 1518 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 1515 def describe_configuration(params = {}, = {}) req = build_request(:describe_configuration, params) req.send_request() end |
#describe_configuration_revision(params = {}) ⇒ Types::DescribeConfigurationRevisionResponse
Returns a description of this revision of the configuration.
1553 1554 1555 1556 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 1553 def describe_configuration_revision(params = {}, = {}) req = build_request(:describe_configuration_revision, params) req.send_request() end |
#describe_replicator(params = {}) ⇒ Types::DescribeReplicatorResponse
Returns a description of the Kafka Replicator whose Amazon Resource Name (ARN) is specified in the request.
1630 1631 1632 1633 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 1630 def describe_replicator(params = {}, = {}) req = build_request(:describe_replicator, params) req.send_request() end |
#describe_vpc_connection(params = {}) ⇒ Types::DescribeVpcConnectionResponse
Displays information about the specified Amazon MSK VPC connection.
1676 1677 1678 1679 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 1676 def describe_vpc_connection(params = {}, = {}) req = build_request(:describe_vpc_connection, params) req.send_request() end |
#get_bootstrap_brokers(params = {}) ⇒ Types::GetBootstrapBrokersResponse
A list of brokers that a client application can use to bootstrap.
1757 1758 1759 1760 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 1757 def get_bootstrap_brokers(params = {}, = {}) req = build_request(:get_bootstrap_brokers, params) req.send_request() end |
#get_cluster_policy(params = {}) ⇒ Types::GetClusterPolicyResponse
Retrieves the contents of the specified MSK cluster policy.
2600 2601 2602 2603 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 2600 def get_cluster_policy(params = {}, = {}) req = build_request(:get_cluster_policy, params) req.send_request() end |
#get_compatible_kafka_versions(params = {}) ⇒ Types::GetCompatibleKafkaVersionsResponse
Gets the Apache Kafka versions to which you can update the MSK cluster.
1788 1789 1790 1791 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 1788 def get_compatible_kafka_versions(params = {}, = {}) req = build_request(:get_compatible_kafka_versions, params) req.send_request() end |
#list_client_vpc_connections(params = {}) ⇒ Types::ListClientVpcConnectionsResponse
Displays a list of client VPC connections.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2487 2488 2489 2490 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 2487 def list_client_vpc_connections(params = {}, = {}) req = build_request(:list_client_vpc_connections, params) req.send_request() end |
#list_cluster_operations(params = {}) ⇒ Types::ListClusterOperationsResponse
Returns a list of all the operations that have been performed on the specified MSK cluster.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1911 1912 1913 1914 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 1911 def list_cluster_operations(params = {}, = {}) req = build_request(:list_cluster_operations, params) req.send_request() end |
#list_cluster_operations_v2(params = {}) ⇒ Types::ListClusterOperationsV2Response
Returns a list of all the operations that have been performed on the specified MSK cluster.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1956 1957 1958 1959 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 1956 def list_cluster_operations_v2(params = {}, = {}) req = build_request(:list_cluster_operations_v2, params) req.send_request() end |
#list_clusters(params = {}) ⇒ Types::ListClustersResponse
Returns a list of all the MSK clusters in the current Region.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2045 2046 2047 2048 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 2045 def list_clusters(params = {}, = {}) req = build_request(:list_clusters, params) req.send_request() end |
#list_clusters_v2(params = {}) ⇒ Types::ListClustersV2Response
Returns a list of all the MSK clusters in the current Region.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2152 2153 2154 2155 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 2152 def list_clusters_v2(params = {}, = {}) req = build_request(:list_clusters_v2, params) req.send_request() end |
#list_configuration_revisions(params = {}) ⇒ Types::ListConfigurationRevisionsResponse
Returns a list of all the revisions of an MSK configuration.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2192 2193 2194 2195 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 2192 def list_configuration_revisions(params = {}, = {}) req = build_request(:list_configuration_revisions, params) req.send_request() end |
#list_configurations(params = {}) ⇒ Types::ListConfigurationsResponse
Returns a list of all the MSK configurations in this Region.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2236 2237 2238 2239 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 2236 def list_configurations(params = {}, = {}) req = build_request(:list_configurations, params) req.send_request() end |
#list_kafka_versions(params = {}) ⇒ Types::ListKafkaVersionsResponse
Returns a list of Apache Kafka versions.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2272 2273 2274 2275 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 2272 def list_kafka_versions(params = {}, = {}) req = build_request(:list_kafka_versions, params) req.send_request() end |
#list_nodes(params = {}) ⇒ Types::ListNodesResponse
Returns a list of the broker nodes in the cluster.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2328 2329 2330 2331 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 2328 def list_nodes(params = {}, = {}) req = build_request(:list_nodes, params) req.send_request() end |
#list_replicators(params = {}) ⇒ Types::ListReplicatorsResponse
Lists the replicators.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2378 2379 2380 2381 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 2378 def list_replicators(params = {}, = {}) req = build_request(:list_replicators, params) req.send_request() end |
#list_scram_secrets(params = {}) ⇒ Types::ListScramSecretsResponse
Returns a list of the Scram Secrets associated with an Amazon MSK cluster.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2417 2418 2419 2420 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 2417 def list_scram_secrets(params = {}, = {}) req = build_request(:list_scram_secrets, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Returns a list of the tags associated with the specified resource.
2445 2446 2447 2448 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 2445 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#list_vpc_connections(params = {}) ⇒ Types::ListVpcConnectionsResponse
Displays a list of Amazon MSK VPC connections.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2527 2528 2529 2530 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 2527 def list_vpc_connections(params = {}, = {}) req = build_request(:list_vpc_connections, params) req.send_request() end |
#put_cluster_policy(params = {}) ⇒ Types::PutClusterPolicyResponse
Creates or updates the specified MSK cluster policy. If updating the policy, the currentVersion field is required in the request payload.
2634 2635 2636 2637 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 2634 def put_cluster_policy(params = {}, = {}) req = build_request(:put_cluster_policy, params) req.send_request() end |
#reboot_broker(params = {}) ⇒ Types::RebootBrokerResponse
Executes a reboot on a broker.
2667 2668 2669 2670 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 2667 def reboot_broker(params = {}, = {}) req = build_request(:reboot_broker, params) req.send_request() end |
#reject_client_vpc_connection(params = {}) ⇒ Struct
Returns an empty response.
2549 2550 2551 2552 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 2549 def reject_client_vpc_connection(params = {}, = {}) req = build_request(:reject_client_vpc_connection, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Adds tags to the specified MSK resource.
2694 2695 2696 2697 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 2694 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes the tags associated with the keys that are provided in the query.
2719 2720 2721 2722 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 2719 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_broker_count(params = {}) ⇒ Types::UpdateBrokerCountResponse
Updates the number of broker nodes in the cluster. You can use this operation to increase the number of brokers in an existing cluster. You can't decrease the number of brokers.
2759 2760 2761 2762 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 2759 def update_broker_count(params = {}, = {}) req = build_request(:update_broker_count, params) req.send_request() end |
#update_broker_storage(params = {}) ⇒ Types::UpdateBrokerStorageResponse
Updates the EBS storage associated with MSK brokers.
2851 2852 2853 2854 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 2851 def update_broker_storage(params = {}, = {}) req = build_request(:update_broker_storage, params) req.send_request() end |
#update_broker_type(params = {}) ⇒ Types::UpdateBrokerTypeResponse
Updates all the brokers in the cluster to the specified type.
2797 2798 2799 2800 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 2797 def update_broker_type(params = {}, = {}) req = build_request(:update_broker_type, params) req.send_request() end |
#update_cluster_configuration(params = {}) ⇒ Types::UpdateClusterConfigurationResponse
Updates the cluster with the configuration that is specified in the request body.
2932 2933 2934 2935 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 2932 def update_cluster_configuration(params = {}, = {}) req = build_request(:update_cluster_configuration, params) req.send_request() end |
#update_cluster_kafka_version(params = {}) ⇒ Types::UpdateClusterKafkaVersionResponse
Updates the Apache Kafka version for the cluster.
2976 2977 2978 2979 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 2976 def update_cluster_kafka_version(params = {}, = {}) req = build_request(:update_cluster_kafka_version, params) req.send_request() end |
#update_configuration(params = {}) ⇒ Types::UpdateConfigurationResponse
Updates an existing MSK configuration. The configuration must be in the Active state.
2891 2892 2893 2894 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 2891 def update_configuration(params = {}, = {}) req = build_request(:update_configuration, params) req.send_request() end |
#update_connectivity(params = {}) ⇒ Types::UpdateConnectivityResponse
Updates the connectivity configuration for the MSK cluster.
3032 3033 3034 3035 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 3032 def update_connectivity(params = {}, = {}) req = build_request(:update_connectivity, params) req.send_request() end |
#update_monitoring(params = {}) ⇒ Types::UpdateMonitoringResponse
Updates the monitoring settings for the cluster. You can use this operation to specify which Apache Kafka metrics you want Amazon MSK to send to Amazon CloudWatch. You can also specify settings for open monitoring with Prometheus.
3107 3108 3109 3110 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 3107 def update_monitoring(params = {}, = {}) req = build_request(:update_monitoring, params) req.send_request() end |
#update_replication_info(params = {}) ⇒ Types::UpdateReplicationInfoResponse
Updates replication info of a replicator.
3167 3168 3169 3170 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 3167 def update_replication_info(params = {}, = {}) req = build_request(:update_replication_info, params) req.send_request() end |
#update_security(params = {}) ⇒ Types::UpdateSecurityResponse
You can use this operation to update the encrypting and authentication settings for an existing cluster.
3235 3236 3237 3238 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 3235 def update_security(params = {}, = {}) req = build_request(:update_security, params) req.send_request() end |
#update_storage(params = {}) ⇒ Types::UpdateStorageResponse
Updates cluster broker volume size (or) sets cluster storage mode to TIERED.
3285 3286 3287 3288 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 3285 def update_storage(params = {}, = {}) req = build_request(:update_storage, params) req.send_request() end |