« blib/lib/Paws/MQ/DescribeBrokerInstanceOptionsResponse.pm
↑ Summary
blib/lib/Paws/MQ/DescribeBrokerResponse.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::MQ::DescribeBrokerOutput; | ||
| 3 | use Moose; | ||
| 4 | has AuthenticationStrategy => (is => 'ro', isa => 'Str', request_name => 'authenticationStrategy', traits => ['NameInRequest']); | ||
| 5 | has AutoMinorVersionUpgrade => (is => 'ro', isa => 'Bool', request_name => 'autoMinorVersionUpgrade', traits => ['NameInRequest']); | ||
| 6 | has BrokerArn => (is => 'ro', isa => 'Str', request_name => 'brokerArn', traits => ['NameInRequest']); | ||
| 7 | has BrokerId => (is => 'ro', isa => 'Str', request_name => 'brokerId', traits => ['NameInRequest']); | ||
| 8 | has BrokerInstances => (is => 'ro', isa => 'ArrayRef[Paws::MQ::BrokerInstance]', request_name => 'brokerInstances', traits => ['NameInRequest']); | ||
| 9 | has BrokerName => (is => 'ro', isa => 'Str', request_name => 'brokerName', traits => ['NameInRequest']); | ||
| 10 | has BrokerState => (is => 'ro', isa => 'Str', request_name => 'brokerState', traits => ['NameInRequest']); | ||
| 11 | has Configurations => (is => 'ro', isa => 'Paws::MQ::Configurations', request_name => 'configurations', traits => ['NameInRequest']); | ||
| 12 | has Created => (is => 'ro', isa => 'Str', request_name => 'created', traits => ['NameInRequest']); | ||
| 13 | has DeploymentMode => (is => 'ro', isa => 'Str', request_name => 'deploymentMode', traits => ['NameInRequest']); | ||
| 14 | has EncryptionOptions => (is => 'ro', isa => 'Paws::MQ::EncryptionOptions', request_name => 'encryptionOptions', traits => ['NameInRequest']); | ||
| 15 | has EngineType => (is => 'ro', isa => 'Str', request_name => 'engineType', traits => ['NameInRequest']); | ||
| 16 | has EngineVersion => (is => 'ro', isa => 'Str', request_name => 'engineVersion', traits => ['NameInRequest']); | ||
| 17 | has HostInstanceType => (is => 'ro', isa => 'Str', request_name => 'hostInstanceType', traits => ['NameInRequest']); | ||
| 18 | has LdapServerMetadata => (is => 'ro', isa => 'Paws::MQ::LdapServerMetadataOutput', request_name => 'ldapServerMetadata', traits => ['NameInRequest']); | ||
| 19 | has Logs => (is => 'ro', isa => 'Paws::MQ::LogsSummary', request_name => 'logs', traits => ['NameInRequest']); | ||
| 20 | has MaintenanceWindowStartTime => (is => 'ro', isa => 'Paws::MQ::WeeklyStartTime', request_name => 'maintenanceWindowStartTime', traits => ['NameInRequest']); | ||
| 21 | has PendingAuthenticationStrategy => (is => 'ro', isa => 'Str', request_name => 'pendingAuthenticationStrategy', traits => ['NameInRequest']); | ||
| 22 | has PendingEngineVersion => (is => 'ro', isa => 'Str', request_name => 'pendingEngineVersion', traits => ['NameInRequest']); | ||
| 23 | has PendingHostInstanceType => (is => 'ro', isa => 'Str', request_name => 'pendingHostInstanceType', traits => ['NameInRequest']); | ||
| 24 | has PendingLdapServerMetadata => (is => 'ro', isa => 'Paws::MQ::LdapServerMetadataOutput', request_name => 'pendingLdapServerMetadata', traits => ['NameInRequest']); | ||
| 25 | has PendingSecurityGroups => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'pendingSecurityGroups', traits => ['NameInRequest']); | ||
| 26 | has PubliclyAccessible => (is => 'ro', isa => 'Bool', request_name => 'publiclyAccessible', traits => ['NameInRequest']); | ||
| 27 | has SecurityGroups => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'securityGroups', traits => ['NameInRequest']); | ||
| 28 | has StorageType => (is => 'ro', isa => 'Str', request_name => 'storageType', traits => ['NameInRequest']); | ||
| 29 | has SubnetIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'subnetIds', traits => ['NameInRequest']); | ||
| 30 | has Tags => (is => 'ro', isa => 'Paws::MQ::__mapOf__string', request_name => 'tags', traits => ['NameInRequest']); | ||
| 31 | has Users => (is => 'ro', isa => 'ArrayRef[Paws::MQ::UserSummary]', request_name => 'users', traits => ['NameInRequest']); | ||
| 32 | |||
| 33 | 1; | ||
| 34 | |||
| 35 | ### main pod documentation begin ### | ||
| 36 | |||
| 37 | =head1 NAME | ||
| 38 | |||
| 39 | Paws::MQ::DescribeBrokerOutput | ||
| 40 | |||
| 41 | =head1 USAGE | ||
| 42 | |||
| 43 | This class represents one of two things: | ||
| 44 | |||
| 45 | =head3 Arguments in a call to a service | ||
| 46 | |||
| 47 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 48 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 49 | |||
| 50 | As an example, if Att1 is expected to be a Paws::MQ::DescribeBrokerOutput object: | ||
| 51 | |||
| 52 | $service_obj->Method(Att1 => { AuthenticationStrategy => $value, ..., Users => $value }); | ||
| 53 | |||
| 54 | =head3 Results returned from an API call | ||
| 55 | |||
| 56 | Use accessors for each attribute. If Att1 is expected to be an Paws::MQ::DescribeBrokerOutput object: | ||
| 57 | |||
| 58 | $result = $service_obj->Method(...); | ||
| 59 | $result->Att1->AuthenticationStrategy | ||
| 60 | |||
| 61 | =head1 DESCRIPTION | ||
| 62 | |||
| 63 | The version of the broker engine. For a list of supported engine | ||
| 64 | versions, see | ||
| 65 | https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html | ||
| 66 | |||
| 67 | =head1 ATTRIBUTES | ||
| 68 | |||
| 69 | |||
| 70 | =head2 AuthenticationStrategy => Str | ||
| 71 | |||
| 72 | The authentication strategy used to secure the broker. | ||
| 73 | |||
| 74 | |||
| 75 | =head2 AutoMinorVersionUpgrade => Bool | ||
| 76 | |||
| 77 | Required. Enables automatic upgrades to new minor versions for brokers, | ||
| 78 | as Apache releases the versions. The automatic upgrades occur during | ||
| 79 | the maintenance window of the broker or after a manual broker reboot. | ||
| 80 | |||
| 81 | |||
| 82 | =head2 BrokerArn => Str | ||
| 83 | |||
| 84 | The Amazon Resource Name (ARN) of the broker. | ||
| 85 | |||
| 86 | |||
| 87 | =head2 BrokerId => Str | ||
| 88 | |||
| 89 | The unique ID that Amazon MQ generates for the broker. | ||
| 90 | |||
| 91 | |||
| 92 | =head2 BrokerInstances => ArrayRef[L<Paws::MQ::BrokerInstance>] | ||
| 93 | |||
| 94 | A list of information about allocated brokers. | ||
| 95 | |||
| 96 | |||
| 97 | =head2 BrokerName => Str | ||
| 98 | |||
| 99 | The name of the broker. This value must be unique in your AWS account, | ||
| 100 | 1-50 characters long, must contain only letters, numbers, dashes, and | ||
| 101 | underscores, and must not contain whitespaces, brackets, wildcard | ||
| 102 | characters, or special characters. | ||
| 103 | |||
| 104 | |||
| 105 | =head2 BrokerState => Str | ||
| 106 | |||
| 107 | The status of the broker. | ||
| 108 | |||
| 109 | |||
| 110 | =head2 Configurations => L<Paws::MQ::Configurations> | ||
| 111 | |||
| 112 | The list of all revisions for the specified configuration. | ||
| 113 | |||
| 114 | |||
| 115 | =head2 Created => Str | ||
| 116 | |||
| 117 | The time when the broker was created. | ||
| 118 | |||
| 119 | |||
| 120 | =head2 DeploymentMode => Str | ||
| 121 | |||
| 122 | Required. The deployment mode of the broker. | ||
| 123 | |||
| 124 | |||
| 125 | =head2 EncryptionOptions => L<Paws::MQ::EncryptionOptions> | ||
| 126 | |||
| 127 | Encryption options for the broker. | ||
| 128 | |||
| 129 | |||
| 130 | =head2 EngineType => Str | ||
| 131 | |||
| 132 | Required. The type of broker engine. Note: Currently, Amazon MQ | ||
| 133 | supports ACTIVEMQ and RABBITMQ. | ||
| 134 | |||
| 135 | |||
| 136 | =head2 EngineVersion => Str | ||
| 137 | |||
| 138 | The version of the broker engine. For a list of supported engine | ||
| 139 | versions, see | ||
| 140 | https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html | ||
| 141 | |||
| 142 | |||
| 143 | =head2 HostInstanceType => Str | ||
| 144 | |||
| 145 | The broker's instance type. | ||
| 146 | |||
| 147 | |||
| 148 | =head2 LdapServerMetadata => L<Paws::MQ::LdapServerMetadataOutput> | ||
| 149 | |||
| 150 | The metadata of the LDAP server used to authenticate and authorize | ||
| 151 | connections to the broker. | ||
| 152 | |||
| 153 | |||
| 154 | =head2 Logs => L<Paws::MQ::LogsSummary> | ||
| 155 | |||
| 156 | The list of information about logs currently enabled and pending to be | ||
| 157 | deployed for the specified broker. | ||
| 158 | |||
| 159 | |||
| 160 | =head2 MaintenanceWindowStartTime => L<Paws::MQ::WeeklyStartTime> | ||
| 161 | |||
| 162 | The parameters that determine the WeeklyStartTime. | ||
| 163 | |||
| 164 | |||
| 165 | =head2 PendingAuthenticationStrategy => Str | ||
| 166 | |||
| 167 | The authentication strategy that will be applied when the broker is | ||
| 168 | rebooted. | ||
| 169 | |||
| 170 | |||
| 171 | =head2 PendingEngineVersion => Str | ||
| 172 | |||
| 173 | The version of the broker engine to upgrade to. For a list of supported | ||
| 174 | engine versions, see | ||
| 175 | https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html | ||
| 176 | |||
| 177 | |||
| 178 | =head2 PendingHostInstanceType => Str | ||
| 179 | |||
| 180 | The host instance type of the broker to upgrade to. For a list of | ||
| 181 | supported instance types, see | ||
| 182 | https://docs.aws.amazon.com/amazon-mq/latest/developer-guide//broker.html#broker-instance-types | ||
| 183 | |||
| 184 | |||
| 185 | =head2 PendingLdapServerMetadata => L<Paws::MQ::LdapServerMetadataOutput> | ||
| 186 | |||
| 187 | The metadata of the LDAP server that will be used to authenticate and | ||
| 188 | authorize connections to the broker once it is rebooted. | ||
| 189 | |||
| 190 | |||
| 191 | =head2 PendingSecurityGroups => ArrayRef[Str|Undef] | ||
| 192 | |||
| 193 | The list of pending security groups to authorize connections to | ||
| 194 | brokers. | ||
| 195 | |||
| 196 | |||
| 197 | =head2 PubliclyAccessible => Bool | ||
| 198 | |||
| 199 | Required. Enables connections from applications outside of the VPC that | ||
| 200 | hosts the broker's subnets. | ||
| 201 | |||
| 202 | |||
| 203 | =head2 SecurityGroups => ArrayRef[Str|Undef] | ||
| 204 | |||
| 205 | The list of security groups (1 minimum, 5 maximum) that authorizes | ||
| 206 | connections to brokers. | ||
| 207 | |||
| 208 | |||
| 209 | =head2 StorageType => Str | ||
| 210 | |||
| 211 | The broker's storage type. | ||
| 212 | |||
| 213 | |||
| 214 | =head2 SubnetIds => ArrayRef[Str|Undef] | ||
| 215 | |||
| 216 | The list of groups that define which subnets and IP ranges the broker | ||
| 217 | can use from different Availability Zones. A SINGLE_INSTANCE deployment | ||
| 218 | requires one subnet (for example, the default subnet). An | ||
| 219 | ACTIVE_STANDBY_MULTI_AZ deployment (ACTIVEMQ) requires two subnets. A | ||
| 220 | CLUSTER_MULTI_AZ deployment (RABBITMQ) has no subnet requirements when | ||
| 221 | deployed with public accessibility, deployment without public | ||
| 222 | accessibility requires at least one subnet. | ||
| 223 | |||
| 224 | |||
| 225 | =head2 Tags => L<Paws::MQ::__mapOf__string> | ||
| 226 | |||
| 227 | The list of all tags associated with this broker. | ||
| 228 | |||
| 229 | |||
| 230 | =head2 Users => ArrayRef[L<Paws::MQ::UserSummary>] | ||
| 231 | |||
| 232 | The list of all broker usernames for the specified broker. | ||
| 233 | |||
| 234 | |||
| 235 | |||
| 236 | =head1 SEE ALSO | ||
| 237 | |||
| 238 | This class forms part of L<Paws>, describing an object used in L<Paws::MQ> | ||
| 239 | |||
| 240 | =head1 BUGS and CONTRIBUTIONS | ||
| 241 | |||
| 242 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 243 | |||
| 244 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 245 | |||
| 246 | =cut | ||
| 247 |