aws-sdk-acmpca 1.0.0 → 1.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-acmpca.rb +1 -1
- data/lib/aws-sdk-acmpca/client.rb +144 -81
- data/lib/aws-sdk-acmpca/client_api.rb +23 -0
- data/lib/aws-sdk-acmpca/types.rb +84 -47
- metadata +3 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 40cac150ba9219a77625e9176d5d13e2da24ac9e
|
4
|
+
data.tar.gz: 72aa0a8685abe3cbbd786b7333f3890d59f1fe07
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 0cd0ffe95fc7aad7d4f677473f90f3c75907aca77e05f5897c86b4047d4f12365847750add352987f5546d922663dee7ea865cf2a802d5f5ffda5cebbf18a999
|
7
|
+
data.tar.gz: 6ea223ebbc56e1d4989f2dfa869a09b22ef3065cd7a5be2e145b1889518140343c7e25aeff803929b94b9453e12487505b9f7b3e19631489e7824904fa6ca065
|
data/lib/aws-sdk-acmpca.rb
CHANGED
@@ -164,7 +164,7 @@ module Aws::ACMPCA
|
|
164
164
|
# list) configuration specifies the CRL expiration period in days (the
|
165
165
|
# validity period of the CRL), the Amazon S3 bucket that will contain
|
166
166
|
# the CRL, and a CNAME alias for the S3 bucket that is included in
|
167
|
-
# certificates issued by the CA. If successful, this
|
167
|
+
# certificates issued by the CA. If successful, this operation returns
|
168
168
|
# the Amazon Resource Name (ARN) of the CA.
|
169
169
|
#
|
170
170
|
# @option params [required, Types::CertificateAuthorityConfiguration] :certificate_authority_configuration
|
@@ -189,9 +189,9 @@ module Aws::ACMPCA
|
|
189
189
|
# minutes. Therefore, if you call **CreateCertificateAuthority**
|
190
190
|
# multiple times with the same idempotency token within a five minute
|
191
191
|
# period, ACM PCA recognizes that you are requesting only one
|
192
|
-
# certificate
|
193
|
-
# token for each call, however, ACM PCA recognizes that you
|
194
|
-
# requesting multiple certificates.
|
192
|
+
# certificate. As a result, ACM PCA issues only one. If you change the
|
193
|
+
# idempotency token for each call, however, ACM PCA recognizes that you
|
194
|
+
# are requesting multiple certificates.
|
195
195
|
#
|
196
196
|
# @return [Types::CreateCertificateAuthorityResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
197
197
|
#
|
@@ -247,14 +247,15 @@ module Aws::ACMPCA
|
|
247
247
|
|
248
248
|
# Creates an audit report that lists every time that the your CA private
|
249
249
|
# key is used. The report is saved in the Amazon S3 bucket that you
|
250
|
-
# specify on input. The IssueCertificate and RevokeCertificate
|
251
|
-
# use the private key. You can generate a new report every 30
|
250
|
+
# specify on input. The IssueCertificate and RevokeCertificate
|
251
|
+
# operations use the private key. You can generate a new report every 30
|
252
|
+
# minutes.
|
252
253
|
#
|
253
254
|
# @option params [required, String] :certificate_authority_arn
|
254
255
|
# Amazon Resource Name (ARN) of the CA to be audited. This is of the
|
255
256
|
# form:
|
256
257
|
#
|
257
|
-
# `arn:aws:acm:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
|
258
|
+
# `arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
|
258
259
|
# `.
|
259
260
|
#
|
260
261
|
# @option params [required, String] :s3_bucket_name
|
@@ -291,33 +292,48 @@ module Aws::ACMPCA
|
|
291
292
|
req.send_request(options)
|
292
293
|
end
|
293
294
|
|
294
|
-
# Deletes
|
295
|
-
#
|
296
|
-
#
|
297
|
-
#
|
298
|
-
#
|
299
|
-
#
|
300
|
-
#
|
301
|
-
# you
|
302
|
-
#
|
303
|
-
#
|
304
|
-
#
|
305
|
-
#
|
306
|
-
#
|
295
|
+
# Deletes a private certificate authority (CA). You must provide the ARN
|
296
|
+
# (Amazon Resource Name) of the private CA that you want to delete. You
|
297
|
+
# can find the ARN by calling the ListCertificateAuthorities operation.
|
298
|
+
# Before you can delete a CA, you must disable it. Call the
|
299
|
+
# UpdateCertificateAuthority operation and set the
|
300
|
+
# **CertificateAuthorityStatus** parameter to `DISABLED`.
|
301
|
+
#
|
302
|
+
# Additionally, you can delete a CA if you are waiting for it to be
|
303
|
+
# created (the **Status** field of the CertificateAuthority is
|
304
|
+
# `CREATING`). You can also delete it if the CA has been created but you
|
305
|
+
# haven't yet imported the signed certificate (the **Status** is
|
306
|
+
# `PENDING_CERTIFICATE`) into ACM PCA.
|
307
|
+
#
|
308
|
+
# If the CA is in one of the aforementioned states and you call
|
309
|
+
# DeleteCertificateAuthority, the CA's status changes to `DELETED`.
|
310
|
+
# However, the CA won't be permentantly deleted until the restoration
|
311
|
+
# period has passed. By default, if you do not set the
|
312
|
+
# `PermanentDeletionTimeInDays` parameter, the CA remains restorable for
|
313
|
+
# 30 days. You can set the parameter from 7 to 30 days. The
|
314
|
+
# DescribeCertificateAuthority operation returns the time remaining in
|
315
|
+
# the restoration window of a Private CA in the `DELETED` state. To
|
316
|
+
# restore an eligable CA, call the RestoreCertificateAuthority
|
317
|
+
# operation.
|
307
318
|
#
|
308
319
|
# @option params [required, String] :certificate_authority_arn
|
309
320
|
# The Amazon Resource Name (ARN) that was returned when you called
|
310
|
-
# CreateCertificateAuthority. This must
|
321
|
+
# CreateCertificateAuthority. This must have the following form:
|
311
322
|
#
|
312
|
-
# `arn:aws:acm:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
|
323
|
+
# `arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
|
313
324
|
# `.
|
314
325
|
#
|
326
|
+
# @option params [Integer] :permanent_deletion_time_in_days
|
327
|
+
# The number of days to make a CA restorable after it has been deleted.
|
328
|
+
# This can be anywhere from 7 to 30 days, with 30 being the default.
|
329
|
+
#
|
315
330
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
316
331
|
#
|
317
332
|
# @example Request syntax with placeholder values
|
318
333
|
#
|
319
334
|
# resp = client.delete_certificate_authority({
|
320
335
|
# certificate_authority_arn: "Arn", # required
|
336
|
+
# permanent_deletion_time_in_days: 1,
|
321
337
|
# })
|
322
338
|
#
|
323
339
|
# @see http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/DeleteCertificateAuthority AWS API Documentation
|
@@ -334,29 +350,33 @@ module Aws::ACMPCA
|
|
334
350
|
# output contains the status of your CA. This can be any of the
|
335
351
|
# following:
|
336
352
|
#
|
337
|
-
# *
|
338
|
-
# authority.
|
353
|
+
# * `CREATING` - ACM PCA is creating your private certificate authority.
|
339
354
|
#
|
340
|
-
# *
|
355
|
+
# * `PENDING_CERTIFICATE` - The certificate is pending. You must use
|
341
356
|
# your on-premises root or subordinate CA to sign your private CA CSR
|
342
357
|
# and then import it into PCA.
|
343
358
|
#
|
344
|
-
# *
|
359
|
+
# * `ACTIVE` - Your private CA is active.
|
345
360
|
#
|
346
|
-
# *
|
361
|
+
# * `DISABLED` - Your private CA has been disabled.
|
347
362
|
#
|
348
|
-
# *
|
363
|
+
# * `EXPIRED` - Your private CA certificate has expired.
|
349
364
|
#
|
350
|
-
# *
|
365
|
+
# * `FAILED` - Your private CA has failed. Your CA can fail because of
|
351
366
|
# problems such a network outage or backend AWS failure or other
|
352
367
|
# errors. A failed CA can never return to the pending state. You must
|
353
368
|
# create a new CA.
|
354
369
|
#
|
370
|
+
# * `DELETED` - Your private CA is within the restoration period, after
|
371
|
+
# which it will be permanently deleted. The length of time remaining
|
372
|
+
# in the CA's restoration period will also be included in this
|
373
|
+
# operation's output.
|
374
|
+
#
|
355
375
|
# @option params [required, String] :certificate_authority_arn
|
356
376
|
# The Amazon Resource Name (ARN) that was returned when you called
|
357
377
|
# CreateCertificateAuthority. This must be of the form:
|
358
378
|
#
|
359
|
-
# `arn:aws:acm:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
|
379
|
+
# `arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
|
360
380
|
# `.
|
361
381
|
#
|
362
382
|
# @return [Types::DescribeCertificateAuthorityResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -376,7 +396,7 @@ module Aws::ACMPCA
|
|
376
396
|
# resp.certificate_authority.last_state_change_at #=> Time
|
377
397
|
# resp.certificate_authority.type #=> String, one of "SUBORDINATE"
|
378
398
|
# resp.certificate_authority.serial #=> String
|
379
|
-
# resp.certificate_authority.status #=> String, one of "CREATING", "PENDING_CERTIFICATE", "ACTIVE", "DISABLED", "EXPIRED", "FAILED"
|
399
|
+
# resp.certificate_authority.status #=> String, one of "CREATING", "PENDING_CERTIFICATE", "ACTIVE", "DELETED", "DISABLED", "EXPIRED", "FAILED"
|
380
400
|
# resp.certificate_authority.not_before #=> Time
|
381
401
|
# resp.certificate_authority.not_after #=> Time
|
382
402
|
# resp.certificate_authority.failure_reason #=> String, one of "REQUEST_TIMED_OUT", "UNSUPPORTED_ALGORITHM", "OTHER"
|
@@ -400,6 +420,7 @@ module Aws::ACMPCA
|
|
400
420
|
# resp.certificate_authority.revocation_configuration.crl_configuration.expiration_in_days #=> Integer
|
401
421
|
# resp.certificate_authority.revocation_configuration.crl_configuration.custom_cname #=> String
|
402
422
|
# resp.certificate_authority.revocation_configuration.crl_configuration.s3_bucket_name #=> String
|
423
|
+
# resp.certificate_authority.restorable_until #=> Time
|
403
424
|
#
|
404
425
|
# @see http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/DescribeCertificateAuthority AWS API Documentation
|
405
426
|
#
|
@@ -411,21 +432,21 @@ module Aws::ACMPCA
|
|
411
432
|
end
|
412
433
|
|
413
434
|
# Lists information about a specific audit report created by calling the
|
414
|
-
# CreateCertificateAuthorityAuditReport
|
435
|
+
# CreateCertificateAuthorityAuditReport operation. Audit information is
|
415
436
|
# created every time the certificate authority (CA) private key is used.
|
416
|
-
# The private key is used when you call the IssueCertificate
|
417
|
-
# the RevokeCertificate
|
437
|
+
# The private key is used when you call the IssueCertificate operation
|
438
|
+
# or the RevokeCertificate operation.
|
418
439
|
#
|
419
440
|
# @option params [required, String] :certificate_authority_arn
|
420
441
|
# The Amazon Resource Name (ARN) of the private CA. This must be of the
|
421
442
|
# form:
|
422
443
|
#
|
423
|
-
# `arn:aws:acm:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
|
444
|
+
# `arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
|
424
445
|
# `.
|
425
446
|
#
|
426
447
|
# @option params [required, String] :audit_report_id
|
427
448
|
# The report ID returned by calling the
|
428
|
-
# CreateCertificateAuthorityAuditReport
|
449
|
+
# CreateCertificateAuthorityAuditReport operation.
|
429
450
|
#
|
430
451
|
# @return [Types::DescribeCertificateAuthorityAuditReportResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
431
452
|
#
|
@@ -458,11 +479,11 @@ module Aws::ACMPCA
|
|
458
479
|
end
|
459
480
|
|
460
481
|
# Retrieves a certificate from your private CA. The ARN of the
|
461
|
-
# certificate is returned when you call the IssueCertificate
|
482
|
+
# certificate is returned when you call the IssueCertificate operation.
|
462
483
|
# You must specify both the ARN of your private CA and the ARN of the
|
463
|
-
# issued certificate when calling the **GetCertificate**
|
484
|
+
# issued certificate when calling the **GetCertificate** operation. You
|
464
485
|
# can retrieve the certificate if it is in the **ISSUED** state. You can
|
465
|
-
# call the CreateCertificateAuthorityAuditReport
|
486
|
+
# call the CreateCertificateAuthorityAuditReport operation to create a
|
466
487
|
# report that contains information about all of the certificates issued
|
467
488
|
# and revoked by your private CA.
|
468
489
|
#
|
@@ -470,14 +491,14 @@ module Aws::ACMPCA
|
|
470
491
|
# The Amazon Resource Name (ARN) that was returned when you called
|
471
492
|
# CreateCertificateAuthority. This must be of the form:
|
472
493
|
#
|
473
|
-
# `arn:aws:acm:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
|
494
|
+
# `arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
|
474
495
|
# `.
|
475
496
|
#
|
476
497
|
# @option params [required, String] :certificate_arn
|
477
498
|
# The ARN of the issued certificate. The ARN contains the certificate
|
478
499
|
# serial number and must be in the following form:
|
479
500
|
#
|
480
|
-
# `arn:aws:acm:region:account:certificate-authority/12345678-1234-1234-1234-123456789012/certificate/286535153982981100925020015808220737245
|
501
|
+
# `arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012/certificate/286535153982981100925020015808220737245
|
481
502
|
# `
|
482
503
|
#
|
483
504
|
# @return [Types::GetCertificateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -515,7 +536,7 @@ module Aws::ACMPCA
|
|
515
536
|
# The Amazon Resource Name (ARN) of your private CA. This is of the
|
516
537
|
# form:
|
517
538
|
#
|
518
|
-
# `arn:aws:acm:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
|
539
|
+
# `arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
|
519
540
|
# `.
|
520
541
|
#
|
521
542
|
# @return [Types::GetCertificateAuthorityCertificateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -545,17 +566,17 @@ module Aws::ACMPCA
|
|
545
566
|
|
546
567
|
# Retrieves the certificate signing request (CSR) for your private
|
547
568
|
# certificate authority (CA). The CSR is created when you call the
|
548
|
-
# CreateCertificateAuthority
|
569
|
+
# CreateCertificateAuthority operation. Take the CSR to your on-premises
|
549
570
|
# X.509 infrastructure and sign it by using your root or a subordinate
|
550
571
|
# CA. Then import the signed certificate back into ACM PCA by calling
|
551
|
-
# the ImportCertificateAuthorityCertificate
|
572
|
+
# the ImportCertificateAuthorityCertificate operation. The CSR is
|
552
573
|
# returned as a base64 PEM-encoded string.
|
553
574
|
#
|
554
575
|
# @option params [required, String] :certificate_authority_arn
|
555
576
|
# The Amazon Resource Name (ARN) that was returned when you called the
|
556
|
-
# CreateCertificateAuthority
|
577
|
+
# CreateCertificateAuthority operation. This must be of the form:
|
557
578
|
#
|
558
|
-
# `arn:aws:acm:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
|
579
|
+
# `arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
|
559
580
|
# `
|
560
581
|
#
|
561
582
|
# @return [Types::GetCertificateAuthorityCsrResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -582,10 +603,10 @@ module Aws::ACMPCA
|
|
582
603
|
end
|
583
604
|
|
584
605
|
# Imports your signed private CA certificate into ACM PCA. Before you
|
585
|
-
# can call this
|
586
|
-
# authority by calling the CreateCertificateAuthority
|
587
|
-
# then generate a certificate signing request (CSR) by calling the
|
588
|
-
# GetCertificateAuthorityCsr
|
606
|
+
# can call this operation, you must create the private certificate
|
607
|
+
# authority by calling the CreateCertificateAuthority operation. You
|
608
|
+
# must then generate a certificate signing request (CSR) by calling the
|
609
|
+
# GetCertificateAuthorityCsr operation. Take the CSR to your on-premises
|
589
610
|
# CA and use the root certificate or a subordinate certificate to sign
|
590
611
|
# it. Create a certificate chain and copy the signed certificate and the
|
591
612
|
# certificate chain to your working directory.
|
@@ -611,7 +632,7 @@ module Aws::ACMPCA
|
|
611
632
|
# The Amazon Resource Name (ARN) that was returned when you called
|
612
633
|
# CreateCertificateAuthority. This must be of the form:
|
613
634
|
#
|
614
|
-
# `arn:aws:acm:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
|
635
|
+
# `arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
|
615
636
|
# `
|
616
637
|
#
|
617
638
|
# @option params [required, String, IO] :certificate
|
@@ -644,11 +665,11 @@ module Aws::ACMPCA
|
|
644
665
|
end
|
645
666
|
|
646
667
|
# Uses your private certificate authority (CA) to issue a client
|
647
|
-
# certificate. This
|
668
|
+
# certificate. This operation returns the Amazon Resource Name (ARN) of
|
648
669
|
# the certificate. You can retrieve the certificate by calling the
|
649
|
-
# GetCertificate
|
670
|
+
# GetCertificate operation and specifying the ARN.
|
650
671
|
#
|
651
|
-
# <note markdown="1"> You cannot use the ACM **ListCertificateAuthorities**
|
672
|
+
# <note markdown="1"> You cannot use the ACM **ListCertificateAuthorities** operation to
|
652
673
|
# retrieve the ARNs of the certificates that you issue by using ACM PCA.
|
653
674
|
#
|
654
675
|
# </note>
|
@@ -657,7 +678,7 @@ module Aws::ACMPCA
|
|
657
678
|
# The Amazon Resource Name (ARN) that was returned when you called
|
658
679
|
# CreateCertificateAuthority. This must be of the form:
|
659
680
|
#
|
660
|
-
# `arn:aws:acm:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
|
681
|
+
# `arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
|
661
682
|
# `
|
662
683
|
#
|
663
684
|
# @option params [required, String, IO] :csr
|
@@ -685,7 +706,7 @@ module Aws::ACMPCA
|
|
685
706
|
#
|
686
707
|
# @option params [String] :idempotency_token
|
687
708
|
# Custom string that can be used to distinguish between calls to the
|
688
|
-
# **IssueCertificate**
|
709
|
+
# **IssueCertificate** operation. Idempotency tokens time out after one
|
689
710
|
# hour. Therefore, if you call **IssueCertificate** multiple times with
|
690
711
|
# the same idempotency token within 5 minutes, ACM PCA recognizes that
|
691
712
|
# you are requesting only one certificate and will issue only one. If
|
@@ -723,7 +744,7 @@ module Aws::ACMPCA
|
|
723
744
|
end
|
724
745
|
|
725
746
|
# Lists the private certificate authorities that you created by using
|
726
|
-
# the CreateCertificateAuthority
|
747
|
+
# the CreateCertificateAuthority operation.
|
727
748
|
#
|
728
749
|
# @option params [String] :next_token
|
729
750
|
# Use this parameter when paginating results in a subsequent request
|
@@ -758,7 +779,7 @@ module Aws::ACMPCA
|
|
758
779
|
# resp.certificate_authorities[0].last_state_change_at #=> Time
|
759
780
|
# resp.certificate_authorities[0].type #=> String, one of "SUBORDINATE"
|
760
781
|
# resp.certificate_authorities[0].serial #=> String
|
761
|
-
# resp.certificate_authorities[0].status #=> String, one of "CREATING", "PENDING_CERTIFICATE", "ACTIVE", "DISABLED", "EXPIRED", "FAILED"
|
782
|
+
# resp.certificate_authorities[0].status #=> String, one of "CREATING", "PENDING_CERTIFICATE", "ACTIVE", "DELETED", "DISABLED", "EXPIRED", "FAILED"
|
762
783
|
# resp.certificate_authorities[0].not_before #=> Time
|
763
784
|
# resp.certificate_authorities[0].not_after #=> Time
|
764
785
|
# resp.certificate_authorities[0].failure_reason #=> String, one of "REQUEST_TIMED_OUT", "UNSUPPORTED_ALGORITHM", "OTHER"
|
@@ -782,6 +803,7 @@ module Aws::ACMPCA
|
|
782
803
|
# resp.certificate_authorities[0].revocation_configuration.crl_configuration.expiration_in_days #=> Integer
|
783
804
|
# resp.certificate_authorities[0].revocation_configuration.crl_configuration.custom_cname #=> String
|
784
805
|
# resp.certificate_authorities[0].revocation_configuration.crl_configuration.s3_bucket_name #=> String
|
806
|
+
# resp.certificate_authorities[0].restorable_until #=> Time
|
785
807
|
# resp.next_token #=> String
|
786
808
|
#
|
787
809
|
# @see http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/ListCertificateAuthorities AWS API Documentation
|
@@ -796,14 +818,14 @@ module Aws::ACMPCA
|
|
796
818
|
# Lists the tags, if any, that are associated with your private CA. Tags
|
797
819
|
# are labels that you can use to identify and organize your CAs. Each
|
798
820
|
# tag consists of a key and an optional value. Call the
|
799
|
-
# TagCertificateAuthority
|
800
|
-
# Call the UntagCertificateAuthority
|
821
|
+
# TagCertificateAuthority operation to add one or more tags to your CA.
|
822
|
+
# Call the UntagCertificateAuthority operation to remove tags.
|
801
823
|
#
|
802
824
|
# @option params [required, String] :certificate_authority_arn
|
803
825
|
# The Amazon Resource Name (ARN) that was returned when you called the
|
804
|
-
# CreateCertificateAuthority
|
826
|
+
# CreateCertificateAuthority operation. This must be of the form:
|
805
827
|
#
|
806
|
-
# `arn:aws:acm:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
|
828
|
+
# `arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
|
807
829
|
# `
|
808
830
|
#
|
809
831
|
# @option params [String] :next_token
|
@@ -847,8 +869,50 @@ module Aws::ACMPCA
|
|
847
869
|
req.send_request(options)
|
848
870
|
end
|
849
871
|
|
872
|
+
# Restores a certificate authority (CA) that is in the `DELETED` state.
|
873
|
+
# You can restore a CA during the period that you defined in the
|
874
|
+
# **PermanentDeletionTimeInDays** parameter of the
|
875
|
+
# DeleteCertificateAuthority operation. Currently, you can specify 7 to
|
876
|
+
# 30 days. If you did not specify a **PermanentDeletionTimeInDays**
|
877
|
+
# value, by default you can restore the CA at any time in a 30 day
|
878
|
+
# period. You can check the time remaining in the restoration period of
|
879
|
+
# a private CA in the `DELETED` state by calling the
|
880
|
+
# DescribeCertificateAuthority or ListCertificateAuthorities operations.
|
881
|
+
# The status of a restored CA is set to its pre-deletion status when the
|
882
|
+
# **RestoreCertificateAuthority** operation returns. To change its
|
883
|
+
# status to `ACTIVE`, call the UpdateCertificateAuthority operation. If
|
884
|
+
# the private CA was in the `PENDING_CERTIFICATE` state at deletion, you
|
885
|
+
# must use the ImportCertificateAuthorityCertificate operation to import
|
886
|
+
# a certificate authority into the private CA before it can be
|
887
|
+
# activated. You cannot restore a CA after the restoration period has
|
888
|
+
# ended.
|
889
|
+
#
|
890
|
+
# @option params [required, String] :certificate_authority_arn
|
891
|
+
# The Amazon Resource Name (ARN) that was returned when you called the
|
892
|
+
# CreateCertificateAuthority operation. This must be of the form:
|
893
|
+
#
|
894
|
+
# `arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
|
895
|
+
# `
|
896
|
+
#
|
897
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
898
|
+
#
|
899
|
+
# @example Request syntax with placeholder values
|
900
|
+
#
|
901
|
+
# resp = client.restore_certificate_authority({
|
902
|
+
# certificate_authority_arn: "Arn", # required
|
903
|
+
# })
|
904
|
+
#
|
905
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/RestoreCertificateAuthority AWS API Documentation
|
906
|
+
#
|
907
|
+
# @overload restore_certificate_authority(params = {})
|
908
|
+
# @param [Hash] params ({})
|
909
|
+
def restore_certificate_authority(params = {}, options = {})
|
910
|
+
req = build_request(:restore_certificate_authority, params)
|
911
|
+
req.send_request(options)
|
912
|
+
end
|
913
|
+
|
850
914
|
# Revokes a certificate that you issued by calling the IssueCertificate
|
851
|
-
#
|
915
|
+
# operation. If you enable a certificate revocation list (CRL) when you
|
852
916
|
# create or update your private CA, information about the revoked
|
853
917
|
# certificates will be included in the CRL. ACM PCA writes the CRL to an
|
854
918
|
# S3 bucket that you specify. For more information about revocation, see
|
@@ -860,7 +924,7 @@ module Aws::ACMPCA
|
|
860
924
|
# Amazon Resource Name (ARN) of the private CA that issued the
|
861
925
|
# certificate to be revoked. This must be of the form:
|
862
926
|
#
|
863
|
-
# `arn:aws:acm:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
|
927
|
+
# `arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
|
864
928
|
# `
|
865
929
|
#
|
866
930
|
# @option params [required, String] :certificate_serial
|
@@ -868,19 +932,19 @@ module Aws::ACMPCA
|
|
868
932
|
# hexadecimal format. You can retrieve the serial number by calling
|
869
933
|
# GetCertificate with the Amazon Resource Name (ARN) of the certificate
|
870
934
|
# you want and the ARN of your private CA. The **GetCertificate**
|
871
|
-
#
|
935
|
+
# operation retrieves the certificate in the PEM format. You can use the
|
872
936
|
# following OpenSSL command to list the certificate in text format and
|
873
937
|
# copy the hexadecimal serial number.
|
874
938
|
#
|
875
939
|
# `openssl x509 -in file_path -text -noout`
|
876
940
|
#
|
877
941
|
# You can also copy the serial number from the console or use the
|
878
|
-
# [DescribeCertificate][1]
|
942
|
+
# [DescribeCertificate][1] operation in the *AWS Certificate Manager API
|
879
943
|
# Reference*.
|
880
944
|
#
|
881
945
|
#
|
882
946
|
#
|
883
|
-
# [1]:
|
947
|
+
# [1]: https://docs.aws.amazon.com/acm/latest/APIReference/API_DescribeCertificate.html
|
884
948
|
#
|
885
949
|
# @option params [required, String] :revocation_reason
|
886
950
|
# Specifies why you revoked the certificate.
|
@@ -912,14 +976,14 @@ module Aws::ACMPCA
|
|
912
976
|
# to identify a specific characteristic of that CA, or you can apply the
|
913
977
|
# same tag to multiple private CAs if you want to filter for a common
|
914
978
|
# relationship among those CAs. To remove one or more tags, use the
|
915
|
-
# UntagCertificateAuthority
|
916
|
-
# what tags are associated with your CA.
|
979
|
+
# UntagCertificateAuthority operation. Call the ListTags operation to
|
980
|
+
# see what tags are associated with your CA.
|
917
981
|
#
|
918
982
|
# @option params [required, String] :certificate_authority_arn
|
919
983
|
# The Amazon Resource Name (ARN) that was returned when you called
|
920
984
|
# CreateCertificateAuthority. This must be of the form:
|
921
985
|
#
|
922
|
-
# `arn:aws:acm:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
|
986
|
+
# `arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
|
923
987
|
# `
|
924
988
|
#
|
925
989
|
# @option params [required, Array<Types::Tag>] :tags
|
@@ -950,17 +1014,17 @@ module Aws::ACMPCA
|
|
950
1014
|
|
951
1015
|
# Remove one or more tags from your private CA. A tag consists of a
|
952
1016
|
# key-value pair. If you do not specify the value portion of the tag
|
953
|
-
# when calling this
|
1017
|
+
# when calling this operation, the tag will be removed regardless of
|
954
1018
|
# value. If you specify a value, the tag is removed only if it is
|
955
1019
|
# associated with the specified value. To add tags to a private CA, use
|
956
|
-
# the TagCertificateAuthority. Call the ListTags
|
1020
|
+
# the TagCertificateAuthority. Call the ListTags operation to see what
|
957
1021
|
# tags are associated with your CA.
|
958
1022
|
#
|
959
1023
|
# @option params [required, String] :certificate_authority_arn
|
960
1024
|
# The Amazon Resource Name (ARN) that was returned when you called
|
961
1025
|
# CreateCertificateAuthority. This must be of the form:
|
962
1026
|
#
|
963
|
-
# `arn:aws:acm:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
|
1027
|
+
# `arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
|
964
1028
|
# `
|
965
1029
|
#
|
966
1030
|
# @option params [required, Array<Types::Tag>] :tags
|
@@ -990,17 +1054,16 @@ module Aws::ACMPCA
|
|
990
1054
|
end
|
991
1055
|
|
992
1056
|
# Updates the status or configuration of a private certificate authority
|
993
|
-
# (CA). Your private CA must be in the
|
994
|
-
#
|
995
|
-
#
|
996
|
-
#
|
997
|
-
# active again.
|
1057
|
+
# (CA). Your private CA must be in the `ACTIVE` or `DISABLED` state
|
1058
|
+
# before you can update it. You can disable a private CA that is in the
|
1059
|
+
# `ACTIVE` state or make a CA that is in the `DISABLED` state active
|
1060
|
+
# again.
|
998
1061
|
#
|
999
1062
|
# @option params [required, String] :certificate_authority_arn
|
1000
1063
|
# Amazon Resource Name (ARN) of the private CA that issued the
|
1001
1064
|
# certificate to be revoked. This must be of the form:
|
1002
1065
|
#
|
1003
|
-
# `arn:aws:acm:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
|
1066
|
+
# `arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
|
1004
1067
|
# `
|
1005
1068
|
#
|
1006
1069
|
# @option params [Types::RevocationConfiguration] :revocation_configuration
|
@@ -1023,7 +1086,7 @@ module Aws::ACMPCA
|
|
1023
1086
|
# s3_bucket_name: "String3To255",
|
1024
1087
|
# },
|
1025
1088
|
# },
|
1026
|
-
# status: "CREATING", # accepts CREATING, PENDING_CERTIFICATE, ACTIVE, DISABLED, EXPIRED, FAILED
|
1089
|
+
# status: "CREATING", # accepts CREATING, PENDING_CERTIFICATE, ACTIVE, DELETED, DISABLED, EXPIRED, FAILED
|
1027
1090
|
# })
|
1028
1091
|
#
|
1029
1092
|
# @see http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/UpdateCertificateAuthority AWS API Documentation
|
@@ -1048,7 +1111,7 @@ module Aws::ACMPCA
|
|
1048
1111
|
params: params,
|
1049
1112
|
config: config)
|
1050
1113
|
context[:gem_name] = 'aws-sdk-acmpca'
|
1051
|
-
context[:gem_version] = '1.
|
1114
|
+
context[:gem_version] = '1.1.0'
|
1052
1115
|
Seahorse::Client::Request.new(handlers, context)
|
1053
1116
|
end
|
1054
1117
|
|
@@ -70,11 +70,13 @@ module Aws::ACMPCA
|
|
70
70
|
MalformedCertificateException = Shapes::StructureShape.new(name: 'MalformedCertificateException')
|
71
71
|
MaxResults = Shapes::IntegerShape.new(name: 'MaxResults')
|
72
72
|
NextToken = Shapes::StringShape.new(name: 'NextToken')
|
73
|
+
PermanentDeletionTimeInDays = Shapes::IntegerShape.new(name: 'PermanentDeletionTimeInDays')
|
73
74
|
PositiveLong = Shapes::IntegerShape.new(name: 'PositiveLong')
|
74
75
|
RequestAlreadyProcessedException = Shapes::StructureShape.new(name: 'RequestAlreadyProcessedException')
|
75
76
|
RequestFailedException = Shapes::StructureShape.new(name: 'RequestFailedException')
|
76
77
|
RequestInProgressException = Shapes::StructureShape.new(name: 'RequestInProgressException')
|
77
78
|
ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException')
|
79
|
+
RestoreCertificateAuthorityRequest = Shapes::StructureShape.new(name: 'RestoreCertificateAuthorityRequest')
|
78
80
|
RevocationConfiguration = Shapes::StructureShape.new(name: 'RevocationConfiguration')
|
79
81
|
RevocationReason = Shapes::StringShape.new(name: 'RevocationReason')
|
80
82
|
RevokeCertificateRequest = Shapes::StructureShape.new(name: 'RevokeCertificateRequest')
|
@@ -129,6 +131,7 @@ module Aws::ACMPCA
|
|
129
131
|
CertificateAuthority.add_member(:failure_reason, Shapes::ShapeRef.new(shape: FailureReason, location_name: "FailureReason"))
|
130
132
|
CertificateAuthority.add_member(:certificate_authority_configuration, Shapes::ShapeRef.new(shape: CertificateAuthorityConfiguration, location_name: "CertificateAuthorityConfiguration"))
|
131
133
|
CertificateAuthority.add_member(:revocation_configuration, Shapes::ShapeRef.new(shape: RevocationConfiguration, location_name: "RevocationConfiguration"))
|
134
|
+
CertificateAuthority.add_member(:restorable_until, Shapes::ShapeRef.new(shape: TStamp, location_name: "RestorableUntil"))
|
132
135
|
CertificateAuthority.struct_class = Types::CertificateAuthority
|
133
136
|
|
134
137
|
CertificateAuthorityConfiguration.add_member(:key_algorithm, Shapes::ShapeRef.new(shape: KeyAlgorithm, required: true, location_name: "KeyAlgorithm"))
|
@@ -161,6 +164,7 @@ module Aws::ACMPCA
|
|
161
164
|
CrlConfiguration.struct_class = Types::CrlConfiguration
|
162
165
|
|
163
166
|
DeleteCertificateAuthorityRequest.add_member(:certificate_authority_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "CertificateAuthorityArn"))
|
167
|
+
DeleteCertificateAuthorityRequest.add_member(:permanent_deletion_time_in_days, Shapes::ShapeRef.new(shape: PermanentDeletionTimeInDays, location_name: "PermanentDeletionTimeInDays"))
|
164
168
|
DeleteCertificateAuthorityRequest.struct_class = Types::DeleteCertificateAuthorityRequest
|
165
169
|
|
166
170
|
DescribeCertificateAuthorityAuditReportRequest.add_member(:certificate_authority_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "CertificateAuthorityArn"))
|
@@ -232,6 +236,9 @@ module Aws::ACMPCA
|
|
232
236
|
ListTagsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
233
237
|
ListTagsResponse.struct_class = Types::ListTagsResponse
|
234
238
|
|
239
|
+
RestoreCertificateAuthorityRequest.add_member(:certificate_authority_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "CertificateAuthorityArn"))
|
240
|
+
RestoreCertificateAuthorityRequest.struct_class = Types::RestoreCertificateAuthorityRequest
|
241
|
+
|
235
242
|
RevocationConfiguration.add_member(:crl_configuration, Shapes::ShapeRef.new(shape: CrlConfiguration, location_name: "CrlConfiguration"))
|
236
243
|
RevocationConfiguration.struct_class = Types::RevocationConfiguration
|
237
244
|
|
@@ -332,6 +339,7 @@ module Aws::ACMPCA
|
|
332
339
|
o.input = Shapes::ShapeRef.new(shape: DescribeCertificateAuthorityAuditReportRequest)
|
333
340
|
o.output = Shapes::ShapeRef.new(shape: DescribeCertificateAuthorityAuditReportResponse)
|
334
341
|
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
342
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidArnException)
|
335
343
|
o.errors << Shapes::ShapeRef.new(shape: InvalidArgsException)
|
336
344
|
end)
|
337
345
|
|
@@ -369,6 +377,7 @@ module Aws::ACMPCA
|
|
369
377
|
o.errors << Shapes::ShapeRef.new(shape: RequestFailedException)
|
370
378
|
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
371
379
|
o.errors << Shapes::ShapeRef.new(shape: InvalidArnException)
|
380
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidStateException)
|
372
381
|
end)
|
373
382
|
|
374
383
|
api.add_operation(:import_certificate_authority_certificate, Seahorse::Model::Operation.new.tap do |o|
|
@@ -382,6 +391,7 @@ module Aws::ACMPCA
|
|
382
391
|
o.errors << Shapes::ShapeRef.new(shape: RequestFailedException)
|
383
392
|
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
384
393
|
o.errors << Shapes::ShapeRef.new(shape: InvalidArnException)
|
394
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidStateException)
|
385
395
|
o.errors << Shapes::ShapeRef.new(shape: MalformedCertificateException)
|
386
396
|
o.errors << Shapes::ShapeRef.new(shape: CertificateMismatchException)
|
387
397
|
end)
|
@@ -419,6 +429,17 @@ module Aws::ACMPCA
|
|
419
429
|
o.errors << Shapes::ShapeRef.new(shape: InvalidArnException)
|
420
430
|
end)
|
421
431
|
|
432
|
+
api.add_operation(:restore_certificate_authority, Seahorse::Model::Operation.new.tap do |o|
|
433
|
+
o.name = "RestoreCertificateAuthority"
|
434
|
+
o.http_method = "POST"
|
435
|
+
o.http_request_uri = "/"
|
436
|
+
o.input = Shapes::ShapeRef.new(shape: RestoreCertificateAuthorityRequest)
|
437
|
+
o.output = Shapes::ShapeRef.new(shape: Shapes::StructureShape.new(struct_class: Aws::EmptyStructure))
|
438
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
439
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidStateException)
|
440
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidArnException)
|
441
|
+
end)
|
442
|
+
|
422
443
|
api.add_operation(:revoke_certificate, Seahorse::Model::Operation.new.tap do |o|
|
423
444
|
o.name = "RevokeCertificate"
|
424
445
|
o.http_method = "POST"
|
@@ -442,6 +463,7 @@ module Aws::ACMPCA
|
|
442
463
|
o.output = Shapes::ShapeRef.new(shape: Shapes::StructureShape.new(struct_class: Aws::EmptyStructure))
|
443
464
|
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
444
465
|
o.errors << Shapes::ShapeRef.new(shape: InvalidArnException)
|
466
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidStateException)
|
445
467
|
o.errors << Shapes::ShapeRef.new(shape: InvalidTagException)
|
446
468
|
o.errors << Shapes::ShapeRef.new(shape: TooManyTagsException)
|
447
469
|
end)
|
@@ -454,6 +476,7 @@ module Aws::ACMPCA
|
|
454
476
|
o.output = Shapes::ShapeRef.new(shape: Shapes::StructureShape.new(struct_class: Aws::EmptyStructure))
|
455
477
|
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
456
478
|
o.errors << Shapes::ShapeRef.new(shape: InvalidArnException)
|
479
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidStateException)
|
457
480
|
o.errors << Shapes::ShapeRef.new(shape: InvalidTagException)
|
458
481
|
end)
|
459
482
|
|
data/lib/aws-sdk-acmpca/types.rb
CHANGED
@@ -16,7 +16,7 @@ module Aws::ACMPCA
|
|
16
16
|
# service. The **Subject** must contain an X.500 distinguished name
|
17
17
|
# (DN). A DN is a sequence of relative distinguished names (RDNs). The
|
18
18
|
# RDNs are separated by commas in the certificate. The DN must be unique
|
19
|
-
# for each
|
19
|
+
# for each entity, but your private CA can issue more than one
|
20
20
|
# certificate with the same DN to the same entity.
|
21
21
|
#
|
22
22
|
# @note When making an API call, you may pass ASN1Subject
|
@@ -40,7 +40,7 @@ module Aws::ACMPCA
|
|
40
40
|
# }
|
41
41
|
#
|
42
42
|
# @!attribute [rw] country
|
43
|
-
# Two
|
43
|
+
# Two-digit code that specifies the country in which the certificate
|
44
44
|
# subject located.
|
45
45
|
# @return [String]
|
46
46
|
#
|
@@ -77,12 +77,12 @@ module Aws::ACMPCA
|
|
77
77
|
# @return [String]
|
78
78
|
#
|
79
79
|
# @!attribute [rw] title
|
80
|
-
# A title such as Mr. or Ms
|
80
|
+
# A title such as Mr. or Ms., which is pre-pended to the name to refer
|
81
81
|
# formally to the certificate subject.
|
82
82
|
# @return [String]
|
83
83
|
#
|
84
84
|
# @!attribute [rw] surname
|
85
|
-
# Family name. In the US and the UK for example, the surname of an
|
85
|
+
# Family name. In the US and the UK, for example, the surname of an
|
86
86
|
# individual is ordered last. In Asian cultures the surname is
|
87
87
|
# typically ordered first.
|
88
88
|
# @return [String]
|
@@ -133,11 +133,11 @@ module Aws::ACMPCA
|
|
133
133
|
# Digital certificates verify that the entity named in the certificate
|
134
134
|
# **Subject** field owns or controls the public key contained in the
|
135
135
|
# **Subject Public Key Info** field. Call the CreateCertificateAuthority
|
136
|
-
#
|
137
|
-
# GetCertificateAuthorityCertificate
|
136
|
+
# operation to create your private CA. You must then call the
|
137
|
+
# GetCertificateAuthorityCertificate operation to retrieve a private CA
|
138
138
|
# certificate signing request (CSR). Take the CSR to your on-premises CA
|
139
139
|
# and sign it with the root CA certificate or a subordinate certificate.
|
140
|
-
# Call the ImportCertificateAuthorityCertificate
|
140
|
+
# Call the ImportCertificateAuthorityCertificate operation to import the
|
141
141
|
# signed certificate into AWS Certificate Manager (ACM).
|
142
142
|
#
|
143
143
|
# @!attribute [rw] arn
|
@@ -186,6 +186,12 @@ module Aws::ACMPCA
|
|
186
186
|
# maintained by your private CA.
|
187
187
|
# @return [Types::RevocationConfiguration]
|
188
188
|
#
|
189
|
+
# @!attribute [rw] restorable_until
|
190
|
+
# The period during which a deleted CA can be restored. For more
|
191
|
+
# information, see the `PermanentDeletionTimeInDays` parameter of the
|
192
|
+
# DeleteCertificateAuthorityRequest operation.
|
193
|
+
# @return [Time]
|
194
|
+
#
|
189
195
|
# @see http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/CertificateAuthority AWS API Documentation
|
190
196
|
#
|
191
197
|
class CertificateAuthority < Struct.new(
|
@@ -199,7 +205,8 @@ module Aws::ACMPCA
|
|
199
205
|
:not_after,
|
200
206
|
:failure_reason,
|
201
207
|
:certificate_authority_configuration,
|
202
|
-
:revocation_configuration
|
208
|
+
:revocation_configuration,
|
209
|
+
:restorable_until)
|
203
210
|
include Aws::Structure
|
204
211
|
end
|
205
212
|
|
@@ -209,7 +216,7 @@ module Aws::ACMPCA
|
|
209
216
|
# issues a certificate, the signature algorithm it uses used when
|
210
217
|
# issuing certificates, and its X.500 distinguished name. You must
|
211
218
|
# specify this information when you call the CreateCertificateAuthority
|
212
|
-
#
|
219
|
+
# operation.
|
213
220
|
#
|
214
221
|
# @note When making an API call, you may pass CertificateAuthorityConfiguration
|
215
222
|
# data as a hash:
|
@@ -272,7 +279,7 @@ module Aws::ACMPCA
|
|
272
279
|
# Amazon Resource Name (ARN) of the CA to be audited. This is of the
|
273
280
|
# form:
|
274
281
|
#
|
275
|
-
# `arn:aws:acm:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
|
282
|
+
# `arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
|
276
283
|
# `.
|
277
284
|
# @return [String]
|
278
285
|
#
|
@@ -372,9 +379,9 @@ module Aws::ACMPCA
|
|
372
379
|
# five minutes. Therefore, if you call **CreateCertificateAuthority**
|
373
380
|
# multiple times with the same idempotency token within a five minute
|
374
381
|
# period, ACM PCA recognizes that you are requesting only one
|
375
|
-
# certificate
|
376
|
-
# token for each call, however, ACM PCA recognizes that
|
377
|
-
# requesting multiple certificates.
|
382
|
+
# certificate. As a result, ACM PCA issues only one. If you change the
|
383
|
+
# idempotency token for each call, however, ACM PCA recognizes that
|
384
|
+
# you are requesting multiple certificates.
|
378
385
|
# @return [String]
|
379
386
|
#
|
380
387
|
# @see http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/CreateCertificateAuthorityRequest AWS API Documentation
|
@@ -391,7 +398,7 @@ module Aws::ACMPCA
|
|
391
398
|
# If successful, the Amazon Resource Name (ARN) of the certificate
|
392
399
|
# authority (CA). This is of the form:
|
393
400
|
#
|
394
|
-
# `arn:aws:acm:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
|
401
|
+
# `arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
|
395
402
|
# `.
|
396
403
|
# @return [String]
|
397
404
|
#
|
@@ -481,8 +488,8 @@ module Aws::ACMPCA
|
|
481
488
|
# Boolean value that specifies whether certificate revocation lists
|
482
489
|
# (CRLs) are enabled. You can use this value to enable certificate
|
483
490
|
# revocation for a new CA when you call the CreateCertificateAuthority
|
484
|
-
#
|
485
|
-
# UpdateCertificateAuthority
|
491
|
+
# operation or for an existing CA when you call the
|
492
|
+
# UpdateCertificateAuthority operation.
|
486
493
|
# @return [Boolean]
|
487
494
|
#
|
488
495
|
# @!attribute [rw] expiration_in_days
|
@@ -501,7 +508,7 @@ module Aws::ACMPCA
|
|
501
508
|
# value for the **CustomCname** argument, the name of your S3 bucket
|
502
509
|
# is placed into the **CRL Distribution Points** extension of the
|
503
510
|
# issued certificate. You can change the name of your bucket by
|
504
|
-
# calling the UpdateCertificateAuthority
|
511
|
+
# calling the UpdateCertificateAuthority operation. You must specify a
|
505
512
|
# bucket policy that allows ACM PCA to write the CRL to your bucket.
|
506
513
|
# @return [String]
|
507
514
|
#
|
@@ -520,20 +527,28 @@ module Aws::ACMPCA
|
|
520
527
|
#
|
521
528
|
# {
|
522
529
|
# certificate_authority_arn: "Arn", # required
|
530
|
+
# permanent_deletion_time_in_days: 1,
|
523
531
|
# }
|
524
532
|
#
|
525
533
|
# @!attribute [rw] certificate_authority_arn
|
526
534
|
# The Amazon Resource Name (ARN) that was returned when you called
|
527
|
-
# CreateCertificateAuthority. This must
|
535
|
+
# CreateCertificateAuthority. This must have the following form:
|
528
536
|
#
|
529
|
-
# `arn:aws:acm:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
|
537
|
+
# `arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
|
530
538
|
# `.
|
531
539
|
# @return [String]
|
532
540
|
#
|
541
|
+
# @!attribute [rw] permanent_deletion_time_in_days
|
542
|
+
# The number of days to make a CA restorable after it has been
|
543
|
+
# deleted. This can be anywhere from 7 to 30 days, with 30 being the
|
544
|
+
# default.
|
545
|
+
# @return [Integer]
|
546
|
+
#
|
533
547
|
# @see http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/DeleteCertificateAuthorityRequest AWS API Documentation
|
534
548
|
#
|
535
549
|
class DeleteCertificateAuthorityRequest < Struct.new(
|
536
|
-
:certificate_authority_arn
|
550
|
+
:certificate_authority_arn,
|
551
|
+
:permanent_deletion_time_in_days)
|
537
552
|
include Aws::Structure
|
538
553
|
end
|
539
554
|
|
@@ -549,13 +564,13 @@ module Aws::ACMPCA
|
|
549
564
|
# The Amazon Resource Name (ARN) of the private CA. This must be of
|
550
565
|
# the form:
|
551
566
|
#
|
552
|
-
# `arn:aws:acm:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
|
567
|
+
# `arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
|
553
568
|
# `.
|
554
569
|
# @return [String]
|
555
570
|
#
|
556
571
|
# @!attribute [rw] audit_report_id
|
557
572
|
# The report ID returned by calling the
|
558
|
-
# CreateCertificateAuthorityAuditReport
|
573
|
+
# CreateCertificateAuthorityAuditReport operation.
|
559
574
|
# @return [String]
|
560
575
|
#
|
561
576
|
# @see http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/DescribeCertificateAuthorityAuditReportRequest AWS API Documentation
|
@@ -605,7 +620,7 @@ module Aws::ACMPCA
|
|
605
620
|
# The Amazon Resource Name (ARN) that was returned when you called
|
606
621
|
# CreateCertificateAuthority. This must be of the form:
|
607
622
|
#
|
608
|
-
# `arn:aws:acm:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
|
623
|
+
# `arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
|
609
624
|
# `.
|
610
625
|
# @return [String]
|
611
626
|
#
|
@@ -639,7 +654,7 @@ module Aws::ACMPCA
|
|
639
654
|
# The Amazon Resource Name (ARN) of your private CA. This is of the
|
640
655
|
# form:
|
641
656
|
#
|
642
|
-
# `arn:aws:acm:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
|
657
|
+
# `arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
|
643
658
|
# `.
|
644
659
|
# @return [String]
|
645
660
|
#
|
@@ -678,9 +693,9 @@ module Aws::ACMPCA
|
|
678
693
|
#
|
679
694
|
# @!attribute [rw] certificate_authority_arn
|
680
695
|
# The Amazon Resource Name (ARN) that was returned when you called the
|
681
|
-
# CreateCertificateAuthority
|
696
|
+
# CreateCertificateAuthority operation. This must be of the form:
|
682
697
|
#
|
683
|
-
# `arn:aws:acm:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
|
698
|
+
# `arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
|
684
699
|
# `
|
685
700
|
# @return [String]
|
686
701
|
#
|
@@ -715,7 +730,7 @@ module Aws::ACMPCA
|
|
715
730
|
# The Amazon Resource Name (ARN) that was returned when you called
|
716
731
|
# CreateCertificateAuthority. This must be of the form:
|
717
732
|
#
|
718
|
-
# `arn:aws:acm:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
|
733
|
+
# `arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
|
719
734
|
# `.
|
720
735
|
# @return [String]
|
721
736
|
#
|
@@ -723,7 +738,7 @@ module Aws::ACMPCA
|
|
723
738
|
# The ARN of the issued certificate. The ARN contains the certificate
|
724
739
|
# serial number and must be in the following form:
|
725
740
|
#
|
726
|
-
# `arn:aws:acm:region:account:certificate-authority/12345678-1234-1234-1234-123456789012/certificate/286535153982981100925020015808220737245
|
741
|
+
# `arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012/certificate/286535153982981100925020015808220737245
|
727
742
|
# `
|
728
743
|
# @return [String]
|
729
744
|
#
|
@@ -767,7 +782,7 @@ module Aws::ACMPCA
|
|
767
782
|
# The Amazon Resource Name (ARN) that was returned when you called
|
768
783
|
# CreateCertificateAuthority. This must be of the form:
|
769
784
|
#
|
770
|
-
# `arn:aws:acm:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
|
785
|
+
# `arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
|
771
786
|
# `
|
772
787
|
# @return [String]
|
773
788
|
#
|
@@ -810,7 +825,7 @@ module Aws::ACMPCA
|
|
810
825
|
# The Amazon Resource Name (ARN) that was returned when you called
|
811
826
|
# CreateCertificateAuthority. This must be of the form:
|
812
827
|
#
|
813
|
-
# `arn:aws:acm:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
|
828
|
+
# `arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
|
814
829
|
# `
|
815
830
|
# @return [String]
|
816
831
|
#
|
@@ -842,8 +857,8 @@ module Aws::ACMPCA
|
|
842
857
|
#
|
843
858
|
# @!attribute [rw] idempotency_token
|
844
859
|
# Custom string that can be used to distinguish between calls to the
|
845
|
-
# **IssueCertificate**
|
846
|
-
# hour. Therefore, if you call **IssueCertificate** multiple times
|
860
|
+
# **IssueCertificate** operation. Idempotency tokens time out after
|
861
|
+
# one hour. Therefore, if you call **IssueCertificate** multiple times
|
847
862
|
# with the same idempotency token within 5 minutes, ACM PCA recognizes
|
848
863
|
# that you are requesting only one certificate and will issue only
|
849
864
|
# one. If you change the idempotency token for each call, PCA
|
@@ -865,7 +880,7 @@ module Aws::ACMPCA
|
|
865
880
|
# The Amazon Resource Name (ARN) of the issued certificate and the
|
866
881
|
# certificate serial number. This is of the form:
|
867
882
|
#
|
868
|
-
# `arn:aws:acm:region:account:certificate-authority/12345678-1234-1234-1234-123456789012/certificate/286535153982981100925020015808220737245
|
883
|
+
# `arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012/certificate/286535153982981100925020015808220737245
|
869
884
|
# `
|
870
885
|
# @return [String]
|
871
886
|
#
|
@@ -936,9 +951,9 @@ module Aws::ACMPCA
|
|
936
951
|
#
|
937
952
|
# @!attribute [rw] certificate_authority_arn
|
938
953
|
# The Amazon Resource Name (ARN) that was returned when you called the
|
939
|
-
# CreateCertificateAuthority
|
954
|
+
# CreateCertificateAuthority operation. This must be of the form:
|
940
955
|
#
|
941
|
-
# `arn:aws:acm:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
|
956
|
+
# `arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
|
942
957
|
# `
|
943
958
|
# @return [String]
|
944
959
|
#
|
@@ -982,8 +997,30 @@ module Aws::ACMPCA
|
|
982
997
|
include Aws::Structure
|
983
998
|
end
|
984
999
|
|
1000
|
+
# @note When making an API call, you may pass RestoreCertificateAuthorityRequest
|
1001
|
+
# data as a hash:
|
1002
|
+
#
|
1003
|
+
# {
|
1004
|
+
# certificate_authority_arn: "Arn", # required
|
1005
|
+
# }
|
1006
|
+
#
|
1007
|
+
# @!attribute [rw] certificate_authority_arn
|
1008
|
+
# The Amazon Resource Name (ARN) that was returned when you called the
|
1009
|
+
# CreateCertificateAuthority operation. This must be of the form:
|
1010
|
+
#
|
1011
|
+
# `arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
|
1012
|
+
# `
|
1013
|
+
# @return [String]
|
1014
|
+
#
|
1015
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/RestoreCertificateAuthorityRequest AWS API Documentation
|
1016
|
+
#
|
1017
|
+
class RestoreCertificateAuthorityRequest < Struct.new(
|
1018
|
+
:certificate_authority_arn)
|
1019
|
+
include Aws::Structure
|
1020
|
+
end
|
1021
|
+
|
985
1022
|
# Certificate revocation information used by the
|
986
|
-
# CreateCertificateAuthority and UpdateCertificateAuthority
|
1023
|
+
# CreateCertificateAuthority and UpdateCertificateAuthority operations.
|
987
1024
|
# Your private certificate authority (CA) can create and maintain a
|
988
1025
|
# certificate revocation list (CRL). A CRL contains information about
|
989
1026
|
# certificates revoked by your CA. For more information, see
|
@@ -1026,7 +1063,7 @@ module Aws::ACMPCA
|
|
1026
1063
|
# Amazon Resource Name (ARN) of the private CA that issued the
|
1027
1064
|
# certificate to be revoked. This must be of the form:
|
1028
1065
|
#
|
1029
|
-
# `arn:aws:acm:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
|
1066
|
+
# `arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
|
1030
1067
|
# `
|
1031
1068
|
# @return [String]
|
1032
1069
|
#
|
@@ -1035,19 +1072,19 @@ module Aws::ACMPCA
|
|
1035
1072
|
# hexadecimal format. You can retrieve the serial number by calling
|
1036
1073
|
# GetCertificate with the Amazon Resource Name (ARN) of the
|
1037
1074
|
# certificate you want and the ARN of your private CA. The
|
1038
|
-
# **GetCertificate**
|
1075
|
+
# **GetCertificate** operation retrieves the certificate in the PEM
|
1039
1076
|
# format. You can use the following OpenSSL command to list the
|
1040
1077
|
# certificate in text format and copy the hexadecimal serial number.
|
1041
1078
|
#
|
1042
1079
|
# `openssl x509 -in file_path -text -noout`
|
1043
1080
|
#
|
1044
1081
|
# You can also copy the serial number from the console or use the
|
1045
|
-
# [DescribeCertificate][1]
|
1082
|
+
# [DescribeCertificate][1] operation in the *AWS Certificate Manager
|
1046
1083
|
# API Reference*.
|
1047
1084
|
#
|
1048
1085
|
#
|
1049
1086
|
#
|
1050
|
-
# [1]:
|
1087
|
+
# [1]: https://docs.aws.amazon.com/acm/latest/APIReference/API_DescribeCertificate.html
|
1051
1088
|
# @return [String]
|
1052
1089
|
#
|
1053
1090
|
# @!attribute [rw] revocation_reason
|
@@ -1066,8 +1103,8 @@ module Aws::ACMPCA
|
|
1066
1103
|
# Tags are labels that you can use to identify and organize your private
|
1067
1104
|
# CAs. Each tag consists of a key and an optional value. You can
|
1068
1105
|
# associate up to 50 tags with a private CA. To add one or more tags to
|
1069
|
-
# a private CA, call the TagCertificateAuthority
|
1070
|
-
# tag, call the UntagCertificateAuthority
|
1106
|
+
# a private CA, call the TagCertificateAuthority operation. To remove a
|
1107
|
+
# tag, call the UntagCertificateAuthority operation.
|
1071
1108
|
#
|
1072
1109
|
# @note When making an API call, you may pass Tag
|
1073
1110
|
# data as a hash:
|
@@ -1110,7 +1147,7 @@ module Aws::ACMPCA
|
|
1110
1147
|
# The Amazon Resource Name (ARN) that was returned when you called
|
1111
1148
|
# CreateCertificateAuthority. This must be of the form:
|
1112
1149
|
#
|
1113
|
-
# `arn:aws:acm:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
|
1150
|
+
# `arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
|
1114
1151
|
# `
|
1115
1152
|
# @return [String]
|
1116
1153
|
#
|
@@ -1143,7 +1180,7 @@ module Aws::ACMPCA
|
|
1143
1180
|
# The Amazon Resource Name (ARN) that was returned when you called
|
1144
1181
|
# CreateCertificateAuthority. This must be of the form:
|
1145
1182
|
#
|
1146
|
-
# `arn:aws:acm:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
|
1183
|
+
# `arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
|
1147
1184
|
# `
|
1148
1185
|
# @return [String]
|
1149
1186
|
#
|
@@ -1172,14 +1209,14 @@ module Aws::ACMPCA
|
|
1172
1209
|
# s3_bucket_name: "String3To255",
|
1173
1210
|
# },
|
1174
1211
|
# },
|
1175
|
-
# status: "CREATING", # accepts CREATING, PENDING_CERTIFICATE, ACTIVE, DISABLED, EXPIRED, FAILED
|
1212
|
+
# status: "CREATING", # accepts CREATING, PENDING_CERTIFICATE, ACTIVE, DELETED, DISABLED, EXPIRED, FAILED
|
1176
1213
|
# }
|
1177
1214
|
#
|
1178
1215
|
# @!attribute [rw] certificate_authority_arn
|
1179
1216
|
# Amazon Resource Name (ARN) of the private CA that issued the
|
1180
1217
|
# certificate to be revoked. This must be of the form:
|
1181
1218
|
#
|
1182
|
-
# `arn:aws:acm:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
|
1219
|
+
# `arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
|
1183
1220
|
# `
|
1184
1221
|
# @return [String]
|
1185
1222
|
#
|
@@ -1203,7 +1240,7 @@ module Aws::ACMPCA
|
|
1203
1240
|
# Length of time for which the certificate issued by your private
|
1204
1241
|
# certificate authority (CA), or by the private CA itself, is valid in
|
1205
1242
|
# days, months, or years. You can issue a certificate by calling the
|
1206
|
-
# IssueCertificate
|
1243
|
+
# IssueCertificate operation.
|
1207
1244
|
#
|
1208
1245
|
# @note When making an API call, you may pass Validity
|
1209
1246
|
# data as a hash:
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-acmpca
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.1.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2018-
|
11
|
+
date: 2018-06-20 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|
@@ -75,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
75
75
|
version: '0'
|
76
76
|
requirements: []
|
77
77
|
rubyforge_project:
|
78
|
-
rubygems_version: 2.5.2.
|
78
|
+
rubygems_version: 2.5.2.3
|
79
79
|
signing_key:
|
80
80
|
specification_version: 4
|
81
81
|
summary: AWS SDK for Ruby - ACM-PCA
|