| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Kafka::ClusterInfo; | ||
| 3 | use Moose; | ||
| 4 | has ActiveOperationArn => (is => 'ro', isa => 'Str', request_name => 'activeOperationArn', traits => ['NameInRequest']); | ||
| 5 | has BrokerNodeGroupInfo => (is => 'ro', isa => 'Paws::Kafka::BrokerNodeGroupInfo', request_name => 'brokerNodeGroupInfo', traits => ['NameInRequest']); | ||
| 6 | has ClientAuthentication => (is => 'ro', isa => 'Paws::Kafka::ClientAuthentication', request_name => 'clientAuthentication', traits => ['NameInRequest']); | ||
| 7 | has ClusterArn => (is => 'ro', isa => 'Str', request_name => 'clusterArn', traits => ['NameInRequest']); | ||
| 8 | has ClusterName => (is => 'ro', isa => 'Str', request_name => 'clusterName', traits => ['NameInRequest']); | ||
| 9 | has CreationTime => (is => 'ro', isa => 'Str', request_name => 'creationTime', traits => ['NameInRequest']); | ||
| 10 | has CurrentBrokerSoftwareInfo => (is => 'ro', isa => 'Paws::Kafka::BrokerSoftwareInfo', request_name => 'currentBrokerSoftwareInfo', traits => ['NameInRequest']); | ||
| 11 | has CurrentVersion => (is => 'ro', isa => 'Str', request_name => 'currentVersion', traits => ['NameInRequest']); | ||
| 12 | has EncryptionInfo => (is => 'ro', isa => 'Paws::Kafka::EncryptionInfo', request_name => 'encryptionInfo', traits => ['NameInRequest']); | ||
| 13 | has EnhancedMonitoring => (is => 'ro', isa => 'Str', request_name => 'enhancedMonitoring', traits => ['NameInRequest']); | ||
| 14 | has LoggingInfo => (is => 'ro', isa => 'Paws::Kafka::LoggingInfo', request_name => 'loggingInfo', traits => ['NameInRequest']); | ||
| 15 | has NumberOfBrokerNodes => (is => 'ro', isa => 'Int', request_name => 'numberOfBrokerNodes', traits => ['NameInRequest']); | ||
| 16 | has OpenMonitoring => (is => 'ro', isa => 'Paws::Kafka::OpenMonitoring', request_name => 'openMonitoring', traits => ['NameInRequest']); | ||
| 17 | has State => (is => 'ro', isa => 'Str', request_name => 'state', traits => ['NameInRequest']); | ||
| 18 | has StateInfo => (is => 'ro', isa => 'Paws::Kafka::StateInfo', request_name => 'stateInfo', traits => ['NameInRequest']); | ||
| 19 | has Tags => (is => 'ro', isa => 'Paws::Kafka::__mapOf__string', request_name => 'tags', traits => ['NameInRequest']); | ||
| 20 | has ZookeeperConnectString => (is => 'ro', isa => 'Str', request_name => 'zookeeperConnectString', traits => ['NameInRequest']); | ||
| 21 | has ZookeeperConnectStringTls => (is => 'ro', isa => 'Str', request_name => 'zookeeperConnectStringTls', traits => ['NameInRequest']); | ||
| 22 | |||
| 23 | 1; | ||
| 24 | |||
| 25 | ### main pod documentation begin ### | ||
| 26 | |||
| 27 | =head1 NAME | ||
| 28 | |||
| 29 | Paws::Kafka::ClusterInfo | ||
| 30 | |||
| 31 | =head1 USAGE | ||
| 32 | |||
| 33 | This class represents one of two things: | ||
| 34 | |||
| 35 | =head3 Arguments in a call to a service | ||
| 36 | |||
| 37 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 38 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 39 | |||
| 40 | As an example, if Att1 is expected to be a Paws::Kafka::ClusterInfo object: | ||
| 41 | |||
| 42 | $service_obj->Method(Att1 => { ActiveOperationArn => $value, ..., ZookeeperConnectStringTls => $value }); | ||
| 43 | |||
| 44 | =head3 Results returned from an API call | ||
| 45 | |||
| 46 | Use accessors for each attribute. If Att1 is expected to be an Paws::Kafka::ClusterInfo object: | ||
| 47 | |||
| 48 | $result = $service_obj->Method(...); | ||
| 49 | $result->Att1->ActiveOperationArn | ||
| 50 | |||
| 51 | =head1 DESCRIPTION | ||
| 52 | |||
| 53 | Returns information about a cluster. | ||
| 54 | |||
| 55 | =head1 ATTRIBUTES | ||
| 56 | |||
| 57 | |||
| 58 | =head2 ActiveOperationArn => Str | ||
| 59 | |||
| 60 | Arn of active cluster operation. | ||
| 61 | |||
| 62 | |||
| 63 | =head2 BrokerNodeGroupInfo => L<Paws::Kafka::BrokerNodeGroupInfo> | ||
| 64 | |||
| 65 | Information about the broker nodes. | ||
| 66 | |||
| 67 | |||
| 68 | =head2 ClientAuthentication => L<Paws::Kafka::ClientAuthentication> | ||
| 69 | |||
| 70 | Includes all client authentication information. | ||
| 71 | |||
| 72 | |||
| 73 | =head2 ClusterArn => Str | ||
| 74 | |||
| 75 | The Amazon Resource Name (ARN) that uniquely identifies the cluster. | ||
| 76 | |||
| 77 | |||
| 78 | =head2 ClusterName => Str | ||
| 79 | |||
| 80 | The name of the cluster. | ||
| 81 | |||
| 82 | |||
| 83 | =head2 CreationTime => Str | ||
| 84 | |||
| 85 | The time when the cluster was created. | ||
| 86 | |||
| 87 | |||
| 88 | =head2 CurrentBrokerSoftwareInfo => L<Paws::Kafka::BrokerSoftwareInfo> | ||
| 89 | |||
| 90 | Information about the version of software currently deployed on the | ||
| 91 | Kafka brokers in the cluster. | ||
| 92 | |||
| 93 | |||
| 94 | =head2 CurrentVersion => Str | ||
| 95 | |||
| 96 | The current version of the MSK cluster. | ||
| 97 | |||
| 98 | |||
| 99 | =head2 EncryptionInfo => L<Paws::Kafka::EncryptionInfo> | ||
| 100 | |||
| 101 | Includes all encryption-related information. | ||
| 102 | |||
| 103 | |||
| 104 | =head2 EnhancedMonitoring => Str | ||
| 105 | |||
| 106 | Specifies which metrics are gathered for the MSK cluster. This property | ||
| 107 | has the following possible values: DEFAULT, PER_BROKER, | ||
| 108 | PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION. For a list of the | ||
| 109 | metrics associated with each of these levels of monitoring, see | ||
| 110 | Monitoring | ||
| 111 | (https://docs.aws.amazon.com/msk/latest/developerguide/monitoring.html). | ||
| 112 | |||
| 113 | |||
| 114 | =head2 LoggingInfo => L<Paws::Kafka::LoggingInfo> | ||
| 115 | |||
| 116 | |||
| 117 | |||
| 118 | |||
| 119 | =head2 NumberOfBrokerNodes => Int | ||
| 120 | |||
| 121 | The number of broker nodes in the cluster. | ||
| 122 | |||
| 123 | |||
| 124 | =head2 OpenMonitoring => L<Paws::Kafka::OpenMonitoring> | ||
| 125 | |||
| 126 | Settings for open monitoring using Prometheus. | ||
| 127 | |||
| 128 | |||
| 129 | =head2 State => Str | ||
| 130 | |||
| 131 | The state of the cluster. The possible states are ACTIVE, CREATING, | ||
| 132 | DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING. | ||
| 133 | |||
| 134 | |||
| 135 | =head2 StateInfo => L<Paws::Kafka::StateInfo> | ||
| 136 | |||
| 137 | |||
| 138 | |||
| 139 | |||
| 140 | =head2 Tags => L<Paws::Kafka::__mapOf__string> | ||
| 141 | |||
| 142 | Tags attached to the cluster. | ||
| 143 | |||
| 144 | |||
| 145 | =head2 ZookeeperConnectString => Str | ||
| 146 | |||
| 147 | The connection string to use to connect to the Apache ZooKeeper | ||
| 148 | cluster. | ||
| 149 | |||
| 150 | |||
| 151 | =head2 ZookeeperConnectStringTls => Str | ||
| 152 | |||
| 153 | The connection string to use to connect to zookeeper cluster on Tls | ||
| 154 | port. | ||
| 155 | |||
| 156 | |||
| 157 | |||
| 158 | =head1 SEE ALSO | ||
| 159 | |||
| 160 | This class forms part of L<Paws>, describing an object used in L<Paws::Kafka> | ||
| 161 | |||
| 162 | =head1 BUGS and CONTRIBUTIONS | ||
| 163 | |||
| 164 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 165 | |||
| 166 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 167 | |||
| 168 | =cut | ||
| 169 |