libZSservicesZSamazonka-kafkaZSamazonka-kafka
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Kafka.Lens

Description

 
Synopsis

Operations

CreateConfiguration

createConfiguration_kafkaVersions :: Lens' CreateConfiguration (Maybe [Text]) Source #

The versions of Apache Kafka with which you can use this MSK configuration.

createConfiguration_description :: Lens' CreateConfiguration (Maybe Text) Source #

The description of the configuration.

createConfiguration_serverProperties :: Lens' CreateConfiguration ByteString Source #

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.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

createConfigurationResponse_state :: Lens' CreateConfigurationResponse (Maybe ConfigurationState) Source #

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

createConfigurationResponse_arn :: Lens' CreateConfigurationResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the configuration.

DescribeCluster

describeCluster_clusterArn :: Lens' DescribeCluster Text Source #

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

RebootBroker

rebootBroker_clusterArn :: Lens' RebootBroker Text Source #

The Amazon Resource Name (ARN) of the cluster to be updated.

rebootBroker_brokerIds :: Lens' RebootBroker [Text] Source #

The list of broker IDs to be rebooted. The reboot-broker operation supports rebooting one broker at a time.

rebootBrokerResponse_clusterArn :: Lens' RebootBrokerResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the cluster.

rebootBrokerResponse_clusterOperationArn :: Lens' RebootBrokerResponse (Maybe Text) Source #

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

ListConfigurationRevisions

listConfigurationRevisions_nextToken :: Lens' ListConfigurationRevisions (Maybe Text) Source #

The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. To get the next batch, provide this token in your next request.

listConfigurationRevisions_maxResults :: Lens' ListConfigurationRevisions (Maybe Natural) Source #

The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.

listConfigurationRevisions_arn :: Lens' ListConfigurationRevisions Text Source #

The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration and all of its revisions.

ListTagsForResource

listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #

The Amazon Resource Name (ARN) that uniquely identifies the resource that's associated with the tags.

ListKafkaVersions

listKafkaVersions_nextToken :: Lens' ListKafkaVersions (Maybe Text) Source #

The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. To get the next batch, provide this token in your next request.

listKafkaVersions_maxResults :: Lens' ListKafkaVersions (Maybe Natural) Source #

The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.

UpdateMonitoring

updateMonitoring_enhancedMonitoring :: Lens' UpdateMonitoring (Maybe EnhancedMonitoring) Source #

Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster.

updateMonitoring_clusterArn :: Lens' UpdateMonitoring Text Source #

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

updateMonitoring_currentVersion :: Lens' UpdateMonitoring Text Source #

The version of the MSK cluster to update. Cluster versions aren't simple numbers. You can describe an MSK cluster to find its version. When this update operation is successful, it generates a new cluster version.

updateMonitoringResponse_clusterArn :: Lens' UpdateMonitoringResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the cluster.

updateMonitoringResponse_clusterOperationArn :: Lens' UpdateMonitoringResponse (Maybe Text) Source #

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

BatchAssociateScramSecret

batchAssociateScramSecret_clusterArn :: Lens' BatchAssociateScramSecret Text Source #

The Amazon Resource Name (ARN) of the cluster to be updated.

UpdateBrokerStorage

updateBrokerStorage_clusterArn :: Lens' UpdateBrokerStorage Text Source #

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

updateBrokerStorage_targetBrokerEBSVolumeInfo :: Lens' UpdateBrokerStorage [BrokerEBSVolumeInfo] Source #

Describes the target volume size and the ID of the broker to apply the update to.

updateBrokerStorage_currentVersion :: Lens' UpdateBrokerStorage Text Source #

The version of cluster to update from. A successful operation will then generate a new version.

updateBrokerStorageResponse_clusterOperationArn :: Lens' UpdateBrokerStorageResponse (Maybe Text) Source #

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

DeleteCluster

deleteCluster_currentVersion :: Lens' DeleteCluster (Maybe Text) Source #

The current version of the MSK cluster.

deleteCluster_clusterArn :: Lens' DeleteCluster Text Source #

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

deleteClusterResponse_state :: Lens' DeleteClusterResponse (Maybe ClusterState) Source #

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

deleteClusterResponse_clusterArn :: Lens' DeleteClusterResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the cluster.

UpdateClusterConfiguration

updateClusterConfiguration_clusterArn :: Lens' UpdateClusterConfiguration Text Source #

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

updateClusterConfiguration_currentVersion :: Lens' UpdateClusterConfiguration Text Source #

The version of the cluster that needs to be updated.

updateClusterConfiguration_configurationInfo :: Lens' UpdateClusterConfiguration ConfigurationInfo Source #

Represents the configuration that you want MSK to use for the brokers in a cluster.

CreateCluster

createCluster_enhancedMonitoring :: Lens' CreateCluster (Maybe EnhancedMonitoring) Source #

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.

createCluster_configurationInfo :: Lens' CreateCluster (Maybe ConfigurationInfo) Source #

Represents the configuration that you want MSK to use for the brokers in a cluster.

createCluster_clientAuthentication :: Lens' CreateCluster (Maybe ClientAuthentication) Source #

Includes all client authentication related information.

createCluster_tags :: Lens' CreateCluster (Maybe (HashMap Text Text)) Source #

Create tags when creating the cluster.

createCluster_encryptionInfo :: Lens' CreateCluster (Maybe EncryptionInfo) Source #

Includes all encryption-related information.

createCluster_brokerNodeGroupInfo :: Lens' CreateCluster BrokerNodeGroupInfo Source #

Information about the broker nodes in the cluster.

createCluster_numberOfBrokerNodes :: Lens' CreateCluster Natural Source #

The number of broker nodes in the cluster.

createClusterResponse_state :: Lens' CreateClusterResponse (Maybe ClusterState) Source #

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

createClusterResponse_clusterArn :: Lens' CreateClusterResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the cluster.

UpdateBrokerCount

updateBrokerCount_clusterArn :: Lens' UpdateBrokerCount Text Source #

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

updateBrokerCount_currentVersion :: Lens' UpdateBrokerCount Text Source #

The version of cluster to update from. A successful operation will then generate a new version.

updateBrokerCount_targetNumberOfBrokerNodes :: Lens' UpdateBrokerCount Natural Source #

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

updateBrokerCountResponse_clusterArn :: Lens' UpdateBrokerCountResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the cluster.

updateBrokerCountResponse_clusterOperationArn :: Lens' UpdateBrokerCountResponse (Maybe Text) Source #

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

ListConfigurations

listConfigurations_nextToken :: Lens' ListConfigurations (Maybe Text) Source #

The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. To get the next batch, provide this token in your next request.

listConfigurations_maxResults :: Lens' ListConfigurations (Maybe Natural) Source #

The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.

listConfigurationsResponse_nextToken :: Lens' ListConfigurationsResponse (Maybe Text) Source #

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.

GetBootstrapBrokers

getBootstrapBrokers_clusterArn :: Lens' GetBootstrapBrokers Text Source #

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

getBootstrapBrokersResponse_bootstrapBrokerStringSaslScram :: Lens' GetBootstrapBrokersResponse (Maybe Text) Source #

A string containing one or more DNS names (or IP) and Sasl Scram port pairs.

getBootstrapBrokersResponse_bootstrapBrokerStringTls :: Lens' GetBootstrapBrokersResponse (Maybe Text) Source #

A string containing one or more DNS names (or IP) and TLS port pairs.

getBootstrapBrokersResponse_bootstrapBrokerStringSaslIam :: Lens' GetBootstrapBrokersResponse (Maybe Text) Source #

A string that contains one or more DNS names (or IP addresses) and SASL IAM port pairs.

UpdateClusterKafkaVersion

updateClusterKafkaVersion_configurationInfo :: Lens' UpdateClusterKafkaVersion (Maybe ConfigurationInfo) Source #

The custom configuration that should be applied on the new version of cluster.

updateClusterKafkaVersion_clusterArn :: Lens' UpdateClusterKafkaVersion Text Source #

The Amazon Resource Name (ARN) of the cluster to be updated.

UpdateSecurity

updateSecurity_clientAuthentication :: Lens' UpdateSecurity (Maybe ClientAuthentication) Source #

Includes all client authentication related information.

updateSecurity_encryptionInfo :: Lens' UpdateSecurity (Maybe EncryptionInfo) Source #

Includes all encryption-related information.

updateSecurity_clusterArn :: Lens' UpdateSecurity Text Source #

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

updateSecurity_currentVersion :: Lens' UpdateSecurity Text Source #

The version of the MSK cluster to update. Cluster versions aren't simple numbers. You can describe an MSK cluster to find its version. When this update operation is successful, it generates a new cluster version.

updateSecurityResponse_clusterArn :: Lens' UpdateSecurityResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the cluster.

updateSecurityResponse_clusterOperationArn :: Lens' UpdateSecurityResponse (Maybe Text) Source #

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

GetCompatibleKafkaVersions

getCompatibleKafkaVersions_clusterArn :: Lens' GetCompatibleKafkaVersions (Maybe Text) Source #

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

DescribeClusterOperation

describeClusterOperation_clusterOperationArn :: Lens' DescribeClusterOperation Text Source #

The Amazon Resource Name (ARN) that uniquely identifies the MSK cluster operation.

UpdateBrokerType

updateBrokerType_clusterArn :: Lens' UpdateBrokerType Text Source #

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

updateBrokerType_currentVersion :: Lens' UpdateBrokerType Text Source #

The cluster version that you want to change. After this operation completes successfully, the cluster will have a new version.

updateBrokerType_targetInstanceType :: Lens' UpdateBrokerType Text Source #

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

updateBrokerTypeResponse_clusterArn :: Lens' UpdateBrokerTypeResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the cluster.

updateBrokerTypeResponse_clusterOperationArn :: Lens' UpdateBrokerTypeResponse (Maybe Text) Source #

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

DescribeConfiguration

describeConfiguration_arn :: Lens' DescribeConfiguration Text Source #

The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration and all of its revisions.

describeConfigurationResponse_state :: Lens' DescribeConfigurationResponse (Maybe ConfigurationState) Source #

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

describeConfigurationResponse_kafkaVersions :: Lens' DescribeConfigurationResponse (Maybe [Text]) Source #

The versions of Apache Kafka with which you can use this MSK configuration.

describeConfigurationResponse_arn :: Lens' DescribeConfigurationResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the configuration.

TagResource

tagResource_resourceArn :: Lens' TagResource Text Source #

The Amazon Resource Name (ARN) that uniquely identifies the resource that's associated with the tags.

tagResource_tags :: Lens' TagResource (HashMap Text Text) Source #

The key-value pair for the resource tag.

ListClusters

listClusters_clusterNameFilter :: Lens' ListClusters (Maybe Text) Source #

Specify a prefix of the name of the clusters that you want to list. The service lists all the clusters whose names start with this prefix.

listClusters_nextToken :: Lens' ListClusters (Maybe Text) Source #

The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. To get the next batch, provide this token in your next request.

listClusters_maxResults :: Lens' ListClusters (Maybe Natural) Source #

The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.

listClustersResponse_nextToken :: Lens' ListClustersResponse (Maybe Text) Source #

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.

listClustersResponse_clusterInfoList :: Lens' ListClustersResponse (Maybe [ClusterInfo]) Source #

Information on each of the MSK clusters in the response.

UntagResource

untagResource_tagKeys :: Lens' UntagResource [Text] Source #

Tag keys must be unique for a given cluster. In addition, the following restrictions apply:

  • Each tag key must be unique. If you add a tag with a key that's already in use, your new tag overwrites the existing key-value pair.
  • You can't start a tag key with aws: because this prefix is reserved for use by AWS. AWS creates tags that begin with this prefix on your behalf, but you can't edit or delete them.
  • Tag keys must be between 1 and 128 Unicode characters in length.
  • Tag keys must consist of the following characters: Unicode letters, digits, white space, and the following special characters: _ . / = + - @.

untagResource_resourceArn :: Lens' UntagResource Text Source #

The Amazon Resource Name (ARN) that uniquely identifies the resource that's associated with the tags.

ListClusterOperations

listClusterOperations_nextToken :: Lens' ListClusterOperations (Maybe Text) Source #

The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. To get the next batch, provide this token in your next request.

listClusterOperations_maxResults :: Lens' ListClusterOperations (Maybe Natural) Source #

The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.

listClusterOperations_clusterArn :: Lens' ListClusterOperations Text Source #

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

listClusterOperationsResponse_nextToken :: Lens' ListClusterOperationsResponse (Maybe Text) Source #

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.

BatchDisassociateScramSecret

batchDisassociateScramSecret_clusterArn :: Lens' BatchDisassociateScramSecret Text Source #

The Amazon Resource Name (ARN) of the cluster to be updated.

DescribeConfigurationRevision

describeConfigurationRevision_revision :: Lens' DescribeConfigurationRevision Integer Source #

A string that uniquely identifies a revision of an MSK configuration.

describeConfigurationRevision_arn :: Lens' DescribeConfigurationRevision Text Source #

The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration and all of its revisions.

describeConfigurationRevisionResponse_serverProperties :: Lens' DescribeConfigurationRevisionResponse (Maybe ByteString) Source #

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.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

DeleteConfiguration

deleteConfiguration_arn :: Lens' DeleteConfiguration Text Source #

The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration.

deleteConfigurationResponse_state :: Lens' DeleteConfigurationResponse (Maybe ConfigurationState) Source #

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

deleteConfigurationResponse_arn :: Lens' DeleteConfigurationResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration.

UpdateConfiguration

updateConfiguration_description :: Lens' UpdateConfiguration (Maybe Text) Source #

The description of the configuration revision.

updateConfiguration_arn :: Lens' UpdateConfiguration Text Source #

The Amazon Resource Name (ARN) of the configuration.

updateConfiguration_serverProperties :: Lens' UpdateConfiguration ByteString Source #

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.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

updateConfigurationResponse_arn :: Lens' UpdateConfigurationResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the configuration.

ListNodes

listNodes_nextToken :: Lens' ListNodes (Maybe Text) Source #

The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. To get the next batch, provide this token in your next request.

listNodes_maxResults :: Lens' ListNodes (Maybe Natural) Source #

The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.

listNodes_clusterArn :: Lens' ListNodes Text Source #

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

listNodesResponse_nextToken :: Lens' ListNodesResponse (Maybe Text) Source #

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.

listNodesResponse_httpStatus :: Lens' ListNodesResponse Int Source #

The response's http status code.

ListScramSecrets

listScramSecretsResponse_secretArnList :: Lens' ListScramSecretsResponse (Maybe [Text]) Source #

The list of scram secrets associated with the cluster.

Types

BrokerEBSVolumeInfo

BrokerLogs

brokerLogs_s3 :: Lens' BrokerLogs (Maybe S3) Source #

Undocumented member.

BrokerNodeGroupInfo

brokerNodeGroupInfo_storageInfo :: Lens' BrokerNodeGroupInfo (Maybe StorageInfo) Source #

Contains information about storage volumes attached to MSK broker nodes.

brokerNodeGroupInfo_brokerAZDistribution :: Lens' BrokerNodeGroupInfo (Maybe BrokerAZDistribution) Source #

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.

brokerNodeGroupInfo_securityGroups :: Lens' BrokerNodeGroupInfo (Maybe [Text]) Source #

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.

brokerNodeGroupInfo_clientSubnets :: Lens' BrokerNodeGroupInfo [Text] Source #

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 be in Availability Zone us-east-1e.

brokerNodeGroupInfo_instanceType :: Lens' BrokerNodeGroupInfo Text Source #

The type of Amazon EC2 instances to use for 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.

BrokerNodeInfo

brokerNodeInfo_currentBrokerSoftwareInfo :: Lens' BrokerNodeInfo (Maybe BrokerSoftwareInfo) Source #

Information about the version of software currently deployed on the Kafka brokers in the cluster.

brokerNodeInfo_clientSubnet :: Lens' BrokerNodeInfo (Maybe Text) Source #

The client subnet to which this broker node belongs.

brokerNodeInfo_attachedENIId :: Lens' BrokerNodeInfo (Maybe Text) Source #

The attached elastic network interface of the broker.

brokerNodeInfo_endpoints :: Lens' BrokerNodeInfo (Maybe [Text]) Source #

Endpoints for accessing the broker.

brokerNodeInfo_clientVpcIpAddress :: Lens' BrokerNodeInfo (Maybe Text) Source #

The virtual private cloud (VPC) of the client.

BrokerSoftwareInfo

brokerSoftwareInfo_configurationRevision :: Lens' BrokerSoftwareInfo (Maybe Integer) Source #

The revision of the configuration to use. This field isn't visible in this preview release.

brokerSoftwareInfo_configurationArn :: Lens' BrokerSoftwareInfo (Maybe Text) Source #

The Amazon Resource Name (ARN) of the configuration used for the cluster. This field isn't visible in this preview release.

ClientAuthentication

clientAuthentication_sasl :: Lens' ClientAuthentication (Maybe Sasl) Source #

Details for ClientAuthentication using SASL.

clientAuthentication_tls :: Lens' ClientAuthentication (Maybe Tls) Source #

Details for ClientAuthentication using TLS.

clientAuthentication_unauthenticated :: Lens' ClientAuthentication (Maybe Unauthenticated) Source #

Contains information about unauthenticated traffic to the cluster.

CloudWatchLogs

ClusterInfo

clusterInfo_creationTime :: Lens' ClusterInfo (Maybe UTCTime) Source #

The time when the cluster was created.

clusterInfo_activeOperationArn :: Lens' ClusterInfo (Maybe Text) Source #

Arn of active cluster operation.

clusterInfo_state :: Lens' ClusterInfo (Maybe ClusterState) Source #

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

clusterInfo_clusterArn :: Lens' ClusterInfo (Maybe Text) Source #

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

clusterInfo_numberOfBrokerNodes :: Lens' ClusterInfo (Maybe Int) Source #

The number of broker nodes in the cluster.

clusterInfo_enhancedMonitoring :: Lens' ClusterInfo (Maybe EnhancedMonitoring) Source #

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.

clusterInfo_openMonitoring :: Lens' ClusterInfo (Maybe OpenMonitoring) Source #

Settings for open monitoring using Prometheus.

clusterInfo_currentBrokerSoftwareInfo :: Lens' ClusterInfo (Maybe BrokerSoftwareInfo) Source #

Information about the version of software currently deployed on the Kafka brokers in the cluster.

clusterInfo_currentVersion :: Lens' ClusterInfo (Maybe Text) Source #

The current version of the MSK cluster.

clusterInfo_zookeeperConnectString :: Lens' ClusterInfo (Maybe Text) Source #

The connection string to use to connect to the Apache ZooKeeper cluster.

clusterInfo_zookeeperConnectStringTls :: Lens' ClusterInfo (Maybe Text) Source #

The connection string to use to connect to zookeeper cluster on Tls port.

clusterInfo_clientAuthentication :: Lens' ClusterInfo (Maybe ClientAuthentication) Source #

Includes all client authentication information.

clusterInfo_tags :: Lens' ClusterInfo (Maybe (HashMap Text Text)) Source #

Tags attached to the cluster.

clusterInfo_encryptionInfo :: Lens' ClusterInfo (Maybe EncryptionInfo) Source #

Includes all encryption-related information.

ClusterOperationInfo

clusterOperationInfo_clientRequestId :: Lens' ClusterOperationInfo (Maybe Text) Source #

The ID of the API request that triggered this operation.

clusterOperationInfo_targetClusterInfo :: Lens' ClusterOperationInfo (Maybe MutableClusterInfo) Source #

Information about cluster attributes after a cluster is updated.

clusterOperationInfo_sourceClusterInfo :: Lens' ClusterOperationInfo (Maybe MutableClusterInfo) Source #

Information about cluster attributes before a cluster is updated.

clusterOperationInfo_endTime :: Lens' ClusterOperationInfo (Maybe UTCTime) Source #

The time at which the operation finished.

clusterOperationInfo_errorInfo :: Lens' ClusterOperationInfo (Maybe ErrorInfo) Source #

Describes the error if the operation fails.

ClusterOperationStep

ClusterOperationStepInfo

CompatibleKafkaVersion

Configuration

configuration_description :: Lens' Configuration Text Source #

The description of the configuration.

configuration_creationTime :: Lens' Configuration UTCTime Source #

The time when the configuration was created.

configuration_kafkaVersions :: Lens' Configuration [Text] Source #

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.

configuration_arn :: Lens' Configuration Text Source #

The Amazon Resource Name (ARN) of the configuration.

configuration_name :: Lens' Configuration Text Source #

The name of the configuration.

configuration_state :: Lens' Configuration ConfigurationState Source #

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

ConfigurationInfo

configurationInfo_revision :: Lens' ConfigurationInfo Integer Source #

The revision of the configuration to use.

configurationInfo_arn :: Lens' ConfigurationInfo Text Source #

ARN of the configuration to use.

ConfigurationRevision

configurationRevision_description :: Lens' ConfigurationRevision (Maybe Text) Source #

The description of the configuration revision.

configurationRevision_creationTime :: Lens' ConfigurationRevision UTCTime Source #

The time when the configuration revision was created.

EBSStorageInfo

eBSStorageInfo_volumeSize :: Lens' EBSStorageInfo (Maybe Natural) Source #

The size in GiB of the EBS volume for the data drive on each broker node.

EncryptionAtRest

encryptionAtRest_dataVolumeKMSKeyId :: Lens' EncryptionAtRest Text Source #

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

encryptionInTransit_clientBroker :: Lens' EncryptionInTransit (Maybe ClientBroker) Source #

Indicates the encryption setting for data in transit between clients and brokers. The following are the possible 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_PLAINTEXT.

encryptionInTransit_inCluster :: Lens' EncryptionInTransit (Maybe Bool) Source #

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

ErrorInfo

errorInfo_errorString :: Lens' ErrorInfo (Maybe Text) Source #

An optional field to provide more details about the error.

errorInfo_errorCode :: Lens' ErrorInfo (Maybe Text) Source #

A number describing the error programmatically.

Firehose

firehose_enabled :: Lens' Firehose Bool Source #

Undocumented member.

Iam

iam_enabled :: Lens' Iam (Maybe Bool) Source #

Indicates whether IAM access control is enabled.

JmxExporter

jmxExporter_enabledInBroker :: Lens' JmxExporter Bool Source #

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

JmxExporterInfo

jmxExporterInfo_enabledInBroker :: Lens' JmxExporterInfo Bool Source #

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

KafkaVersion

LoggingInfo

MutableClusterInfo

mutableClusterInfo_numberOfBrokerNodes :: Lens' MutableClusterInfo (Maybe Int) Source #

The number of broker nodes in the cluster.

mutableClusterInfo_enhancedMonitoring :: Lens' MutableClusterInfo (Maybe EnhancedMonitoring) Source #

Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster.

mutableClusterInfo_configurationInfo :: Lens' MutableClusterInfo (Maybe ConfigurationInfo) Source #

Information about the changes in the configuration of the brokers.

mutableClusterInfo_instanceType :: Lens' MutableClusterInfo (Maybe Text) Source #

Information about the Amazon MSK broker type.

mutableClusterInfo_loggingInfo :: Lens' MutableClusterInfo (Maybe LoggingInfo) Source #

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.

mutableClusterInfo_brokerEBSVolumeInfo :: Lens' MutableClusterInfo (Maybe [BrokerEBSVolumeInfo]) Source #

Specifies the size of the EBS volume and the ID of the associated broker.

mutableClusterInfo_encryptionInfo :: Lens' MutableClusterInfo (Maybe EncryptionInfo) Source #

Includes all encryption-related information.

NodeExporter

nodeExporter_enabledInBroker :: Lens' NodeExporter Bool Source #

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

NodeExporterInfo

nodeExporterInfo_enabledInBroker :: Lens' NodeExporterInfo Bool Source #

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

NodeInfo

nodeInfo_nodeARN :: Lens' NodeInfo (Maybe Text) Source #

The Amazon Resource Name (ARN) of the node.

OpenMonitoring

OpenMonitoringInfo

Prometheus

prometheus_jmxExporter :: Lens' Prometheus (Maybe JmxExporter) Source #

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

prometheus_nodeExporter :: Lens' Prometheus (Maybe NodeExporter) Source #

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

PrometheusInfo

prometheusInfo_jmxExporter :: Lens' PrometheusInfo (Maybe JmxExporterInfo) Source #

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

prometheusInfo_nodeExporter :: Lens' PrometheusInfo (Maybe NodeExporterInfo) Source #

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

S3

s3_prefix :: Lens' S3 (Maybe Text) Source #

Undocumented member.

s3_bucket :: Lens' S3 (Maybe Text) Source #

Undocumented member.

s3_enabled :: Lens' S3 Bool Source #

Undocumented member.

Sasl

sasl_iam :: Lens' Sasl (Maybe Iam) Source #

Indicates whether IAM access control is enabled.

sasl_scram :: Lens' Sasl (Maybe Scram) Source #

Details for SASL/SCRAM client authentication.

Scram

scram_enabled :: Lens' Scram (Maybe Bool) Source #

SASL/SCRAM authentication is enabled or not.

StateInfo

stateInfo_code :: Lens' StateInfo (Maybe Text) Source #

Undocumented member.

StorageInfo

Tls

tls_enabled :: Lens' Tls (Maybe Bool) Source #

Specifies whether you want to enable or disable TLS authentication.

tls_certificateAuthorityArnList :: Lens' Tls (Maybe [Text]) Source #

List of ACM Certificate Authority ARNs.

Unauthenticated

unauthenticated_enabled :: Lens' Unauthenticated (Maybe Bool) Source #

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

UnprocessedScramSecret

unprocessedScramSecret_errorCode :: Lens' UnprocessedScramSecret (Maybe Text) Source #

Error code for associate/disassociate failure.

unprocessedScramSecret_errorMessage :: Lens' UnprocessedScramSecret (Maybe Text) Source #

Error message for associate/disassociate failure.

ZookeeperNodeInfo

zookeeperNodeInfo_attachedENIId :: Lens' ZookeeperNodeInfo (Maybe Text) Source #

The attached elastic network interface of the broker.

zookeeperNodeInfo_endpoints :: Lens' ZookeeperNodeInfo (Maybe [Text]) Source #

Endpoints for accessing the ZooKeeper.

zookeeperNodeInfo_clientVpcIpAddress :: Lens' ZookeeperNodeInfo (Maybe Text) Source #

The virtual private cloud (VPC) IP address of the client.

zookeeperNodeInfo_zookeeperId :: Lens' ZookeeperNodeInfo (Maybe Double) Source #

The role-specific ID for Zookeeper.