SDK for PHP 3.x

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.
CreateReplicator ( array $params = [] )
Creates a new Kafka Replicator.
CreateVpcConnection ( array $params = [] )
Creates a new Amazon MSK VPC connection.
DeleteCluster ( array $params = [] )
Deletes the MSK cluster specified by the Amazon Resource Name (ARN) in the request.
DeleteClusterPolicy ( array $params = [] )
Deletes the MSK cluster policy specified by the Amazon Resource Name (ARN) in your request.
DeleteConfiguration ( array $params = [] )
Deletes the specified MSK configuration.
DeleteReplicator ( array $params = [] )
Deletes a replicator.
DeleteVpcConnection ( array $params = [] )
Deletes the Amazon MSK VPC connection specified in your request.
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.
DescribeClusterOperationV2 ( 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.
DescribeReplicator ( array $params = [] )
Returns a description of the Kafka Replicator whose Amazon Resource Name (ARN) is specified in the request.
DescribeVpcConnection ( array $params = [] )
Displays information about the specified Amazon MSK VPC connection.
GetBootstrapBrokers ( array $params = [] )
A list of brokers that a client application can use to bootstrap.
GetClusterPolicy ( array $params = [] )
Retrieves the contents of the specified MSK cluster policy.
GetCompatibleKafkaVersions ( array $params = [] )
Gets the Apache Kafka versions to which you can update the MSK cluster.
ListClientVpcConnections ( array $params = [] )
Displays a list of client VPC connections.
ListClusterOperations ( array $params = [] )
Returns a list of all the operations that have been performed on the specified MSK cluster.
ListClusterOperationsV2 ( 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.
ListReplicators ( array $params = [] )
Lists the replicators.
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.
ListVpcConnections ( array $params = [] )
Displays a list of Amazon MSK VPC connections.
PutClusterPolicy ( array $params = [] )
Creates or updates the specified MSK cluster policy.
RebootBroker ( array $params = [] )
Executes a reboot on a broker.
RejectClientVpcConnection ( array $params = [] )
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 MSK cluster.
UpdateMonitoring ( array $params = [] )
Updates the monitoring settings for the cluster.
UpdateReplicationInfo ( array $params = [] )
Updates replication info of a replicator.
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:

ListClusters
ListClustersV2
ListConfigurations
ListKafkaVersions
ListNodes
ListClusterOperations
ListClusterOperationsV2
ListConfigurationRevisions
ListReplicators
ListScramSecrets
ListVpcConnections
ListClientVpcConnections

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
ClusterArn
Required: Yes
Type: string
SecretArnList
Required: Yes
Type: Array of strings

List of AWS Secrets Manager secret ARNs.

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

BadRequestException:

Returns information about an error.

UnauthorizedException:

Returns information about an error.

InternalServerErrorException:

Returns information about an error.

ForbiddenException:

Returns information about an error.

NotFoundException:

Returns information about an error.

ServiceUnavailableException:

Returns information about an error.

TooManyRequestsException:

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
ClusterArn
Required: Yes
Type: string
SecretArnList
Required: Yes
Type: Array of strings

List of AWS Secrets Manager secret ARNs.

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

BadRequestException:

Returns information about an error.

UnauthorizedException:

Returns information about an error.

InternalServerErrorException:

Returns information about an error.

ForbiddenException:

Returns information about an error.

NotFoundException:

Returns information about an error.

ServiceUnavailableException:

Returns information about an error.

TooManyRequestsException:

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>',
            ],
            'VpcConnectivity' => [
                'ClientAuthentication' => [
                    'Sasl' => [
                        'Iam' => [
                            'Enabled' => true || false,
                        ],
                        'Scram' => [
                            'Enabled' => true || false,
                        ],
                    ],
                    'Tls' => [
                        'Enabled' => true || false,
                    ],
                ],
            ],
        ],
        'InstanceType' => '<string>', // REQUIRED
        'SecurityGroups' => ['<string>', ...],
        'StorageInfo' => [
            'EbsStorageInfo' => [
                'ProvisionedThroughput' => [
                    'Enabled' => true || false,
                    'VolumeThroughput' => <integer>,
                ],
                'VolumeSize' => <integer>,
            ],
        ],
        'ZoneIds' => ['<string>', ...],
    ],
    '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
ClusterArn
Type: string

The Amazon Resource Name (ARN) of the cluster.

ClusterName
Type: string

The name of the MSK cluster.

State
Type: string

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

Errors

BadRequestException:

Returns information about an error.

InternalServerErrorException:

Returns information about an error.

UnauthorizedException:

Returns information about an error.

ForbiddenException:

Returns information about an error.

ServiceUnavailableException:

Returns information about an error.

TooManyRequestsException:

Returns information about an error.

ConflictException:

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>',
                ],
                'VpcConnectivity' => [
                    'ClientAuthentication' => [
                        'Sasl' => [
                            'Iam' => [
                                'Enabled' => true || false,
                            ],
                            'Scram' => [
                                'Enabled' => true || false,
                            ],
                        ],
                        'Tls' => [
                            'Enabled' => true || false,
                        ],
                    ],
                ],
            ],
            'InstanceType' => '<string>', // REQUIRED
            'SecurityGroups' => ['<string>', ...],
            'StorageInfo' => [
                'EbsStorageInfo' => [
                    'ProvisionedThroughput' => [
                        'Enabled' => true || false,
                        'VolumeThroughput' => <integer>,
                    ],
                    'VolumeSize' => <integer>,
                ],
            ],
            'ZoneIds' => ['<string>', ...],
        ],
        '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
ClusterArn
Type: string
ClusterName
Type: string
ClusterType
Type: string
State
Type: string

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

Errors

BadRequestException:

Returns information about an error.

InternalServerErrorException:

Returns information about an error.

UnauthorizedException:

Returns information about an error.

ForbiddenException:

Returns information about an error.

ServiceUnavailableException:

Returns information about an error.

TooManyRequestsException:

Returns information about an error.

ConflictException:

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

BadRequestException:

Returns information about an error.

InternalServerErrorException:

Returns information about an error.

UnauthorizedException:

Returns information about an error.

ForbiddenException:

Returns information about an error.

ServiceUnavailableException:

Returns information about an error.

TooManyRequestsException:

Returns information about an error.

ConflictException:

Returns information about an error.

CreateReplicator 

$result = $client->createReplicator([/* ... */]);
$promise = $client->createReplicatorAsync([/* ... */]);

Creates a new Kafka Replicator.

Parameter Syntax

$result = $client->createReplicator([
    'Description' => '<string>',
    'KafkaClusters' => [ // REQUIRED
        [
            'AmazonMskCluster' => [ // REQUIRED
                'MskClusterArn' => '<string>', // REQUIRED
            ],
            'VpcConfig' => [ // REQUIRED
                'SecurityGroupIds' => ['<string>', ...],
                'SubnetIds' => ['<string>', ...], // REQUIRED
            ],
        ],
        // ...
    ],
    'ReplicationInfoList' => [ // REQUIRED
        [
            'ConsumerGroupReplication' => [ // REQUIRED
                'ConsumerGroupsToExclude' => ['<string>', ...],
                'ConsumerGroupsToReplicate' => ['<string>', ...], // REQUIRED
                'DetectAndCopyNewConsumerGroups' => true || false,
                'SynchroniseConsumerGroupOffsets' => true || false,
            ],
            'SourceKafkaClusterArn' => '<string>', // REQUIRED
            'TargetCompressionType' => 'NONE|GZIP|SNAPPY|LZ4|ZSTD', // REQUIRED
            'TargetKafkaClusterArn' => '<string>', // REQUIRED
            'TopicReplication' => [ // REQUIRED
                'CopyAccessControlListsForTopics' => true || false,
                'CopyTopicConfigurations' => true || false,
                'DetectAndCopyNewTopics' => true || false,
                'StartingPosition' => [
                    'Type' => 'LATEST|EARLIEST',
                ],
                'TopicsToExclude' => ['<string>', ...],
                'TopicsToReplicate' => ['<string>', ...], // REQUIRED
            ],
        ],
        // ...
    ],
    'ReplicatorName' => '<string>', // REQUIRED
    'ServiceExecutionRoleArn' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...],
]);

Parameter Details

Members
Description
Type: string

A summary description of the replicator.

KafkaClusters
Required: Yes
Type: Array of KafkaCluster structures

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

ReplicationInfoList
Required: Yes
Type: Array of ReplicationInfo structures

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

ReplicatorName
Required: Yes
Type: string

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

ServiceExecutionRoleArn
Required: Yes
Type: string

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
Type: Associative array of custom strings keys (__string) to strings

List of tags to attach to created Replicator.

Result Syntax

[
    'ReplicatorArn' => '<string>',
    'ReplicatorName' => '<string>',
    'ReplicatorState' => 'RUNNING|CREATING|UPDATING|DELETING|FAILED',
]

Result Details

Members
ReplicatorArn
Type: string

The Amazon Resource Name (ARN) of the replicator.

ReplicatorName
Type: string

Name of the replicator provided by the customer.

ReplicatorState
Type: string

State of the replicator.

Errors

BadRequestException:

Returns information about an error.

UnauthorizedException:

Returns information about an error.

InternalServerErrorException:

Returns information about an error.

ForbiddenException:

Returns information about an error.

NotFoundException:

Returns information about an error.

ServiceUnavailableException:

Returns information about an error.

TooManyRequestsException:

Returns information about an error.

ConflictException:

Returns information about an error.

CreateVpcConnection 

$result = $client->createVpcConnection([/* ... */]);
$promise = $client->createVpcConnectionAsync([/* ... */]);

Creates a new Amazon MSK VPC connection.

Parameter Syntax

$result = $client->createVpcConnection([
    'Authentication' => '<string>', // REQUIRED
    'ClientSubnets' => ['<string>', ...], // REQUIRED
    'SecurityGroups' => ['<string>', ...], // REQUIRED
    'Tags' => ['<string>', ...],
    'TargetClusterArn' => '<string>', // REQUIRED
    'VpcId' => '<string>', // REQUIRED
]);

Parameter Details

Members
Authentication
Required: Yes
Type: string
ClientSubnets
Required: Yes
Type: Array of strings

The list of subnets in the client VPC.

SecurityGroups
Required: Yes
Type: Array of strings

The list of security groups to attach to the VPC connection.

Tags
Type: Associative array of custom strings keys (__string) to strings

Create tags when creating the VPC connection.

TargetClusterArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the cluster.

VpcId
Required: Yes
Type: string

The VPC ID of the VPC connection.

Result Syntax

[
    'Authentication' => '<string>',
    'ClientSubnets' => ['<string>', ...],
    'CreationTime' => <DateTime>,
    'SecurityGroups' => ['<string>', ...],
    'State' => 'CREATING|AVAILABLE|INACTIVE|DEACTIVATING|DELETING|FAILED|REJECTED|REJECTING',
    'Tags' => ['<string>', ...],
    'VpcConnectionArn' => '<string>',
    'VpcId' => '<string>',
]

Result Details

Members
Authentication
Type: string
ClientSubnets
Type: Array of strings

The list of subnets in the client VPC.

CreationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time when the VPC connection was created.

SecurityGroups
Type: Array of strings

The list of security groups attached to the VPC connection.

State
Type: string

The state of the VPC connection. The only possible state is CREATING.

Tags
Type: Associative array of custom strings keys (__string) to strings

Tags attached to the VPC connection.

VpcConnectionArn
Type: string

The Amazon Resource Name (ARN) of the VPC connection.

VpcId
Type: string

The VPC ID of the VPC connection.

Errors

BadRequestException:

Returns information about an error.

InternalServerErrorException:

Returns information about an error.

UnauthorizedException:

Returns information about an error.

ForbiddenException:

Returns information about an error.

ServiceUnavailableException:

Returns information about an error.

TooManyRequestsException:

Returns information about an error.

ConflictException:

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

Members
ClusterArn
Required: Yes
Type: string
CurrentVersion
Type: string

Result Syntax

[
    'ClusterArn' => '<string>',
    'State' => 'ACTIVE|CREATING|DELETING|FAILED|HEALING|MAINTENANCE|REBOOTING_BROKER|UPDATING',
]

Result Details

Members
ClusterArn
Type: string

The Amazon Resource Name (ARN) of the cluster.

State
Type: string

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

Errors

NotFoundException:

Returns information about an error.

BadRequestException:

Returns information about an error.

InternalServerErrorException:

Returns information about an error.

ForbiddenException:

Returns information about an error.

DeleteClusterPolicy 

$result = $client->deleteClusterPolicy([/* ... */]);
$promise = $client->deleteClusterPolicyAsync([/* ... */]);

Deletes the MSK cluster policy specified by the Amazon Resource Name (ARN) in your request.

Parameter Syntax

$result = $client->deleteClusterPolicy([
    'ClusterArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
ClusterArn
Required: Yes
Type: string

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

NotFoundException:

Returns information about an error.

BadRequestException:

Returns information about an error.

UnauthorizedException:

Returns information about an error.

InternalServerErrorException:

Returns information about an error.

ForbiddenException:

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

Members
Arn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the configuration.

Result Syntax

[
    'Arn' => '<string>',
    'State' => 'ACTIVE|DELETING|DELETE_FAILED',
]

Result Details

Members
Arn
Type: string

The Amazon Resource Name (ARN) of the configuration.

State
Type: string

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

Errors

NotFoundException:

Returns information about an error.

BadRequestException:

Returns information about an error.

InternalServerErrorException:

Returns information about an error.

ForbiddenException:

Returns information about an error.

DeleteReplicator 

$result = $client->deleteReplicator([/* ... */]);
$promise = $client->deleteReplicatorAsync([/* ... */]);

Deletes a replicator.

Parameter Syntax

$result = $client->deleteReplicator([
    'CurrentVersion' => '<string>',
    'ReplicatorArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
CurrentVersion
Type: string
ReplicatorArn
Required: Yes
Type: string

Result Syntax

[
    'ReplicatorArn' => '<string>',
    'ReplicatorState' => 'RUNNING|CREATING|UPDATING|DELETING|FAILED',
]

Result Details

Members
ReplicatorArn
Type: string

The Amazon Resource Name (ARN) of the replicator.

ReplicatorState
Type: string

The state of the replicator.

Errors

BadRequestException:

Returns information about an error.

UnauthorizedException:

Returns information about an error.

InternalServerErrorException:

Returns information about an error.

ForbiddenException:

Returns information about an error.

NotFoundException:

Returns information about an error.

ServiceUnavailableException:

Returns information about an error.

TooManyRequestsException:

Returns information about an error.

DeleteVpcConnection 

$result = $client->deleteVpcConnection([/* ... */]);
$promise = $client->deleteVpcConnectionAsync([/* ... */]);

Deletes the Amazon MSK VPC connection specified in your request.

Parameter Syntax

$result = $client->deleteVpcConnection([
    'Arn' => '<string>', // REQUIRED
]);

Parameter Details

Members
Arn
Required: Yes
Type: string

Result Syntax

[
    'State' => 'CREATING|AVAILABLE|INACTIVE|DEACTIVATING|DELETING|FAILED|REJECTED|REJECTING',
    'VpcConnectionArn' => '<string>',
]

Result Details

Members
State
Type: string

The state of the VPC connection. The only possible state is DELETING.

VpcConnectionArn
Type: string

The Amazon Resource Name (ARN) of the VPC connection.

Errors

NotFoundException:

Returns information about an error.

BadRequestException:

Returns information about an error.

InternalServerErrorException:

Returns information about an error.

ForbiddenException:

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

Members
ClusterArn
Required: Yes
Type: string

Result Syntax

[
    'ClusterInfo' => [
        'ActiveOperationArn' => '<string>',
        'BrokerNodeGroupInfo' => [
            'BrokerAZDistribution' => 'DEFAULT',
            'ClientSubnets' => ['<string>', ...],
            'ConnectivityInfo' => [
                'PublicAccess' => [
                    'Type' => '<string>',
                ],
                'VpcConnectivity' => [
                    'ClientAuthentication' => [
                        'Sasl' => [
                            'Iam' => [
                                'Enabled' => true || false,
                            ],
                            'Scram' => [
                                'Enabled' => true || false,
                            ],
                        ],
                        'Tls' => [
                            'Enabled' => true || false,
                        ],
                    ],
                ],
            ],
            'InstanceType' => '<string>',
            'SecurityGroups' => ['<string>', ...],
            'StorageInfo' => [
                'EbsStorageInfo' => [
                    'ProvisionedThroughput' => [
                        'Enabled' => true || false,
                        'VolumeThroughput' => <integer>,
                    ],
                    'VolumeSize' => <integer>,
                ],
            ],
            'ZoneIds' => ['<string>', ...],
        ],
        '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>',
        'CustomerActionStatus' => 'CRITICAL_ACTION_REQUIRED|ACTION_RECOMMENDED|NONE',
        '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

NotFoundException:

Returns information about an error.

BadRequestException:

Returns information about an error.

UnauthorizedException:

Returns information about an error.

InternalServerErrorException:

Returns information about an error.

ForbiddenException:

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

Members
ClusterOperationArn
Required: Yes
Type: string

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' => [
            'BrokerCountUpdateInfo' => [
                'CreatedBrokerIds' => [<float>, ...],
                'DeletedBrokerIds' => [<float>, ...],
            ],
            '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>',
                ],
                'VpcConnectivity' => [
                    'ClientAuthentication' => [
                        'Sasl' => [
                            'Iam' => [
                                'Enabled' => true || false,
                            ],
                            'Scram' => [
                                'Enabled' => true || false,
                            ],
                        ],
                        'Tls' => [
                            'Enabled' => true || false,
                        ],
                    ],
                ],
            ],
            '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' => [
            'BrokerCountUpdateInfo' => [
                'CreatedBrokerIds' => [<float>, ...],
                'DeletedBrokerIds' => [<float>, ...],
            ],
            '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>',
                ],
                'VpcConnectivity' => [
                    'ClientAuthentication' => [
                        'Sasl' => [
                            'Iam' => [
                                'Enabled' => true || false,
                            ],
                            'Scram' => [
                                'Enabled' => true || false,
                            ],
                        ],
                        'Tls' => [
                            'Enabled' => true || false,
                        ],
                    ],
                ],
            ],
            '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',
        ],
        'VpcConnectionInfo' => [
            'CreationTime' => <DateTime>,
            'Owner' => '<string>',
            'UserIdentity' => [
                'PrincipalId' => '<string>',
                'Type' => 'AWSACCOUNT|AWSSERVICE',
            ],
            'VpcConnectionArn' => '<string>',
        ],
    ],
]

Result Details

Members
ClusterOperationInfo
Type: ClusterOperationInfo structure

Cluster operation information

Errors

NotFoundException:

Returns information about an error.

BadRequestException:

Returns information about an error.

UnauthorizedException:

Returns information about an error.

InternalServerErrorException:

Returns information about an error.

ForbiddenException:

Returns information about an error.

DescribeClusterOperationV2 

$result = $client->describeClusterOperationV2([/* ... */]);
$promise = $client->describeClusterOperationV2Async([/* ... */]);

Returns a description of the cluster operation specified by the ARN.

Parameter Syntax

$result = $client->describeClusterOperationV2([
    'ClusterOperationArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
ClusterOperationArn
Required: Yes
Type: string

Result Syntax

[
    'ClusterOperationInfo' => [
        'ClusterArn' => '<string>',
        'ClusterType' => 'PROVISIONED|SERVERLESS',
        'EndTime' => <DateTime>,
        'OperationArn' => '<string>',
        'OperationState' => '<string>',
        'OperationType' => '<string>',
        'Provisioned' => [
            'OperationSteps' => [
                [
                    'StepInfo' => [
                        'StepStatus' => '<string>',
                    ],
                    'StepName' => '<string>',
                ],
                // ...
            ],
            'SourceClusterInfo' => [
                'BrokerCountUpdateInfo' => [
                    'CreatedBrokerIds' => [<float>, ...],
                    'DeletedBrokerIds' => [<float>, ...],
                ],
                '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>',
                    ],
                    'VpcConnectivity' => [
                        'ClientAuthentication' => [
                            'Sasl' => [
                                'Iam' => [
                                    'Enabled' => true || false,
                                ],
                                'Scram' => [
                                    'Enabled' => true || false,
                                ],
                            ],
                            'Tls' => [
                                'Enabled' => true || false,
                            ],
                        ],
                    ],
                ],
                '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' => [
                'BrokerCountUpdateInfo' => [
                    'CreatedBrokerIds' => [<float>, ...],
                    'DeletedBrokerIds' => [<float>, ...],
                ],
                '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>',
                    ],
                    'VpcConnectivity' => [
                        'ClientAuthentication' => [
                            'Sasl' => [
                                'Iam' => [
                                    'Enabled' => true || false,
                                ],
                                'Scram' => [
                                    'Enabled' => true || false,
                                ],
                            ],
                            'Tls' => [
                                'Enabled' => true || false,
                            ],
                        ],
                    ],
                ],
                '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',
            ],
            'VpcConnectionInfo' => [
                'CreationTime' => <DateTime>,
                'Owner' => '<string>',
                'UserIdentity' => [
                    'PrincipalId' => '<string>',
                    'Type' => 'AWSACCOUNT|AWSSERVICE',
                ],
                'VpcConnectionArn' => '<string>',
            ],
        ],
        'Serverless' => [
            'VpcConnectionInfo' => [
                'CreationTime' => <DateTime>,
                'Owner' => '<string>',
                'UserIdentity' => [
                    'PrincipalId' => '<string>',
                    'Type' => 'AWSACCOUNT|AWSSERVICE',
                ],
                'VpcConnectionArn' => '<string>',
            ],
        ],
        'StartTime' => <DateTime>,
    ],
]

Result Details

Members
ClusterOperationInfo
Type: ClusterOperationV2 structure

Cluster operation information

Errors

BadRequestException:

Returns information about an error.

UnauthorizedException:

Returns information about an error.

InternalServerErrorException:

Returns information about an error.

ForbiddenException:

Returns information about an error.

NotFoundException:

Returns information about an error.

ServiceUnavailableException:

Returns information about an error.

TooManyRequestsException:

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

Members
ClusterArn
Required: Yes
Type: string

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>',
                    ],
                    'VpcConnectivity' => [
                        'ClientAuthentication' => [
                            'Sasl' => [
                                'Iam' => [
                                    'Enabled' => true || false,
                                ],
                                'Scram' => [
                                    'Enabled' => true || false,
                                ],
                            ],
                            'Tls' => [
                                'Enabled' => true || false,
                            ],
                        ],
                    ],
                ],
                'InstanceType' => '<string>',
                'SecurityGroups' => ['<string>', ...],
                'StorageInfo' => [
                    'EbsStorageInfo' => [
                        'ProvisionedThroughput' => [
                            'Enabled' => true || false,
                            'VolumeThroughput' => <integer>,
                        ],
                        'VolumeSize' => <integer>,
                    ],
                ],
                'ZoneIds' => ['<string>', ...],
            ],
            '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>',
            ],
            'CustomerActionStatus' => 'CRITICAL_ACTION_REQUIRED|ACTION_RECOMMENDED|NONE',
            '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

NotFoundException:

Returns information about an error.

BadRequestException:

Returns information about an error.

UnauthorizedException:

Returns information about an error.

InternalServerErrorException:

Returns information about an error.

ForbiddenException:

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

Members
Arn
Required: Yes
Type: string

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

BadRequestException:

Returns information about an error.

UnauthorizedException:

Returns information about an error.

InternalServerErrorException:

Returns information about an error.

ForbiddenException:

Returns information about an error.

NotFoundException:

Returns information about an error.

ServiceUnavailableException:

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

Members
Arn
Required: Yes
Type: string
Revision
Required: Yes
Type: long (int|float)

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

BadRequestException:

Returns information about an error.

UnauthorizedException:

Returns information about an error.

InternalServerErrorException:

Returns information about an error.

ForbiddenException:

Returns information about an error.

NotFoundException:

Returns information about an error.

ServiceUnavailableException:

Returns information about an error.

DescribeReplicator 

$result = $client->describeReplicator([/* ... */]);
$promise = $client->describeReplicatorAsync([/* ... */]);

Returns a description of the Kafka Replicator whose Amazon Resource Name (ARN) is specified in the request.

Parameter Syntax

$result = $client->describeReplicator([
    'ReplicatorArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
ReplicatorArn
Required: Yes
Type: string

Result Syntax

[
    'CreationTime' => <DateTime>,
    'CurrentVersion' => '<string>',
    'IsReplicatorReference' => true || false,
    'KafkaClusters' => [
        [
            'AmazonMskCluster' => [
                'MskClusterArn' => '<string>',
            ],
            'KafkaClusterAlias' => '<string>',
            'VpcConfig' => [
                'SecurityGroupIds' => ['<string>', ...],
                'SubnetIds' => ['<string>', ...],
            ],
        ],
        // ...
    ],
    'ReplicationInfoList' => [
        [
            'ConsumerGroupReplication' => [
                'ConsumerGroupsToExclude' => ['<string>', ...],
                'ConsumerGroupsToReplicate' => ['<string>', ...],
                'DetectAndCopyNewConsumerGroups' => true || false,
                'SynchroniseConsumerGroupOffsets' => true || false,
            ],
            'SourceKafkaClusterAlias' => '<string>',
            'TargetCompressionType' => 'NONE|GZIP|SNAPPY|LZ4|ZSTD',
            'TargetKafkaClusterAlias' => '<string>',
            'TopicReplication' => [
                'CopyAccessControlListsForTopics' => true || false,
                'CopyTopicConfigurations' => true || false,
                'DetectAndCopyNewTopics' => true || false,
                'StartingPosition' => [
                    'Type' => 'LATEST|EARLIEST',
                ],
                'TopicsToExclude' => ['<string>', ...],
                'TopicsToReplicate' => ['<string>', ...],
            ],
        ],
        // ...
    ],
    'ReplicatorArn' => '<string>',
    'ReplicatorDescription' => '<string>',
    'ReplicatorName' => '<string>',
    'ReplicatorResourceArn' => '<string>',
    'ReplicatorState' => 'RUNNING|CREATING|UPDATING|DELETING|FAILED',
    'ServiceExecutionRoleArn' => '<string>',
    'StateInfo' => [
        'Code' => '<string>',
        'Message' => '<string>',
    ],
    'Tags' => ['<string>', ...],
]

Result Details

Members
CreationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time when the replicator was created.

CurrentVersion
Type: string

The current version number of the replicator.

IsReplicatorReference
Type: boolean

Whether this resource is a replicator reference.

KafkaClusters
Type: Array of KafkaClusterDescription structures

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

ReplicationInfoList
Type: Array of ReplicationInfoDescription structures

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

ReplicatorArn
Type: string

The Amazon Resource Name (ARN) of the replicator.

ReplicatorDescription
Type: string

The description of the replicator.

ReplicatorName
Type: string

The name of the replicator.

ReplicatorResourceArn
Type: string

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

ReplicatorState
Type: string

State of the replicator.

ServiceExecutionRoleArn
Type: 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)

StateInfo
Type: ReplicationStateInfo structure
Details about the state of the replicator.
Tags
Type: Associative array of custom strings keys (__string) to strings

List of tags attached to the Replicator.

Errors

BadRequestException:

Returns information about an error.

UnauthorizedException:

Returns information about an error.

InternalServerErrorException:

Returns information about an error.

ForbiddenException:

Returns information about an error.

NotFoundException:

Returns information about an error.

ServiceUnavailableException:

Returns information about an error.

TooManyRequestsException:

Returns information about an error.

DescribeVpcConnection 

$result = $client->describeVpcConnection([/* ... */]);
$promise = $client->describeVpcConnectionAsync([/* ... */]);

Displays information about the specified Amazon MSK VPC connection.

Parameter Syntax

$result = $client->describeVpcConnection([
    'Arn' => '<string>', // REQUIRED
]);

Parameter Details

Members
Arn
Required: Yes
Type: string

Result Syntax

[
    'Authentication' => '<string>',
    'CreationTime' => <DateTime>,
    'SecurityGroups' => ['<string>', ...],
    'State' => 'CREATING|AVAILABLE|INACTIVE|DEACTIVATING|DELETING|FAILED|REJECTED|REJECTING',
    'Subnets' => ['<string>', ...],
    'Tags' => ['<string>', ...],
    'TargetClusterArn' => '<string>',
    'VpcConnectionArn' => '<string>',
    'VpcId' => '<string>',
]

Result Details

Members
Authentication
Type: string

The authentication type of the VPC connection.

CreationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The creation time of the VPC connection.

SecurityGroups
Type: Array of strings

The list of security groups attached to the VPC connection.

State
Type: string

The state of the VPC connection. The possible states are AVAILABLE, INACTIVE, DEACTIVATING, DELETING, CREATING, REJECTING, REJECTED and FAILED.

Subnets
Type: Array of strings

The list of subnets in the client VPC.

Tags
Type: Associative array of custom strings keys (__string) to strings

Tags attached to the VPC connection.

TargetClusterArn
Type: string

The Amazon Resource Name (ARN) of the cluster.

VpcConnectionArn
Type: string

The Amazon Resource Name (ARN) of the VPC connection.

VpcId
Type: string

The VPC ID of the VPC connection.

Errors

BadRequestException:

Returns information about an error.

UnauthorizedException:

Returns information about an error.

InternalServerErrorException:

Returns information about an error.

ForbiddenException:

Returns information about an error.

NotFoundException:

Returns information about an error.

ServiceUnavailableException:

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

Members
ClusterArn
Required: Yes
Type: string

Result Syntax

[
    'BootstrapBrokerString' => '<string>',
    'BootstrapBrokerStringPublicSaslIam' => '<string>',
    'BootstrapBrokerStringPublicSaslScram' => '<string>',
    'BootstrapBrokerStringPublicTls' => '<string>',
    'BootstrapBrokerStringSaslIam' => '<string>',
    'BootstrapBrokerStringSaslScram' => '<string>',
    'BootstrapBrokerStringTls' => '<string>',
    'BootstrapBrokerStringVpcConnectivitySaslIam' => '<string>',
    'BootstrapBrokerStringVpcConnectivitySaslScram' => '<string>',
    'BootstrapBrokerStringVpcConnectivityTls' => '<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"}
BootstrapBrokerStringVpcConnectivitySaslIam
Type: string

A string containing one or more dns name (or IP) and SASL IAM port pairs for VPC connectivity.

BootstrapBrokerStringVpcConnectivitySaslScram
Type: string

A string containing one or more dns name (or IP) and SASL SCRAM port pairs for VPC connectivity.

BootstrapBrokerStringVpcConnectivityTls
Type: string

A string containing one or more dns name (or IP) and Tls port pairs for VPC connectivity.

Errors

BadRequestException:

Returns information about an error.

UnauthorizedException:

Returns information about an error.

InternalServerErrorException:

Returns information about an error.

ConflictException:

Returns information about an error.

ForbiddenException:

Returns information about an error.

GetClusterPolicy 

$result = $client->getClusterPolicy([/* ... */]);
$promise = $client->getClusterPolicyAsync([/* ... */]);

Retrieves the contents of the specified MSK cluster policy.

Parameter Syntax

$result = $client->getClusterPolicy([
    'ClusterArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
ClusterArn
Required: Yes
Type: string

Result Syntax

[
    'CurrentVersion' => '<string>',
    'Policy' => '<string>',
]

Result Details

Members
CurrentVersion
Type: string

Cluster policy version.

Policy
Type: string

Cluster policy attached to the MSK cluster.

Errors

NotFoundException:

Returns information about an error.

BadRequestException:

Returns information about an error.

UnauthorizedException:

Returns information about an error.

InternalServerErrorException:

Returns information about an error.

ForbiddenException:

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

Members
ClusterArn
Type: string

Result Syntax

[
    'CompatibleKafkaVersions' => [
        [
            'SourceVersion' => '<string>',
            'TargetVersions' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

Members
CompatibleKafkaVersions
Type: Array of CompatibleKafkaVersion structures

A list of CompatibleKafkaVersion objects.

Errors

BadRequestException:

Returns information about an error.

UnauthorizedException:

Returns information about an error.

InternalServerErrorException:

Returns information about an error.

ForbiddenException:

Returns information about an error.

NotFoundException:

Returns information about an error.

ServiceUnavailableException:

Returns information about an error.

TooManyRequestsException:

Returns information about an error.

ListClientVpcConnections 

$result = $client->listClientVpcConnections([/* ... */]);
$promise = $client->listClientVpcConnectionsAsync([/* ... */]);

Displays a list of client VPC connections.

Parameter Syntax

$result = $client->listClientVpcConnections([
    'ClusterArn' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
ClusterArn
Required: Yes
Type: string
MaxResults
Type: int
NextToken
Type: string

Result Syntax

[
    'ClientVpcConnections' => [
        [
            'Authentication' => '<string>',
            'CreationTime' => <DateTime>,
            'Owner' => '<string>',
            'State' => 'CREATING|AVAILABLE|INACTIVE|DEACTIVATING|DELETING|FAILED|REJECTED|REJECTING',
            'VpcConnectionArn' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
ClientVpcConnections
Type: Array of ClientVpcConnection structures

List containing a ClientVpcConnection object.

NextToken
Type: string

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

Errors

ServiceUnavailableException:

Returns information about an error.

BadRequestException:

Returns information about an error.

UnauthorizedException:

Returns information about an error.

InternalServerErrorException:

Returns information about an error.

ForbiddenException:

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

Members
ClusterArn
Required: Yes
Type: string
MaxResults
Type: int
NextToken
Type: string

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' => [
                'BrokerCountUpdateInfo' => [
                    'CreatedBrokerIds' => [<float>, ...],
                    'DeletedBrokerIds' => [<float>, ...],
                ],
                '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>',
                    ],
                    'VpcConnectivity' => [
                        'ClientAuthentication' => [
                            'Sasl' => [
                                'Iam' => [
                                    'Enabled' => true || false,
                                ],
                                'Scram' => [
                                    'Enabled' => true || false,
                                ],
                            ],
                            'Tls' => [
                                'Enabled' => true || false,
                            ],
                        ],
                    ],
                ],
                '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' => [
                'BrokerCountUpdateInfo' => [
                    'CreatedBrokerIds' => [<float>, ...],
                    'DeletedBrokerIds' => [<float>, ...],
                ],
                '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>',
                    ],
                    'VpcConnectivity' => [
                        'ClientAuthentication' => [
                            'Sasl' => [
                                'Iam' => [
                                    'Enabled' => true || false,
                                ],
                                'Scram' => [
                                    'Enabled' => true || false,
                                ],
                            ],
                            'Tls' => [
                                'Enabled' => true || false,
                            ],
                        ],
                    ],
                ],
                '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',
            ],
            'VpcConnectionInfo' => [
                'CreationTime' => <DateTime>,
                'Owner' => '<string>',
                'UserIdentity' => [
                    'PrincipalId' => '<string>',
                    'Type' => 'AWSACCOUNT|AWSSERVICE',
                ],
                'VpcConnectionArn' => '<string>',
            ],
        ],
        // ...
    ],
    '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

BadRequestException:

Returns information about an error.

InternalServerErrorException:

Returns information about an error.

UnauthorizedException:

Returns information about an error.

ForbiddenException:

Returns information about an error.

ListClusterOperationsV2 

$result = $client->listClusterOperationsV2([/* ... */]);
$promise = $client->listClusterOperationsV2Async([/* ... */]);

Returns a list of all the operations that have been performed on the specified MSK cluster.

Parameter Syntax

$result = $client->listClusterOperationsV2([
    'ClusterArn' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
ClusterArn
Required: Yes
Type: string
MaxResults
Type: int
NextToken
Type: string

Result Syntax

[
    'ClusterOperationInfoList' => [
        [
            'ClusterArn' => '<string>',
            'ClusterType' => 'PROVISIONED|SERVERLESS',
            'EndTime' => <DateTime>,
            'OperationArn' => '<string>',
            'OperationState' => '<string>',
            'OperationType' => '<string>',
            'StartTime' => <DateTime>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
ClusterOperationInfoList
Type: Array of ClusterOperationV2Summary structures
NextToken
Type: string

Errors

BadRequestException:

Returns information about an error.

UnauthorizedException:

Returns information about an error.

InternalServerErrorException:

Returns information about an error.

ForbiddenException:

Returns information about an error.

NotFoundException:

Returns information about an error.

ServiceUnavailableException:

Returns information about an error.

TooManyRequestsException:

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

Members
ClusterNameFilter
Type: string
MaxResults
Type: int
NextToken
Type: string

Result Syntax

[
    'ClusterInfoList' => [
        [
            'ActiveOperationArn' => '<string>',
            'BrokerNodeGroupInfo' => [
                'BrokerAZDistribution' => 'DEFAULT',
                'ClientSubnets' => ['<string>', ...],
                'ConnectivityInfo' => [
                    'PublicAccess' => [
                        'Type' => '<string>',
                    ],
                    'VpcConnectivity' => [
                        'ClientAuthentication' => [
                            'Sasl' => [
                                'Iam' => [
                                    'Enabled' => true || false,
                                ],
                                'Scram' => [
                                    'Enabled' => true || false,
                                ],
                            ],
                            'Tls' => [
                                'Enabled' => true || false,
                            ],
                        ],
                    ],
                ],
                'InstanceType' => '<string>',
                'SecurityGroups' => ['<string>', ...],
                'StorageInfo' => [
                    'EbsStorageInfo' => [
                        'ProvisionedThroughput' => [
                            'Enabled' => true || false,
                            'VolumeThroughput' => <integer>,
                        ],
                        'VolumeSize' => <integer>,
                    ],
                ],
                'ZoneIds' => ['<string>', ...],
            ],
            '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>',
            'CustomerActionStatus' => 'CRITICAL_ACTION_REQUIRED|ACTION_RECOMMENDED|NONE',
            '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

BadRequestException:

Returns information about an error.

InternalServerErrorException:

Returns information about an error.

UnauthorizedException:

Returns information about an error.

ForbiddenException:

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
ClusterNameFilter
Type: string
ClusterTypeFilter
Type: string
MaxResults
Type: int
NextToken
Type: string

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>',
                        ],
                        'VpcConnectivity' => [
                            'ClientAuthentication' => [
                                'Sasl' => [
                                    'Iam' => [
                                        'Enabled' => true || false,
                                    ],
                                    'Scram' => [
                                        'Enabled' => true || false,
                                    ],
                                ],
                                'Tls' => [
                                    'Enabled' => true || false,
                                ],
                            ],
                        ],
                    ],
                    'InstanceType' => '<string>',
                    'SecurityGroups' => ['<string>', ...],
                    'StorageInfo' => [
                        'EbsStorageInfo' => [
                            'ProvisionedThroughput' => [
                                'Enabled' => true || false,
                                'VolumeThroughput' => <integer>,
                            ],
                            'VolumeSize' => <integer>,
                        ],
                    ],
                    'ZoneIds' => ['<string>', ...],
                ],
                '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>',
                ],
                'CustomerActionStatus' => 'CRITICAL_ACTION_REQUIRED|ACTION_RECOMMENDED|NONE',
                '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

BadRequestException:

Returns information about an error.

InternalServerErrorException:

Returns information about an error.

UnauthorizedException:

Returns information about an error.

ForbiddenException:

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

Members
Arn
Required: Yes
Type: string
MaxResults
Type: int
NextToken
Type: string

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

BadRequestException:

Returns information about an error.

UnauthorizedException:

Returns information about an error.

InternalServerErrorException:

Returns information about an error.

ForbiddenException:

Returns information about an error.

NotFoundException:

Returns information about an error.

ServiceUnavailableException:

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

Members
MaxResults
Type: int
NextToken
Type: string

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

ServiceUnavailableException:

Returns information about an error.

BadRequestException:

Returns information about an error.

UnauthorizedException:

Returns information about an error.

InternalServerErrorException:

Returns information about an error.

ForbiddenException:

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

Members
MaxResults
Type: int
NextToken
Type: string

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

BadRequestException:

Returns information about an error.

UnauthorizedException:

Returns information about an error.

InternalServerErrorException:

Returns information about an error.

ForbiddenException:

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

Members
ClusterArn
Required: Yes
Type: string
MaxResults
Type: int
NextToken
Type: string

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>', ...],
            ],
            'ControllerNodeInfo' => [
                '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

NotFoundException:

Returns information about an error.

BadRequestException:

Returns information about an error.

InternalServerErrorException:

Returns information about an error.

ForbiddenException:

Returns information about an error.

ListReplicators 

$result = $client->listReplicators([/* ... */]);
$promise = $client->listReplicatorsAsync([/* ... */]);

Lists the replicators.

Parameter Syntax

$result = $client->listReplicators([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ReplicatorNameFilter' => '<string>',
]);

Parameter Details

Members
MaxResults
Type: int
NextToken
Type: string
ReplicatorNameFilter
Type: string

Result Syntax

[
    'NextToken' => '<string>',
    'Replicators' => [
        [
            'CreationTime' => <DateTime>,
            'CurrentVersion' => '<string>',
            'IsReplicatorReference' => true || false,
            'KafkaClustersSummary' => [
                [
                    'AmazonMskCluster' => [
                        'MskClusterArn' => '<string>',
                    ],
                    'KafkaClusterAlias' => '<string>',
                ],
                // ...
            ],
            'ReplicationInfoSummaryList' => [
                [
                    'SourceKafkaClusterAlias' => '<string>',
                    'TargetKafkaClusterAlias' => '<string>',
                ],
                // ...
            ],
            'ReplicatorArn' => '<string>',
            'ReplicatorName' => '<string>',
            'ReplicatorResourceArn' => '<string>',
            'ReplicatorState' => 'RUNNING|CREATING|UPDATING|DELETING|FAILED',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: 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
Type: Array of ReplicatorSummary structures

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

Errors

BadRequestException:

Returns information about an error.

UnauthorizedException:

Returns information about an error.

InternalServerErrorException:

Returns information about an error.

ForbiddenException:

Returns information about an error.

NotFoundException:

Returns information about an error.

ServiceUnavailableException:

Returns information about an error.

TooManyRequestsException:

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

Members
ClusterArn
Required: Yes
Type: string
MaxResults
Type: int
NextToken
Type: string

Result Syntax

[
    'NextToken' => '<string>',
    'SecretArnList' => ['<string>', ...],
]

Result Details

Members
NextToken
Type: string

Paginated results marker.

SecretArnList
Type: Array of strings

The list of scram secrets associated with the cluster.

Errors

BadRequestException:

Returns information about an error.

UnauthorizedException:

Returns information about an error.

InternalServerErrorException:

Returns information about an error.

ForbiddenException:

Returns information about an error.

NotFoundException:

Returns information about an error.

ServiceUnavailableException:

Returns information about an error.

TooManyRequestsException:

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

Members
ResourceArn
Required: Yes
Type: string

Result Syntax

[
    'Tags' => ['<string>', ...],
]

Result Details

Members
Tags
Type: Associative array of custom strings keys (__string) to strings

The key-value pair for the resource tag.

Errors

NotFoundException:

Returns information about an error.

BadRequestException:

Returns information about an error.

InternalServerErrorException:

Returns information about an error.

ListVpcConnections 

$result = $client->listVpcConnections([/* ... */]);
$promise = $client->listVpcConnectionsAsync([/* ... */]);

Displays a list of Amazon MSK VPC connections.

Parameter Syntax

$result = $client->listVpcConnections([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
MaxResults
Type: int
NextToken
Type: string

Result Syntax

[
    'NextToken' => '<string>',
    'VpcConnections' => [
        [
            'Authentication' => '<string>',
            'CreationTime' => <DateTime>,
            'State' => 'CREATING|AVAILABLE|INACTIVE|DEACTIVATING|DELETING|FAILED|REJECTED|REJECTING',
            'TargetClusterArn' => '<string>',
            'VpcConnectionArn' => '<string>',
            'VpcId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string

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

VpcConnections
Type: Array of VpcConnection structures

List containing a VpcConnection object.

Errors

ServiceUnavailableException:

Returns information about an error.

BadRequestException:

Returns information about an error.

UnauthorizedException:

Returns information about an error.

InternalServerErrorException:

Returns information about an error.

ForbiddenException:

Returns information about an error.

PutClusterPolicy 

$result = $client->putClusterPolicy([/* ... */]);
$promise = $client->putClusterPolicyAsync([/* ... */]);

Creates or updates the specified MSK cluster policy. If updating the policy, the currentVersion field is required in the request payload.

Parameter Syntax

$result = $client->putClusterPolicy([
    'ClusterArn' => '<string>', // REQUIRED
    'CurrentVersion' => '<string>',
    'Policy' => '<string>', // REQUIRED
]);

Parameter Details

Members
ClusterArn
Required: Yes
Type: string
CurrentVersion
Type: string
Policy
Required: Yes
Type: string

Result Syntax

[
    'CurrentVersion' => '<string>',
]

Result Details

Members
CurrentVersion
Type: string

Cluster policy version.

Errors

NotFoundException:

Returns information about an error.

BadRequestException:

Returns information about an error.

UnauthorizedException:

Returns information about an error.

InternalServerErrorException:

Returns information about an error.

ForbiddenException:

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
BrokerIds
Required: Yes
Type: Array of strings

The list of broker ids to be rebooted.

ClusterArn
Required: Yes
Type: string

Result Syntax

[
    'ClusterArn' => '<string>',
    'ClusterOperationArn' => '<string>',
]

Result Details

Members
ClusterArn
Type: string

The Amazon Resource Name (ARN) of the cluster.

ClusterOperationArn
Type: string

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

Errors

BadRequestException:

Returns information about an error.

UnauthorizedException:

Returns information about an error.

InternalServerErrorException:

Returns information about an error.

ForbiddenException:

Returns information about an error.

NotFoundException:

Returns information about an error.

ServiceUnavailableException:

Returns information about an error.

TooManyRequestsException:

Returns information about an error.

RejectClientVpcConnection 

$result = $client->rejectClientVpcConnection([/* ... */]);
$promise = $client->rejectClientVpcConnectionAsync([/* ... */]);

Parameter Syntax

$result = $client->rejectClientVpcConnection([
    'ClusterArn' => '<string>', // REQUIRED
    'VpcConnectionArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
ClusterArn
Required: Yes
Type: string
VpcConnectionArn
Required: Yes
Type: string

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ServiceUnavailableException:

Returns information about an error.

BadRequestException:

Returns information about an error.

UnauthorizedException:

Returns information about an error.

InternalServerErrorException:

Returns information about an error.

ForbiddenException:

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
ResourceArn
Required: Yes
Type: string
Tags
Required: Yes
Type: Associative array of custom strings keys (__string) to strings

The key-value pair for the resource tag.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

NotFoundException:

Returns information about an error.

BadRequestException:

Returns information about an error.

InternalServerErrorException:

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

Members
ResourceArn
Required: Yes
Type: string
TagKeys
Required: Yes
Type: Array of strings

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

NotFoundException:

Returns information about an error.

BadRequestException:

Returns information about an error.

InternalServerErrorException:

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
ClusterArn
Required: Yes
Type: string
CurrentVersion
Required: Yes
Type: string

The current version of the cluster.

TargetNumberOfBrokerNodes
Required: Yes
Type: int

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

Result Syntax

[
    'ClusterArn' => '<string>',
    'ClusterOperationArn' => '<string>',
]

Result Details

Members
ClusterArn
Type: string

The Amazon Resource Name (ARN) of the cluster.

ClusterOperationArn
Type: string

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

Errors

ServiceUnavailableException:

Returns information about an error.

BadRequestException:

Returns information about an error.

UnauthorizedException:

Returns information about an error.

InternalServerErrorException:

Returns information about an error.

ForbiddenException:

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
ClusterArn
Type: string

The Amazon Resource Name (ARN) of the cluster.

ClusterOperationArn
Type: string

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

Errors

ServiceUnavailableException:

Returns information about an error.

BadRequestException:

Returns information about an error.

UnauthorizedException:

Returns information about an error.

InternalServerErrorException:

Returns information about an error.

ForbiddenException:

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
ClusterArn
Required: Yes
Type: string
CurrentVersion
Required: Yes
Type: string

The current version of the cluster.

TargetInstanceType
Required: Yes
Type: string

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

Result Syntax

[
    'ClusterArn' => '<string>',
    'ClusterOperationArn' => '<string>',
]

Result Details

Members
ClusterArn
Type: string

The Amazon Resource Name (ARN) of the cluster.

ClusterOperationArn
Type: string

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

Errors

BadRequestException:

Returns information about an error.

ForbiddenException:

Returns information about an error.

InternalServerErrorException:

Returns information about an error.

NotFoundException:

Returns information about an error.

ServiceUnavailableException:

Returns information about an error.

UnauthorizedException:

Returns information about an error.

TooManyRequestsException:

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
ClusterArn
Type: string

The Amazon Resource Name (ARN) of the cluster.

ClusterOperationArn
Type: string

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

Errors

BadRequestException:

Returns information about an error.

UnauthorizedException:

Returns information about an error.

InternalServerErrorException:

Returns information about an error.

ForbiddenException:

Returns information about an error.

NotFoundException:

Returns information about an error.

ServiceUnavailableException:

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
ClusterArn
Type: string

The Amazon Resource Name (ARN) of the cluster.

ClusterOperationArn
Type: string

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

Errors

BadRequestException:

Returns information about an error.

UnauthorizedException:

Returns information about an error.

InternalServerErrorException:

Returns information about an error.

ForbiddenException:

Returns information about an error.

NotFoundException:

Returns information about an error.

ServiceUnavailableException:

Returns information about an error.

TooManyRequestsException:

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
Arn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the configuration.

Description
Type: string

The description of the configuration.

ServerProperties
Required: Yes
Type: blob (string|resource|Psr\Http\Message\StreamInterface)

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

ServiceUnavailableException:

Returns information about an error.

BadRequestException:

Returns information about an error.

UnauthorizedException:

Returns information about an error.

InternalServerErrorException:

Returns information about an error.

ForbiddenException:

Returns information about an error.

UpdateConnectivity 

$result = $client->updateConnectivity([/* ... */]);
$promise = $client->updateConnectivityAsync([/* ... */]);

Updates the connectivity configuration for the MSK cluster.

Parameter Syntax

$result = $client->updateConnectivity([
    'ClusterArn' => '<string>', // REQUIRED
    'ConnectivityInfo' => [ // REQUIRED
        'PublicAccess' => [
            'Type' => '<string>',
        ],
        'VpcConnectivity' => [
            'ClientAuthentication' => [
                'Sasl' => [
                    'Iam' => [
                        'Enabled' => true || false,
                    ],
                    'Scram' => [
                        'Enabled' => true || false,
                    ],
                ],
                'Tls' => [
                    'Enabled' => true || false,
                ],
            ],
        ],
    ],
    '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
ClusterArn
Type: string

The Amazon Resource Name (ARN) of the cluster.

ClusterOperationArn
Type: string

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

Errors

BadRequestException:

Returns information about an error.

UnauthorizedException:

Returns information about an error.

InternalServerErrorException:

Returns information about an error.

ForbiddenException:

Returns information about an error.

NotFoundException:

Returns information about an error.

ServiceUnavailableException:

Returns information about an error.

TooManyRequestsException:

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
ClusterArn
Type: string

The Amazon Resource Name (ARN) of the cluster.

ClusterOperationArn
Type: string

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

Errors

ServiceUnavailableException:

Returns information about an error.

BadRequestException:

Returns information about an error.

UnauthorizedException:

Returns information about an error.

InternalServerErrorException:

Returns information about an error.

ForbiddenException:

Returns information about an error.

UpdateReplicationInfo 

$result = $client->updateReplicationInfo([/* ... */]);
$promise = $client->updateReplicationInfoAsync([/* ... */]);

Updates replication info of a replicator.

Parameter Syntax

$result = $client->updateReplicationInfo([
    'ConsumerGroupReplication' => [
        'ConsumerGroupsToExclude' => ['<string>', ...], // REQUIRED
        'ConsumerGroupsToReplicate' => ['<string>', ...], // REQUIRED
        'DetectAndCopyNewConsumerGroups' => true || false, // REQUIRED
        'SynchroniseConsumerGroupOffsets' => true || false, // REQUIRED
    ],
    'CurrentVersion' => '<string>', // REQUIRED
    'ReplicatorArn' => '<string>', // REQUIRED
    'SourceKafkaClusterArn' => '<string>', // REQUIRED
    'TargetKafkaClusterArn' => '<string>', // REQUIRED
    'TopicReplication' => [
        'CopyAccessControlListsForTopics' => true || false, // REQUIRED
        'CopyTopicConfigurations' => true || false, // REQUIRED
        'DetectAndCopyNewTopics' => true || false, // REQUIRED
        'TopicsToExclude' => ['<string>', ...], // REQUIRED
        'TopicsToReplicate' => ['<string>', ...], // REQUIRED
    ],
]);

Parameter Details

Members
ConsumerGroupReplication
Type: ConsumerGroupReplicationUpdate structure

Updated consumer group replication information.

CurrentVersion
Required: Yes
Type: string

Current replicator version.

ReplicatorArn
Required: Yes
Type: string
SourceKafkaClusterArn
Required: Yes
Type: string

The ARN of the source Kafka cluster.

TargetKafkaClusterArn
Required: Yes
Type: string

The ARN of the target Kafka cluster.

TopicReplication
Type: TopicReplicationUpdate structure

Updated topic replication information.

Result Syntax

[
    'ReplicatorArn' => '<string>',
    'ReplicatorState' => 'RUNNING|CREATING|UPDATING|DELETING|FAILED',
]

Result Details

Members
ReplicatorArn
Type: string

The Amazon Resource Name (ARN) of the replicator.

ReplicatorState
Type: string

State of the replicator.

Errors

BadRequestException:

Returns information about an error.

UnauthorizedException:

Returns information about an error.

InternalServerErrorException:

Returns information about an error.

ForbiddenException:

Returns information about an error.

NotFoundException:

Returns information about an error.

ServiceUnavailableException:

Returns information about an error.

TooManyRequestsException:

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
ClusterArn
Type: string

The Amazon Resource Name (ARN) of the cluster.

ClusterOperationArn
Type: string

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

Errors

BadRequestException:

Returns information about an error.

UnauthorizedException:

Returns information about an error.

InternalServerErrorException:

Returns information about an error.

ForbiddenException:

Returns information about an error.

NotFoundException:

Returns information about an error.

ServiceUnavailableException:

Returns information about an error.

TooManyRequestsException:

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
ClusterArn
Type: string

The Amazon Resource Name (ARN) of the cluster.

ClusterOperationArn
Type: string

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

Errors

BadRequestException:

Returns information about an error.

UnauthorizedException:

Returns information about an error.

InternalServerErrorException:

Returns information about an error.

ForbiddenException:

Returns information about an error.

NotFoundException:

Returns information about an error.

ServiceUnavailableException:

Returns information about an error.

TooManyRequestsException:

Returns information about an error.

Shapes

AmazonMskCluster

Description

Details of an Amazon MSK Cluster.

Members
MskClusterArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of an Amazon MSK cluster.

BadRequestException

Description

Returns information about an error.

Members
InvalidParameter
Type: string
Message
Type: string

BrokerCountUpdateInfo

Description

Describes brokers being changed during a broker count update.

Members
CreatedBrokerIds
Type: Array of doubles

List of Broker Ids when creating new Brokers in a cluster.

DeletedBrokerIds
Type: Array of doubles

List of Broker Ids when deleting existing Brokers in a cluster.

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.

ZoneIds
Type: Array of strings

The zoneIds for the cluster.

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.

ClientVpcConnection

Description

The client VPC connection object.

Members
Authentication
Type: string

The VPC connection authentication type.

CreationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The creation time of the VPC connection.

Owner
Type: string

The owner of the VPC connection.

State
Type: string

The state of a configuration.

VpcConnectionArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the VPC connection.

CloudWatchLogs

Description

Details of the CloudWatch Logs destination for broker logs.

Members
Enabled
Required: Yes
Type: boolean

Specifies whether broker logs get sent to the specified CloudWatch Logs destination.

LogGroup
Type: string

The CloudWatch log group that is the destination for broker logs.

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.

CustomerActionStatus
Type: string

Determines if there is an action required from the customer.

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.

VpcConnectionInfo
Type: VpcConnectionInfo structure

Description of the VPC connection for CreateVpcConnection and DeleteVpcConnection operations.

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
StepStatus
Type: string

The steps current status.

ClusterOperationV2

Description

Returns information about a cluster operation.

Members
ClusterArn
Type: string
ClusterType
Type: string
EndTime
Type: timestamp (string|DateTime or anything parsable by strtotime)
OperationArn
Type: string
OperationState
Type: string
OperationType
Type: string
Provisioned
Type: ClusterOperationV2Provisioned structure

Properties of a provisioned cluster.

Serverless
Type: ClusterOperationV2Serverless structure

Properties of a serverless cluster.

StartTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

ClusterOperationV2Provisioned

Description

Returns information about a provisioned cluster operation.

Members
OperationSteps
Type: Array of ClusterOperationStep structures
SourceClusterInfo
Type: MutableClusterInfo structure

Information about cluster attributes that can be updated via update APIs.

TargetClusterInfo
Type: MutableClusterInfo structure

Information about cluster attributes that can be updated via update APIs.

VpcConnectionInfo
Type: VpcConnectionInfo structure

Description of the VPC connection for CreateVpcConnection and DeleteVpcConnection operations.

ClusterOperationV2Serverless

Description

Returns information about a serverless cluster operation.

Members
VpcConnectionInfo
Type: VpcConnectionInfoServerless structure

Description of the VPC connection for CreateVpcConnection and DeleteVpcConnection operations.

ClusterOperationV2Summary

Description

Returns information about a cluster operation.

Members
ClusterArn
Type: string
ClusterType
Type: string
EndTime
Type: timestamp (string|DateTime or anything parsable by strtotime)
OperationArn
Type: string
OperationState
Type: string
OperationType
Type: string
StartTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

CompatibleKafkaVersion

Description

Contains source Apache Kafka versions and compatible target Apache Kafka versions.

Members
SourceVersion
Type: string
TargetVersions
Type: Array of strings

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)

The time when the configuration was created.

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
Arn
Required: Yes
Type: string

ARN of the configuration to use.

Revision
Required: Yes
Type: long (int|float)

The revision of the configuration to use.

ConfigurationRevision

Description

Describes a configuration revision.

Members
CreationTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time when the configuration revision was created.

Description
Type: string

The description of the configuration revision.

Revision
Required: Yes
Type: long (int|float)

The revision number.

ConflictException

Description

Returns information about an error.

Members
InvalidParameter
Type: string
Message
Type: string

ConnectivityInfo

Description

Information about the broker access configuration.

Members
PublicAccess
Type: PublicAccess structure

Public access control for brokers.

VpcConnectivity
Type: VpcConnectivity structure

VpcConnectivity control for brokers.

ConsumerGroupReplication

Description

Details about consumer group replication.

Members
ConsumerGroupsToExclude
Type: Array of strings

List of regular expression patterns indicating the consumer groups that should not be replicated.

ConsumerGroupsToReplicate
Required: Yes
Type: Array of strings

List of regular expression patterns indicating the consumer groups to copy.

DetectAndCopyNewConsumerGroups
Type: boolean

Enables synchronization of consumer groups to target cluster.

SynchroniseConsumerGroupOffsets
Type: boolean

Enables synchronization of consumer group offsets to target cluster. The translated offsets will be written to topic __consumer_offsets.

ConsumerGroupReplicationUpdate

Description

Details about consumer group replication.

Members
ConsumerGroupsToExclude
Required: Yes
Type: Array of strings

List of regular expression patterns indicating the consumer groups that should not be replicated.

ConsumerGroupsToReplicate
Required: Yes
Type: Array of strings

List of regular expression patterns indicating the consumer groups to copy.

DetectAndCopyNewConsumerGroups
Required: Yes
Type: boolean

Enables synchronization of consumer groups to target cluster.

SynchroniseConsumerGroupOffsets
Required: Yes
Type: boolean

Enables synchronization of consumer group offsets to target cluster. The translated offsets will be written to topic __consumer_offsets.

ControllerNodeInfo

Description

Controller node information.

Members
Endpoints
Type: Array of strings

Endpoints for accessing the Controller.

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
DataVolumeKMSKeyId
Required: Yes
Type: string

The ARN of the AWS KMS key for encrypting data at rest. If you don't specify a KMS key, MSK creates one for you and uses it.

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
InvalidParameter
Type: string

The parameter that caused the error.

Message
Type: string

The description of the error.

ErrorInfo

Description

Returns information about an error state of the cluster.

Members
ErrorCode
Type: string

A number describing the error programmatically.

ErrorString
Type: string

An optional field to provide more details about the error.

Firehose

Description

Firehose details for BrokerLogs.

Members
DeliveryStream
Type: string

The Kinesis Data Firehose delivery stream that is the destination for broker logs.

Enabled
Required: Yes
Type: boolean

Specifies whether broker logs get sent to the specified Kinesis Data Firehose delivery stream.

ForbiddenException

Description

Returns information about an error.

Members
InvalidParameter
Type: string
Message
Type: string

Iam

Members
Enabled
Type: boolean

InternalServerErrorException

Description

Returns information about an error.

Members
InvalidParameter
Type: string
Message
Type: string

JmxExporter

Description

Indicates whether you want to enable or disable the JMX Exporter.

Members
EnabledInBroker
Required: Yes
Type: boolean

Indicates whether you want to enable or disable the JMX Exporter.

JmxExporterInfo

Description

Indicates whether you want to enable or disable the JMX Exporter.

Members
EnabledInBroker
Required: Yes
Type: boolean

JMX Exporter being enabled in broker.

KafkaCluster

Description

Information about Kafka Cluster to be used as source / target for replication.

Members
AmazonMskCluster
Required: Yes
Type: AmazonMskCluster structure

Details of an Amazon MSK Cluster.

VpcConfig
Required: Yes
Type: KafkaClusterClientVpcConfig structure
Details of an Amazon VPC which has network connectivity to the Apache Kafka cluster.

KafkaClusterClientVpcConfig

Members
SecurityGroupIds
Type: Array of strings

The security groups to attach to the ENIs for the broker nodes.

SubnetIds
Required: Yes
Type: Array of strings

The list of subnets in the client VPC to connect to.

KafkaClusterDescription

Description

Information about Kafka Cluster used as source / target for replication.

Members
AmazonMskCluster
Type: AmazonMskCluster structure

Details of an Amazon MSK Cluster.

KafkaClusterAlias
Type: string

The alias of the Kafka cluster. Used to prefix names of replicated topics.

VpcConfig
Type: KafkaClusterClientVpcConfig structure
Details of an Amazon VPC which has network connectivity to the Apache Kafka cluster.

KafkaClusterSummary

Description

Summarized information about Kafka Cluster used as source / target for replication.

Members
AmazonMskCluster
Type: AmazonMskCluster structure

Details of an Amazon MSK Cluster

.
KafkaClusterAlias
Type: string

The alias of the Kafka cluster. Used to prefix names of replicated topics.

KafkaVersion

Description

Information about a Apache Kafka version.

Members
Status
Type: string

The status of the Apache Kafka version.

Version
Type: string

The Apache Kafka version.

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
BrokerCountUpdateInfo
Type: BrokerCountUpdateInfo structure

Describes brokers being changed during a broker count update.

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

The Apache Kafka version.

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
EnabledInBroker
Required: Yes
Type: boolean

Indicates whether you want to enable or disable the Node Exporter.

NodeExporterInfo

Description

Indicates whether you want to enable or disable the Node Exporter.

Members
EnabledInBroker
Required: Yes
Type: boolean

Node Exporter being enabled in broker.

NodeInfo

Description

The node information object.

Members
AddedToClusterTime
Type: string

The start time.

BrokerNodeInfo
Type: BrokerNodeInfo structure

The broker node info.

ControllerNodeInfo
Type: ControllerNodeInfo structure

The ControllerNodeInfo.

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
InvalidParameter
Type: string
Message
Type: string

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.

CustomerActionStatus
Type: string

Determines if there is an action required from the customer.

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
Enabled
Type: boolean

Provisioned throughput is enabled or not.

VolumeThroughput
Type: int

Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second.

PublicAccess

Description

Broker public access control.

Members
Type
Type: string

The value DISABLED indicates that public access is disabled. SERVICE_PROVIDED_EIPS indicates that public access is enabled.

ReplicationInfo

Description

Specifies configuration for replication between a source and target Kafka cluster.

Members
ConsumerGroupReplication
Required: Yes
Type: ConsumerGroupReplication structure

Configuration relating to consumer group replication.

SourceKafkaClusterArn
Required: Yes
Type: string

The ARN of the source Kafka cluster.

TargetCompressionType
Required: Yes
Type: string

The compression type to use when producing records to target cluster.

TargetKafkaClusterArn
Required: Yes
Type: string

The ARN of the target Kafka cluster.

TopicReplication
Required: Yes
Type: TopicReplication structure

Configuration relating to topic replication.

ReplicationInfoDescription

Description

Specifies configuration for replication between a source and target Kafka cluster (sourceKafkaClusterAlias -> targetKafkaClusterAlias)

Members
ConsumerGroupReplication
Type: ConsumerGroupReplication structure

Configuration relating to consumer group replication

.
SourceKafkaClusterAlias
Type: string

The alias of the source Kafka cluster.

TargetCompressionType
Type: string

The compression type to use when producing records to target cluster.

TargetKafkaClusterAlias
Type: string

The alias of the target Kafka cluster.

TopicReplication
Type: TopicReplication structure

Configuration relating to topic replication.

ReplicationInfoSummary

Description

Summarized information of replication between clusters.

Members
SourceKafkaClusterAlias
Type: string

The alias of the source Kafka cluster.

TargetKafkaClusterAlias
Type: string

The alias of the target Kafka cluster.

ReplicationStartingPosition

Description

Configuration for specifying the position in the topics to start replicating from.

Members
Type
Type: string

The type of replication starting position.

ReplicationStateInfo

Description
Details about the state of a replicator
Members
Code
Type: string

Code that describes the current state of the replicator.

Message
Type: string

Message that describes the state of the replicator.

ReplicatorSummary

Description

Information about a replicator.

Members
CreationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the replicator was created.

CurrentVersion
Type: string

The current version of the replicator.

IsReplicatorReference
Type: boolean

Whether this resource is a replicator reference.

KafkaClustersSummary
Type: Array of KafkaClusterSummary structures

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

ReplicationInfoSummaryList
Type: Array of ReplicationInfoSummary structures

A list of summarized information of replications between clusters.

ReplicatorArn
Type: string

The Amazon Resource Name (ARN) of the replicator.

ReplicatorName
Type: string

The name of the replicator.

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

ReplicatorState
Type: string

State of the replicator.

S3

Description

The details of the Amazon S3 destination for broker logs.

Members
Bucket
Type: string

The name of the S3 bucket that is the destination for broker logs.

Enabled
Required: Yes
Type: boolean

Specifies whether broker logs get sent to the specified Amazon S3 destination.

Prefix
Type: string

The S3 prefix that is the destination for broker logs.

Sasl

Members
Iam
Type: Iam structure
Scram
Type: Scram structure

Scram

Members
Enabled
Type: boolean

SASL/SCRAM authentication is enabled or not.

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

Description

Describes the serverless cluster SASL information.

Members
Iam
Type: Iam structure

ServiceUnavailableException

Description

Returns information about an error.

Members
InvalidParameter
Type: string
Message
Type: string

StateInfo

Description

Contains information about the state of the Amazon MSK cluster.

Members
Code
Type: string

If the cluster is in an unusable state, this field contains the code that describes the issue.

Message
Type: string

If the cluster is in an unusable state, this field contains a message that describes the issue.

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
CertificateAuthorityArnList
Type: Array of strings

List of ACM Certificate Authority ARNs.

Enabled
Type: boolean

TLS authentication is enabled or not.

TooManyRequestsException

Description

Returns information about an error.

Members
InvalidParameter
Type: string
Message
Type: string

TopicReplication

Description

Details about topic replication.

Members
CopyAccessControlListsForTopics
Type: boolean

Whether to periodically configure remote topic ACLs to match their corresponding upstream topics.

CopyTopicConfigurations
Type: boolean

Whether to periodically configure remote topics to match their corresponding upstream topics.

DetectAndCopyNewTopics
Type: boolean

Whether to periodically check for new topics and partitions.

StartingPosition
Type: ReplicationStartingPosition structure

Configuration for specifying the position in the topics to start replicating from.

TopicsToExclude
Type: Array of strings

List of regular expression patterns indicating the topics that should not be replicated.

TopicsToReplicate
Required: Yes
Type: Array of strings

List of regular expression patterns indicating the topics to copy.

TopicReplicationUpdate

Description

Details for updating the topic replication of a replicator.

Members
CopyAccessControlListsForTopics
Required: Yes
Type: boolean

Whether to periodically configure remote topic ACLs to match their corresponding upstream topics.

CopyTopicConfigurations
Required: Yes
Type: boolean

Whether to periodically configure remote topics to match their corresponding upstream topics.

DetectAndCopyNewTopics
Required: Yes
Type: boolean

Whether to periodically check for new topics and partitions.

TopicsToExclude
Required: Yes
Type: Array of strings

List of regular expression patterns indicating the topics that should not be replicated.

TopicsToReplicate
Required: Yes
Type: Array of strings

List of regular expression patterns indicating the topics to copy.

Unauthenticated

Description

Contains information about unauthenticated traffic to the cluster.

Members
Enabled
Type: boolean

Specifies whether you want to enable or disable unauthenticated traffic to your cluster.

UnauthorizedException

Description

Returns information about an error.

Members
InvalidParameter
Type: string
Message
Type: string

UnprocessedScramSecret

Members
ErrorCode
Type: string
ErrorMessage
Type: string
SecretArn
Type: string

UserIdentity

Description

Description of the requester that calls the API operation.

Members
PrincipalId
Type: string
Type
Type: string

The identity type of the requester that calls the API operation.

VpcConfig

Description

The configuration of the Amazon VPCs for the cluster.

Members
SecurityGroupIds
Type: Array of strings
SubnetIds
Required: Yes
Type: Array of strings

VpcConnection

Description

The VPC connection object.

Members
Authentication
Type: string

The authentication type for the VPC connection.

CreationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The creation time of the VPC connection.

State
Type: string

The state of a configuration.

TargetClusterArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the cluster.

VpcConnectionArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the VPC connection.

VpcId
Type: string

The VPC ID of the VPC connection.

VpcConnectionInfo

Description

Description of the VPC connection for CreateVpcConnection and DeleteVpcConnection operations.

Members
CreationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)
Owner
Type: string
UserIdentity
Type: UserIdentity structure

Description of the requester that calls the API operation.

VpcConnectionArn
Type: string

VpcConnectionInfoServerless

Description

Description of the VPC connection for CreateVpcConnection and DeleteVpcConnection operations.

Members
CreationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)
Owner
Type: string
UserIdentity
Type: UserIdentity structure

Description of the requester that calls the API operation.

VpcConnectionArn
Type: string

VpcConnectivityIam

Members
Enabled
Type: boolean

VpcConnectivityScram

Members
Enabled
Type: boolean

SASL/SCRAM authentication for VPC connectivity is on or off.

VpcConnectivityTls

Members
Enabled
Type: boolean

TLS authentication for VPC connectivity is on or off.

ZookeeperNodeInfo

Description

Zookeeper node information.

Members
AttachedENIId
Type: string

The attached elastic network interface of the zookeeper.

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.