Managed Streaming for Kafka 2018-11-14
- Client: Aws\Kafka\KafkaClient
- Service ID: kafka
- Version: 2018-11-14
This page describes the parameters and results for the operations of the Managed Streaming for Kafka (2018-11-14), and shows how to use the Aws\Kafka\KafkaClient object to call the described operations. This documentation is specific to the 2018-11-14 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
- BatchAssociateScramSecret ( array $params = [] )
Associates one or more Scram Secrets with an Amazon MSK cluster.
- BatchDisassociateScramSecret ( array $params = [] )
Disassociates one or more Scram Secrets from an Amazon MSK cluster.
- CreateCluster ( array $params = [] )
Creates a new MSK cluster.
- CreateClusterV2 ( array $params = [] )
Creates a new Amazon MSK cluster of either the provisioned or the serverless type.
- CreateConfiguration ( array $params = [] )
Creates a new MSK configuration.
- DeleteCluster ( array $params = [] )
Deletes the MSK cluster specified by the Amazon Resource Name (ARN) in the request.
- DeleteConfiguration ( array $params = [] )
Deletes the specified MSK configuration.
- DescribeCluster ( array $params = [] )
Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request.
- DescribeClusterOperation ( array $params = [] )
Returns a description of the cluster operation specified by the ARN.
- DescribeClusterV2 ( array $params = [] )
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.
- DescribeConfiguration ( array $params = [] )
Returns a description of this MSK configuration.
- DescribeConfigurationRevision ( array $params = [] )
Returns a description of this revision of the configuration.
- GetBootstrapBrokers ( array $params = [] )
A list of brokers that a client application can use to bootstrap.
- GetCompatibleKafkaVersions ( array $params = [] )
Gets the Apache Kafka versions to which you can update the MSK cluster.
- ListClusterOperations ( array $params = [] )
Returns a list of all the operations that have been performed on the specified MSK cluster.
- ListClusters ( array $params = [] )
Returns a list of all the MSK clusters in the current Region.
- ListClustersV2 ( array $params = [] )
Returns a list of all the MSK clusters in the current Region.
- ListConfigurationRevisions ( array $params = [] )
Returns a list of all the revisions of an MSK configuration.
- ListConfigurations ( array $params = [] )
Returns a list of all the MSK configurations in this Region.
- ListKafkaVersions ( array $params = [] )
Returns a list of Apache Kafka versions.
- ListNodes ( array $params = [] )
Returns a list of the broker nodes in the cluster.
- ListScramSecrets ( array $params = [] )
Returns a list of the Scram Secrets associated with an Amazon MSK cluster.
- ListTagsForResource ( array $params = [] )
Returns a list of the tags associated with the specified resource.
- RebootBroker ( array $params = [] )
Executes a reboot on a broker.
- TagResource ( array $params = [] )
Adds tags to the specified MSK resource.
- UntagResource ( array $params = [] )
Removes the tags associated with the keys that are provided in the query.
- UpdateBrokerCount ( array $params = [] )
Updates the number of broker nodes in the cluster.
- UpdateBrokerStorage ( array $params = [] )
Updates the EBS storage associated with MSK brokers.
- UpdateBrokerType ( array $params = [] )
Updates all the brokers in the cluster to the specified type.
- UpdateClusterConfiguration ( array $params = [] )
Updates the cluster with the configuration that is specified in the request body.
- UpdateClusterKafkaVersion ( array $params = [] )
Updates the Apache Kafka version for the cluster.
- UpdateConfiguration ( array $params = [] )
Updates an existing MSK configuration.
- UpdateConnectivity ( array $params = [] )
Updates the connectivity configuration for the cluster.
- UpdateMonitoring ( array $params = [] )
Updates the monitoring settings for the cluster.
- UpdateSecurity ( array $params = [] )
You can use this operation to update the encrypting and authentication settings for an existing cluster.
- UpdateStorage ( array $params = [] )
Updates cluster broker volume size (or) sets cluster storage mode to TIERED.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
Operations
BatchAssociateScramSecret
$result = $client->batchAssociateScramSecret([/* ... */]); $promise = $client->batchAssociateScramSecretAsync([/* ... */]);
Associates one or more Scram Secrets with an Amazon MSK cluster.
Parameter Syntax
$result = $client->batchAssociateScramSecret([
'ClusterArn' => '<string>', // REQUIRED
'SecretArnList' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'ClusterArn' => '<string>',
'UnprocessedScramSecrets' => [
[
'ErrorCode' => '<string>',
'ErrorMessage' => '<string>',
'SecretArn' => '<string>',
],
// ...
],
]
Result Details
Members
- ClusterArn
-
- Type: string
The Amazon Resource Name (ARN) of the cluster.
- UnprocessedScramSecrets
-
- Type: Array of UnprocessedScramSecret structures
List of errors when associating secrets to cluster.
Errors
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
BatchDisassociateScramSecret
$result = $client->batchDisassociateScramSecret([/* ... */]); $promise = $client->batchDisassociateScramSecretAsync([/* ... */]);
Disassociates one or more Scram Secrets from an Amazon MSK cluster.
Parameter Syntax
$result = $client->batchDisassociateScramSecret([
'ClusterArn' => '<string>', // REQUIRED
'SecretArnList' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'ClusterArn' => '<string>',
'UnprocessedScramSecrets' => [
[
'ErrorCode' => '<string>',
'ErrorMessage' => '<string>',
'SecretArn' => '<string>',
],
// ...
],
]
Result Details
Members
- ClusterArn
-
- Type: string
The Amazon Resource Name (ARN) of the cluster.
- UnprocessedScramSecrets
-
- Type: Array of UnprocessedScramSecret structures
List of errors when disassociating secrets to cluster.
Errors
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
CreateCluster
$result = $client->createCluster([/* ... */]); $promise = $client->createClusterAsync([/* ... */]);
Creates a new MSK cluster.
Parameter Syntax
$result = $client->createCluster([
'BrokerNodeGroupInfo' => [ // REQUIRED
'BrokerAZDistribution' => 'DEFAULT',
'ClientSubnets' => ['<string>', ...], // REQUIRED
'ConnectivityInfo' => [
'PublicAccess' => [
'Type' => '<string>',
],
],
'InstanceType' => '<string>', // REQUIRED
'SecurityGroups' => ['<string>', ...],
'StorageInfo' => [
'EbsStorageInfo' => [
'ProvisionedThroughput' => [
'Enabled' => true || false,
'VolumeThroughput' => <integer>,
],
'VolumeSize' => <integer>,
],
],
],
'ClientAuthentication' => [
'Sasl' => [
'Iam' => [
'Enabled' => true || false,
],
'Scram' => [
'Enabled' => true || false,
],
],
'Tls' => [
'CertificateAuthorityArnList' => ['<string>', ...],
'Enabled' => true || false,
],
'Unauthenticated' => [
'Enabled' => true || false,
],
],
'ClusterName' => '<string>', // REQUIRED
'ConfigurationInfo' => [
'Arn' => '<string>', // REQUIRED
'Revision' => <integer>, // REQUIRED
],
'EncryptionInfo' => [
'EncryptionAtRest' => [
'DataVolumeKMSKeyId' => '<string>', // REQUIRED
],
'EncryptionInTransit' => [
'ClientBroker' => 'TLS|TLS_PLAINTEXT|PLAINTEXT',
'InCluster' => true || false,
],
],
'EnhancedMonitoring' => 'DEFAULT|PER_BROKER|PER_TOPIC_PER_BROKER|PER_TOPIC_PER_PARTITION',
'KafkaVersion' => '<string>', // REQUIRED
'LoggingInfo' => [
'BrokerLogs' => [ // REQUIRED
'CloudWatchLogs' => [
'Enabled' => true || false, // REQUIRED
'LogGroup' => '<string>',
],
'Firehose' => [
'DeliveryStream' => '<string>',
'Enabled' => true || false, // REQUIRED
],
'S3' => [
'Bucket' => '<string>',
'Enabled' => true || false, // REQUIRED
'Prefix' => '<string>',
],
],
],
'NumberOfBrokerNodes' => <integer>, // REQUIRED
'OpenMonitoring' => [
'Prometheus' => [ // REQUIRED
'JmxExporter' => [
'EnabledInBroker' => true || false, // REQUIRED
],
'NodeExporter' => [
'EnabledInBroker' => true || false, // REQUIRED
],
],
],
'StorageMode' => 'LOCAL|TIERED',
'Tags' => ['<string>', ...],
]);
Parameter Details
Members
- BrokerNodeGroupInfo
-
- Required: Yes
- Type: BrokerNodeGroupInfo structure
Information about the brokers.
- ClientAuthentication
-
- Type: ClientAuthentication structure
Includes all client authentication related information.
- ClusterName
-
- Required: Yes
- Type: string
The name of the cluster.
- ConfigurationInfo
-
- Type: ConfigurationInfo structure
Represents the configuration that you want MSK to use for the cluster.
- EncryptionInfo
-
- Type: EncryptionInfo structure
Includes all encryption-related information.
- EnhancedMonitoring
-
- Type: string
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.
- KafkaVersion
-
- Required: Yes
- Type: string
The version of Apache Kafka.
- LoggingInfo
-
- Type: LoggingInfo structure
LoggingInfo details.
- NumberOfBrokerNodes
-
- Required: Yes
- Type: int
The number of Apache Kafka broker nodes in the Amazon MSK cluster.
- OpenMonitoring
-
- Type: OpenMonitoringInfo structure
The settings for open monitoring.
- StorageMode
-
- Type: string
This controls storage mode for supported storage tiers.
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Create tags when creating the cluster.
Result Syntax
[
'ClusterArn' => '<string>',
'ClusterName' => '<string>',
'State' => 'ACTIVE|CREATING|DELETING|FAILED|HEALING|MAINTENANCE|REBOOTING_BROKER|UPDATING',
]
Result Details
Members
Errors
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
CreateClusterV2
$result = $client->createClusterV2([/* ... */]); $promise = $client->createClusterV2Async([/* ... */]);
Creates a new Amazon MSK cluster of either the provisioned or the serverless type.
Parameter Syntax
$result = $client->createClusterV2([
'ClusterName' => '<string>', // REQUIRED
'Provisioned' => [
'BrokerNodeGroupInfo' => [ // REQUIRED
'BrokerAZDistribution' => 'DEFAULT',
'ClientSubnets' => ['<string>', ...], // REQUIRED
'ConnectivityInfo' => [
'PublicAccess' => [
'Type' => '<string>',
],
],
'InstanceType' => '<string>', // REQUIRED
'SecurityGroups' => ['<string>', ...],
'StorageInfo' => [
'EbsStorageInfo' => [
'ProvisionedThroughput' => [
'Enabled' => true || false,
'VolumeThroughput' => <integer>,
],
'VolumeSize' => <integer>,
],
],
],
'ClientAuthentication' => [
'Sasl' => [
'Iam' => [
'Enabled' => true || false,
],
'Scram' => [
'Enabled' => true || false,
],
],
'Tls' => [
'CertificateAuthorityArnList' => ['<string>', ...],
'Enabled' => true || false,
],
'Unauthenticated' => [
'Enabled' => true || false,
],
],
'ConfigurationInfo' => [
'Arn' => '<string>', // REQUIRED
'Revision' => <integer>, // REQUIRED
],
'EncryptionInfo' => [
'EncryptionAtRest' => [
'DataVolumeKMSKeyId' => '<string>', // REQUIRED
],
'EncryptionInTransit' => [
'ClientBroker' => 'TLS|TLS_PLAINTEXT|PLAINTEXT',
'InCluster' => true || false,
],
],
'EnhancedMonitoring' => 'DEFAULT|PER_BROKER|PER_TOPIC_PER_BROKER|PER_TOPIC_PER_PARTITION',
'KafkaVersion' => '<string>', // REQUIRED
'LoggingInfo' => [
'BrokerLogs' => [ // REQUIRED
'CloudWatchLogs' => [
'Enabled' => true || false, // REQUIRED
'LogGroup' => '<string>',
],
'Firehose' => [
'DeliveryStream' => '<string>',
'Enabled' => true || false, // REQUIRED
],
'S3' => [
'Bucket' => '<string>',
'Enabled' => true || false, // REQUIRED
'Prefix' => '<string>',
],
],
],
'NumberOfBrokerNodes' => <integer>, // REQUIRED
'OpenMonitoring' => [
'Prometheus' => [ // REQUIRED
'JmxExporter' => [
'EnabledInBroker' => true || false, // REQUIRED
],
'NodeExporter' => [
'EnabledInBroker' => true || false, // REQUIRED
],
],
],
'StorageMode' => 'LOCAL|TIERED',
],
'Serverless' => [
'ClientAuthentication' => [
'Sasl' => [
'Iam' => [
'Enabled' => true || false,
],
],
],
'VpcConfigs' => [ // REQUIRED
[
'SecurityGroupIds' => ['<string>', ...],
'SubnetIds' => ['<string>', ...], // REQUIRED
],
// ...
],
],
'Tags' => ['<string>', ...],
]);
Parameter Details
Members
- ClusterName
-
- Required: Yes
- Type: string
- Provisioned
-
- Type: ProvisionedRequest structure
Creates a provisioned cluster.
- Serverless
-
- Type: ServerlessRequest structure
Creates a serverless cluster.
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Result Syntax
[
'ClusterArn' => '<string>',
'ClusterName' => '<string>',
'ClusterType' => 'PROVISIONED|SERVERLESS',
'State' => 'ACTIVE|CREATING|DELETING|FAILED|HEALING|MAINTENANCE|REBOOTING_BROKER|UPDATING',
]
Result Details
Members
Errors
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
CreateConfiguration
$result = $client->createConfiguration([/* ... */]); $promise = $client->createConfigurationAsync([/* ... */]);
Creates a new MSK configuration.
Parameter Syntax
$result = $client->createConfiguration([
'Description' => '<string>',
'KafkaVersions' => ['<string>', ...],
'Name' => '<string>', // REQUIRED
'ServerProperties' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED
]);
Parameter Details
Members
- Description
-
- Type: string
The description of the configuration.
- KafkaVersions
-
- Type: Array of strings
The versions of Apache Kafka with which you can use this MSK configuration.
- Name
-
- Required: Yes
- Type: string
The name of the configuration. Configuration names are strings that match the regex "^[0-9A-Za-z-]+$".
- ServerProperties
-
- Required: Yes
- Type: blob (string|resource|Psr\Http\Message\StreamInterface)
Result Syntax
[
'Arn' => '<string>',
'CreationTime' => <DateTime>,
'LatestRevision' => [
'CreationTime' => <DateTime>,
'Description' => '<string>',
'Revision' => <integer>,
],
'Name' => '<string>',
'State' => 'ACTIVE|DELETING|DELETE_FAILED',
]
Result Details
Members
- Arn
-
- Type: string
The Amazon Resource Name (ARN) of the configuration.
- CreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the configuration was created.
- LatestRevision
-
- Type: ConfigurationRevision structure
Latest revision of the configuration.
- Name
-
- Type: string
The name of the configuration. Configuration names are strings that match the regex "^[0-9A-Za-z-]+$".
- State
-
- Type: string
The state of the configuration. The possible states are ACTIVE, DELETING and DELETE_FAILED.
Errors
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
DeleteCluster
$result = $client->deleteCluster([/* ... */]); $promise = $client->deleteClusterAsync([/* ... */]);
Deletes the MSK cluster specified by the Amazon Resource Name (ARN) in the request.
Parameter Syntax
$result = $client->deleteCluster([
'ClusterArn' => '<string>', // REQUIRED
'CurrentVersion' => '<string>',
]);
Parameter Details
Result Syntax
[
'ClusterArn' => '<string>',
'State' => 'ACTIVE|CREATING|DELETING|FAILED|HEALING|MAINTENANCE|REBOOTING_BROKER|UPDATING',
]
Result Details
Members
Errors
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
DeleteConfiguration
$result = $client->deleteConfiguration([/* ... */]); $promise = $client->deleteConfigurationAsync([/* ... */]);
Deletes the specified MSK configuration. The configuration must be in the ACTIVE or DELETE_FAILED state.
Parameter Syntax
$result = $client->deleteConfiguration([
'Arn' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'Arn' => '<string>',
'State' => 'ACTIVE|DELETING|DELETE_FAILED',
]
Result Details
Members
Errors
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
DescribeCluster
$result = $client->describeCluster([/* ... */]); $promise = $client->describeClusterAsync([/* ... */]);
Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request.
Parameter Syntax
$result = $client->describeCluster([
'ClusterArn' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'ClusterInfo' => [
'ActiveOperationArn' => '<string>',
'BrokerNodeGroupInfo' => [
'BrokerAZDistribution' => 'DEFAULT',
'ClientSubnets' => ['<string>', ...],
'ConnectivityInfo' => [
'PublicAccess' => [
'Type' => '<string>',
],
],
'InstanceType' => '<string>',
'SecurityGroups' => ['<string>', ...],
'StorageInfo' => [
'EbsStorageInfo' => [
'ProvisionedThroughput' => [
'Enabled' => true || false,
'VolumeThroughput' => <integer>,
],
'VolumeSize' => <integer>,
],
],
],
'ClientAuthentication' => [
'Sasl' => [
'Iam' => [
'Enabled' => true || false,
],
'Scram' => [
'Enabled' => true || false,
],
],
'Tls' => [
'CertificateAuthorityArnList' => ['<string>', ...],
'Enabled' => true || false,
],
'Unauthenticated' => [
'Enabled' => true || false,
],
],
'ClusterArn' => '<string>',
'ClusterName' => '<string>',
'CreationTime' => <DateTime>,
'CurrentBrokerSoftwareInfo' => [
'ConfigurationArn' => '<string>',
'ConfigurationRevision' => <integer>,
'KafkaVersion' => '<string>',
],
'CurrentVersion' => '<string>',
'EncryptionInfo' => [
'EncryptionAtRest' => [
'DataVolumeKMSKeyId' => '<string>',
],
'EncryptionInTransit' => [
'ClientBroker' => 'TLS|TLS_PLAINTEXT|PLAINTEXT',
'InCluster' => true || false,
],
],
'EnhancedMonitoring' => 'DEFAULT|PER_BROKER|PER_TOPIC_PER_BROKER|PER_TOPIC_PER_PARTITION',
'LoggingInfo' => [
'BrokerLogs' => [
'CloudWatchLogs' => [
'Enabled' => true || false,
'LogGroup' => '<string>',
],
'Firehose' => [
'DeliveryStream' => '<string>',
'Enabled' => true || false,
],
'S3' => [
'Bucket' => '<string>',
'Enabled' => true || false,
'Prefix' => '<string>',
],
],
],
'NumberOfBrokerNodes' => <integer>,
'OpenMonitoring' => [
'Prometheus' => [
'JmxExporter' => [
'EnabledInBroker' => true || false,
],
'NodeExporter' => [
'EnabledInBroker' => true || false,
],
],
],
'State' => 'ACTIVE|CREATING|DELETING|FAILED|HEALING|MAINTENANCE|REBOOTING_BROKER|UPDATING',
'StateInfo' => [
'Code' => '<string>',
'Message' => '<string>',
],
'StorageMode' => 'LOCAL|TIERED',
'Tags' => ['<string>', ...],
'ZookeeperConnectString' => '<string>',
'ZookeeperConnectStringTls' => '<string>',
],
]
Result Details
Members
- ClusterInfo
-
- Type: ClusterInfo structure
The cluster information.
Errors
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
DescribeClusterOperation
$result = $client->describeClusterOperation([/* ... */]); $promise = $client->describeClusterOperationAsync([/* ... */]);
Returns a description of the cluster operation specified by the ARN.
Parameter Syntax
$result = $client->describeClusterOperation([
'ClusterOperationArn' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'ClusterOperationInfo' => [
'ClientRequestId' => '<string>',
'ClusterArn' => '<string>',
'CreationTime' => <DateTime>,
'EndTime' => <DateTime>,
'ErrorInfo' => [
'ErrorCode' => '<string>',
'ErrorString' => '<string>',
],
'OperationArn' => '<string>',
'OperationState' => '<string>',
'OperationSteps' => [
[
'StepInfo' => [
'StepStatus' => '<string>',
],
'StepName' => '<string>',
],
// ...
],
'OperationType' => '<string>',
'SourceClusterInfo' => [
'BrokerEBSVolumeInfo' => [
[
'KafkaBrokerNodeId' => '<string>',
'ProvisionedThroughput' => [
'Enabled' => true || false,
'VolumeThroughput' => <integer>,
],
'VolumeSizeGB' => <integer>,
],
// ...
],
'ClientAuthentication' => [
'Sasl' => [
'Iam' => [
'Enabled' => true || false,
],
'Scram' => [
'Enabled' => true || false,
],
],
'Tls' => [
'CertificateAuthorityArnList' => ['<string>', ...],
'Enabled' => true || false,
],
'Unauthenticated' => [
'Enabled' => true || false,
],
],
'ConfigurationInfo' => [
'Arn' => '<string>',
'Revision' => <integer>,
],
'ConnectivityInfo' => [
'PublicAccess' => [
'Type' => '<string>',
],
],
'EncryptionInfo' => [
'EncryptionAtRest' => [
'DataVolumeKMSKeyId' => '<string>',
],
'EncryptionInTransit' => [
'ClientBroker' => 'TLS|TLS_PLAINTEXT|PLAINTEXT',
'InCluster' => true || false,
],
],
'EnhancedMonitoring' => 'DEFAULT|PER_BROKER|PER_TOPIC_PER_BROKER|PER_TOPIC_PER_PARTITION',
'InstanceType' => '<string>',
'KafkaVersion' => '<string>',
'LoggingInfo' => [
'BrokerLogs' => [
'CloudWatchLogs' => [
'Enabled' => true || false,
'LogGroup' => '<string>',
],
'Firehose' => [
'DeliveryStream' => '<string>',
'Enabled' => true || false,
],
'S3' => [
'Bucket' => '<string>',
'Enabled' => true || false,
'Prefix' => '<string>',
],
],
],
'NumberOfBrokerNodes' => <integer>,
'OpenMonitoring' => [
'Prometheus' => [
'JmxExporter' => [
'EnabledInBroker' => true || false,
],
'NodeExporter' => [
'EnabledInBroker' => true || false,
],
],
],
'StorageMode' => 'LOCAL|TIERED',
],
'TargetClusterInfo' => [
'BrokerEBSVolumeInfo' => [
[
'KafkaBrokerNodeId' => '<string>',
'ProvisionedThroughput' => [
'Enabled' => true || false,
'VolumeThroughput' => <integer>,
],
'VolumeSizeGB' => <integer>,
],
// ...
],
'ClientAuthentication' => [
'Sasl' => [
'Iam' => [
'Enabled' => true || false,
],
'Scram' => [
'Enabled' => true || false,
],
],
'Tls' => [
'CertificateAuthorityArnList' => ['<string>', ...],
'Enabled' => true || false,
],
'Unauthenticated' => [
'Enabled' => true || false,
],
],
'ConfigurationInfo' => [
'Arn' => '<string>',
'Revision' => <integer>,
],
'ConnectivityInfo' => [
'PublicAccess' => [
'Type' => '<string>',
],
],
'EncryptionInfo' => [
'EncryptionAtRest' => [
'DataVolumeKMSKeyId' => '<string>',
],
'EncryptionInTransit' => [
'ClientBroker' => 'TLS|TLS_PLAINTEXT|PLAINTEXT',
'InCluster' => true || false,
],
],
'EnhancedMonitoring' => 'DEFAULT|PER_BROKER|PER_TOPIC_PER_BROKER|PER_TOPIC_PER_PARTITION',
'InstanceType' => '<string>',
'KafkaVersion' => '<string>',
'LoggingInfo' => [
'BrokerLogs' => [
'CloudWatchLogs' => [
'Enabled' => true || false,
'LogGroup' => '<string>',
],
'Firehose' => [
'DeliveryStream' => '<string>',
'Enabled' => true || false,
],
'S3' => [
'Bucket' => '<string>',
'Enabled' => true || false,
'Prefix' => '<string>',
],
],
],
'NumberOfBrokerNodes' => <integer>,
'OpenMonitoring' => [
'Prometheus' => [
'JmxExporter' => [
'EnabledInBroker' => true || false,
],
'NodeExporter' => [
'EnabledInBroker' => true || false,
],
],
],
'StorageMode' => 'LOCAL|TIERED',
],
],
]
Result Details
Members
- ClusterOperationInfo
-
- Type: ClusterOperationInfo structure
Cluster operation information
Errors
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
DescribeClusterV2
$result = $client->describeClusterV2([/* ... */]); $promise = $client->describeClusterV2Async([/* ... */]);
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.
Parameter Syntax
$result = $client->describeClusterV2([
'ClusterArn' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'ClusterInfo' => [
'ActiveOperationArn' => '<string>',
'ClusterArn' => '<string>',
'ClusterName' => '<string>',
'ClusterType' => 'PROVISIONED|SERVERLESS',
'CreationTime' => <DateTime>,
'CurrentVersion' => '<string>',
'Provisioned' => [
'BrokerNodeGroupInfo' => [
'BrokerAZDistribution' => 'DEFAULT',
'ClientSubnets' => ['<string>', ...],
'ConnectivityInfo' => [
'PublicAccess' => [
'Type' => '<string>',
],
],
'InstanceType' => '<string>',
'SecurityGroups' => ['<string>', ...],
'StorageInfo' => [
'EbsStorageInfo' => [
'ProvisionedThroughput' => [
'Enabled' => true || false,
'VolumeThroughput' => <integer>,
],
'VolumeSize' => <integer>,
],
],
],
'ClientAuthentication' => [
'Sasl' => [
'Iam' => [
'Enabled' => true || false,
],
'Scram' => [
'Enabled' => true || false,
],
],
'Tls' => [
'CertificateAuthorityArnList' => ['<string>', ...],
'Enabled' => true || false,
],
'Unauthenticated' => [
'Enabled' => true || false,
],
],
'CurrentBrokerSoftwareInfo' => [
'ConfigurationArn' => '<string>',
'ConfigurationRevision' => <integer>,
'KafkaVersion' => '<string>',
],
'EncryptionInfo' => [
'EncryptionAtRest' => [
'DataVolumeKMSKeyId' => '<string>',
],
'EncryptionInTransit' => [
'ClientBroker' => 'TLS|TLS_PLAINTEXT|PLAINTEXT',
'InCluster' => true || false,
],
],
'EnhancedMonitoring' => 'DEFAULT|PER_BROKER|PER_TOPIC_PER_BROKER|PER_TOPIC_PER_PARTITION',
'LoggingInfo' => [
'BrokerLogs' => [
'CloudWatchLogs' => [
'Enabled' => true || false,
'LogGroup' => '<string>',
],
'Firehose' => [
'DeliveryStream' => '<string>',
'Enabled' => true || false,
],
'S3' => [
'Bucket' => '<string>',
'Enabled' => true || false,
'Prefix' => '<string>',
],
],
],
'NumberOfBrokerNodes' => <integer>,
'OpenMonitoring' => [
'Prometheus' => [
'JmxExporter' => [
'EnabledInBroker' => true || false,
],
'NodeExporter' => [
'EnabledInBroker' => true || false,
],
],
],
'StorageMode' => 'LOCAL|TIERED',
'ZookeeperConnectString' => '<string>',
'ZookeeperConnectStringTls' => '<string>',
],
'Serverless' => [
'ClientAuthentication' => [
'Sasl' => [
'Iam' => [
'Enabled' => true || false,
],
],
],
'VpcConfigs' => [
[
'SecurityGroupIds' => ['<string>', ...],
'SubnetIds' => ['<string>', ...],
],
// ...
],
],
'State' => 'ACTIVE|CREATING|DELETING|FAILED|HEALING|MAINTENANCE|REBOOTING_BROKER|UPDATING',
'StateInfo' => [
'Code' => '<string>',
'Message' => '<string>',
],
'Tags' => ['<string>', ...],
],
]
Result Details
Members
- ClusterInfo
-
- Type: Cluster structure
The cluster information.
Errors
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
DescribeConfiguration
$result = $client->describeConfiguration([/* ... */]); $promise = $client->describeConfigurationAsync([/* ... */]);
Returns a description of this MSK configuration.
Parameter Syntax
$result = $client->describeConfiguration([
'Arn' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'Arn' => '<string>',
'CreationTime' => <DateTime>,
'Description' => '<string>',
'KafkaVersions' => ['<string>', ...],
'LatestRevision' => [
'CreationTime' => <DateTime>,
'Description' => '<string>',
'Revision' => <integer>,
],
'Name' => '<string>',
'State' => 'ACTIVE|DELETING|DELETE_FAILED',
]
Result Details
Members
- Arn
-
- Type: string
The Amazon Resource Name (ARN) of the configuration.
- CreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the configuration was created.
- Description
-
- Type: string
The description of the configuration.
- KafkaVersions
-
- Type: Array of strings
The versions of Apache Kafka with which you can use this MSK configuration.
- LatestRevision
-
- Type: ConfigurationRevision structure
Latest revision of the configuration.
- Name
-
- Type: string
The name of the configuration. Configuration names are strings that match the regex "^[0-9A-Za-z-]+$".
- State
-
- Type: string
The state of the configuration. The possible states are ACTIVE, DELETING and DELETE_FAILED.
Errors
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
DescribeConfigurationRevision
$result = $client->describeConfigurationRevision([/* ... */]); $promise = $client->describeConfigurationRevisionAsync([/* ... */]);
Returns a description of this revision of the configuration.
Parameter Syntax
$result = $client->describeConfigurationRevision([
'Arn' => '<string>', // REQUIRED
'Revision' => <integer>, // REQUIRED
]);
Parameter Details
Result Syntax
[
'Arn' => '<string>',
'CreationTime' => <DateTime>,
'Description' => '<string>',
'Revision' => <integer>,
'ServerProperties' => <string || resource || Psr\Http\Message\StreamInterface>,
]
Result Details
Members
- Arn
-
- Type: string
The Amazon Resource Name (ARN) of the configuration.
- CreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the configuration was created.
- Description
-
- Type: string
The description of the configuration.
- Revision
-
- Type: long (int|float)
The revision number.
- ServerProperties
-
- Type: blob (string|resource|Psr\Http\Message\StreamInterface)
Errors
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
GetBootstrapBrokers
$result = $client->getBootstrapBrokers([/* ... */]); $promise = $client->getBootstrapBrokersAsync([/* ... */]);
A list of brokers that a client application can use to bootstrap.
Parameter Syntax
$result = $client->getBootstrapBrokers([
'ClusterArn' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'BootstrapBrokerString' => '<string>',
'BootstrapBrokerStringPublicSaslIam' => '<string>',
'BootstrapBrokerStringPublicSaslScram' => '<string>',
'BootstrapBrokerStringPublicTls' => '<string>',
'BootstrapBrokerStringSaslIam' => '<string>',
'BootstrapBrokerStringSaslScram' => '<string>',
'BootstrapBrokerStringTls' => '<string>',
]
Result Details
Members
- BootstrapBrokerString
-
- Type: string
A string containing one or more hostname:port pairs.
- BootstrapBrokerStringPublicSaslIam
-
- Type: string
A string that contains one or more DNS names (or IP addresses) and SASL IAM port pairs. The following is an example.
{ "BootstrapBrokerStringSaslIam": "b-3.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9198,b-1.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9198,b-2.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9198"} - BootstrapBrokerStringPublicSaslScram
-
- Type: string
A string containing one or more DNS names (or IP addresses) and SASL SCRAM port pairs. The following is an example.
{ "BootstrapBrokerStringSaslScram": "b-3.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9196,b-1.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9196,b-2.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9196"} - BootstrapBrokerStringPublicTls
-
- Type: string
A string containing one or more DNS names (or IP addresses) and TLS port pairs. The following is an example.
{ "BootstrapBrokerStringTls": "b-3.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9194,b-1.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9194,b-2.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9194"} - BootstrapBrokerStringSaslIam
-
- Type: string
A string that contains one or more DNS names (or IP addresses) and SASL IAM port pairs. The following is an example.
{ "BootstrapBrokerStringSaslIam": "b-3.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9098,b-1.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9098,b-2.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9098"} - BootstrapBrokerStringSaslScram
-
- Type: string
A string containing one or more DNS names (or IP addresses) and SASL SCRAM port pairs. The following is an example.
{ "BootstrapBrokerStringSaslScram": "b-3.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9096,b-1.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9096,b-2.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9096"} - BootstrapBrokerStringTls
-
- Type: string
A string containing one or more DNS names (or IP addresses) and TLS port pairs. The following is an example.
{ "BootstrapBrokerStringTls": "b-3.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9094,b-1.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9094,b-2.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9094"}
Errors
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
GetCompatibleKafkaVersions
$result = $client->getCompatibleKafkaVersions([/* ... */]); $promise = $client->getCompatibleKafkaVersionsAsync([/* ... */]);
Gets the Apache Kafka versions to which you can update the MSK cluster.
Parameter Syntax
$result = $client->getCompatibleKafkaVersions([
'ClusterArn' => '<string>',
]);
Parameter Details
Result Syntax
[
'CompatibleKafkaVersions' => [
[
'SourceVersion' => '<string>',
'TargetVersions' => ['<string>', ...],
],
// ...
],
]
Result Details
Members
- CompatibleKafkaVersions
-
- Type: Array of CompatibleKafkaVersion structures
A list of CompatibleKafkaVersion objects.
Errors
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
ListClusterOperations
$result = $client->listClusterOperations([/* ... */]); $promise = $client->listClusterOperationsAsync([/* ... */]);
Returns a list of all the operations that have been performed on the specified MSK cluster.
Parameter Syntax
$result = $client->listClusterOperations([
'ClusterArn' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Result Syntax
[
'ClusterOperationInfoList' => [
[
'ClientRequestId' => '<string>',
'ClusterArn' => '<string>',
'CreationTime' => <DateTime>,
'EndTime' => <DateTime>,
'ErrorInfo' => [
'ErrorCode' => '<string>',
'ErrorString' => '<string>',
],
'OperationArn' => '<string>',
'OperationState' => '<string>',
'OperationSteps' => [
[
'StepInfo' => [
'StepStatus' => '<string>',
],
'StepName' => '<string>',
],
// ...
],
'OperationType' => '<string>',
'SourceClusterInfo' => [
'BrokerEBSVolumeInfo' => [
[
'KafkaBrokerNodeId' => '<string>',
'ProvisionedThroughput' => [
'Enabled' => true || false,
'VolumeThroughput' => <integer>,
],
'VolumeSizeGB' => <integer>,
],
// ...
],
'ClientAuthentication' => [
'Sasl' => [
'Iam' => [
'Enabled' => true || false,
],
'Scram' => [
'Enabled' => true || false,
],
],
'Tls' => [
'CertificateAuthorityArnList' => ['<string>', ...],
'Enabled' => true || false,
],
'Unauthenticated' => [
'Enabled' => true || false,
],
],
'ConfigurationInfo' => [
'Arn' => '<string>',
'Revision' => <integer>,
],
'ConnectivityInfo' => [
'PublicAccess' => [
'Type' => '<string>',
],
],
'EncryptionInfo' => [
'EncryptionAtRest' => [
'DataVolumeKMSKeyId' => '<string>',
],
'EncryptionInTransit' => [
'ClientBroker' => 'TLS|TLS_PLAINTEXT|PLAINTEXT',
'InCluster' => true || false,
],
],
'EnhancedMonitoring' => 'DEFAULT|PER_BROKER|PER_TOPIC_PER_BROKER|PER_TOPIC_PER_PARTITION',
'InstanceType' => '<string>',
'KafkaVersion' => '<string>',
'LoggingInfo' => [
'BrokerLogs' => [
'CloudWatchLogs' => [
'Enabled' => true || false,
'LogGroup' => '<string>',
],
'Firehose' => [
'DeliveryStream' => '<string>',
'Enabled' => true || false,
],
'S3' => [
'Bucket' => '<string>',
'Enabled' => true || false,
'Prefix' => '<string>',
],
],
],
'NumberOfBrokerNodes' => <integer>,
'OpenMonitoring' => [
'Prometheus' => [
'JmxExporter' => [
'EnabledInBroker' => true || false,
],
'NodeExporter' => [
'EnabledInBroker' => true || false,
],
],
],
'StorageMode' => 'LOCAL|TIERED',
],
'TargetClusterInfo' => [
'BrokerEBSVolumeInfo' => [
[
'KafkaBrokerNodeId' => '<string>',
'ProvisionedThroughput' => [
'Enabled' => true || false,
'VolumeThroughput' => <integer>,
],
'VolumeSizeGB' => <integer>,
],
// ...
],
'ClientAuthentication' => [
'Sasl' => [
'Iam' => [
'Enabled' => true || false,
],
'Scram' => [
'Enabled' => true || false,
],
],
'Tls' => [
'CertificateAuthorityArnList' => ['<string>', ...],
'Enabled' => true || false,
],
'Unauthenticated' => [
'Enabled' => true || false,
],
],
'ConfigurationInfo' => [
'Arn' => '<string>',
'Revision' => <integer>,
],
'ConnectivityInfo' => [
'PublicAccess' => [
'Type' => '<string>',
],
],
'EncryptionInfo' => [
'EncryptionAtRest' => [
'DataVolumeKMSKeyId' => '<string>',
],
'EncryptionInTransit' => [
'ClientBroker' => 'TLS|TLS_PLAINTEXT|PLAINTEXT',
'InCluster' => true || false,
],
],
'EnhancedMonitoring' => 'DEFAULT|PER_BROKER|PER_TOPIC_PER_BROKER|PER_TOPIC_PER_PARTITION',
'InstanceType' => '<string>',
'KafkaVersion' => '<string>',
'LoggingInfo' => [
'BrokerLogs' => [
'CloudWatchLogs' => [
'Enabled' => true || false,
'LogGroup' => '<string>',
],
'Firehose' => [
'DeliveryStream' => '<string>',
'Enabled' => true || false,
],
'S3' => [
'Bucket' => '<string>',
'Enabled' => true || false,
'Prefix' => '<string>',
],
],
],
'NumberOfBrokerNodes' => <integer>,
'OpenMonitoring' => [
'Prometheus' => [
'JmxExporter' => [
'EnabledInBroker' => true || false,
],
'NodeExporter' => [
'EnabledInBroker' => true || false,
],
],
],
'StorageMode' => 'LOCAL|TIERED',
],
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- ClusterOperationInfoList
-
- Type: Array of ClusterOperationInfo structures
An array of cluster operation information objects.
- NextToken
-
- Type: 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.
Errors
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
ListClusters
$result = $client->listClusters([/* ... */]); $promise = $client->listClustersAsync([/* ... */]);
Returns a list of all the MSK clusters in the current Region.
Parameter Syntax
$result = $client->listClusters([
'ClusterNameFilter' => '<string>',
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Result Syntax
[
'ClusterInfoList' => [
[
'ActiveOperationArn' => '<string>',
'BrokerNodeGroupInfo' => [
'BrokerAZDistribution' => 'DEFAULT',
'ClientSubnets' => ['<string>', ...],
'ConnectivityInfo' => [
'PublicAccess' => [
'Type' => '<string>',
],
],
'InstanceType' => '<string>',
'SecurityGroups' => ['<string>', ...],
'StorageInfo' => [
'EbsStorageInfo' => [
'ProvisionedThroughput' => [
'Enabled' => true || false,
'VolumeThroughput' => <integer>,
],
'VolumeSize' => <integer>,
],
],
],
'ClientAuthentication' => [
'Sasl' => [
'Iam' => [
'Enabled' => true || false,
],
'Scram' => [
'Enabled' => true || false,
],
],
'Tls' => [
'CertificateAuthorityArnList' => ['<string>', ...],
'Enabled' => true || false,
],
'Unauthenticated' => [
'Enabled' => true || false,
],
],
'ClusterArn' => '<string>',
'ClusterName' => '<string>',
'CreationTime' => <DateTime>,
'CurrentBrokerSoftwareInfo' => [
'ConfigurationArn' => '<string>',
'ConfigurationRevision' => <integer>,
'KafkaVersion' => '<string>',
],
'CurrentVersion' => '<string>',
'EncryptionInfo' => [
'EncryptionAtRest' => [
'DataVolumeKMSKeyId' => '<string>',
],
'EncryptionInTransit' => [
'ClientBroker' => 'TLS|TLS_PLAINTEXT|PLAINTEXT',
'InCluster' => true || false,
],
],
'EnhancedMonitoring' => 'DEFAULT|PER_BROKER|PER_TOPIC_PER_BROKER|PER_TOPIC_PER_PARTITION',
'LoggingInfo' => [
'BrokerLogs' => [
'CloudWatchLogs' => [
'Enabled' => true || false,
'LogGroup' => '<string>',
],
'Firehose' => [
'DeliveryStream' => '<string>',
'Enabled' => true || false,
],
'S3' => [
'Bucket' => '<string>',
'Enabled' => true || false,
'Prefix' => '<string>',
],
],
],
'NumberOfBrokerNodes' => <integer>,
'OpenMonitoring' => [
'Prometheus' => [
'JmxExporter' => [
'EnabledInBroker' => true || false,
],
'NodeExporter' => [
'EnabledInBroker' => true || false,
],
],
],
'State' => 'ACTIVE|CREATING|DELETING|FAILED|HEALING|MAINTENANCE|REBOOTING_BROKER|UPDATING',
'StateInfo' => [
'Code' => '<string>',
'Message' => '<string>',
],
'StorageMode' => 'LOCAL|TIERED',
'Tags' => ['<string>', ...],
'ZookeeperConnectString' => '<string>',
'ZookeeperConnectStringTls' => '<string>',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- ClusterInfoList
-
- Type: Array of ClusterInfo structures
Information on each of the MSK clusters in the response.
- NextToken
-
- Type: 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.
Errors
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
ListClustersV2
$result = $client->listClustersV2([/* ... */]); $promise = $client->listClustersV2Async([/* ... */]);
Returns a list of all the MSK clusters in the current Region.
Parameter Syntax
$result = $client->listClustersV2([
'ClusterNameFilter' => '<string>',
'ClusterTypeFilter' => '<string>',
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'ClusterInfoList' => [
[
'ActiveOperationArn' => '<string>',
'ClusterArn' => '<string>',
'ClusterName' => '<string>',
'ClusterType' => 'PROVISIONED|SERVERLESS',
'CreationTime' => <DateTime>,
'CurrentVersion' => '<string>',
'Provisioned' => [
'BrokerNodeGroupInfo' => [
'BrokerAZDistribution' => 'DEFAULT',
'ClientSubnets' => ['<string>', ...],
'ConnectivityInfo' => [
'PublicAccess' => [
'Type' => '<string>',
],
],
'InstanceType' => '<string>',
'SecurityGroups' => ['<string>', ...],
'StorageInfo' => [
'EbsStorageInfo' => [
'ProvisionedThroughput' => [
'Enabled' => true || false,
'VolumeThroughput' => <integer>,
],
'VolumeSize' => <integer>,
],
],
],
'ClientAuthentication' => [
'Sasl' => [
'Iam' => [
'Enabled' => true || false,
],
'Scram' => [
'Enabled' => true || false,
],
],
'Tls' => [
'CertificateAuthorityArnList' => ['<string>', ...],
'Enabled' => true || false,
],
'Unauthenticated' => [
'Enabled' => true || false,
],
],
'CurrentBrokerSoftwareInfo' => [
'ConfigurationArn' => '<string>',
'ConfigurationRevision' => <integer>,
'KafkaVersion' => '<string>',
],
'EncryptionInfo' => [
'EncryptionAtRest' => [
'DataVolumeKMSKeyId' => '<string>',
],
'EncryptionInTransit' => [
'ClientBroker' => 'TLS|TLS_PLAINTEXT|PLAINTEXT',
'InCluster' => true || false,
],
],
'EnhancedMonitoring' => 'DEFAULT|PER_BROKER|PER_TOPIC_PER_BROKER|PER_TOPIC_PER_PARTITION',
'LoggingInfo' => [
'BrokerLogs' => [
'CloudWatchLogs' => [
'Enabled' => true || false,
'LogGroup' => '<string>',
],
'Firehose' => [
'DeliveryStream' => '<string>',
'Enabled' => true || false,
],
'S3' => [
'Bucket' => '<string>',
'Enabled' => true || false,
'Prefix' => '<string>',
],
],
],
'NumberOfBrokerNodes' => <integer>,
'OpenMonitoring' => [
'Prometheus' => [
'JmxExporter' => [
'EnabledInBroker' => true || false,
],
'NodeExporter' => [
'EnabledInBroker' => true || false,
],
],
],
'StorageMode' => 'LOCAL|TIERED',
'ZookeeperConnectString' => '<string>',
'ZookeeperConnectStringTls' => '<string>',
],
'Serverless' => [
'ClientAuthentication' => [
'Sasl' => [
'Iam' => [
'Enabled' => true || false,
],
],
],
'VpcConfigs' => [
[
'SecurityGroupIds' => ['<string>', ...],
'SubnetIds' => ['<string>', ...],
],
// ...
],
],
'State' => 'ACTIVE|CREATING|DELETING|FAILED|HEALING|MAINTENANCE|REBOOTING_BROKER|UPDATING',
'StateInfo' => [
'Code' => '<string>',
'Message' => '<string>',
],
'Tags' => ['<string>', ...],
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- ClusterInfoList
-
- Type: Array of Cluster structures
Information on each of the MSK clusters in the response.
- NextToken
-
- Type: string
Errors
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
ListConfigurationRevisions
$result = $client->listConfigurationRevisions([/* ... */]); $promise = $client->listConfigurationRevisionsAsync([/* ... */]);
Returns a list of all the revisions of an MSK configuration.
Parameter Syntax
$result = $client->listConfigurationRevisions([
'Arn' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Result Syntax
[
'NextToken' => '<string>',
'Revisions' => [
[
'CreationTime' => <DateTime>,
'Description' => '<string>',
'Revision' => <integer>,
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
Paginated results marker.
- Revisions
-
- Type: Array of ConfigurationRevision structures
List of ConfigurationRevision objects.
Errors
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
ListConfigurations
$result = $client->listConfigurations([/* ... */]); $promise = $client->listConfigurationsAsync([/* ... */]);
Returns a list of all the MSK configurations in this Region.
Parameter Syntax
$result = $client->listConfigurations([
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Result Syntax
[
'Configurations' => [
[
'Arn' => '<string>',
'CreationTime' => <DateTime>,
'Description' => '<string>',
'KafkaVersions' => ['<string>', ...],
'LatestRevision' => [
'CreationTime' => <DateTime>,
'Description' => '<string>',
'Revision' => <integer>,
],
'Name' => '<string>',
'State' => 'ACTIVE|DELETING|DELETE_FAILED',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- Configurations
-
- Type: Array of Configuration structures
An array of MSK configurations.
- NextToken
-
- Type: 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.
Errors
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
ListKafkaVersions
$result = $client->listKafkaVersions([/* ... */]); $promise = $client->listKafkaVersionsAsync([/* ... */]);
Returns a list of Apache Kafka versions.
Parameter Syntax
$result = $client->listKafkaVersions([
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Result Syntax
[
'KafkaVersions' => [
[
'Status' => 'ACTIVE|DEPRECATED',
'Version' => '<string>',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- KafkaVersions
-
- Type: Array of KafkaVersion structures
An array of Apache Kafka version objects.
- NextToken
-
- Type: string
Paginated results marker.
Errors
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
ListNodes
$result = $client->listNodes([/* ... */]); $promise = $client->listNodesAsync([/* ... */]);
Returns a list of the broker nodes in the cluster.
Parameter Syntax
$result = $client->listNodes([
'ClusterArn' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Result Syntax
[
'NextToken' => '<string>',
'NodeInfoList' => [
[
'AddedToClusterTime' => '<string>',
'BrokerNodeInfo' => [
'AttachedENIId' => '<string>',
'BrokerId' => <float>,
'ClientSubnet' => '<string>',
'ClientVpcIpAddress' => '<string>',
'CurrentBrokerSoftwareInfo' => [
'ConfigurationArn' => '<string>',
'ConfigurationRevision' => <integer>,
'KafkaVersion' => '<string>',
],
'Endpoints' => ['<string>', ...],
],
'InstanceType' => '<string>',
'NodeARN' => '<string>',
'NodeType' => 'BROKER',
'ZookeeperNodeInfo' => [
'AttachedENIId' => '<string>',
'ClientVpcIpAddress' => '<string>',
'Endpoints' => ['<string>', ...],
'ZookeeperId' => <float>,
'ZookeeperVersion' => '<string>',
],
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: 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.
- NodeInfoList
-
- Type: Array of NodeInfo structures
List containing a NodeInfo object.
Errors
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
ListScramSecrets
$result = $client->listScramSecrets([/* ... */]); $promise = $client->listScramSecretsAsync([/* ... */]);
Returns a list of the Scram Secrets associated with an Amazon MSK cluster.
Parameter Syntax
$result = $client->listScramSecrets([
'ClusterArn' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Result Syntax
[
'NextToken' => '<string>',
'SecretArnList' => ['<string>', ...],
]
Result Details
Members
Errors
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
ListTagsForResource
$result = $client->listTagsForResource([/* ... */]); $promise = $client->listTagsForResourceAsync([/* ... */]);
Returns a list of the tags associated with the specified resource.
Parameter Syntax
$result = $client->listTagsForResource([
'ResourceArn' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'Tags' => ['<string>', ...],
]
Result Details
Members
Errors
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
RebootBroker
$result = $client->rebootBroker([/* ... */]); $promise = $client->rebootBrokerAsync([/* ... */]);
Executes a reboot on a broker.
Parameter Syntax
$result = $client->rebootBroker([
'BrokerIds' => ['<string>', ...], // REQUIRED
'ClusterArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'ClusterArn' => '<string>',
'ClusterOperationArn' => '<string>',
]
Result Details
Members
Errors
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
TagResource
$result = $client->tagResource([/* ... */]); $promise = $client->tagResourceAsync([/* ... */]);
Adds tags to the specified MSK resource.
Parameter Syntax
$result = $client->tagResource([
'ResourceArn' => '<string>', // REQUIRED
'Tags' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
UntagResource
$result = $client->untagResource([/* ... */]); $promise = $client->untagResourceAsync([/* ... */]);
Removes the tags associated with the keys that are provided in the query.
Parameter Syntax
$result = $client->untagResource([
'ResourceArn' => '<string>', // REQUIRED
'TagKeys' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
UpdateBrokerCount
$result = $client->updateBrokerCount([/* ... */]); $promise = $client->updateBrokerCountAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->updateBrokerCount([
'ClusterArn' => '<string>', // REQUIRED
'CurrentVersion' => '<string>', // REQUIRED
'TargetNumberOfBrokerNodes' => <integer>, // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'ClusterArn' => '<string>',
'ClusterOperationArn' => '<string>',
]
Result Details
Members
Errors
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
UpdateBrokerStorage
$result = $client->updateBrokerStorage([/* ... */]); $promise = $client->updateBrokerStorageAsync([/* ... */]);
Updates the EBS storage associated with MSK brokers.
Parameter Syntax
$result = $client->updateBrokerStorage([
'ClusterArn' => '<string>', // REQUIRED
'CurrentVersion' => '<string>', // REQUIRED
'TargetBrokerEBSVolumeInfo' => [ // REQUIRED
[
'KafkaBrokerNodeId' => '<string>', // REQUIRED
'ProvisionedThroughput' => [
'Enabled' => true || false,
'VolumeThroughput' => <integer>,
],
'VolumeSizeGB' => <integer>,
],
// ...
],
]);
Parameter Details
Members
- ClusterArn
-
- Required: Yes
- Type: string
- CurrentVersion
-
- Required: Yes
- Type: string
The version of cluster to update from. A successful operation will then generate a new version.
- TargetBrokerEBSVolumeInfo
-
- Required: Yes
- Type: Array of BrokerEBSVolumeInfo structures
Describes the target volume size and the ID of the broker to apply the update to.
The value you specify for Target-Volume-in-GiB must be a whole number that is greater than 100 GiB.
The storage per broker after the update operation can't exceed 16384 GiB.
Result Syntax
[
'ClusterArn' => '<string>',
'ClusterOperationArn' => '<string>',
]
Result Details
Members
Errors
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
UpdateBrokerType
$result = $client->updateBrokerType([/* ... */]); $promise = $client->updateBrokerTypeAsync([/* ... */]);
Updates all the brokers in the cluster to the specified type.
Parameter Syntax
$result = $client->updateBrokerType([
'ClusterArn' => '<string>', // REQUIRED
'CurrentVersion' => '<string>', // REQUIRED
'TargetInstanceType' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'ClusterArn' => '<string>',
'ClusterOperationArn' => '<string>',
]
Result Details
Members
Errors
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
UpdateClusterConfiguration
$result = $client->updateClusterConfiguration([/* ... */]); $promise = $client->updateClusterConfigurationAsync([/* ... */]);
Updates the cluster with the configuration that is specified in the request body.
Parameter Syntax
$result = $client->updateClusterConfiguration([
'ClusterArn' => '<string>', // REQUIRED
'ConfigurationInfo' => [ // REQUIRED
'Arn' => '<string>', // REQUIRED
'Revision' => <integer>, // REQUIRED
],
'CurrentVersion' => '<string>', // REQUIRED
]);
Parameter Details
Members
- ClusterArn
-
- Required: Yes
- Type: string
- ConfigurationInfo
-
- Required: Yes
- Type: ConfigurationInfo structure
Represents the configuration that you want MSK to use for the cluster.
- CurrentVersion
-
- Required: Yes
- Type: string
The version of the cluster that you want to update.
Result Syntax
[
'ClusterArn' => '<string>',
'ClusterOperationArn' => '<string>',
]
Result Details
Members
Errors
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
UpdateClusterKafkaVersion
$result = $client->updateClusterKafkaVersion([/* ... */]); $promise = $client->updateClusterKafkaVersionAsync([/* ... */]);
Updates the Apache Kafka version for the cluster.
Parameter Syntax
$result = $client->updateClusterKafkaVersion([
'ClusterArn' => '<string>', // REQUIRED
'ConfigurationInfo' => [
'Arn' => '<string>', // REQUIRED
'Revision' => <integer>, // REQUIRED
],
'CurrentVersion' => '<string>', // REQUIRED
'TargetKafkaVersion' => '<string>', // REQUIRED
]);
Parameter Details
Members
- ClusterArn
-
- Required: Yes
- Type: string
- ConfigurationInfo
-
- Type: ConfigurationInfo structure
Specifies the configuration to use for the brokers.
- CurrentVersion
-
- Required: Yes
- Type: string
Current cluster version.
- TargetKafkaVersion
-
- Required: Yes
- Type: string
Target Apache Kafka version.
Result Syntax
[
'ClusterArn' => '<string>',
'ClusterOperationArn' => '<string>',
]
Result Details
Members
Errors
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
UpdateConfiguration
$result = $client->updateConfiguration([/* ... */]); $promise = $client->updateConfigurationAsync([/* ... */]);
Updates an existing MSK configuration. The configuration must be in the Active state.
Parameter Syntax
$result = $client->updateConfiguration([
'Arn' => '<string>', // REQUIRED
'Description' => '<string>',
'ServerProperties' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'Arn' => '<string>',
'LatestRevision' => [
'CreationTime' => <DateTime>,
'Description' => '<string>',
'Revision' => <integer>,
],
]
Result Details
Members
- Arn
-
- Type: string
The Amazon Resource Name (ARN) of the configuration.
- LatestRevision
-
- Type: ConfigurationRevision structure
Latest revision of the configuration.
Errors
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
UpdateConnectivity
$result = $client->updateConnectivity([/* ... */]); $promise = $client->updateConnectivityAsync([/* ... */]);
Updates the connectivity configuration for the cluster.
Parameter Syntax
$result = $client->updateConnectivity([
'ClusterArn' => '<string>', // REQUIRED
'ConnectivityInfo' => [ // REQUIRED
'PublicAccess' => [
'Type' => '<string>',
],
],
'CurrentVersion' => '<string>', // REQUIRED
]);
Parameter Details
Members
- ClusterArn
-
- Required: Yes
- Type: string
- ConnectivityInfo
-
- Required: Yes
- Type: ConnectivityInfo structure
Information about the broker access configuration.
- CurrentVersion
-
- Required: Yes
- Type: string
The current version of the cluster.
Result Syntax
[
'ClusterArn' => '<string>',
'ClusterOperationArn' => '<string>',
]
Result Details
Members
Errors
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
UpdateMonitoring
$result = $client->updateMonitoring([/* ... */]); $promise = $client->updateMonitoringAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->updateMonitoring([
'ClusterArn' => '<string>', // REQUIRED
'CurrentVersion' => '<string>', // REQUIRED
'EnhancedMonitoring' => 'DEFAULT|PER_BROKER|PER_TOPIC_PER_BROKER|PER_TOPIC_PER_PARTITION',
'LoggingInfo' => [
'BrokerLogs' => [ // REQUIRED
'CloudWatchLogs' => [
'Enabled' => true || false, // REQUIRED
'LogGroup' => '<string>',
],
'Firehose' => [
'DeliveryStream' => '<string>',
'Enabled' => true || false, // REQUIRED
],
'S3' => [
'Bucket' => '<string>',
'Enabled' => true || false, // REQUIRED
'Prefix' => '<string>',
],
],
],
'OpenMonitoring' => [
'Prometheus' => [ // REQUIRED
'JmxExporter' => [
'EnabledInBroker' => true || false, // REQUIRED
],
'NodeExporter' => [
'EnabledInBroker' => true || false, // REQUIRED
],
],
],
]);
Parameter Details
Members
- ClusterArn
-
- Required: Yes
- Type: string
- CurrentVersion
-
- Required: Yes
- Type: string
The version of cluster to update from. A successful operation will then generate a new version.
- EnhancedMonitoring
-
- Type: string
Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster.
- LoggingInfo
-
- Type: LoggingInfo structure
LoggingInfo details.
- OpenMonitoring
-
- Type: OpenMonitoringInfo structure
The settings for open monitoring.
Result Syntax
[
'ClusterArn' => '<string>',
'ClusterOperationArn' => '<string>',
]
Result Details
Members
Errors
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
UpdateSecurity
$result = $client->updateSecurity([/* ... */]); $promise = $client->updateSecurityAsync([/* ... */]);
You can use this operation to update the encrypting and authentication settings for an existing cluster.
Parameter Syntax
$result = $client->updateSecurity([
'ClientAuthentication' => [
'Sasl' => [
'Iam' => [
'Enabled' => true || false,
],
'Scram' => [
'Enabled' => true || false,
],
],
'Tls' => [
'CertificateAuthorityArnList' => ['<string>', ...],
'Enabled' => true || false,
],
'Unauthenticated' => [
'Enabled' => true || false,
],
],
'ClusterArn' => '<string>', // REQUIRED
'CurrentVersion' => '<string>', // REQUIRED
'EncryptionInfo' => [
'EncryptionAtRest' => [
'DataVolumeKMSKeyId' => '<string>', // REQUIRED
],
'EncryptionInTransit' => [
'ClientBroker' => 'TLS|TLS_PLAINTEXT|PLAINTEXT',
'InCluster' => true || false,
],
],
]);
Parameter Details
Members
- ClientAuthentication
-
- Type: ClientAuthentication structure
Includes all client authentication related information.
- ClusterArn
-
- Required: Yes
- Type: string
- CurrentVersion
-
- Required: Yes
- Type: string
You can use the DescribeCluster operation to get the current version of the cluster. After the security update is complete, the cluster will have a new version.
- EncryptionInfo
-
- Type: EncryptionInfo structure
Includes all encryption-related information.
Result Syntax
[
'ClusterArn' => '<string>',
'ClusterOperationArn' => '<string>',
]
Result Details
Members
Errors
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
UpdateStorage
$result = $client->updateStorage([/* ... */]); $promise = $client->updateStorageAsync([/* ... */]);
Updates cluster broker volume size (or) sets cluster storage mode to TIERED.
Parameter Syntax
$result = $client->updateStorage([
'ClusterArn' => '<string>', // REQUIRED
'CurrentVersion' => '<string>', // REQUIRED
'ProvisionedThroughput' => [
'Enabled' => true || false,
'VolumeThroughput' => <integer>,
],
'StorageMode' => 'LOCAL|TIERED',
'VolumeSizeGB' => <integer>,
]);
Parameter Details
Members
- ClusterArn
-
- Required: Yes
- Type: string
- CurrentVersion
-
- Required: Yes
- Type: string
The version of cluster to update from. A successful operation will then generate a new version.
- ProvisionedThroughput
-
- Type: ProvisionedThroughput structure
EBS volume provisioned throughput information.
- StorageMode
-
- Type: string
Controls storage mode for supported storage tiers.
- VolumeSizeGB
-
- Type: int
size of the EBS volume to update.
Result Syntax
[
'ClusterArn' => '<string>',
'ClusterOperationArn' => '<string>',
]
Result Details
Members
Errors
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
-
Returns information about an error.
Shapes
BadRequestException
Description
Returns information about an error.
Members
BrokerEBSVolumeInfo
Description
Specifies the EBS volume upgrade information. The broker identifier must be set to the keyword ALL. This means the changes apply to all the brokers in the cluster.
Members
- KafkaBrokerNodeId
-
- Required: Yes
- Type: string
The ID of the broker to update.
- ProvisionedThroughput
-
- Type: ProvisionedThroughput structure
EBS volume provisioned throughput information.
- VolumeSizeGB
-
- Type: int
Size of the EBS volume to update.
BrokerLogs
Description
The broker logs configuration for this MSK cluster.
Members
- CloudWatchLogs
-
- Type: CloudWatchLogs structure
Details of the CloudWatch Logs destination for broker logs.
- Firehose
-
- Type: Firehose structure
Details of the Kinesis Data Firehose delivery stream that is the destination for broker logs.
- S3
-
- Type: S3 structure
Details of the Amazon S3 destination for broker logs.
BrokerNodeGroupInfo
Description
Describes the setup to be used for Apache Kafka broker nodes in the cluster.
Members
- BrokerAZDistribution
-
- Type: string
The distribution of broker nodes across Availability Zones.
- ClientSubnets
-
- Required: Yes
- Type: Array of strings
The list of subnets to connect to in the client virtual private cloud (VPC). AWS creates elastic network interfaces inside these subnets. Client applications use elastic network interfaces to produce and consume data. Client subnets can't occupy the Availability Zone with ID use use1-az3.
- ConnectivityInfo
-
- Type: ConnectivityInfo structure
Information about the broker access configuration.
- InstanceType
-
- Required: Yes
- Type: string
The type of broker used in the Amazon MSK cluster.
- SecurityGroups
-
- Type: Array of strings
The AWS security groups to associate with the elastic network interfaces in order to specify who can connect to and communicate with the Amazon MSK cluster. If you don't specify a security group, Amazon MSK uses the default security group associated with the VPC. If you specify security groups that were shared with you, you must ensure that you have permissions to them. Specifically, you need the ec2:DescribeSecurityGroups permission.
- StorageInfo
-
- Type: StorageInfo structure
Contains information about storage volumes attached to MSK broker nodes.
BrokerNodeInfo
Description
BrokerNodeInfo
Members
- AttachedENIId
-
- Type: string
The attached elastic network interface of the broker.
- BrokerId
-
- Type: double
The ID of the broker.
- ClientSubnet
-
- Type: string
The client subnet to which this broker node belongs.
- ClientVpcIpAddress
-
- Type: string
The virtual private cloud (VPC) of the client.
- CurrentBrokerSoftwareInfo
-
- Type: BrokerSoftwareInfo structure
Information about the version of software currently deployed on the Apache Kafka brokers in the cluster.
- Endpoints
-
- Type: Array of strings
Endpoints for accessing the broker.
BrokerSoftwareInfo
Description
Information about the current software installed on the cluster.
Members
- ConfigurationArn
-
- Type: string
The Amazon Resource Name (ARN) of the configuration used for the cluster. This field isn't visible in this preview release.
- ConfigurationRevision
-
- Type: long (int|float)
The revision of the configuration to use. This field isn't visible in this preview release.
- KafkaVersion
-
- Type: string
The version of Apache Kafka.
ClientAuthentication
Description
Includes all client authentication information.
Members
- Sasl
-
- Type: Sasl structure
- Tls
-
- Type: Tls structure
Details for ClientAuthentication using TLS.
- Unauthenticated
-
- Type: Unauthenticated structure
Contains information about unauthenticated traffic to the cluster.
CloudWatchLogs
Description
Details of the CloudWatch Logs destination for broker logs.
Members
Cluster
Description
Returns information about a cluster of either the provisioned or the serverless type.
Members
- ActiveOperationArn
-
- Type: string
- ClusterArn
-
- Type: string
- ClusterName
-
- Type: string
- ClusterType
-
- Type: string
- CreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- CurrentVersion
-
- Type: string
- Provisioned
-
- Type: Provisioned structure
Information about the provisioned cluster.
- Serverless
-
- Type: Serverless structure
Information about the serverless cluster.
- State
-
- Type: string
The state of an Apache Kafka cluster.
- StateInfo
-
- Type: StateInfo structure
Contains information about the state of the Amazon MSK cluster.
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
ClusterInfo
Description
Returns information about a cluster.
Members
- ActiveOperationArn
-
- Type: string
Arn of active cluster operation.
- BrokerNodeGroupInfo
-
- Type: BrokerNodeGroupInfo structure
Information about the brokers.
- ClientAuthentication
-
- Type: ClientAuthentication structure
Includes all client authentication information.
- ClusterArn
-
- Type: string
The Amazon Resource Name (ARN) that uniquely identifies the cluster.
- ClusterName
-
- Type: string
The name of the cluster.
- CreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the cluster was created.
- CurrentBrokerSoftwareInfo
-
- Type: BrokerSoftwareInfo structure
Information about the version of software currently deployed on the Apache Kafka brokers in the cluster.
- CurrentVersion
-
- Type: string
The current version of the MSK cluster. Cluster versions aren't simple integers. You can obtain the current version by describing the cluster. An example version is KTVPDKIKX0DER.
- EncryptionInfo
-
- Type: EncryptionInfo structure
Includes all encryption-related information.
- EnhancedMonitoring
-
- Type: string
Specifies which metrics are gathered for the MSK cluster. This property has the following possible values: DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION. For a list of the metrics associated with each of these levels of monitoring, see Monitoring.
- LoggingInfo
-
- Type: LoggingInfo structure
You can configure your MSK cluster to send broker logs to different destination types. This is a container for the configuration details related to broker logs.
- NumberOfBrokerNodes
-
- Type: int
The number of broker nodes in the cluster.
- OpenMonitoring
-
- Type: OpenMonitoring structure
Settings for open monitoring using Prometheus.
- State
-
- Type: string
The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.
- StateInfo
-
- Type: StateInfo structure
Contains information about the state of the Amazon MSK cluster.
- StorageMode
-
- Type: string
This controls storage mode for supported storage tiers.
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Tags attached to the cluster.
- ZookeeperConnectString
-
- Type: string
The connection string to use to connect to the Apache ZooKeeper cluster.
- ZookeeperConnectStringTls
-
- Type: string
The connection string to use to connect to zookeeper cluster on Tls port.
ClusterOperationInfo
Description
Returns information about a cluster operation.
Members
- ClientRequestId
-
- Type: string
The ID of the API request that triggered this operation.
- ClusterArn
-
- Type: string
ARN of the cluster.
- CreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time at which operation was created.
- EndTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time at which the operation finished.
- ErrorInfo
-
- Type: ErrorInfo structure
Describes the error if the operation fails.
- OperationArn
-
- Type: string
ARN of the cluster operation.
- OperationState
-
- Type: string
State of the cluster operation.
- OperationSteps
-
- Type: Array of ClusterOperationStep structures
Steps completed during the operation.
- OperationType
-
- Type: string
Type of the cluster operation.
- SourceClusterInfo
-
- Type: MutableClusterInfo structure
Information about cluster attributes before a cluster is updated.
- TargetClusterInfo
-
- Type: MutableClusterInfo structure
Information about cluster attributes after a cluster is updated.
ClusterOperationStep
Description
Step taken during a cluster operation.
Members
- StepInfo
-
- Type: ClusterOperationStepInfo structure
Information about the step and its status.
- StepName
-
- Type: string
The name of the step.
ClusterOperationStepInfo
Description
State information about the operation step.
Members
CompatibleKafkaVersion
Description
Contains source Apache Kafka versions and compatible target Apache Kafka versions.
Members
Configuration
Description
Represents an MSK Configuration.
Members
- Arn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the configuration.
- CreationTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- Description
-
- Required: Yes
- Type: string
The description of the configuration.
- KafkaVersions
-
- Required: Yes
- Type: Array of strings
An array of the versions of Apache Kafka with which you can use this MSK configuration. You can use this configuration for an MSK cluster only if the Apache Kafka version specified for the cluster appears in this array.
- LatestRevision
-
- Required: Yes
- Type: ConfigurationRevision structure
Latest revision of the configuration.
- Name
-
- Required: Yes
- Type: string
The name of the configuration. Configuration names are strings that match the regex "^[0-9A-Za-z-]+$".
- State
-
- Required: Yes
- Type: string
The state of a configuration.
ConfigurationInfo
Description
Specifies the configuration to use for the brokers.
Members
ConfigurationRevision
Description
Describes a configuration revision.
Members
ConflictException
Description
Returns information about an error.
Members
ConnectivityInfo
Description
Information about the broker access configuration.
Members
- PublicAccess
-
- Type: PublicAccess structure
Public access control for brokers.
EBSStorageInfo
Description
Contains information about the EBS storage volumes attached to Apache Kafka broker nodes.
Members
- ProvisionedThroughput
-
- Type: ProvisionedThroughput structure
EBS volume provisioned throughput information.
- VolumeSize
-
- Type: int
The size in GiB of the EBS volume for the data drive on each broker node.
EncryptionAtRest
Description
The data-volume encryption details.
Members
EncryptionInTransit
Description
The settings for encrypting data in transit.
Members
- ClientBroker
-
- Type: string
Indicates the encryption setting for data in transit between clients and brokers. You must set it to one of the following values.
TLS means that client-broker communication is enabled with TLS only.
TLS_PLAINTEXT means that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data.
PLAINTEXT means that client-broker communication is enabled in plaintext only.
The default value is TLS.
- InCluster
-
- Type: boolean
When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext.
The default value is true.
EncryptionInfo
Description
Includes encryption-related information, such as the AWS KMS key used for encrypting data at rest and whether you want MSK to encrypt your data in transit.
Members
- EncryptionAtRest
-
- Type: EncryptionAtRest structure
The data-volume encryption details.
- EncryptionInTransit
-
- Type: EncryptionInTransit structure
The details for encryption in transit.
Error
Description
Returns information about an error.
Members
ErrorInfo
Description
Returns information about an error state of the cluster.
Members
Firehose
Description
Firehose details for BrokerLogs.
Members
ForbiddenException
Description
Returns information about an error.
Members
Iam
InternalServerErrorException
Description
Returns information about an error.
Members
JmxExporter
Description
Indicates whether you want to enable or disable the JMX Exporter.
Members
JmxExporterInfo
Description
Indicates whether you want to enable or disable the JMX Exporter.
Members
KafkaVersion
Description
Information about a Apache Kafka version.
Members
LoggingInfo
Description
You can configure your MSK cluster to send broker logs to different destination types. This is a container for the configuration details related to broker logs.
Members
- BrokerLogs
-
- Required: Yes
- Type: BrokerLogs structure
You can configure your MSK cluster to send broker logs to different destination types. This configuration specifies the details of these destinations.
MutableClusterInfo
Description
Information about cluster attributes that can be updated via update APIs.
Members
- BrokerEBSVolumeInfo
-
- Type: Array of BrokerEBSVolumeInfo structures
Specifies the size of the EBS volume and the ID of the associated broker.
- ClientAuthentication
-
- Type: ClientAuthentication structure
Includes all client authentication related information.
- ConfigurationInfo
-
- Type: ConfigurationInfo structure
Information about the changes in the configuration of the brokers.
- ConnectivityInfo
-
- Type: ConnectivityInfo structure
Information about the broker access configuration.
- EncryptionInfo
-
- Type: EncryptionInfo structure
Includes all encryption-related information.
- EnhancedMonitoring
-
- Type: string
Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster.
- InstanceType
-
- Type: string
- KafkaVersion
-
- Type: string
- LoggingInfo
-
- Type: LoggingInfo structure
LoggingInfo details.
- NumberOfBrokerNodes
-
- Type: int
The number of broker nodes in the cluster.
- OpenMonitoring
-
- Type: OpenMonitoring structure
Settings for open monitoring using Prometheus.
- StorageMode
-
- Type: string
This controls storage mode for supported storage tiers.
NodeExporter
Description
Indicates whether you want to enable or disable the Node Exporter.
Members
NodeExporterInfo
Description
Indicates whether you want to enable or disable the Node Exporter.
Members
NodeInfo
Description
The node information object.
Members
- AddedToClusterTime
-
- Type: string
The start time.
- BrokerNodeInfo
-
- Type: BrokerNodeInfo structure
The broker node info.
- InstanceType
-
- Type: string
The instance type.
- NodeARN
-
- Type: string
The Amazon Resource Name (ARN) of the node.
- NodeType
-
- Type: string
The node type.
- ZookeeperNodeInfo
-
- Type: ZookeeperNodeInfo structure
The ZookeeperNodeInfo.
NotFoundException
Description
Returns information about an error.
Members
OpenMonitoring
Description
JMX and Node monitoring for the MSK cluster.
Members
- Prometheus
-
- Required: Yes
- Type: Prometheus structure
Prometheus settings.
OpenMonitoringInfo
Description
JMX and Node monitoring for the MSK cluster.
Members
- Prometheus
-
- Required: Yes
- Type: PrometheusInfo structure
Prometheus settings.
Prometheus
Description
Prometheus settings for open monitoring.
Members
- JmxExporter
-
- Type: JmxExporter structure
Indicates whether you want to enable or disable the JMX Exporter.
- NodeExporter
-
- Type: NodeExporter structure
Indicates whether you want to enable or disable the Node Exporter.
PrometheusInfo
Description
Prometheus settings.
Members
- JmxExporter
-
- Type: JmxExporterInfo structure
JMX Exporter settings.
- NodeExporter
-
- Type: NodeExporterInfo structure
Node Exporter settings.
Provisioned
Description
Describes the provisioned cluster.
Members
- BrokerNodeGroupInfo
-
- Required: Yes
- Type: BrokerNodeGroupInfo structure
Information about the brokers.
- ClientAuthentication
-
- Type: ClientAuthentication structure
Includes all client authentication information.
- CurrentBrokerSoftwareInfo
-
- Type: BrokerSoftwareInfo structure
Information about the version of software currently deployed on the Apache Kafka brokers in the cluster.
- EncryptionInfo
-
- Type: EncryptionInfo structure
Includes all encryption-related information.
- EnhancedMonitoring
-
- Type: string
Specifies which metrics are gathered for the MSK cluster. This property has the following possible values: DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION. For a list of the metrics associated with each of these levels of monitoring, see Monitoring.
- LoggingInfo
-
- Type: LoggingInfo structure
You can configure your MSK cluster to send broker logs to different destination types. This is a container for the configuration details related to broker logs.
- NumberOfBrokerNodes
-
- Required: Yes
- Type: int
- OpenMonitoring
-
- Type: OpenMonitoringInfo structure
JMX and Node monitoring for the MSK cluster.
- StorageMode
-
- Type: string
This controls storage mode for supported storage tiers.
- ZookeeperConnectString
-
- Type: string
- ZookeeperConnectStringTls
-
- Type: string
ProvisionedRequest
Description
Creates a provisioned cluster.
Members
- BrokerNodeGroupInfo
-
- Required: Yes
- Type: BrokerNodeGroupInfo structure
Information about the brokers.
- ClientAuthentication
-
- Type: ClientAuthentication structure
Includes all client authentication related information.
- ConfigurationInfo
-
- Type: ConfigurationInfo structure
Represents the configuration that you want MSK to use for the cluster.
- EncryptionInfo
-
- Type: EncryptionInfo structure
Includes all encryption-related information.
- EnhancedMonitoring
-
- Type: string
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.
- KafkaVersion
-
- Required: Yes
- Type: string
- LoggingInfo
-
- Type: LoggingInfo structure
LoggingInfo details.
- NumberOfBrokerNodes
-
- Required: Yes
- Type: int
- OpenMonitoring
-
- Type: OpenMonitoringInfo structure
The settings for open monitoring.
- StorageMode
-
- Type: string
This controls storage mode for supported storage tiers.
ProvisionedThroughput
Description
Contains information about provisioned throughput for EBS storage volumes attached to kafka broker nodes.
Members
PublicAccess
Description
Broker public access control.
Members
S3
Description
The details of the Amazon S3 destination for broker logs.
Members
Sasl
Scram
Serverless
Description
Describes the serverless cluster.
Members
- ClientAuthentication
-
- Type: ServerlessClientAuthentication structure
Information about the serverless cluster client authentication.
- VpcConfigs
-
- Required: Yes
- Type: Array of VpcConfig structures
Information on vpc config for the serverless cluster.
ServerlessClientAuthentication
Description
Describes the serverless cluster client authentication.
Members
- Sasl
-
- Type: ServerlessSasl structure
Serverless cluster SASL information.
ServerlessRequest
Description
Creates serverless cluster.
Members
- ClientAuthentication
-
- Type: ServerlessClientAuthentication structure
Information about the serverless cluster client authentication.
- VpcConfigs
-
- Required: Yes
- Type: Array of VpcConfig structures
Information on vpc config for the serverless cluster.
ServerlessSasl
ServiceUnavailableException
Description
Returns information about an error.
Members
StateInfo
Description
Contains information about the state of the Amazon MSK cluster.
Members
StorageInfo
Description
Contains information about storage volumes attached to MSK broker nodes.
Members
- EbsStorageInfo
-
- Type: EBSStorageInfo structure
EBS volume information.
Tls
Description
Details for client authentication using TLS.
Members
TooManyRequestsException
Description
Returns information about an error.
Members
Unauthenticated
Description
Contains information about unauthenticated traffic to the cluster.
Members
UnauthorizedException
Description
Returns information about an error.
Members
UnprocessedScramSecret
VpcConfig
Description
The configuration of the Amazon VPCs for the cluster.
Members
ZookeeperNodeInfo
Description
Zookeeper node information.
Members
- AttachedENIId
-
- Type: string
The attached elastic network interface of the broker.
- ClientVpcIpAddress
-
- Type: string
The virtual private cloud (VPC) IP address of the client.
- Endpoints
-
- Type: Array of strings
Endpoints for accessing the ZooKeeper.
- ZookeeperId
-
- Type: double
The role-specific ID for Zookeeper.
- ZookeeperVersion
-
- Type: string
The version of Zookeeper.