blib/lib/Paws/MQ/CreateBroker.pm untested

filter: Statementstmt 0.0% 0 / 48 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 50 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::MQ::CreateBroker;
3 use Moose;
4 has AuthenticationStrategy => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'authenticationStrategy');
5 has AutoMinorVersionUpgrade => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'autoMinorVersionUpgrade');
6 has BrokerName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'brokerName');
7 has Configuration => (is => 'ro', isa => 'Paws::MQ::ConfigurationId', traits => ['NameInRequest'], request_name => 'configuration');
8 has CreatorRequestId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'creatorRequestId');
9 has DeploymentMode => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'deploymentMode');
10 has EncryptionOptions => (is => 'ro', isa => 'Paws::MQ::EncryptionOptions', traits => ['NameInRequest'], request_name => 'encryptionOptions');
11 has EngineType => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'engineType');
12 has EngineVersion => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'engineVersion');
13 has HostInstanceType => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'hostInstanceType');
14 has LdapServerMetadata => (is => 'ro', isa => 'Paws::MQ::LdapServerMetadataInput', traits => ['NameInRequest'], request_name => 'ldapServerMetadata');
15 has Logs => (is => 'ro', isa => 'Paws::MQ::Logs', traits => ['NameInRequest'], request_name => 'logs');
16 has MaintenanceWindowStartTime => (is => 'ro', isa => 'Paws::MQ::WeeklyStartTime', traits => ['NameInRequest'], request_name => 'maintenanceWindowStartTime');
17 has PubliclyAccessible => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'publiclyAccessible');
18 has SecurityGroups => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'securityGroups');
19 has StorageType => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'storageType');
20 has SubnetIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'subnetIds');
21 has Tags => (is => 'ro', isa => 'Paws::MQ::__mapOf__string', traits => ['NameInRequest'], request_name => 'tags');
22 has Users => (is => 'ro', isa => 'ArrayRef[Paws::MQ::User]', traits => ['NameInRequest'], request_name => 'users');
23  
24 use MooseX::ClassAttribute;
25  
26 class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateBroker');
27 class_has _api_uri => (isa => 'Str', is => 'ro', default => '/v1/brokers');
28 class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST');
29 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::MQ::CreateBrokerResponse');
30 1;
31  
32 ### main pod documentation begin ###
33  
34 =head1 NAME
35  
36 Paws::MQ::CreateBroker - Arguments for method CreateBroker on L<Paws::MQ>
37  
38 =head1 DESCRIPTION
39  
40 This class represents the parameters used for calling the method CreateBroker on the
41 L<AmazonMQ|Paws::MQ> service. Use the attributes of this class
42 as arguments to method CreateBroker.
43  
44 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateBroker.
45  
46 =head1 SYNOPSIS
47  
48 my $mq = Paws->service('MQ');
49 my $CreateBrokerResponse = $mq->CreateBroker(
50 AuthenticationStrategy => 'SIMPLE', # OPTIONAL
51 AutoMinorVersionUpgrade => 1, # OPTIONAL
52 BrokerName => 'My__string', # OPTIONAL
53 Configuration => {
54 Id => 'My__string',
55 Revision => 1, # OPTIONAL
56 }, # OPTIONAL
57 CreatorRequestId => 'My__string', # OPTIONAL
58 DeploymentMode => 'SINGLE_INSTANCE', # OPTIONAL
59 EncryptionOptions => {
60 UseAwsOwnedKey => 1,
61 KmsKeyId => 'My__string',
62 }, # OPTIONAL
63 EngineType => 'ACTIVEMQ', # OPTIONAL
64 EngineVersion => 'My__string', # OPTIONAL
65 HostInstanceType => 'My__string', # OPTIONAL
66 LdapServerMetadata => {
67 Hosts => [ 'My__string', ... ], # OPTIONAL
68 RoleBase => 'My__string',
69 RoleName => 'My__string',
70 RoleSearchMatching => 'My__string',
71 RoleSearchSubtree => 1,
72 ServiceAccountPassword => 'My__string',
73 ServiceAccountUsername => 'My__string',
74 UserBase => 'My__string',
75 UserRoleName => 'My__string',
76 UserSearchMatching => 'My__string',
77 UserSearchSubtree => 1,
78 }, # OPTIONAL
79 Logs => {
80 Audit => 1,
81 General => 1,
82 }, # OPTIONAL
83 MaintenanceWindowStartTime => {
84 DayOfWeek => 'MONDAY'
85 , # values: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY; OPTIONAL
86 TimeOfDay => 'My__string',
87 TimeZone => 'My__string',
88 }, # OPTIONAL
89 PubliclyAccessible => 1, # OPTIONAL
90 SecurityGroups => [ 'My__string', ... ], # OPTIONAL
91 StorageType => 'EBS', # OPTIONAL
92 SubnetIds => [ 'My__string', ... ], # OPTIONAL
93 Tags => { 'My__string' => 'My__string', }, # OPTIONAL
94 Users => [
95 {
96 ConsoleAccess => 1,
97 Groups => [ 'My__string', ... ], # OPTIONAL
98 Password => 'My__string',
99 Username => 'My__string',
100 },
101 ...
102 ], # OPTIONAL
103 );
104  
105 # Results:
106 my $BrokerArn = $CreateBrokerResponse->BrokerArn;
107 my $BrokerId = $CreateBrokerResponse->BrokerId;
108  
109 # Returns a L<Paws::MQ::CreateBrokerResponse> object.
110  
111 Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object.
112 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/mq/CreateBroker>
113  
114 =head1 ATTRIBUTES
115  
116  
117 =head2 AuthenticationStrategy => Str
118  
119 The authentication strategy used to secure the broker.
120  
121 Valid values are: C<"SIMPLE">, C<"LDAP">
122  
123 =head2 AutoMinorVersionUpgrade => Bool
124  
125 Required. Enables automatic upgrades to new minor versions for brokers,
126 as Apache releases the versions. The automatic upgrades occur during
127 the maintenance window of the broker or after a manual broker reboot.
128  
129  
130  
131 =head2 BrokerName => Str
132  
133 Required. The name of the broker. This value must be unique in your AWS
134 account, 1-50 characters long, must contain only letters, numbers,
135 dashes, and underscores, and must not contain whitespaces, brackets,
136 wildcard characters, or special characters.
137  
138  
139  
140 =head2 Configuration => L<Paws::MQ::ConfigurationId>
141  
142 A list of information about the configuration.
143  
144  
145  
146 =head2 CreatorRequestId => Str
147  
148 The unique ID that the requester receives for the created broker.
149 Amazon MQ passes your ID with the API action. Note: We recommend using
150 a Universally Unique Identifier (UUID) for the creatorRequestId. You
151 may omit the creatorRequestId if your application doesn't require
152 idempotency.
153  
154  
155  
156 =head2 DeploymentMode => Str
157  
158 Required. The deployment mode of the broker.
159  
160 Valid values are: C<"SINGLE_INSTANCE">, C<"ACTIVE_STANDBY_MULTI_AZ">, C<"CLUSTER_MULTI_AZ">
161  
162 =head2 EncryptionOptions => L<Paws::MQ::EncryptionOptions>
163  
164 Encryption options for the broker.
165  
166  
167  
168 =head2 EngineType => Str
169  
170 Required. The type of broker engine. Note: Currently, Amazon MQ
171 supports ACTIVEMQ and RABBITMQ.
172  
173 Valid values are: C<"ACTIVEMQ">, C<"RABBITMQ">
174  
175 =head2 EngineVersion => Str
176  
177 Required. The version of the broker engine. For a list of supported
178 engine versions, see
179 https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html
180  
181  
182  
183 =head2 HostInstanceType => Str
184  
185 Required. The broker's instance type.
186  
187  
188  
189 =head2 LdapServerMetadata => L<Paws::MQ::LdapServerMetadataInput>
190  
191 The metadata of the LDAP server used to authenticate and authorize
192 connections to the broker.
193  
194  
195  
196 =head2 Logs => L<Paws::MQ::Logs>
197  
198 Enables Amazon CloudWatch logging for brokers.
199  
200  
201  
202 =head2 MaintenanceWindowStartTime => L<Paws::MQ::WeeklyStartTime>
203  
204 The parameters that determine the WeeklyStartTime.
205  
206  
207  
208 =head2 PubliclyAccessible => Bool
209  
210 Required. Enables connections from applications outside of the VPC that
211 hosts the broker's subnets.
212  
213  
214  
215 =head2 SecurityGroups => ArrayRef[Str|Undef]
216  
217 The list of security groups (1 minimum, 5 maximum) that authorizes
218 connections to brokers.
219  
220  
221  
222 =head2 StorageType => Str
223  
224 The broker's storage type.
225  
226 Valid values are: C<"EBS">, C<"EFS">
227  
228 =head2 SubnetIds => ArrayRef[Str|Undef]
229  
230 The list of groups that define which subnets and IP ranges the broker
231 can use from different Availability Zones. A SINGLE_INSTANCE deployment
232 requires one subnet (for example, the default subnet). An
233 ACTIVE_STANDBY_MULTI_AZ deployment (ACTIVEMQ) requires two subnets. A
234 CLUSTER_MULTI_AZ deployment (RABBITMQ) has no subnet requirements when
235 deployed with public accessibility, deployment without public
236 accessibility requires at least one subnet.
237  
238  
239  
240 =head2 Tags => L<Paws::MQ::__mapOf__string>
241  
242 Create tags when creating the broker.
243  
244  
245  
246 =head2 Users => ArrayRef[L<Paws::MQ::User>]
247  
248 Required. The list of broker users (persons or applications) who can
249 access queues and topics. For RabbitMQ brokers, one and only one
250 administrative user is accepted and created when a broker is first
251 provisioned. All subsequent broker users are created by making RabbitMQ
252 API calls directly to brokers or via the RabbitMQ Web Console. This
253 value can contain only alphanumeric characters, dashes, periods,
254 underscores, and tildes (- . _ ~). This value must be 2-100 characters
255 long.
256  
257  
258  
259  
260 =head1 SEE ALSO
261  
262 This class forms part of L<Paws>, documenting arguments for method CreateBroker in L<Paws::MQ>
263  
264 =head1 BUGS and CONTRIBUTIONS
265  
266 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
267  
268 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
269  
270 =cut
271