ClusterState class
Input properties used for looking up and filtering Cluster resources.
Constructors
-
ClusterState({Input<
String?> ? arn, Input<String?> ? bootstrapBrokers, Input<String?> ? bootstrapBrokersIpv6, Input<String?> ? bootstrapBrokersPublicSaslIam, Input<String?> ? bootstrapBrokersPublicSaslScram, Input<String?> ? bootstrapBrokersPublicTls, Input<String?> ? bootstrapBrokersSaslIam, Input<String?> ? bootstrapBrokersSaslIamIpv6, Input<String?> ? bootstrapBrokersSaslScram, Input<String?> ? bootstrapBrokersSaslScramIpv6, Input<String?> ? bootstrapBrokersTls, Input<String?> ? bootstrapBrokersTlsIpv6, Input<String?> ? bootstrapBrokersVpcConnectivitySaslIam, Input<String?> ? bootstrapBrokersVpcConnectivitySaslScram, Input<String?> ? bootstrapBrokersVpcConnectivityTls, Input<ClusterBrokerNodeGroupInfo?> ? brokerNodeGroupInfo, Input<ClusterClientAuthentication?> ? clientAuthentication, Input<String?> ? clusterName, Input<String?> ? clusterUuid, Input<ClusterConfigurationInfo?> ? configurationInfo, Input<String?> ? currentVersion, Input<String?> ? customerActionStatus, Input<ClusterEncryptionInfo?> ? encryptionInfo, Input<String?> ? enhancedMonitoring, Input<String?> ? kafkaVersion, Input<ClusterLoggingInfo?> ? loggingInfo, Input<int?> ? numberOfBrokerNodes, Input<ClusterOpenMonitoring?> ? openMonitoring, Input<ClusterRebalancing?> ? rebalancing, Input<String?> ? region, Input<String?> ? storageMode, Input<Map< ? tags, Input<String, String> ?>Map< ? tagsAll, Input<String, String> ?>String?> ? zookeeperConnectString, Input<String?> ? zookeeperConnectStringTls}) -
Creates a new ClusterState.
arnARN of the MSK cluster.bootstrapBrokersComma separated list of one or more hostname:port pairs of kafka brokers suitable to bootstrap connectivity to the kafka cluster. Contains a value ifencryption_info.0.encryption_in_transit.0.client_brokeris set toPLAINTEXTorTLS_PLAINTEXT. The resource sorts values alphabetically. AWS may not always return all endpoints so this value is not guaranteed to be stable across applies.bootstrapBrokersIpv6One or more IPv6 DNS names (or IP addresses) and plaintext port pairs. For example,2001:db8:1234:1a00:*:80,2001:db8:1234:1a02:*:80,2001:db8:1234:1a04:*:80. This attribute will have a value if the cluster is configured withbroker_node_group_info.0.connectivity_info.0.network_typeset toDUALandencryption_info.0.encryption_in_transit.0.client_brokeris set toPLAINTEXTorTLS_PLAINTEXT. The resource sorts the list alphabetically. AWS may not always return all endpoints so the values may not be stable across applies.bootstrapBrokersPublicSaslIamOne or more DNS names (or IP addresses) and SASL IAM port pairs. For example,b-1-public.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9198,b-2-public.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9198,b-3-public.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9198. This attribute will have a value ifencryption_info.0.encryption_in_transit.0.client_brokeris set toTLS_PLAINTEXTorTLSandclient_authentication.0.sasl.0.iamis set totrueandbroker_node_group_info.0.connectivity_info.0.public_access.0.typeis set toSERVICE_PROVIDED_EIPSand the cluster fulfill all other requirements for public access. The resource sorts the list alphabetically. AWS may not always return all endpoints so the values may not be stable across applies.bootstrapBrokersPublicSaslScramOne or more DNS names (or IP addresses) and SASL SCRAM port pairs. For example,b-1-public.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9196,b-2-public.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9196,b-3-public.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9196. This attribute will have a value ifencryption_info.0.encryption_in_transit.0.client_brokeris set toTLS_PLAINTEXTorTLSandclient_authentication.0.sasl.0.scramis set totrueandbroker_node_group_info.0.connectivity_info.0.public_access.0.typeis set toSERVICE_PROVIDED_EIPSand the cluster fulfill all other requirements for public access. The resource sorts the list alphabetically. AWS may not always return all endpoints so the values may not be stable across applies.bootstrapBrokersPublicTlsOne or more DNS names (or IP addresses) and TLS port pairs. For example,b-1-public.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9194,b-2-public.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9194,b-3-public.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9194. This attribute will have a value ifencryption_info.0.encryption_in_transit.0.client_brokeris set toTLS_PLAINTEXTorTLSandbroker_node_group_info.0.connectivity_info.0.public_access.0.typeis set toSERVICE_PROVIDED_EIPSand the cluster fulfill all other requirements for public access. The resource sorts the list alphabetically. AWS may not always return all endpoints so the values may not be stable across applies.bootstrapBrokersSaslIamOne or more DNS names (or IP addresses) and SASL IAM port pairs. For example,b-1.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9098,b-2.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9098,b-3.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9098. This attribute will have a value ifencryption_info.0.encryption_in_transit.0.client_brokeris set toTLS_PLAINTEXTorTLSandclient_authentication.0.sasl.0.iamis set totrue. The resource sorts the list alphabetically. AWS may not always return all endpoints so the values may not be stable across applies.bootstrapBrokersSaslIamIpv6One or more IPv6 DNS names (or IP addresses) and SASL IAM port pairs. This attribute will have a value if the cluster is configured withbroker_node_group_info.0.connectivity_info.0.network_typeset toDUALandencryption_info.0.encryption_in_transit.0.client_brokeris set toTLS_PLAINTEXTorTLSandclient_authentication.0.sasl.0.iamis set totrue. The resource sorts the list alphabetically. AWS may not always return all endpoints so the values may not be stable across applies.bootstrapBrokersSaslScramOne or more DNS names (or IP addresses) and SASL SCRAM port pairs. For example,b-1.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9096,b-2.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9096,b-3.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9096. This attribute will have a value ifencryption_info.0.encryption_in_transit.0.client_brokeris set toTLS_PLAINTEXTorTLSandclient_authentication.0.sasl.0.scramis set totrue. The resource sorts the list alphabetically. AWS may not always return all endpoints so the values may not be stable across applies.bootstrapBrokersSaslScramIpv6One or more IPv6 DNS names (or IP addresses) and SASL SCRAM port pairs. This attribute will have a value if the cluster is configured withbroker_node_group_info.0.connectivity_info.0.network_typeset toDUALandencryption_info.0.encryption_in_transit.0.client_brokeris set toTLS_PLAINTEXTorTLSandclient_authentication.0.sasl.0.scramis set totrue. The resource sorts the list alphabetically. AWS may not always return all endpoints so the values may not be stable across applies.bootstrapBrokersTlsOne or more DNS names (or IP addresses) and TLS port pairs. For example,b-1.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9094,b-2.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9094,b-3.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9094. This attribute will have a value ifencryption_info.0.encryption_in_transit.0.client_brokeris set toTLS_PLAINTEXTorTLS. The resource sorts the list alphabetically. AWS may not always return all endpoints so the values may not be stable across applies.bootstrapBrokersTlsIpv6One or more IPv6 DNS names (or IP addresses) and TLS port pairs. This attribute will have a value if the cluster is configured withbroker_node_group_info.0.connectivity_info.0.network_typeset toDUALandencryption_info.0.encryption_in_transit.0.client_brokeris set toTLS_PLAINTEXTorTLS. The resource sorts the list alphabetically. AWS may not always return all endpoints so the values may not be stable across applies.bootstrapBrokersVpcConnectivitySaslIamA string containing one or more DNS names (or IP addresses) and SASL IAM port pairs for VPC connectivity. AWS may not always return all endpoints so the values may not be stable across applies.bootstrapBrokersVpcConnectivitySaslScramA string containing one or more DNS names (or IP addresses) and SASL SCRAM port pairs for VPC connectivity. AWS may not always return all endpoints so the values may not be stable across applies.bootstrapBrokersVpcConnectivityTlsA string containing one or more DNS names (or IP addresses) and TLS port pairs for VPC connectivity. AWS may not always return all endpoints so the values may not be stable across applies.brokerNodeGroupInfoConfiguration block for the broker nodes of the Kafka cluster. See brokerNodeGroupInfo Argument Reference below.clientAuthenticationConfiguration block for specifying a client authentication. See clientAuthentication Argument Reference below.clusterNameName of the MSK cluster.clusterUuidUUID of the MSK cluster, for use in IAM policies.configurationInfoConfiguration block for specifying an MSK Configuration to attach to Kafka brokers. See configurationInfo Argument Reference below.currentVersionCurrent version of the MSK Cluster used for updates, e.g.,K13V1IB3VIYZZHcustomerActionStatusStatus indicating whether Amazon MSK requires customer action for the cluster. Valid values areNONE,ACTION_RECOMMENDED, andCRITICAL_ACTION_REQUIRED.encryptionInfoConfiguration block for specifying encryption. See encryptionInfo Argument Reference below.enhancedMonitoringSpecify the desired enhanced MSK CloudWatch monitoring level. See Monitoring Amazon MSK with Amazon CloudWatchkafkaVersionSpecify the desired Kafka software version.loggingInfoConfiguration block for streaming broker logs to Cloudwatch/S3/Kinesis Firehose. See loggingInfo Argument Reference below.numberOfBrokerNodesThe desired total number of broker nodes in the kafka cluster. It must be a multiple of the number of specified client subnets.openMonitoringConfiguration block for JMX and Node monitoring for the MSK cluster. See openMonitoring Argument Reference below.rebalancingConfiguration block for intelligent rebalancing. See rebalancing Argument Reference below. Only applicable to MSK Provisioned clusters with Express brokers.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.storageModeControls storage mode for supported storage tiers. Valid values are:LOCALorTIERED.tagsA map of tags to assign to the resource. .If configured with a providerdefaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.tagsAllA map of tags assigned to the resource, including those inherited from the providerdefaultTagsconfiguration block.zookeeperConnectStringA comma separated list of one or more hostname:port pairs to use to connect to the Apache Zookeeper cluster. The returned values are sorted alphabetically. The AWS API may not return all endpoints, so this value is not guaranteed to be stable across applies.zookeeperConnectStringTlsA comma separated list of one or more hostname:port pairs to use to connect to the Apache Zookeeper cluster via TLS. The returned values are sorted alphabetically. The AWS API may not return all endpoints, so this value is not guaranteed to be stable across applies.const -
ClusterState.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
arn
→ Input<
String?> ? -
ARN of the MSK cluster.
final
-
bootstrapBrokers
→ Input<
String?> ? -
Comma separated list of one or more hostname:port pairs of kafka brokers suitable to bootstrap connectivity to the kafka cluster. Contains a value if
encryption_info.0.encryption_in_transit.0.client_brokeris set toPLAINTEXTorTLS_PLAINTEXT. The resource sorts values alphabetically. AWS may not always return all endpoints so this value is not guaranteed to be stable across applies.final -
bootstrapBrokersIpv6
→ Input<
String?> ? -
One or more IPv6 DNS names (or IP addresses) and plaintext port pairs. For example,
2001:db8:1234:1a00:*:80,2001:db8:1234:1a02:*:80,2001:db8:1234:1a04:*:80. This attribute will have a value if the cluster is configured withbroker_node_group_info.0.connectivity_info.0.network_typeset toDUALandencryption_info.0.encryption_in_transit.0.client_brokeris set toPLAINTEXTorTLS_PLAINTEXT. The resource sorts the list alphabetically. AWS may not always return all endpoints so the values may not be stable across applies.final -
bootstrapBrokersPublicSaslIam
→ Input<
String?> ? -
One or more DNS names (or IP addresses) and SASL IAM port pairs. For example,
b-1-public.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9198,b-2-public.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9198,b-3-public.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9198. This attribute will have a value ifencryption_info.0.encryption_in_transit.0.client_brokeris set toTLS_PLAINTEXTorTLSandclient_authentication.0.sasl.0.iamis set totrueandbroker_node_group_info.0.connectivity_info.0.public_access.0.typeis set toSERVICE_PROVIDED_EIPSand the cluster fulfill all other requirements for public access. The resource sorts the list alphabetically. AWS may not always return all endpoints so the values may not be stable across applies.final -
bootstrapBrokersPublicSaslScram
→ Input<
String?> ? -
One or more DNS names (or IP addresses) and SASL SCRAM port pairs. For example,
b-1-public.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9196,b-2-public.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9196,b-3-public.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9196. This attribute will have a value ifencryption_info.0.encryption_in_transit.0.client_brokeris set toTLS_PLAINTEXTorTLSandclient_authentication.0.sasl.0.scramis set totrueandbroker_node_group_info.0.connectivity_info.0.public_access.0.typeis set toSERVICE_PROVIDED_EIPSand the cluster fulfill all other requirements for public access. The resource sorts the list alphabetically. AWS may not always return all endpoints so the values may not be stable across applies.final -
bootstrapBrokersPublicTls
→ Input<
String?> ? -
One or more DNS names (or IP addresses) and TLS port pairs. For example,
b-1-public.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9194,b-2-public.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9194,b-3-public.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9194. This attribute will have a value ifencryption_info.0.encryption_in_transit.0.client_brokeris set toTLS_PLAINTEXTorTLSandbroker_node_group_info.0.connectivity_info.0.public_access.0.typeis set toSERVICE_PROVIDED_EIPSand the cluster fulfill all other requirements for public access. The resource sorts the list alphabetically. AWS may not always return all endpoints so the values may not be stable across applies.final -
bootstrapBrokersSaslIam
→ Input<
String?> ? -
One or more DNS names (or IP addresses) and SASL IAM port pairs. For example,
b-1.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9098,b-2.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9098,b-3.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9098. This attribute will have a value ifencryption_info.0.encryption_in_transit.0.client_brokeris set toTLS_PLAINTEXTorTLSandclient_authentication.0.sasl.0.iamis set totrue. The resource sorts the list alphabetically. AWS may not always return all endpoints so the values may not be stable across applies.final -
bootstrapBrokersSaslIamIpv6
→ Input<
String?> ? -
One or more IPv6 DNS names (or IP addresses) and SASL IAM port pairs. This attribute will have a value if the cluster is configured with
broker_node_group_info.0.connectivity_info.0.network_typeset toDUALandencryption_info.0.encryption_in_transit.0.client_brokeris set toTLS_PLAINTEXTorTLSandclient_authentication.0.sasl.0.iamis set totrue. The resource sorts the list alphabetically. AWS may not always return all endpoints so the values may not be stable across applies.final -
bootstrapBrokersSaslScram
→ Input<
String?> ? -
One or more DNS names (or IP addresses) and SASL SCRAM port pairs. For example,
b-1.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9096,b-2.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9096,b-3.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9096. This attribute will have a value ifencryption_info.0.encryption_in_transit.0.client_brokeris set toTLS_PLAINTEXTorTLSandclient_authentication.0.sasl.0.scramis set totrue. The resource sorts the list alphabetically. AWS may not always return all endpoints so the values may not be stable across applies.final -
bootstrapBrokersSaslScramIpv6
→ Input<
String?> ? -
One or more IPv6 DNS names (or IP addresses) and SASL SCRAM port pairs. This attribute will have a value if the cluster is configured with
broker_node_group_info.0.connectivity_info.0.network_typeset toDUALandencryption_info.0.encryption_in_transit.0.client_brokeris set toTLS_PLAINTEXTorTLSandclient_authentication.0.sasl.0.scramis set totrue. The resource sorts the list alphabetically. AWS may not always return all endpoints so the values may not be stable across applies.final -
bootstrapBrokersTls
→ Input<
String?> ? -
One or more DNS names (or IP addresses) and TLS port pairs. For example,
b-1.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9094,b-2.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9094,b-3.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9094. This attribute will have a value ifencryption_info.0.encryption_in_transit.0.client_brokeris set toTLS_PLAINTEXTorTLS. The resource sorts the list alphabetically. AWS may not always return all endpoints so the values may not be stable across applies.final -
bootstrapBrokersTlsIpv6
→ Input<
String?> ? -
One or more IPv6 DNS names (or IP addresses) and TLS port pairs. This attribute will have a value if the cluster is configured with
broker_node_group_info.0.connectivity_info.0.network_typeset toDUALandencryption_info.0.encryption_in_transit.0.client_brokeris set toTLS_PLAINTEXTorTLS. The resource sorts the list alphabetically. AWS may not always return all endpoints so the values may not be stable across applies.final -
bootstrapBrokersVpcConnectivitySaslIam
→ Input<
String?> ? -
A string containing one or more DNS names (or IP addresses) and SASL IAM port pairs for VPC connectivity. AWS may not always return all endpoints so the values may not be stable across applies.
final
-
bootstrapBrokersVpcConnectivitySaslScram
→ Input<
String?> ? -
A string containing one or more DNS names (or IP addresses) and SASL SCRAM port pairs for VPC connectivity. AWS may not always return all endpoints so the values may not be stable across applies.
final
-
bootstrapBrokersVpcConnectivityTls
→ Input<
String?> ? -
A string containing one or more DNS names (or IP addresses) and TLS port pairs for VPC connectivity. AWS may not always return all endpoints so the values may not be stable across applies.
final
-
brokerNodeGroupInfo
→ Input<
ClusterBrokerNodeGroupInfo?> ? -
Configuration block for the broker nodes of the Kafka cluster. See brokerNodeGroupInfo Argument Reference below.
final
-
clientAuthentication
→ Input<
ClusterClientAuthentication?> ? -
Configuration block for specifying a client authentication. See clientAuthentication Argument Reference below.
final
-
clusterName
→ Input<
String?> ? -
Name of the MSK cluster.
final
-
clusterUuid
→ Input<
String?> ? -
UUID of the MSK cluster, for use in IAM policies.
final
-
configurationInfo
→ Input<
ClusterConfigurationInfo?> ? -
Configuration block for specifying an MSK Configuration to attach to Kafka brokers. See configurationInfo Argument Reference below.
final
-
currentVersion
→ Input<
String?> ? -
Current version of the MSK Cluster used for updates, e.g.,
K13V1IB3VIYZZHfinal -
customerActionStatus
→ Input<
String?> ? -
Status indicating whether Amazon MSK requires customer action for the cluster. Valid values are
NONE,ACTION_RECOMMENDED, andCRITICAL_ACTION_REQUIRED.final -
encryptionInfo
→ Input<
ClusterEncryptionInfo?> ? -
Configuration block for specifying encryption. See encryptionInfo Argument Reference below.
final
-
enhancedMonitoring
→ Input<
String?> ? -
Specify the desired enhanced MSK CloudWatch monitoring level. See Monitoring Amazon MSK with Amazon CloudWatch
final
- hashCode → int
-
The hash code for this object.
no setterinherited
-
kafkaVersion
→ Input<
String?> ? -
Specify the desired Kafka software version.
final
-
loggingInfo
→ Input<
ClusterLoggingInfo?> ? -
Configuration block for streaming broker logs to Cloudwatch/S3/Kinesis Firehose. See loggingInfo Argument Reference below.
final
-
numberOfBrokerNodes
→ Input<
int?> ? -
The desired total number of broker nodes in the kafka cluster. It must be a multiple of the number of specified client subnets.
final
-
openMonitoring
→ Input<
ClusterOpenMonitoring?> ? -
Configuration block for JMX and Node monitoring for the MSK cluster. See openMonitoring Argument Reference below.
final
-
rebalancing
→ Input<
ClusterRebalancing?> ? -
Configuration block for intelligent rebalancing. See rebalancing Argument Reference below. Only applicable to MSK Provisioned clusters with Express brokers.
final
-
region
→ Input<
String?> ? -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
storageMode
→ Input<
String?> ? -
Controls storage mode for supported storage tiers. Valid values are:
LOCALorTIERED.final -
A map of tags to assign to the resource. .If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.final -
A map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.final -
zookeeperConnectString
→ Input<
String?> ? -
A comma separated list of one or more hostname:port pairs to use to connect to the Apache Zookeeper cluster. The returned values are sorted alphabetically. The AWS API may not return all endpoints, so this value is not guaranteed to be stable across applies.
final
-
zookeeperConnectStringTls
→ Input<
String?> ? -
A comma separated list of one or more hostname:port pairs to use to connect to the Apache Zookeeper cluster via TLS. The returned values are sorted alphabetically. The AWS API may not return all endpoints, so this value is not guaranteed to be stable across applies.
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toMap(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited