NAME

Paws::Kafka - Perl Interface to AWS Managed Streaming for Kafka

SYNOPSIS

  use Paws;

  my $obj = Paws->service('Kafka');
  my $res = $obj->Method(
    Arg1 => $val1,
    Arg2 => [ 'V1', 'V2' ],
    # if Arg3 is an object, the HashRef will be used as arguments to the constructor
    # of the arguments type
    Arg3 => { Att1 => 'Val1' },
    # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
    # the constructor of the arguments type
    Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
  );

DESCRIPTION

The operations for managing an Amazon MSK cluster.

For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/kafka-2018-11-14

METHODS

CreateCluster

BrokerNodeGroupInfo => Paws::Kafka::BrokerNodeGroupInfo

ClusterName => Str

KafkaVersion => Str

NumberOfBrokerNodes => Int

[ClientAuthentication => Paws::Kafka::ClientAuthentication]

[ConfigurationInfo => Paws::Kafka::ConfigurationInfo]

[EncryptionInfo => Paws::Kafka::EncryptionInfo]

[EnhancedMonitoring => Str]

[OpenMonitoring => Paws::Kafka::OpenMonitoringInfo]

[Tags => Paws::Kafka::__mapOf__string]

Each argument is described in detail in: Paws::Kafka::CreateCluster

Returns: a Paws::Kafka::CreateClusterResponse instance

Creates a new MSK cluster.

CreateConfiguration

KafkaVersions => ArrayRef[Str|Undef]

Name => Str

ServerProperties => Str

[Description => Str]

Each argument is described in detail in: Paws::Kafka::CreateConfiguration

Returns: a Paws::Kafka::CreateConfigurationResponse instance

Creates a new MSK configuration.

DeleteCluster

ClusterArn => Str

[CurrentVersion => Str]

Each argument is described in detail in: Paws::Kafka::DeleteCluster

Returns: a Paws::Kafka::DeleteClusterResponse instance

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

DescribeCluster

ClusterArn => Str

Each argument is described in detail in: Paws::Kafka::DescribeCluster

Returns: a Paws::Kafka::DescribeClusterResponse instance

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

DescribeClusterOperation

ClusterOperationArn => Str

Each argument is described in detail in: Paws::Kafka::DescribeClusterOperation

Returns: a Paws::Kafka::DescribeClusterOperationResponse instance

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

DescribeConfiguration

Arn => Str

Each argument is described in detail in: Paws::Kafka::DescribeConfiguration

Returns: a Paws::Kafka::DescribeConfigurationResponse instance

Returns a description of this MSK configuration.

DescribeConfigurationRevision

Arn => Str

Revision => Int

Each argument is described in detail in: Paws::Kafka::DescribeConfigurationRevision

Returns: a Paws::Kafka::DescribeConfigurationRevisionResponse instance

Returns a description of this revision of the configuration.

GetBootstrapBrokers

ClusterArn => Str

Each argument is described in detail in: Paws::Kafka::GetBootstrapBrokers

Returns: a Paws::Kafka::GetBootstrapBrokersResponse instance

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

ListClusterOperations

ClusterArn => Str

[MaxResults => Int]

[NextToken => Str]

Each argument is described in detail in: Paws::Kafka::ListClusterOperations

Returns: a Paws::Kafka::ListClusterOperationsResponse instance

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

ListClusters

[ClusterNameFilter => Str]

[MaxResults => Int]

[NextToken => Str]

Each argument is described in detail in: Paws::Kafka::ListClusters

Returns: a Paws::Kafka::ListClustersResponse instance

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

ListConfigurationRevisions

Arn => Str

[MaxResults => Int]

[NextToken => Str]

Each argument is described in detail in: Paws::Kafka::ListConfigurationRevisions

Returns: a Paws::Kafka::ListConfigurationRevisionsResponse instance

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

ListConfigurations

[MaxResults => Int]

[NextToken => Str]

Each argument is described in detail in: Paws::Kafka::ListConfigurations

Returns: a Paws::Kafka::ListConfigurationsResponse instance

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

ListKafkaVersions

[MaxResults => Int]

[NextToken => Str]

Each argument is described in detail in: Paws::Kafka::ListKafkaVersions

Returns: a Paws::Kafka::ListKafkaVersionsResponse instance

Returns a list of Kafka versions.

ListNodes

ClusterArn => Str

[MaxResults => Int]

[NextToken => Str]

Each argument is described in detail in: Paws::Kafka::ListNodes

Returns: a Paws::Kafka::ListNodesResponse instance

Returns a list of the broker nodes in the cluster.

ListTagsForResource

ResourceArn => Str

Each argument is described in detail in: Paws::Kafka::ListTagsForResource

Returns: a Paws::Kafka::ListTagsForResourceResponse instance

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

TagResource

ResourceArn => Str

Tags => Paws::Kafka::__mapOf__string

Each argument is described in detail in: Paws::Kafka::TagResource

Returns: nothing

Adds tags to the specified MSK resource.

UntagResource

ResourceArn => Str

TagKeys => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::Kafka::UntagResource

Returns: nothing

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

UpdateBrokerCount

ClusterArn => Str

CurrentVersion => Str

TargetNumberOfBrokerNodes => Int

Each argument is described in detail in: Paws::Kafka::UpdateBrokerCount

Returns: a Paws::Kafka::UpdateBrokerCountResponse instance

Updates the number of broker nodes in the cluster.

UpdateBrokerStorage

ClusterArn => Str

CurrentVersion => Str

TargetBrokerEBSVolumeInfo => ArrayRef[Paws::Kafka::BrokerEBSVolumeInfo]

Each argument is described in detail in: Paws::Kafka::UpdateBrokerStorage

Returns: a Paws::Kafka::UpdateBrokerStorageResponse instance

Updates the EBS storage associated with MSK brokers.

UpdateClusterConfiguration

ClusterArn => Str

ConfigurationInfo => Paws::Kafka::ConfigurationInfo

CurrentVersion => Str

Each argument is described in detail in: Paws::Kafka::UpdateClusterConfiguration

Returns: a Paws::Kafka::UpdateClusterConfigurationResponse instance

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

UpdateMonitoring

ClusterArn => Str

CurrentVersion => Str

[EnhancedMonitoring => Str]

[OpenMonitoring => Paws::Kafka::OpenMonitoringInfo]

Each argument is described in detail in: Paws::Kafka::UpdateMonitoring

Returns: a Paws::Kafka::UpdateMonitoringResponse instance

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.

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results

ListAllClusterOperations(sub { },ClusterArn => Str, [MaxResults => Int, NextToken => Str])

ListAllClusterOperations(ClusterArn => Str, [MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - ClusterOperationInfoList, passing the object as the first parameter, and the string 'ClusterOperationInfoList' as the second parameter 

If not, it will return a a Paws::Kafka::ListClusterOperationsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllClusters(sub { },[ClusterNameFilter => Str, MaxResults => Int, NextToken => Str])

ListAllClusters([ClusterNameFilter => Str, MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - ClusterInfoList, passing the object as the first parameter, and the string 'ClusterInfoList' as the second parameter 

If not, it will return a a Paws::Kafka::ListClustersResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllConfigurationRevisions(sub { },Arn => Str, [MaxResults => Int, NextToken => Str])

ListAllConfigurationRevisions(Arn => Str, [MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - Revisions, passing the object as the first parameter, and the string 'Revisions' as the second parameter 

If not, it will return a a Paws::Kafka::ListConfigurationRevisionsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllConfigurations(sub { },[MaxResults => Int, NextToken => Str])

ListAllConfigurations([MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - Configurations, passing the object as the first parameter, and the string 'Configurations' as the second parameter 

If not, it will return a a Paws::Kafka::ListConfigurationsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllKafkaVersions(sub { },[MaxResults => Int, NextToken => Str])

ListAllKafkaVersions([MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - KafkaVersions, passing the object as the first parameter, and the string 'KafkaVersions' as the second parameter 

If not, it will return a a Paws::Kafka::ListKafkaVersionsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllNodes(sub { },ClusterArn => Str, [MaxResults => Int, NextToken => Str])

ListAllNodes(ClusterArn => Str, [MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - NodeInfoList, passing the object as the first parameter, and the string 'NodeInfoList' as the second parameter 

If not, it will return a a Paws::Kafka::ListNodesResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

SEE ALSO

This service class forms part of Paws

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues

cpanm Paws::SDK::Config

perl -MCPAN -e shell
install Paws::SDK::Config