cdk-amazon-chime-resources
Version:
1,616 lines (1,371 loc) • 83 kB
TypeScript
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class Kafka extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: Kafka.Types.ClientConfiguration)
config: Config & Kafka.Types.ClientConfiguration;
/**
*
Associates one or more Scram Secrets with an Amazon MSK cluster.
*/
batchAssociateScramSecret(params: Kafka.Types.BatchAssociateScramSecretRequest, callback?: (err: AWSError, data: Kafka.Types.BatchAssociateScramSecretResponse) => void): Request<Kafka.Types.BatchAssociateScramSecretResponse, AWSError>;
/**
*
Associates one or more Scram Secrets with an Amazon MSK cluster.
*/
batchAssociateScramSecret(callback?: (err: AWSError, data: Kafka.Types.BatchAssociateScramSecretResponse) => void): Request<Kafka.Types.BatchAssociateScramSecretResponse, AWSError>;
/**
*
Creates a new MSK cluster.
*/
createCluster(params: Kafka.Types.CreateClusterRequest, callback?: (err: AWSError, data: Kafka.Types.CreateClusterResponse) => void): Request<Kafka.Types.CreateClusterResponse, AWSError>;
/**
*
Creates a new MSK cluster.
*/
createCluster(callback?: (err: AWSError, data: Kafka.Types.CreateClusterResponse) => void): Request<Kafka.Types.CreateClusterResponse, AWSError>;
/**
*
Creates a new MSK cluster.
*/
createClusterV2(params: Kafka.Types.CreateClusterV2Request, callback?: (err: AWSError, data: Kafka.Types.CreateClusterV2Response) => void): Request<Kafka.Types.CreateClusterV2Response, AWSError>;
/**
*
Creates a new MSK cluster.
*/
createClusterV2(callback?: (err: AWSError, data: Kafka.Types.CreateClusterV2Response) => void): Request<Kafka.Types.CreateClusterV2Response, AWSError>;
/**
*
Creates a new MSK configuration.
*/
createConfiguration(params: Kafka.Types.CreateConfigurationRequest, callback?: (err: AWSError, data: Kafka.Types.CreateConfigurationResponse) => void): Request<Kafka.Types.CreateConfigurationResponse, AWSError>;
/**
*
Creates a new MSK configuration.
*/
createConfiguration(callback?: (err: AWSError, data: Kafka.Types.CreateConfigurationResponse) => void): Request<Kafka.Types.CreateConfigurationResponse, AWSError>;
/**
*
Deletes the MSK cluster specified by the Amazon Resource Name (ARN) in the request.
*/
deleteCluster(params: Kafka.Types.DeleteClusterRequest, callback?: (err: AWSError, data: Kafka.Types.DeleteClusterResponse) => void): Request<Kafka.Types.DeleteClusterResponse, AWSError>;
/**
*
Deletes the MSK cluster specified by the Amazon Resource Name (ARN) in the request.
*/
deleteCluster(callback?: (err: AWSError, data: Kafka.Types.DeleteClusterResponse) => void): Request<Kafka.Types.DeleteClusterResponse, AWSError>;
/**
*
Deletes an MSK Configuration.
*/
deleteConfiguration(params: Kafka.Types.DeleteConfigurationRequest, callback?: (err: AWSError, data: Kafka.Types.DeleteConfigurationResponse) => void): Request<Kafka.Types.DeleteConfigurationResponse, AWSError>;
/**
*
Deletes an MSK Configuration.
*/
deleteConfiguration(callback?: (err: AWSError, data: Kafka.Types.DeleteConfigurationResponse) => void): Request<Kafka.Types.DeleteConfigurationResponse, AWSError>;
/**
*
Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request.
*/
describeCluster(params: Kafka.Types.DescribeClusterRequest, callback?: (err: AWSError, data: Kafka.Types.DescribeClusterResponse) => void): Request<Kafka.Types.DescribeClusterResponse, AWSError>;
/**
*
Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request.
*/
describeCluster(callback?: (err: AWSError, data: Kafka.Types.DescribeClusterResponse) => void): Request<Kafka.Types.DescribeClusterResponse, AWSError>;
/**
*
Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request.
*/
describeClusterV2(params: Kafka.Types.DescribeClusterV2Request, callback?: (err: AWSError, data: Kafka.Types.DescribeClusterV2Response) => void): Request<Kafka.Types.DescribeClusterV2Response, AWSError>;
/**
*
Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request.
*/
describeClusterV2(callback?: (err: AWSError, data: Kafka.Types.DescribeClusterV2Response) => void): Request<Kafka.Types.DescribeClusterV2Response, AWSError>;
/**
*
Returns a description of the cluster operation specified by the ARN.
*/
describeClusterOperation(params: Kafka.Types.DescribeClusterOperationRequest, callback?: (err: AWSError, data: Kafka.Types.DescribeClusterOperationResponse) => void): Request<Kafka.Types.DescribeClusterOperationResponse, AWSError>;
/**
*
Returns a description of the cluster operation specified by the ARN.
*/
describeClusterOperation(callback?: (err: AWSError, data: Kafka.Types.DescribeClusterOperationResponse) => void): Request<Kafka.Types.DescribeClusterOperationResponse, AWSError>;
/**
*
Returns a description of this MSK configuration.
*/
describeConfiguration(params: Kafka.Types.DescribeConfigurationRequest, callback?: (err: AWSError, data: Kafka.Types.DescribeConfigurationResponse) => void): Request<Kafka.Types.DescribeConfigurationResponse, AWSError>;
/**
*
Returns a description of this MSK configuration.
*/
describeConfiguration(callback?: (err: AWSError, data: Kafka.Types.DescribeConfigurationResponse) => void): Request<Kafka.Types.DescribeConfigurationResponse, AWSError>;
/**
*
Returns a description of this revision of the configuration.
*/
describeConfigurationRevision(params: Kafka.Types.DescribeConfigurationRevisionRequest, callback?: (err: AWSError, data: Kafka.Types.DescribeConfigurationRevisionResponse) => void): Request<Kafka.Types.DescribeConfigurationRevisionResponse, AWSError>;
/**
*
Returns a description of this revision of the configuration.
*/
describeConfigurationRevision(callback?: (err: AWSError, data: Kafka.Types.DescribeConfigurationRevisionResponse) => void): Request<Kafka.Types.DescribeConfigurationRevisionResponse, AWSError>;
/**
*
Disassociates one or more Scram Secrets from an Amazon MSK cluster.
*/
batchDisassociateScramSecret(params: Kafka.Types.BatchDisassociateScramSecretRequest, callback?: (err: AWSError, data: Kafka.Types.BatchDisassociateScramSecretResponse) => void): Request<Kafka.Types.BatchDisassociateScramSecretResponse, AWSError>;
/**
*
Disassociates one or more Scram Secrets from an Amazon MSK cluster.
*/
batchDisassociateScramSecret(callback?: (err: AWSError, data: Kafka.Types.BatchDisassociateScramSecretResponse) => void): Request<Kafka.Types.BatchDisassociateScramSecretResponse, AWSError>;
/**
*
A list of brokers that a client application can use to bootstrap.
*/
getBootstrapBrokers(params: Kafka.Types.GetBootstrapBrokersRequest, callback?: (err: AWSError, data: Kafka.Types.GetBootstrapBrokersResponse) => void): Request<Kafka.Types.GetBootstrapBrokersResponse, AWSError>;
/**
*
A list of brokers that a client application can use to bootstrap.
*/
getBootstrapBrokers(callback?: (err: AWSError, data: Kafka.Types.GetBootstrapBrokersResponse) => void): Request<Kafka.Types.GetBootstrapBrokersResponse, AWSError>;
/**
*
Gets the Apache Kafka versions to which you can update the MSK cluster.
*/
getCompatibleKafkaVersions(params: Kafka.Types.GetCompatibleKafkaVersionsRequest, callback?: (err: AWSError, data: Kafka.Types.GetCompatibleKafkaVersionsResponse) => void): Request<Kafka.Types.GetCompatibleKafkaVersionsResponse, AWSError>;
/**
*
Gets the Apache Kafka versions to which you can update the MSK cluster.
*/
getCompatibleKafkaVersions(callback?: (err: AWSError, data: Kafka.Types.GetCompatibleKafkaVersionsResponse) => void): Request<Kafka.Types.GetCompatibleKafkaVersionsResponse, AWSError>;
/**
*
Returns a list of all the operations that have been performed on the specified MSK cluster.
*/
listClusterOperations(params: Kafka.Types.ListClusterOperationsRequest, callback?: (err: AWSError, data: Kafka.Types.ListClusterOperationsResponse) => void): Request<Kafka.Types.ListClusterOperationsResponse, AWSError>;
/**
*
Returns a list of all the operations that have been performed on the specified MSK cluster.
*/
listClusterOperations(callback?: (err: AWSError, data: Kafka.Types.ListClusterOperationsResponse) => void): Request<Kafka.Types.ListClusterOperationsResponse, AWSError>;
/**
*
Returns a list of all the MSK clusters in the current Region.
*/
listClusters(params: Kafka.Types.ListClustersRequest, callback?: (err: AWSError, data: Kafka.Types.ListClustersResponse) => void): Request<Kafka.Types.ListClustersResponse, AWSError>;
/**
*
Returns a list of all the MSK clusters in the current Region.
*/
listClusters(callback?: (err: AWSError, data: Kafka.Types.ListClustersResponse) => void): Request<Kafka.Types.ListClustersResponse, AWSError>;
/**
*
Returns a list of all the MSK clusters in the current Region.
*/
listClustersV2(params: Kafka.Types.ListClustersV2Request, callback?: (err: AWSError, data: Kafka.Types.ListClustersV2Response) => void): Request<Kafka.Types.ListClustersV2Response, AWSError>;
/**
*
Returns a list of all the MSK clusters in the current Region.
*/
listClustersV2(callback?: (err: AWSError, data: Kafka.Types.ListClustersV2Response) => void): Request<Kafka.Types.ListClustersV2Response, AWSError>;
/**
*
Returns a list of all the MSK configurations in this Region.
*/
listConfigurationRevisions(params: Kafka.Types.ListConfigurationRevisionsRequest, callback?: (err: AWSError, data: Kafka.Types.ListConfigurationRevisionsResponse) => void): Request<Kafka.Types.ListConfigurationRevisionsResponse, AWSError>;
/**
*
Returns a list of all the MSK configurations in this Region.
*/
listConfigurationRevisions(callback?: (err: AWSError, data: Kafka.Types.ListConfigurationRevisionsResponse) => void): Request<Kafka.Types.ListConfigurationRevisionsResponse, AWSError>;
/**
*
Returns a list of all the MSK configurations in this Region.
*/
listConfigurations(params: Kafka.Types.ListConfigurationsRequest, callback?: (err: AWSError, data: Kafka.Types.ListConfigurationsResponse) => void): Request<Kafka.Types.ListConfigurationsResponse, AWSError>;
/**
*
Returns a list of all the MSK configurations in this Region.
*/
listConfigurations(callback?: (err: AWSError, data: Kafka.Types.ListConfigurationsResponse) => void): Request<Kafka.Types.ListConfigurationsResponse, AWSError>;
/**
*
Returns a list of Apache Kafka versions.
*/
listKafkaVersions(params: Kafka.Types.ListKafkaVersionsRequest, callback?: (err: AWSError, data: Kafka.Types.ListKafkaVersionsResponse) => void): Request<Kafka.Types.ListKafkaVersionsResponse, AWSError>;
/**
*
Returns a list of Apache Kafka versions.
*/
listKafkaVersions(callback?: (err: AWSError, data: Kafka.Types.ListKafkaVersionsResponse) => void): Request<Kafka.Types.ListKafkaVersionsResponse, AWSError>;
/**
*
Returns a list of the broker nodes in the cluster.
*/
listNodes(params: Kafka.Types.ListNodesRequest, callback?: (err: AWSError, data: Kafka.Types.ListNodesResponse) => void): Request<Kafka.Types.ListNodesResponse, AWSError>;
/**
*
Returns a list of the broker nodes in the cluster.
*/
listNodes(callback?: (err: AWSError, data: Kafka.Types.ListNodesResponse) => void): Request<Kafka.Types.ListNodesResponse, AWSError>;
/**
*
Returns a list of the Scram Secrets associated with an Amazon MSK cluster.
*/
listScramSecrets(params: Kafka.Types.ListScramSecretsRequest, callback?: (err: AWSError, data: Kafka.Types.ListScramSecretsResponse) => void): Request<Kafka.Types.ListScramSecretsResponse, AWSError>;
/**
*
Returns a list of the Scram Secrets associated with an Amazon MSK cluster.
*/
listScramSecrets(callback?: (err: AWSError, data: Kafka.Types.ListScramSecretsResponse) => void): Request<Kafka.Types.ListScramSecretsResponse, AWSError>;
/**
*
Returns a list of the tags associated with the specified resource.
*/
listTagsForResource(params: Kafka.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: Kafka.Types.ListTagsForResourceResponse) => void): Request<Kafka.Types.ListTagsForResourceResponse, AWSError>;
/**
*
Returns a list of the tags associated with the specified resource.
*/
listTagsForResource(callback?: (err: AWSError, data: Kafka.Types.ListTagsForResourceResponse) => void): Request<Kafka.Types.ListTagsForResourceResponse, AWSError>;
/**
* Reboots brokers.
*/
rebootBroker(params: Kafka.Types.RebootBrokerRequest, callback?: (err: AWSError, data: Kafka.Types.RebootBrokerResponse) => void): Request<Kafka.Types.RebootBrokerResponse, AWSError>;
/**
* Reboots brokers.
*/
rebootBroker(callback?: (err: AWSError, data: Kafka.Types.RebootBrokerResponse) => void): Request<Kafka.Types.RebootBrokerResponse, AWSError>;
/**
*
Adds tags to the specified MSK resource.
*/
tagResource(params: Kafka.Types.TagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
*
Adds tags to the specified MSK resource.
*/
tagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
*
Removes the tags associated with the keys that are provided in the query.
*/
untagResource(params: Kafka.Types.UntagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
*
Removes the tags associated with the keys that are provided in the query.
*/
untagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
*
Updates the number of broker nodes in the cluster.
*/
updateBrokerCount(params: Kafka.Types.UpdateBrokerCountRequest, callback?: (err: AWSError, data: Kafka.Types.UpdateBrokerCountResponse) => void): Request<Kafka.Types.UpdateBrokerCountResponse, AWSError>;
/**
*
Updates the number of broker nodes in the cluster.
*/
updateBrokerCount(callback?: (err: AWSError, data: Kafka.Types.UpdateBrokerCountResponse) => void): Request<Kafka.Types.UpdateBrokerCountResponse, AWSError>;
/**
*
Updates EC2 instance type.
*/
updateBrokerType(params: Kafka.Types.UpdateBrokerTypeRequest, callback?: (err: AWSError, data: Kafka.Types.UpdateBrokerTypeResponse) => void): Request<Kafka.Types.UpdateBrokerTypeResponse, AWSError>;
/**
*
Updates EC2 instance type.
*/
updateBrokerType(callback?: (err: AWSError, data: Kafka.Types.UpdateBrokerTypeResponse) => void): Request<Kafka.Types.UpdateBrokerTypeResponse, AWSError>;
/**
*
Updates the EBS storage associated with MSK brokers.
*/
updateBrokerStorage(params: Kafka.Types.UpdateBrokerStorageRequest, callback?: (err: AWSError, data: Kafka.Types.UpdateBrokerStorageResponse) => void): Request<Kafka.Types.UpdateBrokerStorageResponse, AWSError>;
/**
*
Updates the EBS storage associated with MSK brokers.
*/
updateBrokerStorage(callback?: (err: AWSError, data: Kafka.Types.UpdateBrokerStorageResponse) => void): Request<Kafka.Types.UpdateBrokerStorageResponse, AWSError>;
/**
*
Updates an MSK configuration.
*/
updateConfiguration(params: Kafka.Types.UpdateConfigurationRequest, callback?: (err: AWSError, data: Kafka.Types.UpdateConfigurationResponse) => void): Request<Kafka.Types.UpdateConfigurationResponse, AWSError>;
/**
*
Updates an MSK configuration.
*/
updateConfiguration(callback?: (err: AWSError, data: Kafka.Types.UpdateConfigurationResponse) => void): Request<Kafka.Types.UpdateConfigurationResponse, AWSError>;
/**
*
Updates the cluster's connectivity configuration.
*/
updateConnectivity(params: Kafka.Types.UpdateConnectivityRequest, callback?: (err: AWSError, data: Kafka.Types.UpdateConnectivityResponse) => void): Request<Kafka.Types.UpdateConnectivityResponse, AWSError>;
/**
*
Updates the cluster's connectivity configuration.
*/
updateConnectivity(callback?: (err: AWSError, data: Kafka.Types.UpdateConnectivityResponse) => void): Request<Kafka.Types.UpdateConnectivityResponse, AWSError>;
/**
*
Updates the cluster with the configuration that is specified in the request body.
*/
updateClusterConfiguration(params: Kafka.Types.UpdateClusterConfigurationRequest, callback?: (err: AWSError, data: Kafka.Types.UpdateClusterConfigurationResponse) => void): Request<Kafka.Types.UpdateClusterConfigurationResponse, AWSError>;
/**
*
Updates the cluster with the configuration that is specified in the request body.
*/
updateClusterConfiguration(callback?: (err: AWSError, data: Kafka.Types.UpdateClusterConfigurationResponse) => void): Request<Kafka.Types.UpdateClusterConfigurationResponse, AWSError>;
/**
*
Updates the Apache Kafka version for the cluster.
*/
updateClusterKafkaVersion(params: Kafka.Types.UpdateClusterKafkaVersionRequest, callback?: (err: AWSError, data: Kafka.Types.UpdateClusterKafkaVersionResponse) => void): Request<Kafka.Types.UpdateClusterKafkaVersionResponse, AWSError>;
/**
*
Updates the Apache Kafka version for the cluster.
*/
updateClusterKafkaVersion(callback?: (err: AWSError, data: Kafka.Types.UpdateClusterKafkaVersionResponse) => void): Request<Kafka.Types.UpdateClusterKafkaVersionResponse, AWSError>;
/**
*
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.
*/
updateMonitoring(params: Kafka.Types.UpdateMonitoringRequest, callback?: (err: AWSError, data: Kafka.Types.UpdateMonitoringResponse) => void): Request<Kafka.Types.UpdateMonitoringResponse, AWSError>;
/**
*
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.
*/
updateMonitoring(callback?: (err: AWSError, data: Kafka.Types.UpdateMonitoringResponse) => void): Request<Kafka.Types.UpdateMonitoringResponse, AWSError>;
/**
*
Updates the security settings for the cluster. You can use this operation to specify encryption and authentication on existing clusters.
*/
updateSecurity(params: Kafka.Types.UpdateSecurityRequest, callback?: (err: AWSError, data: Kafka.Types.UpdateSecurityResponse) => void): Request<Kafka.Types.UpdateSecurityResponse, AWSError>;
/**
*
Updates the security settings for the cluster. You can use this operation to specify encryption and authentication on existing clusters.
*/
updateSecurity(callback?: (err: AWSError, data: Kafka.Types.UpdateSecurityResponse) => void): Request<Kafka.Types.UpdateSecurityResponse, AWSError>;
/**
* Updates cluster broker volume size (or) sets cluster storage mode to TIERED.
*/
updateStorage(params: Kafka.Types.UpdateStorageRequest, callback?: (err: AWSError, data: Kafka.Types.UpdateStorageResponse) => void): Request<Kafka.Types.UpdateStorageResponse, AWSError>;
/**
* Updates cluster broker volume size (or) sets cluster storage mode to TIERED.
*/
updateStorage(callback?: (err: AWSError, data: Kafka.Types.UpdateStorageResponse) => void): Request<Kafka.Types.UpdateStorageResponse, AWSError>;
}
declare namespace Kafka {
export interface BatchAssociateScramSecretRequest {
/**
*
The Amazon Resource Name (ARN) of the cluster to be updated.
*/
ClusterArn: __string;
/**
*
List of AWS Secrets Manager secret ARNs.
*/
SecretArnList: __listOf__string;
}
export interface BatchAssociateScramSecretResponse {
/**
*
The Amazon Resource Name (ARN) of the cluster.
*/
ClusterArn?: __string;
/**
*
List of errors when associating secrets to cluster.
*/
UnprocessedScramSecrets?: __listOfUnprocessedScramSecret;
}
export type BrokerAZDistribution = "DEFAULT"|string;
export interface BrokerEBSVolumeInfo {
/**
*
The ID of the broker to update.
*/
KafkaBrokerNodeId: __string;
/**
*
EBS volume provisioned throughput information.
*/
ProvisionedThroughput?: ProvisionedThroughput;
/**
*
Size of the EBS volume to update.
*/
VolumeSizeGB?: __integer;
}
export interface BrokerLogs {
CloudWatchLogs?: CloudWatchLogs;
Firehose?: Firehose;
S3?: S3;
}
export interface BrokerNodeGroupInfo {
/**
*
The distribution of broker nodes across Availability Zones. This is an optional parameter. If you don't specify it, Amazon MSK gives it the value DEFAULT. You can also explicitly set this parameter to the value DEFAULT. No other values are currently allowed.
Amazon MSK distributes the broker nodes evenly across the Availability Zones that correspond to the subnets you provide when you create the cluster.
*/
BrokerAZDistribution?: BrokerAZDistribution;
/**
*
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.
*/
ClientSubnets: __listOf__string;
/**
*
The type of Amazon EC2 instances to use for Apache Kafka brokers. The following instance types are allowed: kafka.m5.large, kafka.m5.xlarge, kafka.m5.2xlarge,
kafka.m5.4xlarge, kafka.m5.12xlarge, and kafka.m5.24xlarge.
*/
InstanceType: __stringMin5Max32;
/**
*
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.
*/
SecurityGroups?: __listOf__string;
/**
*
Contains information about storage volumes attached to MSK broker nodes.
*/
StorageInfo?: StorageInfo;
/**
*
Information about the broker access configuration.
*/
ConnectivityInfo?: ConnectivityInfo;
}
export interface BrokerNodeInfo {
/**
*
The attached elastic network interface of the broker.
*/
AttachedENIId?: __string;
/**
*
The ID of the broker.
*/
BrokerId?: __double;
/**
*
The client subnet to which this broker node belongs.
*/
ClientSubnet?: __string;
/**
*
The virtual private cloud (VPC) of the client.
*/
ClientVpcIpAddress?: __string;
/**
*
Information about the version of software currently deployed on the Apache Kafka brokers in the cluster.
*/
CurrentBrokerSoftwareInfo?: BrokerSoftwareInfo;
/**
*
Endpoints for accessing the broker.
*/
Endpoints?: __listOf__string;
}
export interface BrokerSoftwareInfo {
/**
*
The Amazon Resource Name (ARN) of the configuration used for the cluster. This field isn't visible in this preview release.
*/
ConfigurationArn?: __string;
/**
*
The revision of the configuration to use. This field isn't visible in this preview release.
*/
ConfigurationRevision?: __long;
/**
*
The version of Apache Kafka.
*/
KafkaVersion?: __string;
}
export interface ClientAuthentication {
/**
*
Details for ClientAuthentication using SASL.
*/
Sasl?: Sasl;
/**
*
Details for ClientAuthentication using TLS.
*/
Tls?: Tls;
/**
*
Contains information about unauthenticated traffic to the cluster.
*/
Unauthenticated?: Unauthenticated;
}
export interface ServerlessClientAuthentication {
/**
*
Details for ClientAuthentication using SASL.
*/
Sasl?: ServerlessSasl;
}
export type ClientBroker = "TLS"|"TLS_PLAINTEXT"|"PLAINTEXT"|string;
export interface CloudWatchLogs {
Enabled: __boolean;
LogGroup?: __string;
}
export interface ClusterInfo {
/**
*
Arn of active cluster operation.
*/
ActiveOperationArn?: __string;
/**
*
Information about the broker nodes.
*/
BrokerNodeGroupInfo?: BrokerNodeGroupInfo;
/**
*
Includes all client authentication information.
*/
ClientAuthentication?: ClientAuthentication;
/**
*
The Amazon Resource Name (ARN) that uniquely identifies the cluster.
*/
ClusterArn?: __string;
/**
*
The name of the cluster.
*/
ClusterName?: __string;
/**
*
The time when the cluster was created.
*/
CreationTime?: __timestampIso8601;
/**
*
Information about the version of software currently deployed on the Apache Kafka brokers in the cluster.
*/
CurrentBrokerSoftwareInfo?: BrokerSoftwareInfo;
/**
*
The current version of the MSK cluster.
*/
CurrentVersion?: __string;
/**
*
Includes all encryption-related information.
*/
EncryptionInfo?: EncryptionInfo;
/**
*
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.
*/
EnhancedMonitoring?: EnhancedMonitoring;
/**
*
Settings for open monitoring using Prometheus.
*/
OpenMonitoring?: OpenMonitoring;
LoggingInfo?: LoggingInfo;
/**
*
The number of broker nodes in the cluster.
*/
NumberOfBrokerNodes?: __integer;
/**
*
The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.
*/
State?: ClusterState;
StateInfo?: StateInfo;
/**
*
Tags attached to the cluster.
*/
Tags?: __mapOf__string;
/**
*
The connection string to use to connect to the Apache ZooKeeper cluster.
*/
ZookeeperConnectString?: __string;
/**
*
The connection string to use to connect to zookeeper cluster on Tls port.
*/
ZookeeperConnectStringTls?: __string;
/**
*
This controls storage mode for supported storage tiers.
*/
StorageMode?: StorageMode;
}
export interface Cluster {
/**
*
The Amazon Resource Name (ARN) that uniquely identifies a cluster operation.
*/
ActiveOperationArn?: __string;
/**
*
Cluster Type.
*/
ClusterType?: ClusterType;
/**
*
The Amazon Resource Name (ARN) that uniquely identifies the cluster.
*/
ClusterArn?: __string;
/**
*
The name of the cluster.
*/
ClusterName?: __string;
/**
*
The time when the cluster was created.
*/
CreationTime?: __timestampIso8601;
/**
*
The current version of the MSK cluster.
*/
CurrentVersion?: __string;
/**
*
The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.
*/
State?: ClusterState;
/**
*
State Info for the Amazon MSK cluster.
*/
StateInfo?: StateInfo;
/**
*
Tags attached to the cluster.
*/
Tags?: __mapOf__string;
/**
*
Information about the provisioned cluster.
*/
Provisioned?: Provisioned;
/**
*
Information about the serverless cluster.
*/
Serverless?: Serverless;
}
export interface ClusterOperationInfo {
/**
*
The ID of the API request that triggered this operation.
*/
ClientRequestId?: __string;
/**
*
ARN of the cluster.
*/
ClusterArn?: __string;
/**
*
The time that the operation was created.
*/
CreationTime?: __timestampIso8601;
/**
*
The time at which the operation finished.
*/
EndTime?: __timestampIso8601;
/**
*
Describes the error if the operation fails.
*/
ErrorInfo?: ErrorInfo;
/**
*
ARN of the cluster operation.
*/
OperationArn?: __string;
/**
*
State of the cluster operation.
*/
OperationState?: __string;
/**
*
Steps completed during the operation.
*/
OperationSteps?: __listOfClusterOperationStep;
/**
*
Type of the cluster operation.
*/
OperationType?: __string;
/**
*
Information about cluster attributes before a cluster is updated.
*/
SourceClusterInfo?: MutableClusterInfo;
/**
*
Information about cluster attributes after a cluster is updated.
*/
TargetClusterInfo?: MutableClusterInfo;
}
export interface ClusterOperationStep {
/**
*
Information about the step and its status.
*/
StepInfo?: ClusterOperationStepInfo;
/**
*
The name of the step.
*/
StepName?: __string;
}
export interface ClusterOperationStepInfo {
/**
*
The steps current status.
*/
StepStatus?: __string;
}
export type ClusterState = "ACTIVE"|"CREATING"|"DELETING"|"FAILED"|"HEALING"|"MAINTENANCE"|"REBOOTING_BROKER"|"UPDATING"|string;
export type ClusterType = "PROVISIONED"|"SERVERLESS"|string;
export interface ProvisionedRequest {
/**
*
Information about the brokers.
*/
BrokerNodeGroupInfo: BrokerNodeGroupInfo;
/**
*
Includes all client authentication information.
*/
ClientAuthentication?: ClientAuthentication;
/**
*
Represents the configuration that you want Amazon MSK to use for the brokers in a cluster.
*/
ConfigurationInfo?: ConfigurationInfo;
/**
*
Includes all encryption-related information.
*/
EncryptionInfo?: EncryptionInfo;
/**
*
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.
*/
EnhancedMonitoring?: EnhancedMonitoring;
/**
*
The settings for open monitoring.
*/
OpenMonitoring?: OpenMonitoringInfo;
/**
*
The Apache Kafka version that you want for the cluster.
*/
KafkaVersion: __stringMin1Max128;
/**
*
Log delivery information for the cluster.
*/
LoggingInfo?: LoggingInfo;
/**
*
The number of broker nodes in the cluster.
*/
NumberOfBrokerNodes: __integerMin1Max15;
/**
*
This controls storage mode for supported storage tiers.
*/
StorageMode?: StorageMode;
}
export interface Provisioned {
/**
*
Information about the brokers.
*/
BrokerNodeGroupInfo: BrokerNodeGroupInfo;
/**
*
Information about the Apache Kafka version deployed on the brokers.
*/
CurrentBrokerSoftwareInfo?: BrokerSoftwareInfo;
/**
*
Includes all client authentication information.
*/
ClientAuthentication?: ClientAuthentication;
/**
*
Includes all encryption-related information.
*/
EncryptionInfo?: EncryptionInfo;
/**
*
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.
*/
EnhancedMonitoring?: EnhancedMonitoring;
/**
*
The settings for open monitoring.
*/
OpenMonitoring?: OpenMonitoringInfo;
/**
*
Log delivery information for the cluster.
*/
LoggingInfo?: LoggingInfo;
/**
*
The number of broker nodes in the cluster.
*/
NumberOfBrokerNodes: __integerMin1Max15;
/**
*
The connection string to use to connect to the Apache ZooKeeper cluster.
*/
ZookeeperConnectString?: __string;
/**
*
The connection string to use to connect to the Apache ZooKeeper cluster on a TLS port.
*/
ZookeeperConnectStringTls?: __string;
/**
*
This controls storage mode for supported storage tiers.
*/
StorageMode?: StorageMode;
}
export interface VpcConfig {
/**
*
The IDs of the subnets associated with the cluster.
*/
SubnetIds: __listOf__string;
/**
*
The IDs of the security groups associated with the cluster.
*/
SecurityGroupIds?: __listOf__string;
}
export interface ServerlessRequest {
/**
*
The configuration of the Amazon VPCs for the cluster.
*/
VpcConfigs: __listOfVpcConfig;
/**
*
Includes all client authentication information.
*/
ClientAuthentication?: ServerlessClientAuthentication;
}
export interface Serverless {
/**
*
The configuration of the Amazon VPCs for the cluster.
*/
VpcConfigs: __listOfVpcConfig;
/**
*
Includes all client authentication information.
*/
ClientAuthentication?: ServerlessClientAuthentication;
}
export interface CompatibleKafkaVersion {
/**
*
An Apache Kafka version.
*/
SourceVersion?: __string;
/**
*
A list of Apache Kafka versions.
*/
TargetVersions?: __listOf__string;
}
export interface Configuration {
/**
*
The Amazon Resource Name (ARN) of the configuration.
*/
Arn: __string;
/**
*
The time when the configuration was created.
*/
CreationTime: __timestampIso8601;
/**
*
The description of the configuration.
*/
Description: __string;
/**
*
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.
*/
KafkaVersions: __listOf__string;
/**
*
Latest revision of the configuration.
*/
LatestRevision: ConfigurationRevision;
/**
*
The name of the configuration.
*/
Name: __string;
/**
*
The state of the configuration. The possible states are ACTIVE, DELETING, and DELETE_FAILED.
*/
State: ConfigurationState;
}
export interface ConfigurationInfo {
/**
*
ARN of the configuration to use.
*/
Arn: __string;
/**
*
The revision of the configuration to use.
*/
Revision: __long;
}
export interface ConfigurationRevision {
/**
*
The time when the configuration revision was created.
*/
CreationTime: __timestampIso8601;
/**
*
The description of the configuration revision.
*/
Description?: __string;
/**
*
The revision number.
*/
Revision: __long;
}
export type ConfigurationState = "ACTIVE"|"DELETING"|"DELETE_FAILED"|string;
export interface ConnectivityInfo {
/**
*
Public access control for brokers.
*/
PublicAccess?: PublicAccess;
}
export interface CreateClusterV2Request {
/**
*
The name of the cluster.
*/
ClusterName: __stringMin1Max64;
/**
*
A map of tags that you want the cluster to have.
*/
Tags?: __mapOf__string;
/**
*
Information about the provisioned cluster.
*/
Provisioned?: ProvisionedRequest;
/**
*
Information about the serverless cluster.
*/
Serverless?: ServerlessRequest;
}
export interface CreateClusterRequest {
/**
*
Information about the broker nodes in the cluster.
*/
BrokerNodeGroupInfo: BrokerNodeGroupInfo;
/**
*
Includes all client authentication related information.
*/
ClientAuthentication?: ClientAuthentication;
/**
*
The name of the cluster.
*/
ClusterName: __stringMin1Max64;
/**
*
Represents the configuration that you want MSK to use for the brokers in a cluster.
*/
ConfigurationInfo?: ConfigurationInfo;
/**
*
Includes all encryption-related information.
*/
EncryptionInfo?: EncryptionInfo;
/**
*
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.
*/
EnhancedMonitoring?: EnhancedMonitoring;
/**
*
The settings for open monitoring.
*/
OpenMonitoring?: OpenMonitoringInfo;
/**
*
The version of Apache Kafka.
*/
KafkaVersion: __stringMin1Max128;
LoggingInfo?: LoggingInfo;
/**
*
The number of broker nodes in the cluster.
*/
NumberOfBrokerNodes: __integerMin1Max15;
/**
*
Create tags when creating the cluster.
*/
Tags?: __mapOf__string;
/**
*
This controls storage mode for supported storage tiers.
*/
StorageMode?: StorageMode;
}
export interface CreateClusterResponse {
/**
*
The Amazon Resource Name (ARN) of the cluster.
*/
ClusterArn?: __string;
/**
*
The name of the MSK cluster.
*/
ClusterName?: __string;
/**
*
The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.
*/
State?: ClusterState;
}
export interface CreateClusterV2Response {
/**
*
The Amazon Resource Name (ARN) of the cluster.
*/
ClusterArn?: __string;
/**
*
The name of the MSK cluster.
*/
ClusterName?: __string;
/**
*
The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.
*/
State?: ClusterState;
/**
*
The type of the cluster. The possible states are PROVISIONED or SERVERLESS.
*/
ClusterType?: ClusterType;
}
export interface CreateConfigurationRequest {
/**
*
The description of the configuration.
*/
Description?: __string;
/**
*
The versions of Apache Kafka with which you can use this MSK configuration.
*/
KafkaVersions?: __listOf__string;
/**
*
The name of the configuration.
*/
Name: __string;
/**
*
Contents of the server.properties file. When using the API, you must ensure that the contents of the file are base64 encoded.
When using the AWS Management Console, the SDK, or the AWS CLI, the contents of server.properties can be in plaintext.
*/
ServerProperties: __blob;
}
export interface CreateConfigurationResponse {
/**
*
The Amazon Resource Name (ARN) of the configuration.
*/
Arn?: __string;
/**
*
The time when the configuration was created.
*/
CreationTime?: __timestampIso8601;
/**
*
Latest revision of the configuration.
*/
LatestRevision?: ConfigurationRevision;
/**
*
The name of the configuration.
*/
Name?: __string;
/**
*
The state of the configuration. The possible states are ACTIVE, DELETING, and DELETE_FAILED.
*/
State?: ConfigurationState;
}
export interface DeleteClusterRequest {
/**
*
The Amazon Resource Name (ARN) that uniquely identifies the cluster.
*/
ClusterArn: __string;
/**
*
The current version of the MSK cluster.
*/
CurrentVersion?: __string;
}
export interface DeleteClusterResponse {
/**
*
The Amazon Resource Name (ARN) of the cluster.
*/
ClusterArn?: __string;
/**
*
The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.
*/
State?: ClusterState;
}
export interface DeleteConfigurationRequest {
/**
*
The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration.
*/
Arn: __string;
}
export interface DeleteConfigurationResponse {
/**
*
The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration.
*/
Arn?: __string;
/**
*
The state of the configuration. The possible states are ACTIVE, DELETING, and DELETE_FAILED.
*/
State?: ConfigurationState;
}
export interface DescribeClusterOperationRequest {
/**
*
The Amazon Resource Name (ARN) that uniquely identifies the MSK cluster operation.
*/
ClusterOperationArn: __string;
}
export interface DescribeClusterOperationResponse {
/**
*
Cluster operation information
*/
ClusterOperationInfo?: ClusterOperationInfo;
}
export interface DescribeClusterRequest {
/**
*
The Amazon Resource Name (ARN) that uniquely identifies the cluster.
*/
ClusterArn: __string;
}
export interface DescribeClusterV2Request {
/**
*
The Amazon Resource Name (ARN) that uniquely identifies the cluster.
*/
ClusterArn: __string;
}
export interface DescribeClusterResponse {
/**
*
The cluster information.
*/
ClusterInfo?: ClusterInfo;
}
export interface DescribeClusterV2Response {
/**
*
The cluster information.
*/
ClusterInfo?: Cluster;
}
export interface DescribeConfigurationRequest {
/**
*
The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration and all of its revisions.
*/
Arn: __string;
}
export interface DescribeConfigurationResponse {
/**
*
The Amazon Resource Name (ARN) of the configuration.
*/
Arn?: __string;
/**
*
The time when the configuration was created.
*/
CreationTime?: __timestampIso8601;
/**
*
The description of the configuration.
*/
Description?: __string;
/**
*
The versions of Apache Kafka with which you can use this MSK configuration.
*/
KafkaVersions?: __listOf__string;
/**
*
Latest revision of the configuration.
*/
LatestRevision?: ConfigurationRevision;
/**
*
The name of the configuration.
*/
Name?: __string;
/**
*
The state of the configuration. The possible states are ACTIVE, DELETING, and DELETE_FAILED.
*/
State?: ConfigurationState;
}
export interface DescribeConfigurationRevisionRequest {
/**
*
The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration and all of its revisions.
*/
Arn: __string;
/**
*
A string that uniquely identifies a revision of an MSK configuration.
*/
Revision: __long;
}
export interface DescribeConfigurationRevisionResponse {
/**
*
The Amazon Resource Name (ARN) of the configuration.
*/
Arn?: __string;
/**
*
The time when the configuration was created.
*/
CreationTime?: __timestampIso8601;
/**
*
The description of the configuration.
*/
Description?: __string;
/**
*
The revision number.
*/
Revision?: __long;
/**
*
Contents of the server.properties file. When using the API, you must ensure that the contents of the file are base64 encoded.
When using the AWS Management Console, the SDK, or the AWS CLI, the contents of server.properties can be in plaintext.
*/
ServerProperties?: __blob;
}
export interface BatchDisassociateScramSecretRequest {
/**
*
The Amazon Resource Name (ARN) of the cluster to be updated.
*/
ClusterArn: __string;
/**
*
List of AWS Secrets Manager secret ARNs.
*/
SecretArnList: __listOf__string;
}
export interface BatchDisassociateScramSecretResponse {
/**
*
The Amazon Resource Name (ARN) of the cluster.
*/
ClusterArn?: __string;
/**
*
List of errors when disassociating secrets to cluster.
*/
UnprocessedScramSecrets?: __listOfUnprocessedScramSecret;
}
export interface EBSStorageInfo {
/**
*
EBS volume provisioned throughput information.
*/
ProvisionedThroughput?: ProvisionedThroughput;
/**
*
The size in GiB of the EBS volume for the data drive on each broker node.
*/
VolumeSize?: __integerMin1Max16384;
}
export interface EncryptionAtRest {
/**
*
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.
*/
DataVolumeKMSKeyId: __string;
}
export interface EncryptionInTransit {
/**
*
Indicates the encryption setting for data in transit between clients and brokers. The following are the possible values.
TLS means that c