Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

Kafka

import { Kafka } from "https://aws-api.deno.dev/v0.3/services/kafka.ts?docs=full";
class Kafka {
constructor(apiFactory: client.ApiFactory);
async batchAssociateScramSecret(params: BatchAssociateScramSecretRequest, opts?: client.RequestOptions): Promise<BatchAssociateScramSecretResponse>;
async batchDisassociateScramSecret(params: BatchDisassociateScramSecretRequest, opts?: client.RequestOptions): Promise<BatchDisassociateScramSecretResponse>;
async createCluster(params: CreateClusterRequest, opts?: client.RequestOptions): Promise<CreateClusterResponse>;
async createClusterV2(params: CreateClusterV2Request, opts?: client.RequestOptions): Promise<CreateClusterV2Response>;
async createConfiguration(params: CreateConfigurationRequest, opts?: client.RequestOptions): Promise<CreateConfigurationResponse>;
async deleteCluster(params: DeleteClusterRequest, opts?: client.RequestOptions): Promise<DeleteClusterResponse>;
async deleteConfiguration(params: DeleteConfigurationRequest, opts?: client.RequestOptions): Promise<DeleteConfigurationResponse>;
async describeCluster(params: DescribeClusterRequest, opts?: client.RequestOptions): Promise<DescribeClusterResponse>;
async describeClusterOperation(params: DescribeClusterOperationRequest, opts?: client.RequestOptions): Promise<DescribeClusterOperationResponse>;
async describeClusterV2(params: DescribeClusterV2Request, opts?: client.RequestOptions): Promise<DescribeClusterV2Response>;
async describeConfiguration(params: DescribeConfigurationRequest, opts?: client.RequestOptions): Promise<DescribeConfigurationResponse>;
async describeConfigurationRevision(params: DescribeConfigurationRevisionRequest, opts?: client.RequestOptions): Promise<DescribeConfigurationRevisionResponse>;
async getBootstrapBrokers(params: GetBootstrapBrokersRequest, opts?: client.RequestOptions): Promise<GetBootstrapBrokersResponse>;
async getCompatibleKafkaVersions(params?: GetCompatibleKafkaVersionsRequest, opts?: client.RequestOptions): Promise<GetCompatibleKafkaVersionsResponse>;
async listClusterOperations(params: ListClusterOperationsRequest, opts?: client.RequestOptions): Promise<ListClusterOperationsResponse>;
async listClusters(params?: ListClustersRequest, opts?: client.RequestOptions): Promise<ListClustersResponse>;
async listClustersV2(params?: ListClustersV2Request, opts?: client.RequestOptions): Promise<ListClustersV2Response>;
async listConfigurationRevisions(params: ListConfigurationRevisionsRequest, opts?: client.RequestOptions): Promise<ListConfigurationRevisionsResponse>;
async listConfigurations(params?: ListConfigurationsRequest, opts?: client.RequestOptions): Promise<ListConfigurationsResponse>;
async listKafkaVersions(params?: ListKafkaVersionsRequest, opts?: client.RequestOptions): Promise<ListKafkaVersionsResponse>;
async listNodes(params: ListNodesRequest, opts?: client.RequestOptions): Promise<ListNodesResponse>;
async listScramSecrets(params: ListScramSecretsRequest, opts?: client.RequestOptions): Promise<ListScramSecretsResponse>;
async listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>;
async rebootBroker(params: RebootBrokerRequest, opts?: client.RequestOptions): Promise<RebootBrokerResponse>;
async tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>;
async untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>;
async updateBrokerCount(params: UpdateBrokerCountRequest, opts?: client.RequestOptions): Promise<UpdateBrokerCountResponse>;
async updateBrokerStorage(params: UpdateBrokerStorageRequest, opts?: client.RequestOptions): Promise<UpdateBrokerStorageResponse>;
async updateBrokerType(params: UpdateBrokerTypeRequest, opts?: client.RequestOptions): Promise<UpdateBrokerTypeResponse>;
async updateClusterConfiguration(params: UpdateClusterConfigurationRequest, opts?: client.RequestOptions): Promise<UpdateClusterConfigurationResponse>;
async updateClusterKafkaVersion(params: UpdateClusterKafkaVersionRequest, opts?: client.RequestOptions): Promise<UpdateClusterKafkaVersionResponse>;
async updateConfiguration(params: UpdateConfigurationRequest, opts?: client.RequestOptions): Promise<UpdateConfigurationResponse>;
async updateConnectivity(params: UpdateConnectivityRequest, opts?: client.RequestOptions): Promise<UpdateConnectivityResponse>;
async updateMonitoring(params: UpdateMonitoringRequest, opts?: client.RequestOptions): Promise<UpdateMonitoringResponse>;
async updateSecurity(params: UpdateSecurityRequest, opts?: client.RequestOptions): Promise<UpdateSecurityResponse>;
 
static ApiMetadata: client.ApiMetadata;
}

§Constructors

§
new Kafka(apiFactory: client.ApiFactory)
[src]

§Methods

§
batchAssociateScramSecret(params: BatchAssociateScramSecretRequest, opts?: client.RequestOptions): Promise<BatchAssociateScramSecretResponse>
[src]

Associates one or more Scram Secrets with an Amazon MSK cluster.

§
batchDisassociateScramSecret(params: BatchDisassociateScramSecretRequest, opts?: client.RequestOptions): Promise<BatchDisassociateScramSecretResponse>
[src]

Disassociates one or more Scram Secrets from an Amazon MSK cluster.

§
createCluster(params: CreateClusterRequest, opts?: client.RequestOptions): Promise<CreateClusterResponse>
[src]

Creates a new MSK cluster.

§
createClusterV2(params: CreateClusterV2Request, opts?: client.RequestOptions): Promise<CreateClusterV2Response>
[src]

Creates a new MSK cluster.

§
createConfiguration(params: CreateConfigurationRequest, opts?: client.RequestOptions): Promise<CreateConfigurationResponse>
[src]

Creates a new MSK configuration.

§
deleteCluster(params: DeleteClusterRequest, opts?: client.RequestOptions): Promise<DeleteClusterResponse>
[src]

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

§
deleteConfiguration(params: DeleteConfigurationRequest, opts?: client.RequestOptions): Promise<DeleteConfigurationResponse>
[src]

Deletes an MSK Configuration.

§
describeCluster(params: DescribeClusterRequest, opts?: client.RequestOptions): Promise<DescribeClusterResponse>
[src]

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

§
describeClusterOperation(params: DescribeClusterOperationRequest, opts?: client.RequestOptions): Promise<DescribeClusterOperationResponse>
[src]

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

§
describeClusterV2(params: DescribeClusterV2Request, opts?: client.RequestOptions): Promise<DescribeClusterV2Response>
[src]

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

§
describeConfiguration(params: DescribeConfigurationRequest, opts?: client.RequestOptions): Promise<DescribeConfigurationResponse>
[src]

Returns a description of this MSK configuration.

§
describeConfigurationRevision(params: DescribeConfigurationRevisionRequest, opts?: client.RequestOptions): Promise<DescribeConfigurationRevisionResponse>
[src]

Returns a description of this revision of the configuration.

§
getBootstrapBrokers(params: GetBootstrapBrokersRequest, opts?: client.RequestOptions): Promise<GetBootstrapBrokersResponse>
[src]

A list of brokers that a client application can use to bootstrap.

§
getCompatibleKafkaVersions(params?: GetCompatibleKafkaVersionsRequest, opts?: client.RequestOptions): Promise<GetCompatibleKafkaVersionsResponse>
[src]

Gets the Apache Kafka versions to which you can update the MSK cluster.

§
listClusterOperations(params: ListClusterOperationsRequest, opts?: client.RequestOptions): Promise<ListClusterOperationsResponse>
[src]

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

§
listClusters(params?: ListClustersRequest, opts?: client.RequestOptions): Promise<ListClustersResponse>
[src]

Returns a list of all the MSK clusters in the current Region.

§
listClustersV2(params?: ListClustersV2Request, opts?: client.RequestOptions): Promise<ListClustersV2Response>
[src]

Returns a list of all the MSK clusters in the current Region.

§
listConfigurationRevisions(params: ListConfigurationRevisionsRequest, opts?: client.RequestOptions): Promise<ListConfigurationRevisionsResponse>
[src]

Returns a list of all the MSK configurations in this Region.

§
listConfigurations(params?: ListConfigurationsRequest, opts?: client.RequestOptions): Promise<ListConfigurationsResponse>
[src]

Returns a list of all the MSK configurations in this Region.

§
listKafkaVersions(params?: ListKafkaVersionsRequest, opts?: client.RequestOptions): Promise<ListKafkaVersionsResponse>
[src]

Returns a list of Apache Kafka versions.

§
listNodes(params: ListNodesRequest, opts?: client.RequestOptions): Promise<ListNodesResponse>
[src]

Returns a list of the broker nodes in the cluster.

§
listScramSecrets(params: ListScramSecretsRequest, opts?: client.RequestOptions): Promise<ListScramSecretsResponse>
[src]

Returns a list of the Scram Secrets associated with an Amazon MSK cluster.

§
listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>
[src]

Returns a list of the tags associated with the specified resource.

§
rebootBroker(params: RebootBrokerRequest, opts?: client.RequestOptions): Promise<RebootBrokerResponse>
[src]

Reboots brokers.

§
tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>
[src]

Adds tags to the specified MSK resource.

§
untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>
[src]

Removes the tags associated with the keys that are provided in the query.

§
updateBrokerCount(params: UpdateBrokerCountRequest, opts?: client.RequestOptions): Promise<UpdateBrokerCountResponse>
[src]

Updates the number of broker nodes in the cluster.

§
updateBrokerStorage(params: UpdateBrokerStorageRequest, opts?: client.RequestOptions): Promise<UpdateBrokerStorageResponse>
[src]

Updates the EBS storage associated with MSK brokers.

§
updateBrokerType(params: UpdateBrokerTypeRequest, opts?: client.RequestOptions): Promise<UpdateBrokerTypeResponse>
[src]

Updates EC2 instance type.

§
updateClusterConfiguration(params: UpdateClusterConfigurationRequest, opts?: client.RequestOptions): Promise<UpdateClusterConfigurationResponse>
[src]

Updates the cluster with the configuration that is specified in the request body.

§
updateClusterKafkaVersion(params: UpdateClusterKafkaVersionRequest, opts?: client.RequestOptions): Promise<UpdateClusterKafkaVersionResponse>
[src]

Updates the Apache Kafka version for the cluster.

§
updateConfiguration(params: UpdateConfigurationRequest, opts?: client.RequestOptions): Promise<UpdateConfigurationResponse>
[src]

Updates an MSK configuration.

§
updateConnectivity(params: UpdateConnectivityRequest, opts?: client.RequestOptions): Promise<UpdateConnectivityResponse>
[src]

Updates the cluster's connectivity configuration.

§
updateMonitoring(params: UpdateMonitoringRequest, opts?: client.RequestOptions): Promise<UpdateMonitoringResponse>
[src]

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.

§
updateSecurity(params: UpdateSecurityRequest, opts?: client.RequestOptions): Promise<UpdateSecurityResponse>
[src]

Updates the security settings for the cluster. You can use this operation to specify encryption and authentication on existing clusters.

§Static Properties