Struct aws_sdk_kafka::client::Client

pub struct Client { /* private fields */ }

Client for Managed Streaming for Kafka

Client for invoking operations on Managed Streaming for Kafka. Each operation on Managed Streaming for Kafka is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_kafka::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Config struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_kafka::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the BatchAssociateScramSecret operation has a Client::batch_associate_scram_secret, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.batch_associate_scram_secret()
    .cluster_arn("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn batch_associate_scram_secret( &self, ) -> BatchAssociateScramSecretFluentBuilder

Constructs a fluent builder for the BatchAssociateScramSecret operation.

• The fluent builder is configurable:
  • cluster_arn(impl Into<String>) / set_cluster_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the cluster to be updated.

    
    
  • secret_arn_list(impl Into<String>) / set_secret_arn_list(Option<Vec::<String>>):
    required: true
    

    List of AWS Secrets Manager secret ARNs.

    
    
• On success, responds with BatchAssociateScramSecretOutput with field(s):
  • cluster_arn(Option<String>):

    The Amazon Resource Name (ARN) of the cluster.

  • unprocessed_scram_secrets(Option<Vec::<UnprocessedScramSecret>>):

    List of errors when associating secrets to cluster.

• On failure, responds with SdkError<BatchAssociateScramSecretError>

impl Client

pub fn batch_disassociate_scram_secret( &self, ) -> BatchDisassociateScramSecretFluentBuilder

Constructs a fluent builder for the BatchDisassociateScramSecret operation.

• The fluent builder is configurable:
  • cluster_arn(impl Into<String>) / set_cluster_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the cluster to be updated.

    
    
  • secret_arn_list(impl Into<String>) / set_secret_arn_list(Option<Vec::<String>>):
    required: true
    

    List of AWS Secrets Manager secret ARNs.

    
    
• On success, responds with BatchDisassociateScramSecretOutput with field(s):
  • cluster_arn(Option<String>):

    The Amazon Resource Name (ARN) of the cluster.

  • unprocessed_scram_secrets(Option<Vec::<UnprocessedScramSecret>>):

    List of errors when disassociating secrets to cluster.

• On failure, responds with SdkError<BatchDisassociateScramSecretError>

impl Client

pub fn create_cluster(&self) -> CreateClusterFluentBuilder

Constructs a fluent builder for the CreateCluster operation.

• The fluent builder is configurable:
  • broker_node_group_info(BrokerNodeGroupInfo) / set_broker_node_group_info(Option<BrokerNodeGroupInfo>):
    required: true
    

    Information about the broker nodes in the cluster.

    
    
  • client_authentication(ClientAuthentication) / set_client_authentication(Option<ClientAuthentication>):
    required: false
    

    Includes all client authentication related information.

    
    
  • cluster_name(impl Into<String>) / set_cluster_name(Option<String>):
    required: true
    

    The name of the cluster.

    
    
  • configuration_info(ConfigurationInfo) / set_configuration_info(Option<ConfigurationInfo>):
    required: false
    

    Represents the configuration that you want MSK to use for the brokers in a cluster.

    
    
  • encryption_info(EncryptionInfo) / set_encryption_info(Option<EncryptionInfo>):
    required: false
    

    Includes all encryption-related information.

    
    
  • enhanced_monitoring(EnhancedMonitoring) / set_enhanced_monitoring(Option<EnhancedMonitoring>):
    required: false
    

    Specifies the level of monitoring for the MSK cluster. The possible values are DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION.

    
    
  • open_monitoring(OpenMonitoringInfo) / set_open_monitoring(Option<OpenMonitoringInfo>):
    required: false
    

    The settings for open monitoring.

    
    
  • kafka_version(impl Into<String>) / set_kafka_version(Option<String>):
    required: true
    

    The version of Apache Kafka.

    
    
  • logging_info(LoggingInfo) / set_logging_info(Option<LoggingInfo>):
    required: false
    (undocumented)
    
  • number_of_broker_nodes(i32) / set_number_of_broker_nodes(Option<i32>):
    required: true
    

    The number of broker nodes in the cluster.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    Create tags when creating the cluster.

    
    
  • storage_mode(StorageMode) / set_storage_mode(Option<StorageMode>):
    required: false
    

    This controls storage mode for supported storage tiers.

    
    
• On success, responds with CreateClusterOutput with field(s):
  • cluster_arn(Option<String>):

    The Amazon Resource Name (ARN) of the cluster.

  • cluster_name(Option<String>):

    The name of the MSK cluster.

  • state(Option<ClusterState>):

    The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.

• On failure, responds with SdkError<CreateClusterError>

impl Client

pub fn create_cluster_v2(&self) -> CreateClusterV2FluentBuilder

Constructs a fluent builder for the CreateClusterV2 operation.

• The fluent builder is configurable:
  • cluster_name(impl Into<String>) / set_cluster_name(Option<String>):
    required: true
    

    The name of the cluster.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    A map of tags that you want the cluster to have.

    
    
  • provisioned(ProvisionedRequest) / set_provisioned(Option<ProvisionedRequest>):
    required: false
    

    Information about the provisioned cluster.

    
    
  • serverless(ServerlessRequest) / set_serverless(Option<ServerlessRequest>):
    required: false
    

    Information about the serverless cluster.

    
    
• On success, responds with CreateClusterV2Output with field(s):
  • cluster_arn(Option<String>):

    The Amazon Resource Name (ARN) of the cluster.

  • cluster_name(Option<String>):

    The name of the MSK cluster.

  • state(Option<ClusterState>):

    The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.

  • cluster_type(Option<ClusterType>):

    The type of the cluster. The possible states are PROVISIONED or SERVERLESS.

• On failure, responds with SdkError<CreateClusterV2Error>

impl Client

pub fn create_configuration(&self) -> CreateConfigurationFluentBuilder

Constructs a fluent builder for the CreateConfiguration operation.

• The fluent builder is configurable:
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the configuration.

    
    
  • kafka_versions(impl Into<String>) / set_kafka_versions(Option<Vec::<String>>):
    required: false
    

    The versions of Apache Kafka with which you can use this MSK configuration.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the configuration.

    
    
  • server_properties(Blob) / set_server_properties(Option<Blob>):
    required: true
    

    Contents of the server.properties file. When using the API, you must ensure that the contents of the file are base64 encoded. When using the AWS Management Console, the SDK, or the AWS CLI, the contents of server.properties can be in plaintext.

    
    
• On success, responds with CreateConfigurationOutput with field(s):
  • arn(Option<String>):

    The Amazon Resource Name (ARN) of the configuration.

  • creation_time(Option<DateTime>):

    The time when the configuration was created.

  • latest_revision(Option<ConfigurationRevision>):

    Latest revision of the configuration.

  • name(Option<String>):

    The name of the configuration.

  • state(Option<ConfigurationState>):

    The state of the configuration. The possible states are ACTIVE, DELETING, and DELETE_FAILED.

• On failure, responds with SdkError<CreateConfigurationError>

impl Client

pub fn create_replicator(&self) -> CreateReplicatorFluentBuilder

Constructs a fluent builder for the CreateReplicator operation.

• The fluent builder is configurable:
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A summary description of the replicator.

    
    
  • kafka_clusters(KafkaCluster) / set_kafka_clusters(Option<Vec::<KafkaCluster>>):
    required: true
    

    Kafka Clusters to use in setting up sources / targets for replication.

    
    
  • replication_info_list(ReplicationInfo) / set_replication_info_list(Option<Vec::<ReplicationInfo>>):
    required: true
    

    A list of replication configurations, where each configuration targets a given source cluster to target cluster replication flow.

    
    
  • replicator_name(impl Into<String>) / set_replicator_name(Option<String>):
    required: true
    

    The name of the replicator. Alpha-numeric characters with ‘-’ are allowed.

    
    
  • service_execution_role_arn(impl Into<String>) / set_service_execution_role_arn(Option<String>):
    required: true
    

    The ARN of the IAM role used by the replicator to access resources in the customer’s account (e.g source and target clusters)

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    List of tags to attach to created Replicator.

    
    
• On success, responds with CreateReplicatorOutput with field(s):
  • replicator_arn(Option<String>):

    The Amazon Resource Name (ARN) of the replicator.

  • replicator_name(Option<String>):

    Name of the replicator provided by the customer.

  • replicator_state(Option<ReplicatorState>):

    State of the replicator.

• On failure, responds with SdkError<CreateReplicatorError>

impl Client

pub fn create_vpc_connection(&self) -> CreateVpcConnectionFluentBuilder

Constructs a fluent builder for the CreateVpcConnection operation.

• The fluent builder is configurable:
  • target_cluster_arn(impl Into<String>) / set_target_cluster_arn(Option<String>):
    required: true
    

    The cluster Amazon Resource Name (ARN) for the VPC connection.

    
    
  • authentication(impl Into<String>) / set_authentication(Option<String>):
    required: true
    

    The authentication type of VPC connection.

    
    
  • vpc_id(impl Into<String>) / set_vpc_id(Option<String>):
    required: true
    

    The VPC ID of VPC connection.

    
    
  • client_subnets(impl Into<String>) / set_client_subnets(Option<Vec::<String>>):
    required: true
    

    The list of client subnets.

    
    
  • security_groups(impl Into<String>) / set_security_groups(Option<Vec::<String>>):
    required: true
    

    The list of security groups.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    A map of tags for the VPC connection.

    
    
• On success, responds with CreateVpcConnectionOutput with field(s):
  • vpc_connection_arn(Option<String>):

    The VPC connection ARN.

  • state(Option<VpcConnectionState>):

    The State of Vpc Connection.

  • authentication(Option<String>):

    The authentication type of VPC connection.

  • vpc_id(Option<String>):

    The VPC ID of the VPC connection.

  • client_subnets(Option<Vec::<String>>):

    The list of client subnets.

  • security_groups(Option<Vec::<String>>):

    The list of security groups.

  • creation_time(Option<DateTime>):

    The creation time of VPC connection.

  • tags(Option<HashMap::<String, String>>):

    A map of tags for the VPC connection.

• On failure, responds with SdkError<CreateVpcConnectionError>

impl Client

pub fn delete_cluster(&self) -> DeleteClusterFluentBuilder

Constructs a fluent builder for the DeleteCluster operation.

• The fluent builder is configurable:
  • cluster_arn(impl Into<String>) / set_cluster_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) that uniquely identifies the cluster.

    
    
  • current_version(impl Into<String>) / set_current_version(Option<String>):
    required: false
    

    The current version of the MSK cluster.

    
    
• On success, responds with DeleteClusterOutput with field(s):
  • cluster_arn(Option<String>):

    The Amazon Resource Name (ARN) of the cluster.

  • state(Option<ClusterState>):

    The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.

• On failure, responds with SdkError<DeleteClusterError>

impl Client

pub fn delete_cluster_policy(&self) -> DeleteClusterPolicyFluentBuilder

Constructs a fluent builder for the DeleteClusterPolicy operation.

• The fluent builder is configurable:
  • cluster_arn(impl Into<String>) / set_cluster_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the cluster.

    
    
• On success, responds with DeleteClusterPolicyOutput
• On failure, responds with SdkError<DeleteClusterPolicyError>

impl Client

pub fn delete_configuration(&self) -> DeleteConfigurationFluentBuilder

Constructs a fluent builder for the DeleteConfiguration operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration.

    
    
• On success, responds with DeleteConfigurationOutput with field(s):
  • arn(Option<String>):

    The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration.

  • state(Option<ConfigurationState>):

    The state of the configuration. The possible states are ACTIVE, DELETING, and DELETE_FAILED.

• On failure, responds with SdkError<DeleteConfigurationError>

impl Client

pub fn delete_replicator(&self) -> DeleteReplicatorFluentBuilder

Constructs a fluent builder for the DeleteReplicator operation.

• The fluent builder is configurable:
  • current_version(impl Into<String>) / set_current_version(Option<String>):
    required: false
    

    The current version of the replicator.

    
    
  • replicator_arn(impl Into<String>) / set_replicator_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the replicator to be deleted.

    
    
• On success, responds with DeleteReplicatorOutput with field(s):
  • replicator_arn(Option<String>):

    The Amazon Resource Name (ARN) of the replicator.

  • replicator_state(Option<ReplicatorState>):

    The state of the replicator.

• On failure, responds with SdkError<DeleteReplicatorError>

impl Client

pub fn delete_vpc_connection(&self) -> DeleteVpcConnectionFluentBuilder

Constructs a fluent builder for the DeleteVpcConnection operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) that uniquely identifies an MSK VPC connection.

    
    
• On success, responds with DeleteVpcConnectionOutput with field(s):
  • vpc_connection_arn(Option<String>):

    The Amazon Resource Name (ARN) that uniquely identifies an MSK VPC connection.

  • state(Option<VpcConnectionState>):

    The state of the VPC connection.

• On failure, responds with SdkError<DeleteVpcConnectionError>

impl Client

pub fn describe_cluster(&self) -> DescribeClusterFluentBuilder

Constructs a fluent builder for the DescribeCluster operation.

• The fluent builder is configurable:
  • cluster_arn(impl Into<String>) / set_cluster_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) that uniquely identifies the cluster.

    
    
• On success, responds with DescribeClusterOutput with field(s):
  • cluster_info(Option<ClusterInfo>):

    The cluster information.

• On failure, responds with SdkError<DescribeClusterError>

impl Client

pub fn describe_cluster_operation( &self, ) -> DescribeClusterOperationFluentBuilder

Constructs a fluent builder for the DescribeClusterOperation operation.

• The fluent builder is configurable:
  • cluster_operation_arn(impl Into<String>) / set_cluster_operation_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) that uniquely identifies the MSK cluster operation.

    
    
• On success, responds with DescribeClusterOperationOutput with field(s):
  • cluster_operation_info(Option<ClusterOperationInfo>):

    Cluster operation information

• On failure, responds with SdkError<DescribeClusterOperationError>

impl Client

pub fn describe_cluster_operation_v2( &self, ) -> DescribeClusterOperationV2FluentBuilder

Constructs a fluent builder for the DescribeClusterOperationV2 operation.

• The fluent builder is configurable:
  • cluster_operation_arn(impl Into<String>) / set_cluster_operation_arn(Option<String>):
    required: true
    ARN of the cluster operation to describe.
    
• On success, responds with DescribeClusterOperationV2Output with field(s):
  • cluster_operation_info(Option<ClusterOperationV2>):

    Cluster operation information

• On failure, responds with SdkError<DescribeClusterOperationV2Error>

impl Client

pub fn describe_cluster_v2(&self) -> DescribeClusterV2FluentBuilder

Constructs a fluent builder for the DescribeClusterV2 operation.

• The fluent builder is configurable:
  • cluster_arn(impl Into<String>) / set_cluster_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) that uniquely identifies the cluster.

    
    
• On success, responds with DescribeClusterV2Output with field(s):
  • cluster_info(Option<Cluster>):

    The cluster information.

• On failure, responds with SdkError<DescribeClusterV2Error>

impl Client

pub fn describe_configuration(&self) -> DescribeConfigurationFluentBuilder

Constructs a fluent builder for the DescribeConfiguration operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration and all of its revisions.

    
    
• On success, responds with DescribeConfigurationOutput with field(s):
  • arn(Option<String>):

    The Amazon Resource Name (ARN) of the configuration.

  • creation_time(Option<DateTime>):

    The time when the configuration was created.

  • description(Option<String>):

    The description of the configuration.

  • kafka_versions(Option<Vec::<String>>):

    The versions of Apache Kafka with which you can use this MSK configuration.

  • latest_revision(Option<ConfigurationRevision>):

    Latest revision of the configuration.

  • name(Option<String>):

    The name of the configuration.

  • state(Option<ConfigurationState>):

    The state of the configuration. The possible states are ACTIVE, DELETING, and DELETE_FAILED.

• On failure, responds with SdkError<DescribeConfigurationError>

impl Client

pub fn describe_configuration_revision( &self, ) -> DescribeConfigurationRevisionFluentBuilder

Constructs a fluent builder for the DescribeConfigurationRevision operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration and all of its revisions.

    
    
  • revision(i64) / set_revision(Option<i64>):
    required: true
    

    A string that uniquely identifies a revision of an MSK configuration.

    
    
• On success, responds with DescribeConfigurationRevisionOutput with field(s):
  • arn(Option<String>):

    The Amazon Resource Name (ARN) of the configuration.

  • creation_time(Option<DateTime>):

    The time when the configuration was created.

  • description(Option<String>):

    The description of the configuration.

  • revision(Option<i64>):

    The revision number.

  • server_properties(Option<Blob>):

    Contents of the server.properties file. When using the API, you must ensure that the contents of the file are base64 encoded. When using the AWS Management Console, the SDK, or the AWS CLI, the contents of server.properties can be in plaintext.

• On failure, responds with SdkError<DescribeConfigurationRevisionError>

impl Client

pub fn describe_replicator(&self) -> DescribeReplicatorFluentBuilder

Constructs a fluent builder for the DescribeReplicator operation.

• The fluent builder is configurable:
  • replicator_arn(impl Into<String>) / set_replicator_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the replicator to be described.

    
    
• On success, responds with DescribeReplicatorOutput with field(s):
  • creation_time(Option<DateTime>):

    The time when the replicator was created.

  • current_version(Option<String>):

    The current version number of the replicator.

  • is_replicator_reference(Option<bool>):

    Whether this resource is a replicator reference.

  • kafka_clusters(Option<Vec::<KafkaClusterDescription>>):

    Kafka Clusters used in setting up sources / targets for replication.

  • replication_info_list(Option<Vec::<ReplicationInfoDescription>>):

    A list of replication configurations, where each configuration targets a given source cluster to target cluster replication flow.

  • replicator_arn(Option<String>):

    The Amazon Resource Name (ARN) of the replicator.

  • replicator_description(Option<String>):

    The description of the replicator.

  • replicator_name(Option<String>):

    The name of the replicator.

  • replicator_resource_arn(Option<String>):

    The Amazon Resource Name (ARN) of the replicator resource in the region where the replicator was created.

  • replicator_state(Option<ReplicatorState>):

    State of the replicator.

  • service_execution_role_arn(Option<String>):

    The Amazon Resource Name (ARN) of the IAM role used by the replicator to access resources in the customer’s account (e.g source and target clusters)

  • state_info(Option<ReplicationStateInfo>):

    Details about the state of the replicator.

  • tags(Option<HashMap::<String, String>>):

    List of tags attached to the Replicator.

• On failure, responds with SdkError<DescribeReplicatorError>

impl Client

pub fn describe_vpc_connection(&self) -> DescribeVpcConnectionFluentBuilder

Constructs a fluent builder for the DescribeVpcConnection operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) that uniquely identifies a MSK VPC connection.

    
    
• On success, responds with DescribeVpcConnectionOutput with field(s):
  • vpc_connection_arn(Option<String>):

    The Amazon Resource Name (ARN) that uniquely identifies a MSK VPC connection.

  • target_cluster_arn(Option<String>):

    The Amazon Resource Name (ARN) that uniquely identifies an MSK cluster.

  • state(Option<VpcConnectionState>):

    The state of VPC connection.

  • authentication(Option<String>):

    The authentication type of VPC connection.

  • vpc_id(Option<String>):

    The VPC Id for the VPC connection.

  • subnets(Option<Vec::<String>>):

    The list of subnets for the VPC connection.

  • security_groups(Option<Vec::<String>>):

    The list of security groups for the VPC connection.

  • creation_time(Option<DateTime>):

    The creation time of the VPC connection.

  • tags(Option<HashMap::<String, String>>):

    A map of tags for the VPC connection.

• On failure, responds with SdkError<DescribeVpcConnectionError>

impl Client

pub fn get_bootstrap_brokers(&self) -> GetBootstrapBrokersFluentBuilder

Constructs a fluent builder for the GetBootstrapBrokers operation.

• The fluent builder is configurable:
  • cluster_arn(impl Into<String>) / set_cluster_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) that uniquely identifies the cluster.

    
    
• On success, responds with GetBootstrapBrokersOutput with field(s):
  • bootstrap_broker_string(Option<String>):

    A string containing one or more hostname:port pairs.

  • bootstrap_broker_string_tls(Option<String>):

    A string containing one or more DNS names (or IP) and TLS port pairs.

  • bootstrap_broker_string_sasl_scram(Option<String>):

    A string containing one or more DNS names (or IP) and Sasl Scram port pairs.

  • bootstrap_broker_string_sasl_iam(Option<String>):

    A string that contains one or more DNS names (or IP addresses) and SASL IAM port pairs.

  • bootstrap_broker_string_public_tls(Option<String>):

    A string containing one or more DNS names (or IP) and TLS port pairs.

  • bootstrap_broker_string_public_sasl_scram(Option<String>):

    A string containing one or more DNS names (or IP) and Sasl Scram port pairs.

  • bootstrap_broker_string_public_sasl_iam(Option<String>):

    A string that contains one or more DNS names (or IP addresses) and SASL IAM port pairs.

  • bootstrap_broker_string_vpc_connectivity_tls(Option<String>):

    A string containing one or more DNS names (or IP) and TLS port pairs for VPC connectivity.

  • bootstrap_broker_string_vpc_connectivity_sasl_scram(Option<String>):

    A string containing one or more DNS names (or IP) and SASL/SCRAM port pairs for VPC connectivity.

  • bootstrap_broker_string_vpc_connectivity_sasl_iam(Option<String>):

    A string containing one or more DNS names (or IP) and SASL/IAM port pairs for VPC connectivity.

• On failure, responds with SdkError<GetBootstrapBrokersError>

impl Client

pub fn get_cluster_policy(&self) -> GetClusterPolicyFluentBuilder

Constructs a fluent builder for the GetClusterPolicy operation.

• The fluent builder is configurable:
  • cluster_arn(impl Into<String>) / set_cluster_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the cluster.

    
    
• On success, responds with GetClusterPolicyOutput with field(s):
  • current_version(Option<String>):

    The version of cluster policy.

  • policy(Option<String>):

    The cluster policy.

• On failure, responds with SdkError<GetClusterPolicyError>

impl Client

pub fn get_compatible_kafka_versions( &self, ) -> GetCompatibleKafkaVersionsFluentBuilder

Constructs a fluent builder for the GetCompatibleKafkaVersions operation.

• The fluent builder is configurable:
  • cluster_arn(impl Into<String>) / set_cluster_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the cluster check.

    
    
• On success, responds with GetCompatibleKafkaVersionsOutput with field(s):
  • compatible_kafka_versions(Option<Vec::<CompatibleKafkaVersion>>):

    A list of CompatibleKafkaVersion objects.

• On failure, responds with SdkError<GetCompatibleKafkaVersionsError>

impl Client

pub fn list_client_vpc_connections( &self, ) -> ListClientVpcConnectionsFluentBuilder

Constructs a fluent builder for the ListClientVpcConnections operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • cluster_arn(impl Into<String>) / set_cluster_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the cluster.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. To get the next batch, provide this token in your next request.

    
    
• On success, responds with ListClientVpcConnectionsOutput with field(s):
  • client_vpc_connections(Option<Vec::<ClientVpcConnection>>):

    List of client VPC connections.

  • next_token(Option<String>):

    The paginated results marker. When the result of a ListClientVpcConnections operation is truncated, the call returns NextToken in the response. To get another batch of configurations, provide this token in your next request.

• On failure, responds with SdkError<ListClientVpcConnectionsError>

impl Client

pub fn list_cluster_operations(&self) -> ListClusterOperationsFluentBuilder

Constructs a fluent builder for the ListClusterOperations operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • cluster_arn(impl Into<String>) / set_cluster_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) that uniquely identifies the cluster.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. To get the next batch, provide this token in your next request.

    
    
• On success, responds with ListClusterOperationsOutput with field(s):
  • cluster_operation_info_list(Option<Vec::<ClusterOperationInfo>>):

    An array of cluster operation information objects.

  • next_token(Option<String>):

    If the response of ListClusterOperations is truncated, it returns a NextToken in the response. This Nexttoken should be sent in the subsequent request to ListClusterOperations.

• On failure, responds with SdkError<ListClusterOperationsError>

impl Client

pub fn list_cluster_operations_v2(&self) -> ListClusterOperationsV2FluentBuilder

Constructs a fluent builder for the ListClusterOperationsV2 operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • cluster_arn(impl Into<String>) / set_cluster_arn(Option<String>):
    required: true
    The arn of the cluster whose operations are being requested.
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    The maxResults of the query.
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    The nextToken of the query.
    
• On success, responds with ListClusterOperationsV2Output with field(s):
  • cluster_operation_info_list(Option<Vec::<ClusterOperationV2Summary>>):

    An array of cluster operation information objects.

  • next_token(Option<String>):

    If the response of ListClusterOperationsV2 is truncated, it returns a NextToken in the response. This NextToken should be sent in the subsequent request to ListClusterOperationsV2.

• On failure, responds with SdkError<ListClusterOperationsV2Error>

impl Client

pub fn list_clusters(&self) -> ListClustersFluentBuilder

Constructs a fluent builder for the ListClusters operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • cluster_name_filter(impl Into<String>) / set_cluster_name_filter(Option<String>):
    required: false
    

    Specify a prefix of the name of the clusters that you want to list. The service lists all the clusters whose names start with this prefix.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. To get the next batch, provide this token in your next request.

    
    
• On success, responds with ListClustersOutput with field(s):
  • cluster_info_list(Option<Vec::<ClusterInfo>>):

    Information on each of the MSK clusters in the response.

  • next_token(Option<String>):

    The paginated results marker. When the result of a ListClusters operation is truncated, the call returns NextToken in the response. To get another batch of clusters, provide this token in your next request.

• On failure, responds with SdkError<ListClustersError>

impl Client

pub fn list_clusters_v2(&self) -> ListClustersV2FluentBuilder

Constructs a fluent builder for the ListClustersV2 operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • cluster_name_filter(impl Into<String>) / set_cluster_name_filter(Option<String>):
    required: false
    

    Specify a prefix of the names of the clusters that you want to list. The service lists all the clusters whose names start with this prefix.

    
    
  • cluster_type_filter(impl Into<String>) / set_cluster_type_filter(Option<String>):
    required: false
    

    Specify either PROVISIONED or SERVERLESS.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. To get the next batch, provide this token in your next request.

    
    
• On success, responds with ListClustersV2Output with field(s):
  • cluster_info_list(Option<Vec::<Cluster>>):

    Information on each of the MSK clusters in the response.

  • next_token(Option<String>):

    The paginated results marker. When the result of a ListClusters operation is truncated, the call returns NextToken in the response. To get another batch of clusters, provide this token in your next request.

• On failure, responds with SdkError<ListClustersV2Error>

impl Client

pub fn list_configuration_revisions( &self, ) -> ListConfigurationRevisionsFluentBuilder

Constructs a fluent builder for the ListConfigurationRevisions operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration and all of its revisions.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. To get the next batch, provide this token in your next request.

    
    
• On success, responds with ListConfigurationRevisionsOutput with field(s):
  • next_token(Option<String>):

    Paginated results marker.

  • revisions(Option<Vec::<ConfigurationRevision>>):

    List of ConfigurationRevision objects.

• On failure, responds with SdkError<ListConfigurationRevisionsError>

impl Client

pub fn list_configurations(&self) -> ListConfigurationsFluentBuilder

Constructs a fluent builder for the ListConfigurations operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. To get the next batch, provide this token in your next request.

    
    
• On success, responds with ListConfigurationsOutput with field(s):
  • configurations(Option<Vec::<Configuration>>):

    An array of MSK configurations.

  • next_token(Option<String>):

    The paginated results marker. When the result of a ListConfigurations operation is truncated, the call returns NextToken in the response. To get another batch of configurations, provide this token in your next request.

• On failure, responds with SdkError<ListConfigurationsError>

impl Client

pub fn list_kafka_versions(&self) -> ListKafkaVersionsFluentBuilder

Constructs a fluent builder for the ListKafkaVersions operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. To get the next batch, provide this token in your next request.

    
    
• On success, responds with ListKafkaVersionsOutput with field(s):
  • kafka_versions(Option<Vec::<KafkaVersion>>): (undocumented)
  • next_token(Option<String>): (undocumented)
• On failure, responds with SdkError<ListKafkaVersionsError>

impl Client

pub fn list_nodes(&self) -> ListNodesFluentBuilder

Constructs a fluent builder for the ListNodes operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • cluster_arn(impl Into<String>) / set_cluster_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) that uniquely identifies the cluster.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. To get the next batch, provide this token in your next request.

    
    
• On success, responds with ListNodesOutput with field(s):
  • next_token(Option<String>):

    The paginated results marker. When the result of a ListNodes operation is truncated, the call returns NextToken in the response. To get another batch of nodes, provide this token in your next request.

  • node_info_list(Option<Vec::<NodeInfo>>):

    List containing a NodeInfo object.

• On failure, responds with SdkError<ListNodesError>

impl Client

pub fn list_replicators(&self) -> ListReplicatorsFluentBuilder

Constructs a fluent builder for the ListReplicators operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    If the response of ListReplicators is truncated, it returns a NextToken in the response. This NextToken should be sent in the subsequent request to ListReplicators.

    
    
  • replicator_name_filter(impl Into<String>) / set_replicator_name_filter(Option<String>):
    required: false
    

    Returns replicators starting with given name.

    
    
• On success, responds with ListReplicatorsOutput with field(s):
  • next_token(Option<String>):

    If the response of ListReplicators is truncated, it returns a NextToken in the response. This NextToken should be sent in the subsequent request to ListReplicators.

  • replicators(Option<Vec::<ReplicatorSummary>>):

    List containing information of each of the replicators in the account.

• On failure, responds with SdkError<ListReplicatorsError>

impl Client

pub fn list_scram_secrets(&self) -> ListScramSecretsFluentBuilder

Constructs a fluent builder for the ListScramSecrets operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • cluster_arn(impl Into<String>) / set_cluster_arn(Option<String>):
    required: true
    

    The arn of the cluster.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maxResults of the query.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The nextToken of the query.

    
    
• On success, responds with ListScramSecretsOutput with field(s):
  • next_token(Option<String>):

    Paginated results marker.

  • secret_arn_list(Option<Vec::<String>>):

    The list of scram secrets associated with the cluster.

• On failure, responds with SdkError<ListScramSecretsError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) that uniquely identifies the resource that’s associated with the tags.

    
    
• On success, responds with ListTagsForResourceOutput with field(s):
  • tags(Option<HashMap::<String, String>>):

    The key-value pair for the resource tag.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn list_vpc_connections(&self) -> ListVpcConnectionsFluentBuilder

Constructs a fluent builder for the ListVpcConnections operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. To get the next batch, provide this token in your next request.

    
    
• On success, responds with ListVpcConnectionsOutput with field(s):
  • vpc_connections(Option<Vec::<VpcConnection>>):

    List of VPC connections.

  • next_token(Option<String>):

    The paginated results marker. When the result of a ListClientVpcConnections operation is truncated, the call returns NextToken in the response. To get another batch of configurations, provide this token in your next request.

• On failure, responds with SdkError<ListVpcConnectionsError>

impl Client

pub fn put_cluster_policy(&self) -> PutClusterPolicyFluentBuilder

Constructs a fluent builder for the PutClusterPolicy operation.

• The fluent builder is configurable:
  • cluster_arn(impl Into<String>) / set_cluster_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the cluster.

    
    
  • current_version(impl Into<String>) / set_current_version(Option<String>):
    required: false
    

    The policy version.

    
    
  • policy(impl Into<String>) / set_policy(Option<String>):
    required: true
    

    The policy.

    
    
• On success, responds with PutClusterPolicyOutput with field(s):
  • current_version(Option<String>):

    The policy version.

• On failure, responds with SdkError<PutClusterPolicyError>

impl Client

pub fn reboot_broker(&self) -> RebootBrokerFluentBuilder

Constructs a fluent builder for the RebootBroker operation.

• The fluent builder is configurable:
  • broker_ids(impl Into<String>) / set_broker_ids(Option<Vec::<String>>):
    required: true
    

    The list of broker IDs to be rebooted. The reboot-broker operation supports rebooting one broker at a time.

    
    
  • cluster_arn(impl Into<String>) / set_cluster_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the cluster to be updated.

    
    
• On success, responds with RebootBrokerOutput with field(s):
  • cluster_arn(Option<String>):

    The Amazon Resource Name (ARN) of the cluster.

  • cluster_operation_arn(Option<String>):

    The Amazon Resource Name (ARN) of the cluster operation.

• On failure, responds with SdkError<RebootBrokerError>

impl Client

pub fn reject_client_vpc_connection( &self, ) -> RejectClientVpcConnectionFluentBuilder

Constructs a fluent builder for the RejectClientVpcConnection operation.

• The fluent builder is configurable:
  • cluster_arn(impl Into<String>) / set_cluster_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the cluster.

    
    
  • vpc_connection_arn(impl Into<String>) / set_vpc_connection_arn(Option<String>):
    required: true
    

    The VPC connection ARN.

    
    
• On success, responds with RejectClientVpcConnectionOutput
• On failure, responds with SdkError<RejectClientVpcConnectionError>

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) that uniquely identifies the resource that’s associated with the tags.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: true
    

    The key-value pair for the resource tag.

    
    
• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) that uniquely identifies the resource that’s associated with the tags.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

    Tag keys must be unique for a given cluster. In addition, the following restrictions apply:

    • Each tag key must be unique. If you add a tag with a key that’s already in use, your new tag overwrites the existing key-value pair.

    • You can’t start a tag key with aws: because this prefix is reserved for use by AWS. AWS creates tags that begin with this prefix on your behalf, but you can’t edit or delete them.

    • Tag keys must be between 1 and 128 Unicode characters in length.

    • Tag keys must consist of the following characters: Unicode letters, digits, white space, and the following special characters: _ . / = + - @.

    
    
• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

impl Client

pub fn update_broker_count(&self) -> UpdateBrokerCountFluentBuilder

Constructs a fluent builder for the UpdateBrokerCount operation.

• The fluent builder is configurable:
  • cluster_arn(impl Into<String>) / set_cluster_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) that uniquely identifies the cluster.

    
    
  • current_version(impl Into<String>) / set_current_version(Option<String>):
    required: true
    

    The version of cluster to update from. A successful operation will then generate a new version.

    
    
  • target_number_of_broker_nodes(i32) / set_target_number_of_broker_nodes(Option<i32>):
    required: true
    

    The number of broker nodes that you want the cluster to have after this operation completes successfully.

    
    
• On success, responds with UpdateBrokerCountOutput with field(s):
  • cluster_arn(Option<String>):

    The Amazon Resource Name (ARN) of the cluster.

  • cluster_operation_arn(Option<String>):

    The Amazon Resource Name (ARN) of the cluster operation.

• On failure, responds with SdkError<UpdateBrokerCountError>

impl Client

pub fn update_broker_storage(&self) -> UpdateBrokerStorageFluentBuilder

Constructs a fluent builder for the UpdateBrokerStorage operation.

• The fluent builder is configurable:
  • cluster_arn(impl Into<String>) / set_cluster_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) that uniquely identifies the cluster.

    
    
  • current_version(impl Into<String>) / set_current_version(Option<String>):
    required: true
    

    The version of cluster to update from. A successful operation will then generate a new version.

    
    
  • target_broker_ebs_volume_info(BrokerEbsVolumeInfo) / set_target_broker_ebs_volume_info(Option<Vec::<BrokerEbsVolumeInfo>>):
    required: true
    

    Describes the target volume size and the ID of the broker to apply the update to.

    
    
• On success, responds with UpdateBrokerStorageOutput with field(s):
  • cluster_arn(Option<String>):

    The Amazon Resource Name (ARN) of the cluster.

  • cluster_operation_arn(Option<String>):

    The Amazon Resource Name (ARN) of the cluster operation.

• On failure, responds with SdkError<UpdateBrokerStorageError>

impl Client

pub fn update_broker_type(&self) -> UpdateBrokerTypeFluentBuilder

Constructs a fluent builder for the UpdateBrokerType operation.

• The fluent builder is configurable:
  • cluster_arn(impl Into<String>) / set_cluster_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) that uniquely identifies the cluster.

    
    
  • current_version(impl Into<String>) / set_current_version(Option<String>):
    required: true
    

    The cluster version that you want to change. After this operation completes successfully, the cluster will have a new version.

    
    
  • target_instance_type(impl Into<String>) / set_target_instance_type(Option<String>):
    required: true
    

    The Amazon MSK broker type that you want all of the brokers in this cluster to be.

    
    
• On success, responds with UpdateBrokerTypeOutput with field(s):
  • cluster_arn(Option<String>):

    The Amazon Resource Name (ARN) of the cluster.

  • cluster_operation_arn(Option<String>):

    The Amazon Resource Name (ARN) of the cluster operation.

• On failure, responds with SdkError<UpdateBrokerTypeError>

impl Client

pub fn update_cluster_configuration( &self, ) -> UpdateClusterConfigurationFluentBuilder

Constructs a fluent builder for the UpdateClusterConfiguration operation.

• The fluent builder is configurable:
  • cluster_arn(impl Into<String>) / set_cluster_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) that uniquely identifies the cluster.

    
    
  • configuration_info(ConfigurationInfo) / set_configuration_info(Option<ConfigurationInfo>):
    required: true
    

    Represents the configuration that you want MSK to use for the brokers in a cluster.

    
    
  • current_version(impl Into<String>) / set_current_version(Option<String>):
    required: true
    

    The version of the cluster that needs to be updated.

    
    
• On success, responds with UpdateClusterConfigurationOutput with field(s):
  • cluster_arn(Option<String>):

    The Amazon Resource Name (ARN) of the cluster.

  • cluster_operation_arn(Option<String>):

    The Amazon Resource Name (ARN) of the cluster operation.

• On failure, responds with SdkError<UpdateClusterConfigurationError>

impl Client

pub fn update_cluster_kafka_version( &self, ) -> UpdateClusterKafkaVersionFluentBuilder

Constructs a fluent builder for the UpdateClusterKafkaVersion operation.

• The fluent builder is configurable:
  • cluster_arn(impl Into<String>) / set_cluster_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the cluster to be updated.

    
    
  • configuration_info(ConfigurationInfo) / set_configuration_info(Option<ConfigurationInfo>):
    required: false
    

    The custom configuration that should be applied on the new version of cluster.

    
    
  • current_version(impl Into<String>) / set_current_version(Option<String>):
    required: true
    

    Current cluster version.

    
    
  • target_kafka_version(impl Into<String>) / set_target_kafka_version(Option<String>):
    required: true
    

    Target Kafka version.

    
    
• On success, responds with UpdateClusterKafkaVersionOutput with field(s):
  • cluster_arn(Option<String>):

    The Amazon Resource Name (ARN) of the cluster.

  • cluster_operation_arn(Option<String>):

    The Amazon Resource Name (ARN) of the cluster operation.

• On failure, responds with SdkError<UpdateClusterKafkaVersionError>

impl Client

pub fn update_configuration(&self) -> UpdateConfigurationFluentBuilder

Constructs a fluent builder for the UpdateConfiguration operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the configuration.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the configuration revision.

    
    
  • server_properties(Blob) / set_server_properties(Option<Blob>):
    required: true
    

    Contents of the server.properties file. When using the API, you must ensure that the contents of the file are base64 encoded. When using the AWS Management Console, the SDK, or the AWS CLI, the contents of server.properties can be in plaintext.

    
    
• On success, responds with UpdateConfigurationOutput with field(s):
  • arn(Option<String>):

    The Amazon Resource Name (ARN) of the configuration.

  • latest_revision(Option<ConfigurationRevision>):

    Latest revision of the configuration.

• On failure, responds with SdkError<UpdateConfigurationError>

impl Client

pub fn update_connectivity(&self) -> UpdateConnectivityFluentBuilder

Constructs a fluent builder for the UpdateConnectivity operation.

• The fluent builder is configurable:
  • cluster_arn(impl Into<String>) / set_cluster_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the configuration.

    
    
  • connectivity_info(ConnectivityInfo) / set_connectivity_info(Option<ConnectivityInfo>):
    required: true
    

    Information about the broker access configuration.

    
    
  • current_version(impl Into<String>) / set_current_version(Option<String>):
    required: true
    

    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.

    
    
• On success, responds with UpdateConnectivityOutput with field(s):
  • cluster_arn(Option<String>):

    The Amazon Resource Name (ARN) of the cluster.

  • cluster_operation_arn(Option<String>):

    The Amazon Resource Name (ARN) of the cluster operation.

• On failure, responds with SdkError<UpdateConnectivityError>

impl Client

pub fn update_monitoring(&self) -> UpdateMonitoringFluentBuilder

Constructs a fluent builder for the UpdateMonitoring operation.

• The fluent builder is configurable:
  • cluster_arn(impl Into<String>) / set_cluster_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) that uniquely identifies the cluster.

    
    
  • current_version(impl Into<String>) / set_current_version(Option<String>):
    required: true
    

    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.

    
    
  • enhanced_monitoring(EnhancedMonitoring) / set_enhanced_monitoring(Option<EnhancedMonitoring>):
    required: false
    

    Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster.

    
    
  • open_monitoring(OpenMonitoringInfo) / set_open_monitoring(Option<OpenMonitoringInfo>):
    required: false
    

    The settings for open monitoring.

    
    
  • logging_info(LoggingInfo) / set_logging_info(Option<LoggingInfo>):
    required: false
    (undocumented)
    
• On success, responds with UpdateMonitoringOutput with field(s):
  • cluster_arn(Option<String>):

    The Amazon Resource Name (ARN) of the cluster.

  • cluster_operation_arn(Option<String>):

    The Amazon Resource Name (ARN) of the cluster operation.

• On failure, responds with SdkError<UpdateMonitoringError>

impl Client

pub fn update_replication_info(&self) -> UpdateReplicationInfoFluentBuilder

Constructs a fluent builder for the UpdateReplicationInfo operation.

• The fluent builder is configurable:
  • consumer_group_replication(ConsumerGroupReplicationUpdate) / set_consumer_group_replication(Option<ConsumerGroupReplicationUpdate>):
    required: false
    

    Updated consumer group replication information.

    
    
  • current_version(impl Into<String>) / set_current_version(Option<String>):
    required: true
    

    Current replicator version.

    
    
  • replicator_arn(impl Into<String>) / set_replicator_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the replicator to be updated.

    
    
  • source_kafka_cluster_arn(impl Into<String>) / set_source_kafka_cluster_arn(Option<String>):
    required: true
    

    The ARN of the source Kafka cluster.

    
    
  • target_kafka_cluster_arn(impl Into<String>) / set_target_kafka_cluster_arn(Option<String>):
    required: true
    

    The ARN of the target Kafka cluster.

    
    
  • topic_replication(TopicReplicationUpdate) / set_topic_replication(Option<TopicReplicationUpdate>):
    required: false
    

    Updated topic replication information.

    
    
• On success, responds with UpdateReplicationInfoOutput with field(s):
  • replicator_arn(Option<String>):

    The Amazon Resource Name (ARN) of the replicator.

  • replicator_state(Option<ReplicatorState>):

    State of the replicator.

• On failure, responds with SdkError<UpdateReplicationInfoError>

impl Client

pub fn update_security(&self) -> UpdateSecurityFluentBuilder

Constructs a fluent builder for the UpdateSecurity operation.

• The fluent builder is configurable:
  • client_authentication(ClientAuthentication) / set_client_authentication(Option<ClientAuthentication>):
    required: false
    

    Includes all client authentication related information.

    
    
  • cluster_arn(impl Into<String>) / set_cluster_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) that uniquely identifies the cluster.

    
    
  • current_version(impl Into<String>) / set_current_version(Option<String>):
    required: true
    

    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.

    
    
  • encryption_info(EncryptionInfo) / set_encryption_info(Option<EncryptionInfo>):
    required: false
    

    Includes all encryption-related information.

    
    
• On success, responds with UpdateSecurityOutput with field(s):
  • cluster_arn(Option<String>):

    The Amazon Resource Name (ARN) of the cluster.

  • cluster_operation_arn(Option<String>):

    The Amazon Resource Name (ARN) of the cluster operation.

• On failure, responds with SdkError<UpdateSecurityError>

impl Client

pub fn update_storage(&self) -> UpdateStorageFluentBuilder

Constructs a fluent builder for the UpdateStorage operation.

• The fluent builder is configurable:
  • cluster_arn(impl Into<String>) / set_cluster_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the cluster to be updated.

    
    
  • current_version(impl Into<String>) / set_current_version(Option<String>):
    required: true
    

    The version of cluster to update from. A successful operation will then generate a new version.

    
    
  • provisioned_throughput(ProvisionedThroughput) / set_provisioned_throughput(Option<ProvisionedThroughput>):
    required: false
    

    EBS volume provisioned throughput information.

    
    
  • storage_mode(StorageMode) / set_storage_mode(Option<StorageMode>):
    required: false
    

    Controls storage mode for supported storage tiers.

    
    
  • volume_size_gb(i32) / set_volume_size_gb(Option<i32>):
    required: false
    

    size of the EBS volume to update.

    
    
• On success, responds with UpdateStorageOutput with field(s):
  • cluster_arn(Option<String>):

    The Amazon Resource Name (ARN) of the cluster.

  • cluster_operation_arn(Option<String>):

    The Amazon Resource Name (ARN) of the cluster operation.

• On failure, responds with SdkError<UpdateStorageError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.