amazonka-kafka-2.0: Amazon Managed Streaming for Kafka SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Kafka.Lens

Description

 
Synopsis

Operations

BatchAssociateScramSecret

batchAssociateScramSecret_clusterArn :: Lens' BatchAssociateScramSecret Text Source #

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

batchAssociateScramSecret_secretArnList :: Lens' BatchAssociateScramSecret [Text] Source #

List of AWS Secrets Manager secret ARNs.

batchAssociateScramSecretResponse_clusterArn :: Lens' BatchAssociateScramSecretResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the cluster.

batchAssociateScramSecretResponse_unprocessedScramSecrets :: Lens' BatchAssociateScramSecretResponse (Maybe [UnprocessedScramSecret]) Source #

List of errors when associating secrets to cluster.

batchAssociateScramSecretResponse_httpStatus :: Lens' BatchAssociateScramSecretResponse Int Source #

The response's http status code.

BatchDisassociateScramSecret

batchDisassociateScramSecret_clusterArn :: Lens' BatchDisassociateScramSecret Text Source #

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

batchDisassociateScramSecret_secretArnList :: Lens' BatchDisassociateScramSecret [Text] Source #

List of AWS Secrets Manager secret ARNs.

batchDisassociateScramSecretResponse_clusterArn :: Lens' BatchDisassociateScramSecretResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the cluster.

batchDisassociateScramSecretResponse_unprocessedScramSecrets :: Lens' BatchDisassociateScramSecretResponse (Maybe [UnprocessedScramSecret]) Source #

List of errors when disassociating secrets to cluster.

batchDisassociateScramSecretResponse_httpStatus :: Lens' BatchDisassociateScramSecretResponse Int Source #

The response's http status code.

CreateCluster

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

Includes all client authentication related information.

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

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

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

Includes all encryption-related information.

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_loggingInfo :: Lens' CreateCluster (Maybe LoggingInfo) Source #

Undocumented member.

createCluster_openMonitoring :: Lens' CreateCluster (Maybe OpenMonitoringInfo) Source #

The settings for open monitoring.

createCluster_storageMode :: Lens' CreateCluster (Maybe StorageMode) Source #

This controls storage mode for supported storage tiers.

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

Create tags when creating the cluster.

createCluster_brokerNodeGroupInfo :: Lens' CreateCluster BrokerNodeGroupInfo Source #

Information about the broker nodes in the cluster.

createCluster_kafkaVersion :: Lens' CreateCluster Text Source #

The version of Apache Kafka.

createCluster_numberOfBrokerNodes :: Lens' CreateCluster Natural Source #

The number of broker nodes in the cluster.

createCluster_clusterName :: Lens' CreateCluster Text Source #

The name of the cluster.

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

The Amazon Resource Name (ARN) of the cluster.

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

The name of the MSK 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_httpStatus :: Lens' CreateClusterResponse Int Source #

The response's http status code.

CreateClusterV2

createClusterV2_provisioned :: Lens' CreateClusterV2 (Maybe ProvisionedRequest) Source #

Information about the provisioned cluster.

createClusterV2_serverless :: Lens' CreateClusterV2 (Maybe ServerlessRequest) Source #

Information about the serverless cluster.

createClusterV2_tags :: Lens' CreateClusterV2 (Maybe (HashMap Text Text)) Source #

A map of tags that you want the cluster to have.

createClusterV2_clusterName :: Lens' CreateClusterV2 Text Source #

The name of the cluster.

createClusterV2Response_clusterArn :: Lens' CreateClusterV2Response (Maybe Text) Source #

The Amazon Resource Name (ARN) of the cluster.

createClusterV2Response_clusterName :: Lens' CreateClusterV2Response (Maybe Text) Source #

The name of the MSK cluster.

createClusterV2Response_clusterType :: Lens' CreateClusterV2Response (Maybe ClusterType) Source #

The type of the cluster. The possible states are PROVISIONED or SERVERLESS.

createClusterV2Response_state :: Lens' CreateClusterV2Response (Maybe ClusterState) Source #

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

createClusterV2Response_httpStatus :: Lens' CreateClusterV2Response Int Source #

The response's http status code.

CreateConfiguration

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

The description of the configuration.

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

The versions of Apache Kafka with which you can use this MSK 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.

createConfiguration_name :: Lens' CreateConfiguration Text Source #

The name of the configuration.

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

The Amazon Resource Name (ARN) of the configuration.

createConfigurationResponse_creationTime :: Lens' CreateConfigurationResponse (Maybe UTCTime) Source #

The time when the configuration was created.

createConfigurationResponse_latestRevision :: Lens' CreateConfigurationResponse (Maybe ConfigurationRevision) Source #

Latest revision of the configuration.

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

The name of the configuration.

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

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

createConfigurationResponse_httpStatus :: Lens' CreateConfigurationResponse Int Source #

The response's http status code.

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_clusterArn :: Lens' DeleteClusterResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of 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_httpStatus :: Lens' DeleteClusterResponse Int Source #

The response's http status code.

DeleteConfiguration

deleteConfiguration_arn :: Lens' DeleteConfiguration Text Source #

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

deleteConfigurationResponse_arn :: Lens' DeleteConfigurationResponse (Maybe 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_httpStatus :: Lens' DeleteConfigurationResponse Int Source #

The response's http status code.

DescribeCluster

describeCluster_clusterArn :: Lens' DescribeCluster Text Source #

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

describeClusterResponse_clusterInfo :: Lens' DescribeClusterResponse (Maybe ClusterInfo) Source #

The cluster information.

describeClusterResponse_httpStatus :: Lens' DescribeClusterResponse Int Source #

The response's http status code.

DescribeClusterOperation

describeClusterOperation_clusterOperationArn :: Lens' DescribeClusterOperation Text Source #

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

describeClusterOperationResponse_clusterOperationInfo :: Lens' DescribeClusterOperationResponse (Maybe ClusterOperationInfo) Source #

Cluster operation information

describeClusterOperationResponse_httpStatus :: Lens' DescribeClusterOperationResponse Int Source #

The response's http status code.

DescribeClusterV2

describeClusterV2_clusterArn :: Lens' DescribeClusterV2 Text Source #

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

describeClusterV2Response_clusterInfo :: Lens' DescribeClusterV2Response (Maybe Cluster) Source #

The cluster information.

describeClusterV2Response_httpStatus :: Lens' DescribeClusterV2Response Int Source #

The response's http status code.

DescribeConfiguration

describeConfiguration_arn :: Lens' DescribeConfiguration Text Source #

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

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

The Amazon Resource Name (ARN) of the configuration.

describeConfigurationResponse_creationTime :: Lens' DescribeConfigurationResponse (Maybe UTCTime) Source #

The time when the configuration was created.

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

The description of the configuration.

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

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

describeConfigurationResponse_latestRevision :: Lens' DescribeConfigurationResponse (Maybe ConfigurationRevision) Source #

Latest revision of the configuration.

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

The name of the configuration.

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

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

describeConfigurationResponse_httpStatus :: Lens' DescribeConfigurationResponse Int Source #

The response's http status code.

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_arn :: Lens' DescribeConfigurationRevisionResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the configuration.

describeConfigurationRevisionResponse_creationTime :: Lens' DescribeConfigurationRevisionResponse (Maybe UTCTime) Source #

The time when the configuration was created.

describeConfigurationRevisionResponse_description :: Lens' DescribeConfigurationRevisionResponse (Maybe Text) Source #

The description of the configuration.

describeConfigurationRevisionResponse_revision :: Lens' DescribeConfigurationRevisionResponse (Maybe Integer) Source #

The revision number.

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.

describeConfigurationRevisionResponse_httpStatus :: Lens' DescribeConfigurationRevisionResponse Int Source #

The response's http status code.

GetBootstrapBrokers

getBootstrapBrokers_clusterArn :: Lens' GetBootstrapBrokers Text Source #

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

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

A string containing one or more hostname:port pairs.

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

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

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

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

getBootstrapBrokersResponse_bootstrapBrokerStringPublicTls :: 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.

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_httpStatus :: Lens' GetBootstrapBrokersResponse Int Source #

The response's http status code.

GetCompatibleKafkaVersions

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

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

getCompatibleKafkaVersionsResponse_compatibleKafkaVersions :: Lens' GetCompatibleKafkaVersionsResponse (Maybe [CompatibleKafkaVersion]) Source #

A list of CompatibleKafkaVersion objects.

getCompatibleKafkaVersionsResponse_httpStatus :: Lens' GetCompatibleKafkaVersionsResponse Int Source #

The response's http status code.

ListClusterOperations

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_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_clusterArn :: Lens' ListClusterOperations Text Source #

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

listClusterOperationsResponse_clusterOperationInfoList :: Lens' ListClusterOperationsResponse (Maybe [ClusterOperationInfo]) Source #

An array of cluster operation information objects.

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.

listClusterOperationsResponse_httpStatus :: Lens' ListClusterOperationsResponse Int Source #

The response's http status code.

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_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.

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.

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

Information on each of the MSK clusters in the response.

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_httpStatus :: Lens' ListClustersResponse Int Source #

The response's http status code.

ListClustersV2

listClustersV2_clusterNameFilter :: Lens' ListClustersV2 (Maybe Text) Source #

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

listClustersV2_clusterTypeFilter :: Lens' ListClustersV2 (Maybe Text) Source #

Specify either PROVISIONED or SERVERLESS.

listClustersV2_maxResults :: Lens' ListClustersV2 (Maybe Natural) Source #

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

listClustersV2_nextToken :: Lens' ListClustersV2 (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.

listClustersV2Response_clusterInfoList :: Lens' ListClustersV2Response (Maybe [Cluster]) Source #

Information on each of the MSK clusters in the response.

listClustersV2Response_nextToken :: Lens' ListClustersV2Response (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.

listClustersV2Response_httpStatus :: Lens' ListClustersV2Response Int Source #

The response's http status code.

ListConfigurationRevisions

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_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_arn :: Lens' ListConfigurationRevisions Text Source #

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

listConfigurationRevisionsResponse_nextToken :: Lens' ListConfigurationRevisionsResponse (Maybe Text) Source #

Paginated results marker.

listConfigurationRevisionsResponse_revisions :: Lens' ListConfigurationRevisionsResponse (Maybe [ConfigurationRevision]) Source #

List of ConfigurationRevision objects.

listConfigurationRevisionsResponse_httpStatus :: Lens' ListConfigurationRevisionsResponse Int Source #

The response's http status code.

ListConfigurations

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.

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.

listConfigurationsResponse_configurations :: Lens' ListConfigurationsResponse (Maybe [Configuration]) Source #

An array of MSK configurations.

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.

listConfigurationsResponse_httpStatus :: Lens' ListConfigurationsResponse Int Source #

The response's http status code.

ListKafkaVersions

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.

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.

listKafkaVersionsResponse_kafkaVersions :: Lens' ListKafkaVersionsResponse (Maybe [KafkaVersion]) Source #

Undocumented member.

listKafkaVersionsResponse_nextToken :: Lens' ListKafkaVersionsResponse (Maybe Text) Source #

Undocumented member.

listKafkaVersionsResponse_httpStatus :: Lens' ListKafkaVersionsResponse Int Source #

The response's http status code.

ListNodes

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_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_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_nodeInfoList :: Lens' ListNodesResponse (Maybe [NodeInfo]) Source #

List containing a NodeInfo object.

listNodesResponse_httpStatus :: Lens' ListNodesResponse Int Source #

The response's http status code.

ListScramSecrets

listScramSecrets_maxResults :: Lens' ListScramSecrets (Maybe Natural) Source #

The maxResults of the query.

listScramSecrets_nextToken :: Lens' ListScramSecrets (Maybe Text) Source #

The nextToken of the query.

listScramSecrets_clusterArn :: Lens' ListScramSecrets Text Source #

The arn of the cluster.

listScramSecretsResponse_nextToken :: Lens' ListScramSecretsResponse (Maybe Text) Source #

Paginated results marker.

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

The list of scram secrets associated with the cluster.

listScramSecretsResponse_httpStatus :: Lens' ListScramSecretsResponse Int Source #

The response's http status code.

ListTagsForResource

listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #

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

listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe (HashMap Text Text)) Source #

The key-value pair for the resource tag.

listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int Source #

The response's http status code.

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.

rebootBrokerResponse_httpStatus :: Lens' RebootBrokerResponse Int Source #

The response's http status code.

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.

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.

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.

updateBrokerCountResponse_httpStatus :: Lens' UpdateBrokerCountResponse Int Source #

The response's http status code.

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_clusterArn :: Lens' UpdateBrokerStorageResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the cluster.

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

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

updateBrokerStorageResponse_httpStatus :: Lens' UpdateBrokerStorageResponse Int Source #

The response's http status code.

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.

updateBrokerTypeResponse_httpStatus :: Lens' UpdateBrokerTypeResponse Int Source #

The response's http status code.

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.

updateClusterConfigurationResponse_clusterArn :: Lens' UpdateClusterConfigurationResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the cluster.

updateClusterConfigurationResponse_clusterOperationArn :: Lens' UpdateClusterConfigurationResponse (Maybe Text) Source #

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

updateClusterConfigurationResponse_httpStatus :: Lens' UpdateClusterConfigurationResponse Int Source #

The response's http status code.

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.

updateClusterKafkaVersion_targetKafkaVersion :: Lens' UpdateClusterKafkaVersion Text Source #

Target Kafka version.

updateClusterKafkaVersion_currentVersion :: Lens' UpdateClusterKafkaVersion Text Source #

Current cluster version.

updateClusterKafkaVersionResponse_clusterArn :: Lens' UpdateClusterKafkaVersionResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the cluster.

updateClusterKafkaVersionResponse_clusterOperationArn :: Lens' UpdateClusterKafkaVersionResponse (Maybe Text) Source #

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

updateClusterKafkaVersionResponse_httpStatus :: Lens' UpdateClusterKafkaVersionResponse Int Source #

The response's http status code.

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.

updateConfigurationResponse_latestRevision :: Lens' UpdateConfigurationResponse (Maybe ConfigurationRevision) Source #

Latest revision of the configuration.

updateConfigurationResponse_httpStatus :: Lens' UpdateConfigurationResponse Int Source #

The response's http status code.

UpdateConnectivity

updateConnectivity_clusterArn :: Lens' UpdateConnectivity Text Source #

The Amazon Resource Name (ARN) of the configuration.

updateConnectivity_connectivityInfo :: Lens' UpdateConnectivity ConnectivityInfo Source #

Information about the broker access configuration.

updateConnectivity_currentVersion :: Lens' UpdateConnectivity 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.

updateConnectivityResponse_clusterArn :: Lens' UpdateConnectivityResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the cluster.

updateConnectivityResponse_clusterOperationArn :: Lens' UpdateConnectivityResponse (Maybe Text) Source #

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

updateConnectivityResponse_httpStatus :: Lens' UpdateConnectivityResponse Int Source #

The response's http status code.

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_loggingInfo :: Lens' UpdateMonitoring (Maybe LoggingInfo) Source #

Undocumented member.

updateMonitoring_openMonitoring :: Lens' UpdateMonitoring (Maybe OpenMonitoringInfo) Source #

The settings for open monitoring.

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.

updateMonitoringResponse_httpStatus :: Lens' UpdateMonitoringResponse Int Source #

The response's http status code.

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.

updateSecurityResponse_httpStatus :: Lens' UpdateSecurityResponse Int Source #

The response's http status code.

UpdateStorage

updateStorage_provisionedThroughput :: Lens' UpdateStorage (Maybe ProvisionedThroughput) Source #

EBS volume provisioned throughput information.

updateStorage_storageMode :: Lens' UpdateStorage (Maybe StorageMode) Source #

Controls storage mode for supported storage tiers.

updateStorage_volumeSizeGB :: Lens' UpdateStorage (Maybe Int) Source #

size of the EBS volume to update.

updateStorage_clusterArn :: Lens' UpdateStorage Text Source #

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

updateStorage_currentVersion :: Lens' UpdateStorage Text Source #

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

updateStorageResponse_clusterArn :: Lens' UpdateStorageResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the cluster.

updateStorageResponse_clusterOperationArn :: Lens' UpdateStorageResponse (Maybe Text) Source #

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

updateStorageResponse_httpStatus :: Lens' UpdateStorageResponse Int Source #

The response's http status code.

Types

BrokerEBSVolumeInfo

brokerEBSVolumeInfo_provisionedThroughput :: Lens' BrokerEBSVolumeInfo (Maybe ProvisionedThroughput) Source #

EBS volume provisioned throughput information.

brokerEBSVolumeInfo_volumeSizeGB :: Lens' BrokerEBSVolumeInfo (Maybe Int) Source #

Size of the EBS volume to update.

brokerEBSVolumeInfo_kafkaBrokerNodeId :: Lens' BrokerEBSVolumeInfo Text Source #

The ID of the broker to update.

BrokerLogs

brokerLogs_cloudWatchLogs :: Lens' BrokerLogs (Maybe CloudWatchLogs) Source #

Undocumented member.

brokerLogs_firehose :: Lens' BrokerLogs (Maybe Firehose) Source #

Undocumented member.

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

Undocumented member.

BrokerNodeGroupInfo

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_connectivityInfo :: Lens' BrokerNodeGroupInfo (Maybe ConnectivityInfo) Source #

Information about the broker access configuration.

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_storageInfo :: Lens' BrokerNodeGroupInfo (Maybe StorageInfo) Source #

Contains information about storage volumes attached to MSK broker nodes.

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 occupy the Availability Zone with ID use use1-az3.

brokerNodeGroupInfo_instanceType :: Lens' BrokerNodeGroupInfo Text Source #

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.

BrokerNodeInfo

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

The attached elastic network interface of the broker.

brokerNodeInfo_brokerId :: Lens' BrokerNodeInfo (Maybe Double) Source #

The ID of the broker.

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

The client subnet to which this broker node belongs.

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

The virtual private cloud (VPC) of the client.

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

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

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

Endpoints for accessing the broker.

BrokerSoftwareInfo

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.

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

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

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

The version of Apache Kafka.

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

cloudWatchLogs_logGroup :: Lens' CloudWatchLogs (Maybe Text) Source #

Undocumented member.

cloudWatchLogs_enabled :: Lens' CloudWatchLogs Bool Source #

Undocumented member.

Cluster

cluster_activeOperationArn :: Lens' Cluster (Maybe Text) Source #

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

cluster_clusterArn :: Lens' Cluster (Maybe Text) Source #

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

cluster_clusterName :: Lens' Cluster (Maybe Text) Source #

The name of the cluster.

cluster_clusterType :: Lens' Cluster (Maybe ClusterType) Source #

Cluster Type.

cluster_creationTime :: Lens' Cluster (Maybe UTCTime) Source #

The time when the cluster was created.

cluster_currentVersion :: Lens' Cluster (Maybe Text) Source #

The current version of the MSK cluster.

cluster_provisioned :: Lens' Cluster (Maybe Provisioned) Source #

Information about the provisioned cluster.

cluster_serverless :: Lens' Cluster (Maybe Serverless) Source #

Information about the serverless cluster.

cluster_state :: Lens' Cluster (Maybe ClusterState) Source #

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

cluster_stateInfo :: Lens' Cluster (Maybe StateInfo) Source #

State Info for the Amazon MSK cluster.

cluster_tags :: Lens' Cluster (Maybe (HashMap Text Text)) Source #

Tags attached to the cluster.

ClusterInfo

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

Arn of active cluster operation.

clusterInfo_brokerNodeGroupInfo :: Lens' ClusterInfo (Maybe BrokerNodeGroupInfo) Source #

Information about the broker nodes.

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

Includes all client authentication information.

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

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

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

The name of the cluster.

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

The time when the cluster was created.

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

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

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

The current version of the MSK cluster.

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

Includes all encryption-related information.

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_loggingInfo :: Lens' ClusterInfo (Maybe LoggingInfo) Source #

Undocumented member.

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

The number of broker nodes in the cluster.

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

Settings for open monitoring using Prometheus.

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_stateInfo :: Lens' ClusterInfo (Maybe StateInfo) Source #

Undocumented member.

clusterInfo_storageMode :: Lens' ClusterInfo (Maybe StorageMode) Source #

This controls storage mode for supported storage tiers.

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

Tags attached to the 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.

ClusterOperationInfo

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

The ID of the API request that triggered this operation.

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

ARN of the cluster.

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

The time that the operation was created.

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.

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

ARN of the cluster operation.

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

State of the cluster operation.

clusterOperationInfo_operationSteps :: Lens' ClusterOperationInfo (Maybe [ClusterOperationStep]) Source #

Steps completed during the operation.

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

Type of the cluster operation.

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

Information about cluster attributes before a cluster is updated.

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

Information about cluster attributes after a cluster is updated.

ClusterOperationStep

clusterOperationStep_stepInfo :: Lens' ClusterOperationStep (Maybe ClusterOperationStepInfo) Source #

Information about the step and its status.

clusterOperationStep_stepName :: Lens' ClusterOperationStep (Maybe Text) Source #

The name of the step.

ClusterOperationStepInfo

clusterOperationStepInfo_stepStatus :: Lens' ClusterOperationStepInfo (Maybe Text) Source #

The steps current status.

CompatibleKafkaVersion

compatibleKafkaVersion_sourceVersion :: Lens' CompatibleKafkaVersion (Maybe Text) Source #

An Apache Kafka version.

compatibleKafkaVersion_targetVersions :: Lens' CompatibleKafkaVersion (Maybe [Text]) Source #

A list of Apache Kafka versions.

Configuration

configuration_description :: Lens' Configuration Text Source #

The description of the configuration.

configuration_latestRevision :: Lens' Configuration ConfigurationRevision Source #

Latest revision 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_revision :: Lens' ConfigurationRevision Integer Source #

The revision number.

configurationRevision_creationTime :: Lens' ConfigurationRevision UTCTime Source #

The time when the configuration revision was created.

ConnectivityInfo

connectivityInfo_publicAccess :: Lens' ConnectivityInfo (Maybe PublicAccess) Source #

Public access control for brokers.

EBSStorageInfo

eBSStorageInfo_provisionedThroughput :: Lens' EBSStorageInfo (Maybe ProvisionedThroughput) Source #

EBS volume provisioned throughput information.

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

encryptionInfo_encryptionAtRest :: Lens' EncryptionInfo (Maybe EncryptionAtRest) Source #

The data-volume encryption details.

encryptionInfo_encryptionInTransit :: Lens' EncryptionInfo (Maybe EncryptionInTransit) Source #

The details for encryption in transit.

ErrorInfo

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

A number describing the error programmatically.

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

An optional field to provide more details about the error.

Firehose

firehose_deliveryStream :: Lens' Firehose (Maybe Text) Source #

Undocumented member.

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 turn on or turn off the JMX Exporter.

JmxExporterInfo

jmxExporterInfo_enabledInBroker :: Lens' JmxExporterInfo Bool Source #

Indicates whether you want to turn on or turn off the JMX Exporter.

KafkaVersion

kafkaVersion_status :: Lens' KafkaVersion (Maybe KafkaVersionStatus) Source #

Undocumented member.

kafkaVersion_version :: Lens' KafkaVersion (Maybe Text) Source #

Undocumented member.

LoggingInfo

loggingInfo_brokerLogs :: Lens' LoggingInfo BrokerLogs Source #

Undocumented member.

MutableClusterInfo

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

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

mutableClusterInfo_clientAuthentication :: Lens' MutableClusterInfo (Maybe ClientAuthentication) Source #

Includes all client authentication information.

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

Information about the changes in the configuration of the brokers.

mutableClusterInfo_connectivityInfo :: Lens' MutableClusterInfo (Maybe ConnectivityInfo) Source #

Information about the broker access configuration.

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

Includes all encryption-related information.

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

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

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

Information about the Amazon MSK broker type.

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

The Apache Kafka version.

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_numberOfBrokerNodes :: Lens' MutableClusterInfo (Maybe Int) Source #

The number of broker nodes in the cluster.

mutableClusterInfo_openMonitoring :: Lens' MutableClusterInfo (Maybe OpenMonitoring) Source #

The settings for open monitoring.

mutableClusterInfo_storageMode :: Lens' MutableClusterInfo (Maybe StorageMode) Source #

This controls storage mode for supported storage tiers.

NodeExporter

nodeExporter_enabledInBroker :: Lens' NodeExporter Bool Source #

Indicates whether you want to turn on or turn off the Node Exporter.

NodeExporterInfo

nodeExporterInfo_enabledInBroker :: Lens' NodeExporterInfo Bool Source #

Indicates whether you want to turn on or turn off the Node Exporter.

NodeInfo

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

The start time.

nodeInfo_brokerNodeInfo :: Lens' NodeInfo (Maybe BrokerNodeInfo) Source #

The broker node info.

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

The instance type.

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

The Amazon Resource Name (ARN) of the node.

nodeInfo_nodeType :: Lens' NodeInfo (Maybe NodeType) Source #

The node type.

nodeInfo_zookeeperNodeInfo :: Lens' NodeInfo (Maybe ZookeeperNodeInfo) Source #

The ZookeeperNodeInfo.

OpenMonitoring

openMonitoring_prometheus :: Lens' OpenMonitoring Prometheus Source #

Prometheus settings.

OpenMonitoringInfo

openMonitoringInfo_prometheus :: Lens' OpenMonitoringInfo PrometheusInfo Source #

Prometheus settings.

Prometheus

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

Indicates whether you want to turn on or turn off the JMX Exporter.

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

Indicates whether you want to turn on or turn off the Node Exporter.

PrometheusInfo

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

Indicates whether you want to turn on or turn off the JMX Exporter.

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

Indicates whether you want to turn on or turn off the Node Exporter.

Provisioned

provisioned_clientAuthentication :: Lens' Provisioned (Maybe ClientAuthentication) Source #

Includes all client authentication information.

provisioned_currentBrokerSoftwareInfo :: Lens' Provisioned (Maybe BrokerSoftwareInfo) Source #

Information about the Apache Kafka version deployed on the brokers.

provisioned_encryptionInfo :: Lens' Provisioned (Maybe EncryptionInfo) Source #

Includes all encryption-related information.

provisioned_enhancedMonitoring :: Lens' Provisioned (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.

provisioned_loggingInfo :: Lens' Provisioned (Maybe LoggingInfo) Source #

Log delivery information for the cluster.

provisioned_openMonitoring :: Lens' Provisioned (Maybe OpenMonitoringInfo) Source #

The settings for open monitoring.

provisioned_storageMode :: Lens' Provisioned (Maybe StorageMode) Source #

This controls storage mode for supported storage tiers.

provisioned_zookeeperConnectString :: Lens' Provisioned (Maybe Text) Source #

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

provisioned_zookeeperConnectStringTls :: Lens' Provisioned (Maybe Text) Source #

The connection string to use to connect to the Apache ZooKeeper cluster on a TLS port.

provisioned_brokerNodeGroupInfo :: Lens' Provisioned BrokerNodeGroupInfo Source #

Information about the brokers.

provisioned_numberOfBrokerNodes :: Lens' Provisioned Natural Source #

The number of broker nodes in the cluster.

ProvisionedRequest

provisionedRequest_clientAuthentication :: Lens' ProvisionedRequest (Maybe ClientAuthentication) Source #

Includes all client authentication information.

provisionedRequest_configurationInfo :: Lens' ProvisionedRequest (Maybe ConfigurationInfo) Source #

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

provisionedRequest_encryptionInfo :: Lens' ProvisionedRequest (Maybe EncryptionInfo) Source #

Includes all encryption-related information.

provisionedRequest_enhancedMonitoring :: Lens' ProvisionedRequest (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.

provisionedRequest_loggingInfo :: Lens' ProvisionedRequest (Maybe LoggingInfo) Source #

Log delivery information for the cluster.

provisionedRequest_openMonitoring :: Lens' ProvisionedRequest (Maybe OpenMonitoringInfo) Source #

The settings for open monitoring.

provisionedRequest_storageMode :: Lens' ProvisionedRequest (Maybe StorageMode) Source #

This controls storage mode for supported storage tiers.

provisionedRequest_brokerNodeGroupInfo :: Lens' ProvisionedRequest BrokerNodeGroupInfo Source #

Information about the brokers.

provisionedRequest_kafkaVersion :: Lens' ProvisionedRequest Text Source #

The Apache Kafka version that you want for the cluster.

provisionedRequest_numberOfBrokerNodes :: Lens' ProvisionedRequest Natural Source #

The number of broker nodes in the cluster.

ProvisionedThroughput

provisionedThroughput_enabled :: Lens' ProvisionedThroughput (Maybe Bool) Source #

Provisioned throughput is enabled or not.

provisionedThroughput_volumeThroughput :: Lens' ProvisionedThroughput (Maybe Int) Source #

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

PublicAccess

publicAccess_type :: Lens' PublicAccess (Maybe Text) Source #

The value DISABLED indicates that public access is turned off. SERVICE_PROVIDED_EIPS indicates that public access is turned on.

S3

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

Undocumented member.

s3_prefix :: 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.

Serverless

serverless_clientAuthentication :: Lens' Serverless (Maybe ServerlessClientAuthentication) Source #

Includes all client authentication information.

serverless_vpcConfigs :: Lens' Serverless [VpcConfig] Source #

The configuration of the Amazon VPCs for the cluster.

ServerlessClientAuthentication

serverlessClientAuthentication_sasl :: Lens' ServerlessClientAuthentication (Maybe ServerlessSasl) Source #

Details for ClientAuthentication using SASL.

ServerlessRequest

serverlessRequest_clientAuthentication :: Lens' ServerlessRequest (Maybe ServerlessClientAuthentication) Source #

Includes all client authentication information.

serverlessRequest_vpcConfigs :: Lens' ServerlessRequest [VpcConfig] Source #

The configuration of the Amazon VPCs for the cluster.

ServerlessSasl

serverlessSasl_iam :: Lens' ServerlessSasl (Maybe Iam) Source #

Indicates whether IAM access control is enabled.

StateInfo

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

Undocumented member.

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

Undocumented member.

StorageInfo

storageInfo_ebsStorageInfo :: Lens' StorageInfo (Maybe EBSStorageInfo) Source #

EBS volume information.

Tls

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

List of ACM Certificate Authority ARNs.

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

Specifies whether you want to turn on or turn off TLS authentication.

Unauthenticated

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

Specifies whether you want to turn on or turn off 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.

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

AWS Secrets Manager secret ARN.

VpcConfig

vpcConfig_securityGroupIds :: Lens' VpcConfig (Maybe [Text]) Source #

The IDs of the security groups associated with the cluster.

vpcConfig_subnetIds :: Lens' VpcConfig [Text] Source #

The IDs of the subnets associated with the cluster.

ZookeeperNodeInfo

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

The attached elastic network interface of the broker.

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

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

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

Endpoints for accessing the ZooKeeper.

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

The role-specific ID for Zookeeper.

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

The version of Zookeeper.