aws-sdk-cloudhsm 1.0.0.rc1 → 1.0.0.rc2

Sign up to get free protection for your applications and to get access to all the features.
@@ -1,23 +1,14 @@
1
1
  # WARNING ABOUT GENERATED CODE
2
2
  #
3
- # This file is generated. See the contributing for info on making contributions:
3
+ # This file is generated. See the contributing guide for more information:
4
4
  # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
5
  #
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
- module Aws
9
- module CloudHSM
10
- module Errors
8
+ module Aws::CloudHSM
9
+ module Errors
11
10
 
12
- extend Aws::Errors::DynamicErrors
11
+ extend Aws::Errors::DynamicErrors
13
12
 
14
- # Raised when calling #load or #data on a resource class that can not be
15
- # loaded. This can happen when:
16
- #
17
- # * A resource class has identifiers, but no data attributes.
18
- # * Resource data is only available when making an API call that
19
- # enumerates all resources of that type.
20
- class ResourceNotLoadable < RuntimeError; end
21
- end
22
13
  end
23
14
  end
@@ -1,25 +1,23 @@
1
1
  # WARNING ABOUT GENERATED CODE
2
2
  #
3
- # This file is generated. See the contributing for info on making contributions:
3
+ # This file is generated. See the contributing guide for more information:
4
4
  # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
5
  #
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
- module Aws
9
- module CloudHSM
10
- class Resource
8
+ module Aws::CloudHSM
9
+ class Resource
11
10
 
12
- # @param options ({})
13
- # @option options [Client] :client
14
- def initialize(options = {})
15
- @client = options[:client] || Client.new(options)
16
- end
17
-
18
- # @return [Client]
19
- def client
20
- @client
21
- end
11
+ # @param options ({})
12
+ # @option options [Client] :client
13
+ def initialize(options = {})
14
+ @client = options[:client] || Client.new(options)
15
+ end
22
16
 
17
+ # @return [Client]
18
+ def client
19
+ @client
23
20
  end
21
+
24
22
  end
25
23
  end
@@ -1,844 +1,1004 @@
1
1
  # WARNING ABOUT GENERATED CODE
2
2
  #
3
- # This file is generated. See the contributing for info on making contributions:
3
+ # This file is generated. See the contributing guide for more information:
4
4
  # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
5
  #
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
- module Aws
9
- module CloudHSM
10
- module Types
11
-
12
- # @note When making an API call, pass AddTagsToResourceRequest
13
- # data as a hash:
14
- #
15
- # {
16
- # resource_arn: "String", # required
17
- # tag_list: [ # required
18
- # {
19
- # key: "TagKey", # required
20
- # value: "TagValue", # required
21
- # },
22
- # ],
23
- # }
24
- # @!attribute [rw] resource_arn
25
- # The Amazon Resource Name (ARN) of the AWS CloudHSM resource to tag.
26
- # @return [String]
27
- #
28
- # @!attribute [rw] tag_list
29
- # One or more tags.
30
- # @return [Array<Types::Tag>]
31
- class AddTagsToResourceRequest < Struct.new(
32
- :resource_arn,
33
- :tag_list)
34
- include Aws::Structure
35
- end
36
-
37
- # @!attribute [rw] status
38
- # The status of the operation.
39
- # @return [String]
40
- class AddTagsToResourceResponse < Struct.new(
41
- :status)
42
- include Aws::Structure
43
- end
44
-
45
- # Contains the inputs for the CreateHapgRequest action.
46
- # @note When making an API call, pass CreateHapgRequest
47
- # data as a hash:
48
- #
49
- # {
50
- # label: "Label", # required
51
- # }
52
- # @!attribute [rw] label
53
- # The label of the new high-availability partition group.
54
- # @return [String]
55
- class CreateHapgRequest < Struct.new(
56
- :label)
57
- include Aws::Structure
58
- end
59
-
60
- # Contains the output of the CreateHAPartitionGroup action.
61
- # @!attribute [rw] hapg_arn
62
- # The ARN of the high-availability partition group.
63
- # @return [String]
64
- class CreateHapgResponse < Struct.new(
65
- :hapg_arn)
66
- include Aws::Structure
67
- end
68
-
69
- # Contains the inputs for the CreateHsm operation.
70
- # @note When making an API call, pass CreateHsmRequest
71
- # data as a hash:
72
- #
73
- # {
74
- # subnet_id: "SubnetId", # required
75
- # ssh_key: "SshKey", # required
76
- # eni_ip: "IpAddress",
77
- # iam_role_arn: "IamRoleArn", # required
78
- # external_id: "ExternalId",
79
- # subscription_type: "PRODUCTION", # required, accepts PRODUCTION
80
- # client_token: "ClientToken",
81
- # syslog_ip: "IpAddress",
82
- # }
83
- # @!attribute [rw] subnet_id
84
- # The identifier of the subnet in your VPC in which to place the HSM.
85
- # @return [String]
86
- #
87
- # @!attribute [rw] ssh_key
88
- # The SSH public key to install on the HSM.
89
- # @return [String]
90
- #
91
- # @!attribute [rw] eni_ip
92
- # The IP address to assign to the HSM's ENI.
93
- #
94
- # If an IP address is not specified, an IP address will be randomly
95
- # chosen from the CIDR range of the subnet.
96
- # @return [String]
97
- #
98
- # @!attribute [rw] iam_role_arn
99
- # The ARN of an IAM role to enable the AWS CloudHSM service to
100
- # allocate an ENI on your behalf.
101
- # @return [String]
102
- #
103
- # @!attribute [rw] external_id
104
- # The external ID from **IamRoleArn**, if present.
105
- # @return [String]
106
- #
107
- # @!attribute [rw] subscription_type
108
- # Specifies the type of subscription for the HSM.
109
- #
110
- # * **PRODUCTION** - The HSM is being used in a production
111
- # environment.
112
- # * **TRIAL** - The HSM is being used in a product trial.
113
- # @return [String]
114
- #
115
- # @!attribute [rw] client_token
116
- # A user-defined token to ensure idempotence. Subsequent calls to this
117
- # operation with the same token will be ignored.
118
- # @return [String]
119
- #
120
- # @!attribute [rw] syslog_ip
121
- # The IP address for the syslog monitoring server. The AWS CloudHSM
122
- # service only supports one syslog monitoring server.
123
- # @return [String]
124
- class CreateHsmRequest < Struct.new(
125
- :subnet_id,
126
- :ssh_key,
127
- :eni_ip,
128
- :iam_role_arn,
129
- :external_id,
130
- :subscription_type,
131
- :client_token,
132
- :syslog_ip)
133
- include Aws::Structure
134
- end
135
-
136
- # Contains the output of the CreateHsm operation.
137
- # @!attribute [rw] hsm_arn
138
- # The ARN of the HSM.
139
- # @return [String]
140
- class CreateHsmResponse < Struct.new(
141
- :hsm_arn)
142
- include Aws::Structure
143
- end
144
-
145
- # Contains the inputs for the CreateLunaClient action.
146
- # @note When making an API call, pass CreateLunaClientRequest
147
- # data as a hash:
148
- #
149
- # {
150
- # label: "ClientLabel",
151
- # certificate: "Certificate", # required
152
- # }
153
- # @!attribute [rw] label
154
- # The label for the client.
155
- # @return [String]
156
- #
157
- # @!attribute [rw] certificate
158
- # The contents of a Base64-Encoded X.509 v3 certificate to be
159
- # installed on the HSMs used by this client.
160
- # @return [String]
161
- class CreateLunaClientRequest < Struct.new(
162
- :label,
163
- :certificate)
164
- include Aws::Structure
165
- end
166
-
167
- # Contains the output of the CreateLunaClient action.
168
- # @!attribute [rw] client_arn
169
- # The ARN of the client.
170
- # @return [String]
171
- class CreateLunaClientResponse < Struct.new(
172
- :client_arn)
173
- include Aws::Structure
174
- end
175
-
176
- # Contains the inputs for the DeleteHapg action.
177
- # @note When making an API call, pass DeleteHapgRequest
178
- # data as a hash:
179
- #
180
- # {
181
- # hapg_arn: "HapgArn", # required
182
- # }
183
- # @!attribute [rw] hapg_arn
184
- # The ARN of the high-availability partition group to delete.
185
- # @return [String]
186
- class DeleteHapgRequest < Struct.new(
187
- :hapg_arn)
188
- include Aws::Structure
189
- end
190
-
191
- # Contains the output of the DeleteHapg action.
192
- # @!attribute [rw] status
193
- # The status of the action.
194
- # @return [String]
195
- class DeleteHapgResponse < Struct.new(
196
- :status)
197
- include Aws::Structure
198
- end
199
-
200
- # Contains the inputs for the DeleteHsm operation.
201
- # @note When making an API call, pass DeleteHsmRequest
202
- # data as a hash:
203
- #
204
- # {
205
- # hsm_arn: "HsmArn", # required
206
- # }
207
- # @!attribute [rw] hsm_arn
208
- # The ARN of the HSM to delete.
209
- # @return [String]
210
- class DeleteHsmRequest < Struct.new(
211
- :hsm_arn)
212
- include Aws::Structure
213
- end
214
-
215
- # Contains the output of the DeleteHsm operation.
216
- # @!attribute [rw] status
217
- # The status of the operation.
218
- # @return [String]
219
- class DeleteHsmResponse < Struct.new(
220
- :status)
221
- include Aws::Structure
222
- end
223
-
224
- # @note When making an API call, pass DeleteLunaClientRequest
225
- # data as a hash:
226
- #
227
- # {
228
- # client_arn: "ClientArn", # required
229
- # }
230
- # @!attribute [rw] client_arn
231
- # The ARN of the client to delete.
232
- # @return [String]
233
- class DeleteLunaClientRequest < Struct.new(
234
- :client_arn)
235
- include Aws::Structure
236
- end
237
-
238
- # @!attribute [rw] status
239
- # The status of the action.
240
- # @return [String]
241
- class DeleteLunaClientResponse < Struct.new(
242
- :status)
243
- include Aws::Structure
244
- end
245
-
246
- # Contains the inputs for the DescribeHapg action.
247
- # @note When making an API call, pass DescribeHapgRequest
248
- # data as a hash:
249
- #
250
- # {
251
- # hapg_arn: "HapgArn", # required
252
- # }
253
- # @!attribute [rw] hapg_arn
254
- # The ARN of the high-availability partition group to describe.
255
- # @return [String]
256
- class DescribeHapgRequest < Struct.new(
257
- :hapg_arn)
258
- include Aws::Structure
259
- end
260
-
261
- # Contains the output of the DescribeHapg action.
262
- # @!attribute [rw] hapg_arn
263
- # The ARN of the high-availability partition group.
264
- # @return [String]
265
- #
266
- # @!attribute [rw] hapg_serial
267
- # The serial number of the high-availability partition group.
268
- # @return [String]
269
- #
270
- # @!attribute [rw] hsms_last_action_failed
271
- # Contains a list of ARNs that identify the HSMs.
272
- # @return [Array<String>]
273
- #
274
- # @!attribute [rw] hsms_pending_deletion
275
- # Contains a list of ARNs that identify the HSMs.
276
- # @return [Array<String>]
277
- #
278
- # @!attribute [rw] hsms_pending_registration
279
- # Contains a list of ARNs that identify the HSMs.
280
- # @return [Array<String>]
281
- #
282
- # @!attribute [rw] label
283
- # The label for the high-availability partition group.
284
- # @return [String]
285
- #
286
- # @!attribute [rw] last_modified_timestamp
287
- # The date and time the high-availability partition group was last
288
- # modified.
289
- # @return [String]
290
- #
291
- # @!attribute [rw] partition_serial_list
292
- # The list of partition serial numbers that belong to the
293
- # high-availability partition group.
294
- # @return [Array<String>]
295
- #
296
- # @!attribute [rw] state
297
- # The state of the high-availability partition group.
298
- # @return [String]
299
- class DescribeHapgResponse < Struct.new(
300
- :hapg_arn,
301
- :hapg_serial,
302
- :hsms_last_action_failed,
303
- :hsms_pending_deletion,
304
- :hsms_pending_registration,
305
- :label,
306
- :last_modified_timestamp,
307
- :partition_serial_list,
308
- :state)
309
- include Aws::Structure
310
- end
311
-
312
- # Contains the inputs for the DescribeHsm operation.
313
- # @note When making an API call, pass DescribeHsmRequest
314
- # data as a hash:
315
- #
316
- # {
317
- # hsm_arn: "HsmArn",
318
- # hsm_serial_number: "HsmSerialNumber",
319
- # }
320
- # @!attribute [rw] hsm_arn
321
- # The ARN of the HSM. Either the *HsmArn* or the *SerialNumber*
322
- # parameter must be specified.
323
- # @return [String]
324
- #
325
- # @!attribute [rw] hsm_serial_number
326
- # The serial number of the HSM. Either the *HsmArn* or the
327
- # *HsmSerialNumber* parameter must be specified.
328
- # @return [String]
329
- class DescribeHsmRequest < Struct.new(
330
- :hsm_arn,
331
- :hsm_serial_number)
332
- include Aws::Structure
333
- end
334
-
335
- # Contains the output of the DescribeHsm operation.
336
- # @!attribute [rw] hsm_arn
337
- # The ARN of the HSM.
338
- # @return [String]
339
- #
340
- # @!attribute [rw] status
341
- # The status of the HSM.
342
- # @return [String]
343
- #
344
- # @!attribute [rw] status_details
345
- # Contains additional information about the status of the HSM.
346
- # @return [String]
347
- #
348
- # @!attribute [rw] availability_zone
349
- # The Availability Zone that the HSM is in.
350
- # @return [String]
351
- #
352
- # @!attribute [rw] eni_id
353
- # The identifier of the elastic network interface (ENI) attached to
354
- # the HSM.
355
- # @return [String]
356
- #
357
- # @!attribute [rw] eni_ip
358
- # The IP address assigned to the HSM's ENI.
359
- # @return [String]
360
- #
361
- # @!attribute [rw] subscription_type
362
- # Specifies the type of subscription for the HSM.
363
- #
364
- # * **PRODUCTION** - The HSM is being used in a production
365
- # environment.
366
- # * **TRIAL** - The HSM is being used in a product trial.
367
- # @return [String]
368
- #
369
- # @!attribute [rw] subscription_start_date
370
- # The subscription start date.
371
- # @return [String]
372
- #
373
- # @!attribute [rw] subscription_end_date
374
- # The subscription end date.
375
- # @return [String]
376
- #
377
- # @!attribute [rw] vpc_id
378
- # The identifier of the VPC that the HSM is in.
379
- # @return [String]
380
- #
381
- # @!attribute [rw] subnet_id
382
- # The identifier of the subnet that the HSM is in.
383
- # @return [String]
384
- #
385
- # @!attribute [rw] iam_role_arn
386
- # The ARN of the IAM role assigned to the HSM.
387
- # @return [String]
388
- #
389
- # @!attribute [rw] serial_number
390
- # The serial number of the HSM.
391
- # @return [String]
392
- #
393
- # @!attribute [rw] vendor_name
394
- # The name of the HSM vendor.
395
- # @return [String]
396
- #
397
- # @!attribute [rw] hsm_type
398
- # The HSM model type.
399
- # @return [String]
400
- #
401
- # @!attribute [rw] software_version
402
- # The HSM software version.
403
- # @return [String]
404
- #
405
- # @!attribute [rw] ssh_public_key
406
- # The public SSH key.
407
- # @return [String]
408
- #
409
- # @!attribute [rw] ssh_key_last_updated
410
- # The date and time that the SSH key was last updated.
411
- # @return [String]
412
- #
413
- # @!attribute [rw] server_cert_uri
414
- # The URI of the certificate server.
415
- # @return [String]
416
- #
417
- # @!attribute [rw] server_cert_last_updated
418
- # The date and time that the server certificate was last updated.
419
- # @return [String]
420
- #
421
- # @!attribute [rw] partitions
422
- # The list of partitions on the HSM.
423
- # @return [Array<String>]
424
- class DescribeHsmResponse < Struct.new(
425
- :hsm_arn,
426
- :status,
427
- :status_details,
428
- :availability_zone,
429
- :eni_id,
430
- :eni_ip,
431
- :subscription_type,
432
- :subscription_start_date,
433
- :subscription_end_date,
434
- :vpc_id,
435
- :subnet_id,
436
- :iam_role_arn,
437
- :serial_number,
438
- :vendor_name,
439
- :hsm_type,
440
- :software_version,
441
- :ssh_public_key,
442
- :ssh_key_last_updated,
443
- :server_cert_uri,
444
- :server_cert_last_updated,
445
- :partitions)
446
- include Aws::Structure
447
- end
448
-
449
- # @note When making an API call, pass DescribeLunaClientRequest
450
- # data as a hash:
451
- #
452
- # {
453
- # client_arn: "ClientArn",
454
- # certificate_fingerprint: "CertificateFingerprint",
455
- # }
456
- # @!attribute [rw] client_arn
457
- # The ARN of the client.
458
- # @return [String]
459
- #
460
- # @!attribute [rw] certificate_fingerprint
461
- # The certificate fingerprint.
462
- # @return [String]
463
- class DescribeLunaClientRequest < Struct.new(
464
- :client_arn,
465
- :certificate_fingerprint)
466
- include Aws::Structure
467
- end
468
-
469
- # @!attribute [rw] client_arn
470
- # The ARN of the client.
471
- # @return [String]
472
- #
473
- # @!attribute [rw] certificate
474
- # The certificate installed on the HSMs used by this client.
475
- # @return [String]
476
- #
477
- # @!attribute [rw] certificate_fingerprint
478
- # The certificate fingerprint.
479
- # @return [String]
480
- #
481
- # @!attribute [rw] last_modified_timestamp
482
- # The date and time the client was last modified.
483
- # @return [String]
484
- #
485
- # @!attribute [rw] label
486
- # The label of the client.
487
- # @return [String]
488
- class DescribeLunaClientResponse < Struct.new(
489
- :client_arn,
490
- :certificate,
491
- :certificate_fingerprint,
492
- :last_modified_timestamp,
493
- :label)
494
- include Aws::Structure
495
- end
496
-
497
- # @note When making an API call, pass GetConfigRequest
498
- # data as a hash:
499
- #
500
- # {
501
- # client_arn: "ClientArn", # required
502
- # client_version: "5.1", # required, accepts 5.1, 5.3
503
- # hapg_list: ["HapgArn"], # required
504
- # }
505
- # @!attribute [rw] client_arn
506
- # The ARN of the client.
507
- # @return [String]
508
- #
509
- # @!attribute [rw] client_version
510
- # The client version.
511
- # @return [String]
512
- #
513
- # @!attribute [rw] hapg_list
514
- # A list of ARNs that identify the high-availability partition groups
515
- # that are associated with the client.
516
- # @return [Array<String>]
517
- class GetConfigRequest < Struct.new(
518
- :client_arn,
519
- :client_version,
520
- :hapg_list)
521
- include Aws::Structure
522
- end
523
-
524
- # @!attribute [rw] config_type
525
- # The type of credentials.
526
- # @return [String]
527
- #
528
- # @!attribute [rw] config_file
529
- # The chrystoki.conf configuration file.
530
- # @return [String]
531
- #
532
- # @!attribute [rw] config_cred
533
- # The certificate file containing the server.pem files of the HSMs.
534
- # @return [String]
535
- class GetConfigResponse < Struct.new(
536
- :config_type,
537
- :config_file,
538
- :config_cred)
539
- include Aws::Structure
540
- end
541
-
542
- # Contains the inputs for the ListAvailableZones action.
543
- # @api private
544
- class ListAvailableZonesRequest < Aws::EmptyStructure; end
545
-
546
- # @!attribute [rw] az_list
547
- # The list of Availability Zones that have available AWS CloudHSM
548
- # capacity.
549
- # @return [Array<String>]
550
- class ListAvailableZonesResponse < Struct.new(
551
- :az_list)
552
- include Aws::Structure
553
- end
554
-
555
- # @note When making an API call, pass ListHapgsRequest
556
- # data as a hash:
557
- #
558
- # {
559
- # next_token: "PaginationToken",
560
- # }
561
- # @!attribute [rw] next_token
562
- # The *NextToken* value from a previous call to ListHapgs. Pass null
563
- # if this is the first call.
564
- # @return [String]
565
- class ListHapgsRequest < Struct.new(
566
- :next_token)
567
- include Aws::Structure
568
- end
569
-
570
- # @!attribute [rw] hapg_list
571
- # The list of high-availability partition groups.
572
- # @return [Array<String>]
573
- #
574
- # @!attribute [rw] next_token
575
- # If not null, more results are available. Pass this value to
576
- # ListHapgs to retrieve the next set of items.
577
- # @return [String]
578
- class ListHapgsResponse < Struct.new(
579
- :hapg_list,
580
- :next_token)
581
- include Aws::Structure
582
- end
583
-
584
- # @note When making an API call, pass ListHsmsRequest
585
- # data as a hash:
586
- #
587
- # {
588
- # next_token: "PaginationToken",
589
- # }
590
- # @!attribute [rw] next_token
591
- # The *NextToken* value from a previous call to ListHsms. Pass null if
592
- # this is the first call.
593
- # @return [String]
594
- class ListHsmsRequest < Struct.new(
595
- :next_token)
596
- include Aws::Structure
597
- end
598
-
599
- # Contains the output of the ListHsms operation.
600
- # @!attribute [rw] hsm_list
601
- # The list of ARNs that identify the HSMs.
602
- # @return [Array<String>]
603
- #
604
- # @!attribute [rw] next_token
605
- # If not null, more results are available. Pass this value to ListHsms
606
- # to retrieve the next set of items.
607
- # @return [String]
608
- class ListHsmsResponse < Struct.new(
609
- :hsm_list,
610
- :next_token)
611
- include Aws::Structure
612
- end
613
-
614
- # @note When making an API call, pass ListLunaClientsRequest
615
- # data as a hash:
616
- #
617
- # {
618
- # next_token: "PaginationToken",
619
- # }
620
- # @!attribute [rw] next_token
621
- # The *NextToken* value from a previous call to ListLunaClients. Pass
622
- # null if this is the first call.
623
- # @return [String]
624
- class ListLunaClientsRequest < Struct.new(
625
- :next_token)
626
- include Aws::Structure
627
- end
628
-
629
- # @!attribute [rw] client_list
630
- # The list of clients.
631
- # @return [Array<String>]
632
- #
633
- # @!attribute [rw] next_token
634
- # If not null, more results are available. Pass this to
635
- # ListLunaClients to retrieve the next set of items.
636
- # @return [String]
637
- class ListLunaClientsResponse < Struct.new(
638
- :client_list,
639
- :next_token)
640
- include Aws::Structure
641
- end
642
-
643
- # @note When making an API call, pass ListTagsForResourceRequest
644
- # data as a hash:
645
- #
646
- # {
647
- # resource_arn: "String", # required
648
- # }
649
- # @!attribute [rw] resource_arn
650
- # The Amazon Resource Name (ARN) of the AWS CloudHSM resource.
651
- # @return [String]
652
- class ListTagsForResourceRequest < Struct.new(
653
- :resource_arn)
654
- include Aws::Structure
655
- end
656
-
657
- # @!attribute [rw] tag_list
658
- # One or more tags.
659
- # @return [Array<Types::Tag>]
660
- class ListTagsForResourceResponse < Struct.new(
661
- :tag_list)
662
- include Aws::Structure
663
- end
664
-
665
- # @note When making an API call, pass ModifyHapgRequest
666
- # data as a hash:
667
- #
668
- # {
669
- # hapg_arn: "HapgArn", # required
670
- # label: "Label",
671
- # partition_serial_list: ["PartitionSerial"],
672
- # }
673
- # @!attribute [rw] hapg_arn
674
- # The ARN of the high-availability partition group to modify.
675
- # @return [String]
676
- #
677
- # @!attribute [rw] label
678
- # The new label for the high-availability partition group.
679
- # @return [String]
680
- #
681
- # @!attribute [rw] partition_serial_list
682
- # The list of partition serial numbers to make members of the
683
- # high-availability partition group.
684
- # @return [Array<String>]
685
- class ModifyHapgRequest < Struct.new(
686
- :hapg_arn,
687
- :label,
688
- :partition_serial_list)
689
- include Aws::Structure
690
- end
691
-
692
- # @!attribute [rw] hapg_arn
693
- # The ARN of the high-availability partition group.
694
- # @return [String]
695
- class ModifyHapgResponse < Struct.new(
696
- :hapg_arn)
697
- include Aws::Structure
698
- end
699
-
700
- # Contains the inputs for the ModifyHsm operation.
701
- # @note When making an API call, pass ModifyHsmRequest
702
- # data as a hash:
703
- #
704
- # {
705
- # hsm_arn: "HsmArn", # required
706
- # subnet_id: "SubnetId",
707
- # eni_ip: "IpAddress",
708
- # iam_role_arn: "IamRoleArn",
709
- # external_id: "ExternalId",
710
- # syslog_ip: "IpAddress",
711
- # }
712
- # @!attribute [rw] hsm_arn
713
- # The ARN of the HSM to modify.
714
- # @return [String]
715
- #
716
- # @!attribute [rw] subnet_id
717
- # The new identifier of the subnet that the HSM is in. The new subnet
718
- # must be in the same Availability Zone as the current subnet.
719
- # @return [String]
720
- #
721
- # @!attribute [rw] eni_ip
722
- # The new IP address for the elastic network interface (ENI) attached
723
- # to the HSM.
724
- #
725
- # If the HSM is moved to a different subnet, and an IP address is not
726
- # specified, an IP address will be randomly chosen from the CIDR range
727
- # of the new subnet.
728
- # @return [String]
729
- #
730
- # @!attribute [rw] iam_role_arn
731
- # The new IAM role ARN.
732
- # @return [String]
733
- #
734
- # @!attribute [rw] external_id
735
- # The new external ID.
736
- # @return [String]
737
- #
738
- # @!attribute [rw] syslog_ip
739
- # The new IP address for the syslog monitoring server. The AWS
740
- # CloudHSM service only supports one syslog monitoring server.
741
- # @return [String]
742
- class ModifyHsmRequest < Struct.new(
743
- :hsm_arn,
744
- :subnet_id,
745
- :eni_ip,
746
- :iam_role_arn,
747
- :external_id,
748
- :syslog_ip)
749
- include Aws::Structure
750
- end
751
-
752
- # Contains the output of the ModifyHsm operation.
753
- # @!attribute [rw] hsm_arn
754
- # The ARN of the HSM.
755
- # @return [String]
756
- class ModifyHsmResponse < Struct.new(
757
- :hsm_arn)
758
- include Aws::Structure
759
- end
760
-
761
- # @note When making an API call, pass ModifyLunaClientRequest
762
- # data as a hash:
763
- #
764
- # {
765
- # client_arn: "ClientArn", # required
766
- # certificate: "Certificate", # required
767
- # }
768
- # @!attribute [rw] client_arn
769
- # The ARN of the client.
770
- # @return [String]
771
- #
772
- # @!attribute [rw] certificate
773
- # The new certificate for the client.
774
- # @return [String]
775
- class ModifyLunaClientRequest < Struct.new(
776
- :client_arn,
777
- :certificate)
778
- include Aws::Structure
779
- end
780
-
781
- # @!attribute [rw] client_arn
782
- # The ARN of the client.
783
- # @return [String]
784
- class ModifyLunaClientResponse < Struct.new(
785
- :client_arn)
786
- include Aws::Structure
787
- end
788
-
789
- # @note When making an API call, pass RemoveTagsFromResourceRequest
790
- # data as a hash:
791
- #
792
- # {
793
- # resource_arn: "String", # required
794
- # tag_key_list: ["TagKey"], # required
795
- # }
796
- # @!attribute [rw] resource_arn
797
- # The Amazon Resource Name (ARN) of the AWS CloudHSM resource.
798
- # @return [String]
799
- #
800
- # @!attribute [rw] tag_key_list
801
- # The tag key or keys to remove.
802
- #
803
- # Specify only the tag key to remove (not the value). To overwrite the
804
- # value for an existing tag, use AddTagsToResource.
805
- # @return [Array<String>]
806
- class RemoveTagsFromResourceRequest < Struct.new(
807
- :resource_arn,
808
- :tag_key_list)
809
- include Aws::Structure
810
- end
811
-
812
- # @!attribute [rw] status
813
- # The status of the operation.
814
- # @return [String]
815
- class RemoveTagsFromResourceResponse < Struct.new(
816
- :status)
817
- include Aws::Structure
818
- end
819
-
820
- # A key-value pair that identifies or specifies metadata about an AWS
821
- # CloudHSM resource.
822
- # @note When making an API call, pass Tag
823
- # data as a hash:
824
- #
825
- # {
826
- # key: "TagKey", # required
827
- # value: "TagValue", # required
828
- # }
829
- # @!attribute [rw] key
830
- # The key of the tag.
831
- # @return [String]
832
- #
833
- # @!attribute [rw] value
834
- # The value of the tag.
835
- # @return [String]
836
- class Tag < Struct.new(
837
- :key,
838
- :value)
839
- include Aws::Structure
840
- end
8
+ module Aws::CloudHSM
9
+ module Types
10
+
11
+ # @note When making an API call, you may pass AddTagsToResourceRequest
12
+ # data as a hash:
13
+ #
14
+ # {
15
+ # resource_arn: "String", # required
16
+ # tag_list: [ # required
17
+ # {
18
+ # key: "TagKey", # required
19
+ # value: "TagValue", # required
20
+ # },
21
+ # ],
22
+ # }
23
+ #
24
+ # @!attribute [rw] resource_arn
25
+ # The Amazon Resource Name (ARN) of the AWS CloudHSM resource to tag.
26
+ # @return [String]
27
+ #
28
+ # @!attribute [rw] tag_list
29
+ # One or more tags.
30
+ # @return [Array<Types::Tag>]
31
+ #
32
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30/AddTagsToResourceRequest AWS API Documentation
33
+ #
34
+ class AddTagsToResourceRequest < Struct.new(
35
+ :resource_arn,
36
+ :tag_list)
37
+ include Aws::Structure
38
+ end
39
+
40
+ # @!attribute [rw] status
41
+ # The status of the operation.
42
+ # @return [String]
43
+ #
44
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30/AddTagsToResourceResponse AWS API Documentation
45
+ #
46
+ class AddTagsToResourceResponse < Struct.new(
47
+ :status)
48
+ include Aws::Structure
49
+ end
50
+
51
+ # Contains the inputs for the CreateHapgRequest action.
52
+ #
53
+ # @note When making an API call, you may pass CreateHapgRequest
54
+ # data as a hash:
55
+ #
56
+ # {
57
+ # label: "Label", # required
58
+ # }
59
+ #
60
+ # @!attribute [rw] label
61
+ # The label of the new high-availability partition group.
62
+ # @return [String]
63
+ #
64
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30/CreateHapgRequest AWS API Documentation
65
+ #
66
+ class CreateHapgRequest < Struct.new(
67
+ :label)
68
+ include Aws::Structure
69
+ end
70
+
71
+ # Contains the output of the CreateHAPartitionGroup action.
72
+ #
73
+ # @!attribute [rw] hapg_arn
74
+ # The ARN of the high-availability partition group.
75
+ # @return [String]
76
+ #
77
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30/CreateHapgResponse AWS API Documentation
78
+ #
79
+ class CreateHapgResponse < Struct.new(
80
+ :hapg_arn)
81
+ include Aws::Structure
82
+ end
83
+
84
+ # Contains the inputs for the CreateHsm operation.
85
+ #
86
+ # @note When making an API call, you may pass CreateHsmRequest
87
+ # data as a hash:
88
+ #
89
+ # {
90
+ # subnet_id: "SubnetId", # required
91
+ # ssh_key: "SshKey", # required
92
+ # eni_ip: "IpAddress",
93
+ # iam_role_arn: "IamRoleArn", # required
94
+ # external_id: "ExternalId",
95
+ # subscription_type: "PRODUCTION", # required, accepts PRODUCTION
96
+ # client_token: "ClientToken",
97
+ # syslog_ip: "IpAddress",
98
+ # }
99
+ #
100
+ # @!attribute [rw] subnet_id
101
+ # The identifier of the subnet in your VPC in which to place the HSM.
102
+ # @return [String]
103
+ #
104
+ # @!attribute [rw] ssh_key
105
+ # The SSH public key to install on the HSM.
106
+ # @return [String]
107
+ #
108
+ # @!attribute [rw] eni_ip
109
+ # The IP address to assign to the HSM's ENI.
110
+ #
111
+ # If an IP address is not specified, an IP address will be randomly
112
+ # chosen from the CIDR range of the subnet.
113
+ # @return [String]
114
+ #
115
+ # @!attribute [rw] iam_role_arn
116
+ # The ARN of an IAM role to enable the AWS CloudHSM service to
117
+ # allocate an ENI on your behalf.
118
+ # @return [String]
119
+ #
120
+ # @!attribute [rw] external_id
121
+ # The external ID from **IamRoleArn**, if present.
122
+ # @return [String]
123
+ #
124
+ # @!attribute [rw] subscription_type
125
+ # Specifies the type of subscription for the HSM.
126
+ #
127
+ # * **PRODUCTION** - The HSM is being used in a production
128
+ # environment.
129
+ # * **TRIAL** - The HSM is being used in a product trial.
130
+ # @return [String]
131
+ #
132
+ # @!attribute [rw] client_token
133
+ # A user-defined token to ensure idempotence. Subsequent calls to this
134
+ # operation with the same token will be ignored.
135
+ # @return [String]
136
+ #
137
+ # @!attribute [rw] syslog_ip
138
+ # The IP address for the syslog monitoring server. The AWS CloudHSM
139
+ # service only supports one syslog monitoring server.
140
+ # @return [String]
141
+ #
142
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30/CreateHsmRequest AWS API Documentation
143
+ #
144
+ class CreateHsmRequest < Struct.new(
145
+ :subnet_id,
146
+ :ssh_key,
147
+ :eni_ip,
148
+ :iam_role_arn,
149
+ :external_id,
150
+ :subscription_type,
151
+ :client_token,
152
+ :syslog_ip)
153
+ include Aws::Structure
154
+ end
155
+
156
+ # Contains the output of the CreateHsm operation.
157
+ #
158
+ # @!attribute [rw] hsm_arn
159
+ # The ARN of the HSM.
160
+ # @return [String]
161
+ #
162
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30/CreateHsmResponse AWS API Documentation
163
+ #
164
+ class CreateHsmResponse < Struct.new(
165
+ :hsm_arn)
166
+ include Aws::Structure
167
+ end
168
+
169
+ # Contains the inputs for the CreateLunaClient action.
170
+ #
171
+ # @note When making an API call, you may pass CreateLunaClientRequest
172
+ # data as a hash:
173
+ #
174
+ # {
175
+ # label: "ClientLabel",
176
+ # certificate: "Certificate", # required
177
+ # }
178
+ #
179
+ # @!attribute [rw] label
180
+ # The label for the client.
181
+ # @return [String]
182
+ #
183
+ # @!attribute [rw] certificate
184
+ # The contents of a Base64-Encoded X.509 v3 certificate to be
185
+ # installed on the HSMs used by this client.
186
+ # @return [String]
187
+ #
188
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30/CreateLunaClientRequest AWS API Documentation
189
+ #
190
+ class CreateLunaClientRequest < Struct.new(
191
+ :label,
192
+ :certificate)
193
+ include Aws::Structure
194
+ end
195
+
196
+ # Contains the output of the CreateLunaClient action.
197
+ #
198
+ # @!attribute [rw] client_arn
199
+ # The ARN of the client.
200
+ # @return [String]
201
+ #
202
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30/CreateLunaClientResponse AWS API Documentation
203
+ #
204
+ class CreateLunaClientResponse < Struct.new(
205
+ :client_arn)
206
+ include Aws::Structure
207
+ end
208
+
209
+ # Contains the inputs for the DeleteHapg action.
210
+ #
211
+ # @note When making an API call, you may pass DeleteHapgRequest
212
+ # data as a hash:
213
+ #
214
+ # {
215
+ # hapg_arn: "HapgArn", # required
216
+ # }
217
+ #
218
+ # @!attribute [rw] hapg_arn
219
+ # The ARN of the high-availability partition group to delete.
220
+ # @return [String]
221
+ #
222
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30/DeleteHapgRequest AWS API Documentation
223
+ #
224
+ class DeleteHapgRequest < Struct.new(
225
+ :hapg_arn)
226
+ include Aws::Structure
227
+ end
228
+
229
+ # Contains the output of the DeleteHapg action.
230
+ #
231
+ # @!attribute [rw] status
232
+ # The status of the action.
233
+ # @return [String]
234
+ #
235
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30/DeleteHapgResponse AWS API Documentation
236
+ #
237
+ class DeleteHapgResponse < Struct.new(
238
+ :status)
239
+ include Aws::Structure
240
+ end
241
+
242
+ # Contains the inputs for the DeleteHsm operation.
243
+ #
244
+ # @note When making an API call, you may pass DeleteHsmRequest
245
+ # data as a hash:
246
+ #
247
+ # {
248
+ # hsm_arn: "HsmArn", # required
249
+ # }
250
+ #
251
+ # @!attribute [rw] hsm_arn
252
+ # The ARN of the HSM to delete.
253
+ # @return [String]
254
+ #
255
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30/DeleteHsmRequest AWS API Documentation
256
+ #
257
+ class DeleteHsmRequest < Struct.new(
258
+ :hsm_arn)
259
+ include Aws::Structure
260
+ end
261
+
262
+ # Contains the output of the DeleteHsm operation.
263
+ #
264
+ # @!attribute [rw] status
265
+ # The status of the operation.
266
+ # @return [String]
267
+ #
268
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30/DeleteHsmResponse AWS API Documentation
269
+ #
270
+ class DeleteHsmResponse < Struct.new(
271
+ :status)
272
+ include Aws::Structure
273
+ end
274
+
275
+ # @note When making an API call, you may pass DeleteLunaClientRequest
276
+ # data as a hash:
277
+ #
278
+ # {
279
+ # client_arn: "ClientArn", # required
280
+ # }
281
+ #
282
+ # @!attribute [rw] client_arn
283
+ # The ARN of the client to delete.
284
+ # @return [String]
285
+ #
286
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30/DeleteLunaClientRequest AWS API Documentation
287
+ #
288
+ class DeleteLunaClientRequest < Struct.new(
289
+ :client_arn)
290
+ include Aws::Structure
291
+ end
292
+
293
+ # @!attribute [rw] status
294
+ # The status of the action.
295
+ # @return [String]
296
+ #
297
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30/DeleteLunaClientResponse AWS API Documentation
298
+ #
299
+ class DeleteLunaClientResponse < Struct.new(
300
+ :status)
301
+ include Aws::Structure
302
+ end
303
+
304
+ # Contains the inputs for the DescribeHapg action.
305
+ #
306
+ # @note When making an API call, you may pass DescribeHapgRequest
307
+ # data as a hash:
308
+ #
309
+ # {
310
+ # hapg_arn: "HapgArn", # required
311
+ # }
312
+ #
313
+ # @!attribute [rw] hapg_arn
314
+ # The ARN of the high-availability partition group to describe.
315
+ # @return [String]
316
+ #
317
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30/DescribeHapgRequest AWS API Documentation
318
+ #
319
+ class DescribeHapgRequest < Struct.new(
320
+ :hapg_arn)
321
+ include Aws::Structure
322
+ end
323
+
324
+ # Contains the output of the DescribeHapg action.
325
+ #
326
+ # @!attribute [rw] hapg_arn
327
+ # The ARN of the high-availability partition group.
328
+ # @return [String]
329
+ #
330
+ # @!attribute [rw] hapg_serial
331
+ # The serial number of the high-availability partition group.
332
+ # @return [String]
333
+ #
334
+ # @!attribute [rw] hsms_last_action_failed
335
+ # Contains a list of ARNs that identify the HSMs.
336
+ # @return [Array<String>]
337
+ #
338
+ # @!attribute [rw] hsms_pending_deletion
339
+ # Contains a list of ARNs that identify the HSMs.
340
+ # @return [Array<String>]
341
+ #
342
+ # @!attribute [rw] hsms_pending_registration
343
+ # Contains a list of ARNs that identify the HSMs.
344
+ # @return [Array<String>]
345
+ #
346
+ # @!attribute [rw] label
347
+ # The label for the high-availability partition group.
348
+ # @return [String]
349
+ #
350
+ # @!attribute [rw] last_modified_timestamp
351
+ # The date and time the high-availability partition group was last
352
+ # modified.
353
+ # @return [String]
354
+ #
355
+ # @!attribute [rw] partition_serial_list
356
+ # The list of partition serial numbers that belong to the
357
+ # high-availability partition group.
358
+ # @return [Array<String>]
359
+ #
360
+ # @!attribute [rw] state
361
+ # The state of the high-availability partition group.
362
+ # @return [String]
363
+ #
364
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30/DescribeHapgResponse AWS API Documentation
365
+ #
366
+ class DescribeHapgResponse < Struct.new(
367
+ :hapg_arn,
368
+ :hapg_serial,
369
+ :hsms_last_action_failed,
370
+ :hsms_pending_deletion,
371
+ :hsms_pending_registration,
372
+ :label,
373
+ :last_modified_timestamp,
374
+ :partition_serial_list,
375
+ :state)
376
+ include Aws::Structure
377
+ end
378
+
379
+ # Contains the inputs for the DescribeHsm operation.
380
+ #
381
+ # @note When making an API call, you may pass DescribeHsmRequest
382
+ # data as a hash:
383
+ #
384
+ # {
385
+ # hsm_arn: "HsmArn",
386
+ # hsm_serial_number: "HsmSerialNumber",
387
+ # }
388
+ #
389
+ # @!attribute [rw] hsm_arn
390
+ # The ARN of the HSM. Either the *HsmArn* or the *SerialNumber*
391
+ # parameter must be specified.
392
+ # @return [String]
393
+ #
394
+ # @!attribute [rw] hsm_serial_number
395
+ # The serial number of the HSM. Either the *HsmArn* or the
396
+ # *HsmSerialNumber* parameter must be specified.
397
+ # @return [String]
398
+ #
399
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30/DescribeHsmRequest AWS API Documentation
400
+ #
401
+ class DescribeHsmRequest < Struct.new(
402
+ :hsm_arn,
403
+ :hsm_serial_number)
404
+ include Aws::Structure
405
+ end
406
+
407
+ # Contains the output of the DescribeHsm operation.
408
+ #
409
+ # @!attribute [rw] hsm_arn
410
+ # The ARN of the HSM.
411
+ # @return [String]
412
+ #
413
+ # @!attribute [rw] status
414
+ # The status of the HSM.
415
+ # @return [String]
416
+ #
417
+ # @!attribute [rw] status_details
418
+ # Contains additional information about the status of the HSM.
419
+ # @return [String]
420
+ #
421
+ # @!attribute [rw] availability_zone
422
+ # The Availability Zone that the HSM is in.
423
+ # @return [String]
424
+ #
425
+ # @!attribute [rw] eni_id
426
+ # The identifier of the elastic network interface (ENI) attached to
427
+ # the HSM.
428
+ # @return [String]
429
+ #
430
+ # @!attribute [rw] eni_ip
431
+ # The IP address assigned to the HSM's ENI.
432
+ # @return [String]
433
+ #
434
+ # @!attribute [rw] subscription_type
435
+ # Specifies the type of subscription for the HSM.
436
+ #
437
+ # * **PRODUCTION** - The HSM is being used in a production
438
+ # environment.
439
+ # * **TRIAL** - The HSM is being used in a product trial.
440
+ # @return [String]
441
+ #
442
+ # @!attribute [rw] subscription_start_date
443
+ # The subscription start date.
444
+ # @return [String]
445
+ #
446
+ # @!attribute [rw] subscription_end_date
447
+ # The subscription end date.
448
+ # @return [String]
449
+ #
450
+ # @!attribute [rw] vpc_id
451
+ # The identifier of the VPC that the HSM is in.
452
+ # @return [String]
453
+ #
454
+ # @!attribute [rw] subnet_id
455
+ # The identifier of the subnet that the HSM is in.
456
+ # @return [String]
457
+ #
458
+ # @!attribute [rw] iam_role_arn
459
+ # The ARN of the IAM role assigned to the HSM.
460
+ # @return [String]
461
+ #
462
+ # @!attribute [rw] serial_number
463
+ # The serial number of the HSM.
464
+ # @return [String]
465
+ #
466
+ # @!attribute [rw] vendor_name
467
+ # The name of the HSM vendor.
468
+ # @return [String]
469
+ #
470
+ # @!attribute [rw] hsm_type
471
+ # The HSM model type.
472
+ # @return [String]
473
+ #
474
+ # @!attribute [rw] software_version
475
+ # The HSM software version.
476
+ # @return [String]
477
+ #
478
+ # @!attribute [rw] ssh_public_key
479
+ # The public SSH key.
480
+ # @return [String]
481
+ #
482
+ # @!attribute [rw] ssh_key_last_updated
483
+ # The date and time that the SSH key was last updated.
484
+ # @return [String]
485
+ #
486
+ # @!attribute [rw] server_cert_uri
487
+ # The URI of the certificate server.
488
+ # @return [String]
489
+ #
490
+ # @!attribute [rw] server_cert_last_updated
491
+ # The date and time that the server certificate was last updated.
492
+ # @return [String]
493
+ #
494
+ # @!attribute [rw] partitions
495
+ # The list of partitions on the HSM.
496
+ # @return [Array<String>]
497
+ #
498
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30/DescribeHsmResponse AWS API Documentation
499
+ #
500
+ class DescribeHsmResponse < Struct.new(
501
+ :hsm_arn,
502
+ :status,
503
+ :status_details,
504
+ :availability_zone,
505
+ :eni_id,
506
+ :eni_ip,
507
+ :subscription_type,
508
+ :subscription_start_date,
509
+ :subscription_end_date,
510
+ :vpc_id,
511
+ :subnet_id,
512
+ :iam_role_arn,
513
+ :serial_number,
514
+ :vendor_name,
515
+ :hsm_type,
516
+ :software_version,
517
+ :ssh_public_key,
518
+ :ssh_key_last_updated,
519
+ :server_cert_uri,
520
+ :server_cert_last_updated,
521
+ :partitions)
522
+ include Aws::Structure
523
+ end
524
+
525
+ # @note When making an API call, you may pass DescribeLunaClientRequest
526
+ # data as a hash:
527
+ #
528
+ # {
529
+ # client_arn: "ClientArn",
530
+ # certificate_fingerprint: "CertificateFingerprint",
531
+ # }
532
+ #
533
+ # @!attribute [rw] client_arn
534
+ # The ARN of the client.
535
+ # @return [String]
536
+ #
537
+ # @!attribute [rw] certificate_fingerprint
538
+ # The certificate fingerprint.
539
+ # @return [String]
540
+ #
541
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30/DescribeLunaClientRequest AWS API Documentation
542
+ #
543
+ class DescribeLunaClientRequest < Struct.new(
544
+ :client_arn,
545
+ :certificate_fingerprint)
546
+ include Aws::Structure
547
+ end
548
+
549
+ # @!attribute [rw] client_arn
550
+ # The ARN of the client.
551
+ # @return [String]
552
+ #
553
+ # @!attribute [rw] certificate
554
+ # The certificate installed on the HSMs used by this client.
555
+ # @return [String]
556
+ #
557
+ # @!attribute [rw] certificate_fingerprint
558
+ # The certificate fingerprint.
559
+ # @return [String]
560
+ #
561
+ # @!attribute [rw] last_modified_timestamp
562
+ # The date and time the client was last modified.
563
+ # @return [String]
564
+ #
565
+ # @!attribute [rw] label
566
+ # The label of the client.
567
+ # @return [String]
568
+ #
569
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30/DescribeLunaClientResponse AWS API Documentation
570
+ #
571
+ class DescribeLunaClientResponse < Struct.new(
572
+ :client_arn,
573
+ :certificate,
574
+ :certificate_fingerprint,
575
+ :last_modified_timestamp,
576
+ :label)
577
+ include Aws::Structure
578
+ end
841
579
 
580
+ # @note When making an API call, you may pass GetConfigRequest
581
+ # data as a hash:
582
+ #
583
+ # {
584
+ # client_arn: "ClientArn", # required
585
+ # client_version: "5.1", # required, accepts 5.1, 5.3
586
+ # hapg_list: ["HapgArn"], # required
587
+ # }
588
+ #
589
+ # @!attribute [rw] client_arn
590
+ # The ARN of the client.
591
+ # @return [String]
592
+ #
593
+ # @!attribute [rw] client_version
594
+ # The client version.
595
+ # @return [String]
596
+ #
597
+ # @!attribute [rw] hapg_list
598
+ # A list of ARNs that identify the high-availability partition groups
599
+ # that are associated with the client.
600
+ # @return [Array<String>]
601
+ #
602
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30/GetConfigRequest AWS API Documentation
603
+ #
604
+ class GetConfigRequest < Struct.new(
605
+ :client_arn,
606
+ :client_version,
607
+ :hapg_list)
608
+ include Aws::Structure
842
609
  end
610
+
611
+ # @!attribute [rw] config_type
612
+ # The type of credentials.
613
+ # @return [String]
614
+ #
615
+ # @!attribute [rw] config_file
616
+ # The chrystoki.conf configuration file.
617
+ # @return [String]
618
+ #
619
+ # @!attribute [rw] config_cred
620
+ # The certificate file containing the server.pem files of the HSMs.
621
+ # @return [String]
622
+ #
623
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30/GetConfigResponse AWS API Documentation
624
+ #
625
+ class GetConfigResponse < Struct.new(
626
+ :config_type,
627
+ :config_file,
628
+ :config_cred)
629
+ include Aws::Structure
630
+ end
631
+
632
+ # Contains the inputs for the ListAvailableZones action.
633
+ #
634
+ # @api private
635
+ #
636
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30/ListAvailableZonesRequest AWS API Documentation
637
+ #
638
+ class ListAvailableZonesRequest < Aws::EmptyStructure; end
639
+
640
+ # @!attribute [rw] az_list
641
+ # The list of Availability Zones that have available AWS CloudHSM
642
+ # capacity.
643
+ # @return [Array<String>]
644
+ #
645
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30/ListAvailableZonesResponse AWS API Documentation
646
+ #
647
+ class ListAvailableZonesResponse < Struct.new(
648
+ :az_list)
649
+ include Aws::Structure
650
+ end
651
+
652
+ # @note When making an API call, you may pass ListHapgsRequest
653
+ # data as a hash:
654
+ #
655
+ # {
656
+ # next_token: "PaginationToken",
657
+ # }
658
+ #
659
+ # @!attribute [rw] next_token
660
+ # The *NextToken* value from a previous call to ListHapgs. Pass null
661
+ # if this is the first call.
662
+ # @return [String]
663
+ #
664
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30/ListHapgsRequest AWS API Documentation
665
+ #
666
+ class ListHapgsRequest < Struct.new(
667
+ :next_token)
668
+ include Aws::Structure
669
+ end
670
+
671
+ # @!attribute [rw] hapg_list
672
+ # The list of high-availability partition groups.
673
+ # @return [Array<String>]
674
+ #
675
+ # @!attribute [rw] next_token
676
+ # If not null, more results are available. Pass this value to
677
+ # ListHapgs to retrieve the next set of items.
678
+ # @return [String]
679
+ #
680
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30/ListHapgsResponse AWS API Documentation
681
+ #
682
+ class ListHapgsResponse < Struct.new(
683
+ :hapg_list,
684
+ :next_token)
685
+ include Aws::Structure
686
+ end
687
+
688
+ # @note When making an API call, you may pass ListHsmsRequest
689
+ # data as a hash:
690
+ #
691
+ # {
692
+ # next_token: "PaginationToken",
693
+ # }
694
+ #
695
+ # @!attribute [rw] next_token
696
+ # The *NextToken* value from a previous call to ListHsms. Pass null if
697
+ # this is the first call.
698
+ # @return [String]
699
+ #
700
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30/ListHsmsRequest AWS API Documentation
701
+ #
702
+ class ListHsmsRequest < Struct.new(
703
+ :next_token)
704
+ include Aws::Structure
705
+ end
706
+
707
+ # Contains the output of the ListHsms operation.
708
+ #
709
+ # @!attribute [rw] hsm_list
710
+ # The list of ARNs that identify the HSMs.
711
+ # @return [Array<String>]
712
+ #
713
+ # @!attribute [rw] next_token
714
+ # If not null, more results are available. Pass this value to ListHsms
715
+ # to retrieve the next set of items.
716
+ # @return [String]
717
+ #
718
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30/ListHsmsResponse AWS API Documentation
719
+ #
720
+ class ListHsmsResponse < Struct.new(
721
+ :hsm_list,
722
+ :next_token)
723
+ include Aws::Structure
724
+ end
725
+
726
+ # @note When making an API call, you may pass ListLunaClientsRequest
727
+ # data as a hash:
728
+ #
729
+ # {
730
+ # next_token: "PaginationToken",
731
+ # }
732
+ #
733
+ # @!attribute [rw] next_token
734
+ # The *NextToken* value from a previous call to ListLunaClients. Pass
735
+ # null if this is the first call.
736
+ # @return [String]
737
+ #
738
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30/ListLunaClientsRequest AWS API Documentation
739
+ #
740
+ class ListLunaClientsRequest < Struct.new(
741
+ :next_token)
742
+ include Aws::Structure
743
+ end
744
+
745
+ # @!attribute [rw] client_list
746
+ # The list of clients.
747
+ # @return [Array<String>]
748
+ #
749
+ # @!attribute [rw] next_token
750
+ # If not null, more results are available. Pass this to
751
+ # ListLunaClients to retrieve the next set of items.
752
+ # @return [String]
753
+ #
754
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30/ListLunaClientsResponse AWS API Documentation
755
+ #
756
+ class ListLunaClientsResponse < Struct.new(
757
+ :client_list,
758
+ :next_token)
759
+ include Aws::Structure
760
+ end
761
+
762
+ # @note When making an API call, you may pass ListTagsForResourceRequest
763
+ # data as a hash:
764
+ #
765
+ # {
766
+ # resource_arn: "String", # required
767
+ # }
768
+ #
769
+ # @!attribute [rw] resource_arn
770
+ # The Amazon Resource Name (ARN) of the AWS CloudHSM resource.
771
+ # @return [String]
772
+ #
773
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30/ListTagsForResourceRequest AWS API Documentation
774
+ #
775
+ class ListTagsForResourceRequest < Struct.new(
776
+ :resource_arn)
777
+ include Aws::Structure
778
+ end
779
+
780
+ # @!attribute [rw] tag_list
781
+ # One or more tags.
782
+ # @return [Array<Types::Tag>]
783
+ #
784
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30/ListTagsForResourceResponse AWS API Documentation
785
+ #
786
+ class ListTagsForResourceResponse < Struct.new(
787
+ :tag_list)
788
+ include Aws::Structure
789
+ end
790
+
791
+ # @note When making an API call, you may pass ModifyHapgRequest
792
+ # data as a hash:
793
+ #
794
+ # {
795
+ # hapg_arn: "HapgArn", # required
796
+ # label: "Label",
797
+ # partition_serial_list: ["PartitionSerial"],
798
+ # }
799
+ #
800
+ # @!attribute [rw] hapg_arn
801
+ # The ARN of the high-availability partition group to modify.
802
+ # @return [String]
803
+ #
804
+ # @!attribute [rw] label
805
+ # The new label for the high-availability partition group.
806
+ # @return [String]
807
+ #
808
+ # @!attribute [rw] partition_serial_list
809
+ # The list of partition serial numbers to make members of the
810
+ # high-availability partition group.
811
+ # @return [Array<String>]
812
+ #
813
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30/ModifyHapgRequest AWS API Documentation
814
+ #
815
+ class ModifyHapgRequest < Struct.new(
816
+ :hapg_arn,
817
+ :label,
818
+ :partition_serial_list)
819
+ include Aws::Structure
820
+ end
821
+
822
+ # @!attribute [rw] hapg_arn
823
+ # The ARN of the high-availability partition group.
824
+ # @return [String]
825
+ #
826
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30/ModifyHapgResponse AWS API Documentation
827
+ #
828
+ class ModifyHapgResponse < Struct.new(
829
+ :hapg_arn)
830
+ include Aws::Structure
831
+ end
832
+
833
+ # Contains the inputs for the ModifyHsm operation.
834
+ #
835
+ # @note When making an API call, you may pass ModifyHsmRequest
836
+ # data as a hash:
837
+ #
838
+ # {
839
+ # hsm_arn: "HsmArn", # required
840
+ # subnet_id: "SubnetId",
841
+ # eni_ip: "IpAddress",
842
+ # iam_role_arn: "IamRoleArn",
843
+ # external_id: "ExternalId",
844
+ # syslog_ip: "IpAddress",
845
+ # }
846
+ #
847
+ # @!attribute [rw] hsm_arn
848
+ # The ARN of the HSM to modify.
849
+ # @return [String]
850
+ #
851
+ # @!attribute [rw] subnet_id
852
+ # The new identifier of the subnet that the HSM is in. The new subnet
853
+ # must be in the same Availability Zone as the current subnet.
854
+ # @return [String]
855
+ #
856
+ # @!attribute [rw] eni_ip
857
+ # The new IP address for the elastic network interface (ENI) attached
858
+ # to the HSM.
859
+ #
860
+ # If the HSM is moved to a different subnet, and an IP address is not
861
+ # specified, an IP address will be randomly chosen from the CIDR range
862
+ # of the new subnet.
863
+ # @return [String]
864
+ #
865
+ # @!attribute [rw] iam_role_arn
866
+ # The new IAM role ARN.
867
+ # @return [String]
868
+ #
869
+ # @!attribute [rw] external_id
870
+ # The new external ID.
871
+ # @return [String]
872
+ #
873
+ # @!attribute [rw] syslog_ip
874
+ # The new IP address for the syslog monitoring server. The AWS
875
+ # CloudHSM service only supports one syslog monitoring server.
876
+ # @return [String]
877
+ #
878
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30/ModifyHsmRequest AWS API Documentation
879
+ #
880
+ class ModifyHsmRequest < Struct.new(
881
+ :hsm_arn,
882
+ :subnet_id,
883
+ :eni_ip,
884
+ :iam_role_arn,
885
+ :external_id,
886
+ :syslog_ip)
887
+ include Aws::Structure
888
+ end
889
+
890
+ # Contains the output of the ModifyHsm operation.
891
+ #
892
+ # @!attribute [rw] hsm_arn
893
+ # The ARN of the HSM.
894
+ # @return [String]
895
+ #
896
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30/ModifyHsmResponse AWS API Documentation
897
+ #
898
+ class ModifyHsmResponse < Struct.new(
899
+ :hsm_arn)
900
+ include Aws::Structure
901
+ end
902
+
903
+ # @note When making an API call, you may pass ModifyLunaClientRequest
904
+ # data as a hash:
905
+ #
906
+ # {
907
+ # client_arn: "ClientArn", # required
908
+ # certificate: "Certificate", # required
909
+ # }
910
+ #
911
+ # @!attribute [rw] client_arn
912
+ # The ARN of the client.
913
+ # @return [String]
914
+ #
915
+ # @!attribute [rw] certificate
916
+ # The new certificate for the client.
917
+ # @return [String]
918
+ #
919
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30/ModifyLunaClientRequest AWS API Documentation
920
+ #
921
+ class ModifyLunaClientRequest < Struct.new(
922
+ :client_arn,
923
+ :certificate)
924
+ include Aws::Structure
925
+ end
926
+
927
+ # @!attribute [rw] client_arn
928
+ # The ARN of the client.
929
+ # @return [String]
930
+ #
931
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30/ModifyLunaClientResponse AWS API Documentation
932
+ #
933
+ class ModifyLunaClientResponse < Struct.new(
934
+ :client_arn)
935
+ include Aws::Structure
936
+ end
937
+
938
+ # @note When making an API call, you may pass RemoveTagsFromResourceRequest
939
+ # data as a hash:
940
+ #
941
+ # {
942
+ # resource_arn: "String", # required
943
+ # tag_key_list: ["TagKey"], # required
944
+ # }
945
+ #
946
+ # @!attribute [rw] resource_arn
947
+ # The Amazon Resource Name (ARN) of the AWS CloudHSM resource.
948
+ # @return [String]
949
+ #
950
+ # @!attribute [rw] tag_key_list
951
+ # The tag key or keys to remove.
952
+ #
953
+ # Specify only the tag key to remove (not the value). To overwrite the
954
+ # value for an existing tag, use AddTagsToResource.
955
+ # @return [Array<String>]
956
+ #
957
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30/RemoveTagsFromResourceRequest AWS API Documentation
958
+ #
959
+ class RemoveTagsFromResourceRequest < Struct.new(
960
+ :resource_arn,
961
+ :tag_key_list)
962
+ include Aws::Structure
963
+ end
964
+
965
+ # @!attribute [rw] status
966
+ # The status of the operation.
967
+ # @return [String]
968
+ #
969
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30/RemoveTagsFromResourceResponse AWS API Documentation
970
+ #
971
+ class RemoveTagsFromResourceResponse < Struct.new(
972
+ :status)
973
+ include Aws::Structure
974
+ end
975
+
976
+ # A key-value pair that identifies or specifies metadata about an AWS
977
+ # CloudHSM resource.
978
+ #
979
+ # @note When making an API call, you may pass Tag
980
+ # data as a hash:
981
+ #
982
+ # {
983
+ # key: "TagKey", # required
984
+ # value: "TagValue", # required
985
+ # }
986
+ #
987
+ # @!attribute [rw] key
988
+ # The key of the tag.
989
+ # @return [String]
990
+ #
991
+ # @!attribute [rw] value
992
+ # The value of the tag.
993
+ # @return [String]
994
+ #
995
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30/Tag AWS API Documentation
996
+ #
997
+ class Tag < Struct.new(
998
+ :key,
999
+ :value)
1000
+ include Aws::Structure
1001
+ end
1002
+
843
1003
  end
844
1004
  end