aws-sdk-acmpca 1.51.0 → 1.53.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +13 -1
- data/VERSION +1 -1
- data/lib/aws-sdk-acmpca/client.rb +252 -190
- data/lib/aws-sdk-acmpca/client_api.rb +5 -4
- data/lib/aws-sdk-acmpca/endpoint_parameters.rb +3 -0
- data/lib/aws-sdk-acmpca/endpoint_provider.rb +38 -101
- data/lib/aws-sdk-acmpca/types.rb +202 -1159
- data/lib/aws-sdk-acmpca.rb +1 -1
- metadata +2 -2
|
@@ -393,20 +393,22 @@ module Aws::ACMPCA
|
|
|
393
393
|
# CA. If successful, this action returns the Amazon Resource Name (ARN)
|
|
394
394
|
# of the CA.
|
|
395
395
|
#
|
|
396
|
-
#
|
|
397
|
-
#
|
|
398
|
-
#
|
|
399
|
-
#
|
|
400
|
-
#
|
|
401
|
-
# have permission to write to the bucket, then an exception is thrown.
|
|
402
|
-
# For more information, see [Access policies for CRLs in Amazon S3][2].
|
|
396
|
+
# <note markdown="1"> Both Amazon Web Services Private CA and the IAM principal must have
|
|
397
|
+
# permission to write to the S3 bucket that you specify. If the IAM
|
|
398
|
+
# principal making the call does not have permission to write to the
|
|
399
|
+
# bucket, then an exception is thrown. For more information, see [Access
|
|
400
|
+
# policies for CRLs in Amazon S3][1].
|
|
403
401
|
#
|
|
404
402
|
# </note>
|
|
405
403
|
#
|
|
404
|
+
# Amazon Web Services Private CA assets that are stored in Amazon S3 can
|
|
405
|
+
# be protected with encryption. For more information, see [Encrypting
|
|
406
|
+
# Your CRLs][2].
|
|
407
|
+
#
|
|
406
408
|
#
|
|
407
409
|
#
|
|
408
|
-
# [1]: https://docs.aws.amazon.com/
|
|
409
|
-
# [2]: https://docs.aws.amazon.com/
|
|
410
|
+
# [1]: https://docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html#s3-policies
|
|
411
|
+
# [2]: https://docs.aws.amazon.com/privateca/latest/userguide/PcaCreateCa.html#crl-encryption
|
|
410
412
|
#
|
|
411
413
|
# @option params [required, Types::CertificateAuthorityConfiguration] :certificate_authority_configuration
|
|
412
414
|
# Name and bit size of the private key algorithm, the name of the
|
|
@@ -416,13 +418,35 @@ module Aws::ACMPCA
|
|
|
416
418
|
# Contains information to enable Online Certificate Status Protocol
|
|
417
419
|
# (OCSP) support, to enable a certificate revocation list (CRL), to
|
|
418
420
|
# enable both, or to enable neither. The default is for both certificate
|
|
419
|
-
# validation mechanisms to be disabled.
|
|
420
|
-
#
|
|
421
|
+
# validation mechanisms to be disabled.
|
|
422
|
+
#
|
|
423
|
+
# <note markdown="1"> The following requirements apply to revocation configurations.
|
|
424
|
+
#
|
|
425
|
+
# * A configuration disabling CRLs or OCSP must contain only the
|
|
426
|
+
# `Enabled=False` parameter, and will fail if other parameters such as
|
|
427
|
+
# `CustomCname` or `ExpirationInDays` are included.
|
|
428
|
+
#
|
|
429
|
+
# * In a CRL configuration, the `S3BucketName` parameter must conform to
|
|
430
|
+
# [Amazon S3 bucket naming rules][1].
|
|
431
|
+
#
|
|
432
|
+
# * A configuration containing a custom Canonical Name (CNAME) parameter
|
|
433
|
+
# for CRLs or OCSP must conform to [RFC2396][2] restrictions on the
|
|
434
|
+
# use of special characters in a CNAME.
|
|
435
|
+
#
|
|
436
|
+
# * In a CRL or OCSP configuration, the value of a CNAME parameter must
|
|
437
|
+
# not include a protocol prefix such as "http://" or "https://".
|
|
438
|
+
#
|
|
439
|
+
# </note>
|
|
440
|
+
#
|
|
441
|
+
# For more information, see the [OcspConfiguration][3] and
|
|
442
|
+
# [CrlConfiguration][4] types.
|
|
421
443
|
#
|
|
422
444
|
#
|
|
423
445
|
#
|
|
424
|
-
# [1]: https://docs.aws.amazon.com/
|
|
425
|
-
# [2]: https://
|
|
446
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html
|
|
447
|
+
# [2]: https://www.ietf.org/rfc/rfc2396.txt
|
|
448
|
+
# [3]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_OcspConfiguration.html
|
|
449
|
+
# [4]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_CrlConfiguration.html
|
|
426
450
|
#
|
|
427
451
|
# @option params [required, String] :certificate_authority_type
|
|
428
452
|
# The type of the certificate authority.
|
|
@@ -432,10 +456,11 @@ module Aws::ACMPCA
|
|
|
432
456
|
# **CreateCertificateAuthority** action. Idempotency tokens for
|
|
433
457
|
# **CreateCertificateAuthority** time out after five minutes. Therefore,
|
|
434
458
|
# if you call **CreateCertificateAuthority** multiple times with the
|
|
435
|
-
# same idempotency token within five minutes,
|
|
436
|
-
# that you are requesting only certificate
|
|
437
|
-
# one. If you change the idempotency token
|
|
438
|
-
#
|
|
459
|
+
# same idempotency token within five minutes, Amazon Web Services
|
|
460
|
+
# Private CA recognizes that you are requesting only certificate
|
|
461
|
+
# authority and will issue only one. If you change the idempotency token
|
|
462
|
+
# for each call, Amazon Web Services Private CA recognizes that you are
|
|
463
|
+
# requesting multiple certificate authorities.
|
|
439
464
|
#
|
|
440
465
|
# @option params [String] :key_storage_security_standard
|
|
441
466
|
# Specifies a cryptographic key management compliance standard used for
|
|
@@ -570,13 +595,13 @@ module Aws::ACMPCA
|
|
|
570
595
|
# crl_configuration: {
|
|
571
596
|
# enabled: false, # required
|
|
572
597
|
# expiration_in_days: 1,
|
|
573
|
-
# custom_cname: "
|
|
574
|
-
# s3_bucket_name: "
|
|
598
|
+
# custom_cname: "CnameString",
|
|
599
|
+
# s3_bucket_name: "S3BucketName3To255",
|
|
575
600
|
# s3_object_acl: "PUBLIC_READ", # accepts PUBLIC_READ, BUCKET_OWNER_FULL_CONTROL
|
|
576
601
|
# },
|
|
577
602
|
# ocsp_configuration: {
|
|
578
603
|
# enabled: false, # required
|
|
579
|
-
# ocsp_custom_cname: "
|
|
604
|
+
# ocsp_custom_cname: "CnameString",
|
|
580
605
|
# },
|
|
581
606
|
# },
|
|
582
607
|
# certificate_authority_type: "ROOT", # required, accepts ROOT, SUBORDINATE
|
|
@@ -609,16 +634,17 @@ module Aws::ACMPCA
|
|
|
609
634
|
# on input. The [IssueCertificate][1] and [RevokeCertificate][2] actions
|
|
610
635
|
# use the private key.
|
|
611
636
|
#
|
|
612
|
-
# <note markdown="1"> Both
|
|
613
|
-
# bucket that you specify. If the IAM
|
|
614
|
-
# have permission to write to the
|
|
615
|
-
# For more information, see [Access
|
|
637
|
+
# <note markdown="1"> Both Amazon Web Services Private CA and the IAM principal must have
|
|
638
|
+
# permission to write to the S3 bucket that you specify. If the IAM
|
|
639
|
+
# principal making the call does not have permission to write to the
|
|
640
|
+
# bucket, then an exception is thrown. For more information, see [Access
|
|
641
|
+
# policies for CRLs in Amazon S3][3].
|
|
616
642
|
#
|
|
617
643
|
# </note>
|
|
618
644
|
#
|
|
619
|
-
#
|
|
620
|
-
# with encryption. For more information, see [Encrypting
|
|
621
|
-
# Reports][4].
|
|
645
|
+
# Amazon Web Services Private CA assets that are stored in Amazon S3 can
|
|
646
|
+
# be protected with encryption. For more information, see [Encrypting
|
|
647
|
+
# Your Audit Reports][4].
|
|
622
648
|
#
|
|
623
649
|
# <note markdown="1"> You can generate a maximum of one report every 30 minutes.
|
|
624
650
|
#
|
|
@@ -626,10 +652,10 @@ module Aws::ACMPCA
|
|
|
626
652
|
#
|
|
627
653
|
#
|
|
628
654
|
#
|
|
629
|
-
# [1]: https://docs.aws.amazon.com/
|
|
630
|
-
# [2]: https://docs.aws.amazon.com/
|
|
631
|
-
# [3]: https://docs.aws.amazon.com/
|
|
632
|
-
# [4]: https://docs.aws.amazon.com/
|
|
655
|
+
# [1]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_IssueCertificate.html
|
|
656
|
+
# [2]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_RevokeCertificate.html
|
|
657
|
+
# [3]: https://docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html#s3-policies
|
|
658
|
+
# [4]: https://docs.aws.amazon.com/privateca/latest/userguide/PcaAuditReport.html#audit-report-encryption
|
|
633
659
|
#
|
|
634
660
|
# @option params [required, String] :certificate_authority_arn
|
|
635
661
|
# The Amazon Resource Name (ARN) of the CA to be audited. This is of the
|
|
@@ -694,14 +720,14 @@ module Aws::ACMPCA
|
|
|
694
720
|
# accounts, then permissions cannot be used to enable automatic
|
|
695
721
|
# renewals. Instead, the ACM certificate owner must set up a
|
|
696
722
|
# resource-based policy to enable cross-account issuance and renewals.
|
|
697
|
-
# For more information, see [Using a Resource Based Policy with
|
|
698
|
-
# Private CA][3].
|
|
723
|
+
# For more information, see [Using a Resource Based Policy with Amazon
|
|
724
|
+
# Web Services Private CA][3].
|
|
699
725
|
#
|
|
700
726
|
#
|
|
701
727
|
#
|
|
702
|
-
# [1]: https://docs.aws.amazon.com/
|
|
703
|
-
# [2]: https://docs.aws.amazon.com/
|
|
704
|
-
# [3]: https://docs.aws.amazon.com/
|
|
728
|
+
# [1]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListPermissions.html
|
|
729
|
+
# [2]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeletePermission.html
|
|
730
|
+
# [3]: https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html
|
|
705
731
|
#
|
|
706
732
|
# @option params [required, String] :certificate_authority_arn
|
|
707
733
|
# The Amazon Resource Name (ARN) of the CA that grants the permissions.
|
|
@@ -713,7 +739,7 @@ module Aws::ACMPCA
|
|
|
713
739
|
#
|
|
714
740
|
#
|
|
715
741
|
#
|
|
716
|
-
# [1]: https://docs.aws.amazon.com/
|
|
742
|
+
# [1]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html
|
|
717
743
|
#
|
|
718
744
|
# @option params [required, String] :principal
|
|
719
745
|
# The Amazon Web Services service or identity that receives the
|
|
@@ -766,8 +792,8 @@ module Aws::ACMPCA
|
|
|
766
792
|
# Additionally, you can delete a CA if you are waiting for it to be
|
|
767
793
|
# created (that is, the status of the CA is `CREATING`). You can also
|
|
768
794
|
# delete it if the CA has been created but you haven't yet imported the
|
|
769
|
-
# signed certificate into
|
|
770
|
-
# is `PENDING_CERTIFICATE`).
|
|
795
|
+
# signed certificate into Amazon Web Services Private CA (that is, the
|
|
796
|
+
# status of the CA is `PENDING_CERTIFICATE`).
|
|
771
797
|
#
|
|
772
798
|
# When you successfully call [DeleteCertificateAuthority][3], the CA's
|
|
773
799
|
# status changes to `DELETED`. However, the CA won't be permanently
|
|
@@ -781,11 +807,11 @@ module Aws::ACMPCA
|
|
|
781
807
|
#
|
|
782
808
|
#
|
|
783
809
|
#
|
|
784
|
-
# [1]: https://docs.aws.amazon.com/
|
|
785
|
-
# [2]: https://docs.aws.amazon.com/
|
|
786
|
-
# [3]: https://docs.aws.amazon.com/
|
|
787
|
-
# [4]: https://docs.aws.amazon.com/
|
|
788
|
-
# [5]: https://docs.aws.amazon.com/
|
|
810
|
+
# [1]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html
|
|
811
|
+
# [2]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_UpdateCertificateAuthority.html
|
|
812
|
+
# [3]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeleteCertificateAuthority.html
|
|
813
|
+
# [4]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_DescribeCertificateAuthority.html
|
|
814
|
+
# [5]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_RestoreCertificateAuthority.html
|
|
789
815
|
#
|
|
790
816
|
# @option params [required, String] :certificate_authority_arn
|
|
791
817
|
# The Amazon Resource Name (ARN) that was returned when you called
|
|
@@ -796,7 +822,7 @@ module Aws::ACMPCA
|
|
|
796
822
|
#
|
|
797
823
|
#
|
|
798
824
|
#
|
|
799
|
-
# [1]: https://docs.aws.amazon.com/
|
|
825
|
+
# [1]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html
|
|
800
826
|
#
|
|
801
827
|
# @option params [Integer] :permanent_deletion_time_in_days
|
|
802
828
|
# The number of days to make a CA restorable after it has been deleted.
|
|
@@ -845,14 +871,14 @@ module Aws::ACMPCA
|
|
|
845
871
|
# accounts, then permissions cannot be used to enable automatic
|
|
846
872
|
# renewals. Instead, the ACM certificate owner must set up a
|
|
847
873
|
# resource-based policy to enable cross-account issuance and renewals.
|
|
848
|
-
# For more information, see [Using a Resource Based Policy with
|
|
849
|
-
# Private CA][3].
|
|
874
|
+
# For more information, see [Using a Resource Based Policy with Amazon
|
|
875
|
+
# Web Services Private CA][3].
|
|
850
876
|
#
|
|
851
877
|
#
|
|
852
878
|
#
|
|
853
|
-
# [1]: https://docs.aws.amazon.com/
|
|
854
|
-
# [2]: https://docs.aws.amazon.com/
|
|
855
|
-
# [3]: https://docs.aws.amazon.com/
|
|
879
|
+
# [1]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreatePermission.html
|
|
880
|
+
# [2]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListPermissions.html
|
|
881
|
+
# [3]: https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html
|
|
856
882
|
#
|
|
857
883
|
# @option params [required, String] :certificate_authority_arn
|
|
858
884
|
# The Amazon Resource Number (ARN) of the private CA that issued the
|
|
@@ -865,7 +891,7 @@ module Aws::ACMPCA
|
|
|
865
891
|
#
|
|
866
892
|
#
|
|
867
893
|
#
|
|
868
|
-
# [1]: https://docs.aws.amazon.com/
|
|
894
|
+
# [1]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html
|
|
869
895
|
#
|
|
870
896
|
# @option params [required, String] :principal
|
|
871
897
|
# The Amazon Web Services service or identity that will have its CA
|
|
@@ -914,7 +940,7 @@ module Aws::ACMPCA
|
|
|
914
940
|
# customer account, to Amazon Web Services Organizations, or to an
|
|
915
941
|
# Amazon Web Services Organizations unit. Policies are under the
|
|
916
942
|
# control of a CA administrator. For more information, see [Using a
|
|
917
|
-
# Resource Based Policy with
|
|
943
|
+
# Resource Based Policy with Amazon Web Services Private CA][3].
|
|
918
944
|
#
|
|
919
945
|
# * A policy permits a user of Certificate Manager (ACM) to issue ACM
|
|
920
946
|
# certificates signed by a CA in another account.
|
|
@@ -922,8 +948,8 @@ module Aws::ACMPCA
|
|
|
922
948
|
# * For ACM to manage automatic renewal of these certificates, the ACM
|
|
923
949
|
# user must configure a Service Linked Role (SLR). The SLR allows the
|
|
924
950
|
# ACM service to assume the identity of the user, subject to
|
|
925
|
-
# confirmation against the
|
|
926
|
-
# information, see [Using a Service Linked Role with ACM][4].
|
|
951
|
+
# confirmation against the Amazon Web Services Private CA policy. For
|
|
952
|
+
# more information, see [Using a Service Linked Role with ACM][4].
|
|
927
953
|
#
|
|
928
954
|
# * Updates made in Amazon Web Services Resource Manager (RAM) are
|
|
929
955
|
# reflected in policies. For more information, see [Attach a Policy
|
|
@@ -931,11 +957,11 @@ module Aws::ACMPCA
|
|
|
931
957
|
#
|
|
932
958
|
#
|
|
933
959
|
#
|
|
934
|
-
# [1]: https://docs.aws.amazon.com/
|
|
935
|
-
# [2]: https://docs.aws.amazon.com/
|
|
936
|
-
# [3]: https://docs.aws.amazon.com/
|
|
960
|
+
# [1]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_GetPolicy.html
|
|
961
|
+
# [2]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_PutPolicy.html
|
|
962
|
+
# [3]: https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html
|
|
937
963
|
# [4]: https://docs.aws.amazon.com/acm/latest/userguide/acm-slr.html
|
|
938
|
-
# [5]: https://docs.aws.amazon.com/
|
|
964
|
+
# [5]: https://docs.aws.amazon.com/privateca/latest/userguide/pca-ram.html
|
|
939
965
|
#
|
|
940
966
|
# @option params [required, String] :resource_arn
|
|
941
967
|
# The Amazon Resource Number (ARN) of the private CA that will have its
|
|
@@ -946,7 +972,7 @@ module Aws::ACMPCA
|
|
|
946
972
|
#
|
|
947
973
|
#
|
|
948
974
|
#
|
|
949
|
-
# [1]: https://docs.aws.amazon.com/
|
|
975
|
+
# [1]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html
|
|
950
976
|
#
|
|
951
977
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
952
978
|
#
|
|
@@ -970,12 +996,13 @@ module Aws::ACMPCA
|
|
|
970
996
|
# its ARN (Amazon Resource Name). The output contains the status of your
|
|
971
997
|
# CA. This can be any of the following:
|
|
972
998
|
#
|
|
973
|
-
# * `CREATING` -
|
|
974
|
-
# authority.
|
|
999
|
+
# * `CREATING` - Amazon Web Services Private CA is creating your private
|
|
1000
|
+
# certificate authority.
|
|
975
1001
|
#
|
|
976
1002
|
# * `PENDING_CERTIFICATE` - The certificate is pending. You must use
|
|
977
|
-
# your
|
|
978
|
-
# sign your private CA CSR and then import it into
|
|
1003
|
+
# your Amazon Web Services Private CA-hosted or on-premises root or
|
|
1004
|
+
# subordinate CA to sign your private CA CSR and then import it into
|
|
1005
|
+
# Amazon Web Services Private CA.
|
|
979
1006
|
#
|
|
980
1007
|
# * `ACTIVE` - Your private CA is active.
|
|
981
1008
|
#
|
|
@@ -1001,7 +1028,7 @@ module Aws::ACMPCA
|
|
|
1001
1028
|
#
|
|
1002
1029
|
#
|
|
1003
1030
|
#
|
|
1004
|
-
# [1]: https://docs.aws.amazon.com/
|
|
1031
|
+
# [1]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html
|
|
1005
1032
|
#
|
|
1006
1033
|
# @return [Types::DescribeCertificateAuthorityResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1007
1034
|
#
|
|
@@ -1110,9 +1137,9 @@ module Aws::ACMPCA
|
|
|
1110
1137
|
#
|
|
1111
1138
|
#
|
|
1112
1139
|
#
|
|
1113
|
-
# [1]: https://docs.aws.amazon.com/
|
|
1114
|
-
# [2]: https://docs.aws.amazon.com/
|
|
1115
|
-
# [3]: https://docs.aws.amazon.com/
|
|
1140
|
+
# [1]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthorityAuditReport.html
|
|
1141
|
+
# [2]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_IssueCertificate.html
|
|
1142
|
+
# [3]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_RevokeCertificate.html
|
|
1116
1143
|
#
|
|
1117
1144
|
# @option params [required, String] :certificate_authority_arn
|
|
1118
1145
|
# The Amazon Resource Name (ARN) of the private CA. This must be of the
|
|
@@ -1127,7 +1154,7 @@ module Aws::ACMPCA
|
|
|
1127
1154
|
#
|
|
1128
1155
|
#
|
|
1129
1156
|
#
|
|
1130
|
-
# [1]: https://docs.aws.amazon.com/
|
|
1157
|
+
# [1]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthorityAuditReport.html
|
|
1131
1158
|
#
|
|
1132
1159
|
# @return [Types::DescribeCertificateAuthorityAuditReportResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1133
1160
|
#
|
|
@@ -1176,8 +1203,8 @@ module Aws::ACMPCA
|
|
|
1176
1203
|
#
|
|
1177
1204
|
#
|
|
1178
1205
|
#
|
|
1179
|
-
# [1]: https://docs.aws.amazon.com/
|
|
1180
|
-
# [2]: https://docs.aws.amazon.com/
|
|
1206
|
+
# [1]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_IssueCertificate.html
|
|
1207
|
+
# [2]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthorityAuditReport.html
|
|
1181
1208
|
#
|
|
1182
1209
|
# @option params [required, String] :certificate_authority_arn
|
|
1183
1210
|
# The Amazon Resource Name (ARN) that was returned when you called
|
|
@@ -1188,7 +1215,7 @@ module Aws::ACMPCA
|
|
|
1188
1215
|
#
|
|
1189
1216
|
#
|
|
1190
1217
|
#
|
|
1191
|
-
# [1]: https://docs.aws.amazon.com/
|
|
1218
|
+
# [1]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html
|
|
1192
1219
|
#
|
|
1193
1220
|
# @option params [required, String] :certificate_arn
|
|
1194
1221
|
# The ARN of the issued certificate. The ARN contains the certificate
|
|
@@ -1268,16 +1295,16 @@ module Aws::ACMPCA
|
|
|
1268
1295
|
|
|
1269
1296
|
# Retrieves the certificate signing request (CSR) for your private
|
|
1270
1297
|
# certificate authority (CA). The CSR is created when you call the
|
|
1271
|
-
# [CreateCertificateAuthority][1] action. Sign the CSR with your
|
|
1272
|
-
# Private CA-hosted or on-premises root or subordinate CA.
|
|
1273
|
-
# the signed certificate back into
|
|
1274
|
-
# [ImportCertificateAuthorityCertificate][2]
|
|
1275
|
-
# as a base64 PEM-encoded string.
|
|
1298
|
+
# [CreateCertificateAuthority][1] action. Sign the CSR with your Amazon
|
|
1299
|
+
# Web Services Private CA-hosted or on-premises root or subordinate CA.
|
|
1300
|
+
# Then import the signed certificate back into Amazon Web Services
|
|
1301
|
+
# Private CA by calling the [ImportCertificateAuthorityCertificate][2]
|
|
1302
|
+
# action. The CSR is returned as a base64 PEM-encoded string.
|
|
1276
1303
|
#
|
|
1277
1304
|
#
|
|
1278
1305
|
#
|
|
1279
|
-
# [1]: https://docs.aws.amazon.com/
|
|
1280
|
-
# [2]: https://docs.aws.amazon.com/
|
|
1306
|
+
# [1]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html
|
|
1307
|
+
# [2]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_ImportCertificateAuthorityCertificate.html
|
|
1281
1308
|
#
|
|
1282
1309
|
# @option params [required, String] :certificate_authority_arn
|
|
1283
1310
|
# The Amazon Resource Name (ARN) that was returned when you called the
|
|
@@ -1288,7 +1315,7 @@ module Aws::ACMPCA
|
|
|
1288
1315
|
#
|
|
1289
1316
|
#
|
|
1290
1317
|
#
|
|
1291
|
-
# [1]: https://docs.aws.amazon.com/
|
|
1318
|
+
# [1]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html
|
|
1292
1319
|
#
|
|
1293
1320
|
# @return [Types::GetCertificateAuthorityCsrResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1294
1321
|
#
|
|
@@ -1331,7 +1358,7 @@ module Aws::ACMPCA
|
|
|
1331
1358
|
# customer account, to Amazon Web Services Organizations, or to an
|
|
1332
1359
|
# Amazon Web Services Organizations unit. Policies are under the
|
|
1333
1360
|
# control of a CA administrator. For more information, see [Using a
|
|
1334
|
-
# Resource Based Policy with
|
|
1361
|
+
# Resource Based Policy with Amazon Web Services Private CA][3].
|
|
1335
1362
|
#
|
|
1336
1363
|
# * A policy permits a user of Certificate Manager (ACM) to issue ACM
|
|
1337
1364
|
# certificates signed by a CA in another account.
|
|
@@ -1339,8 +1366,8 @@ module Aws::ACMPCA
|
|
|
1339
1366
|
# * For ACM to manage automatic renewal of these certificates, the ACM
|
|
1340
1367
|
# user must configure a Service Linked Role (SLR). The SLR allows the
|
|
1341
1368
|
# ACM service to assume the identity of the user, subject to
|
|
1342
|
-
# confirmation against the
|
|
1343
|
-
# information, see [Using a Service Linked Role with ACM][4].
|
|
1369
|
+
# confirmation against the Amazon Web Services Private CA policy. For
|
|
1370
|
+
# more information, see [Using a Service Linked Role with ACM][4].
|
|
1344
1371
|
#
|
|
1345
1372
|
# * Updates made in Amazon Web Services Resource Manager (RAM) are
|
|
1346
1373
|
# reflected in policies. For more information, see [Attach a Policy
|
|
@@ -1348,11 +1375,11 @@ module Aws::ACMPCA
|
|
|
1348
1375
|
#
|
|
1349
1376
|
#
|
|
1350
1377
|
#
|
|
1351
|
-
# [1]: https://docs.aws.amazon.com/
|
|
1352
|
-
# [2]: https://docs.aws.amazon.com/
|
|
1353
|
-
# [3]: https://docs.aws.amazon.com/
|
|
1378
|
+
# [1]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_PutPolicy.html
|
|
1379
|
+
# [2]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeletePolicy.html
|
|
1380
|
+
# [3]: https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html
|
|
1354
1381
|
# [4]: https://docs.aws.amazon.com/acm/latest/userguide/acm-slr.html
|
|
1355
|
-
# [5]: https://docs.aws.amazon.com/
|
|
1382
|
+
# [5]: https://docs.aws.amazon.com/privateca/latest/userguide/pca-ram.html
|
|
1356
1383
|
#
|
|
1357
1384
|
# @option params [required, String] :resource_arn
|
|
1358
1385
|
# The Amazon Resource Number (ARN) of the private CA that will have its
|
|
@@ -1382,14 +1409,14 @@ module Aws::ACMPCA
|
|
|
1382
1409
|
req.send_request(options)
|
|
1383
1410
|
end
|
|
1384
1411
|
|
|
1385
|
-
# Imports a signed private CA certificate into
|
|
1386
|
-
# action is used when you are using a chain of trust
|
|
1387
|
-
# located outside
|
|
1388
|
-
# following preparations must in place:
|
|
1412
|
+
# Imports a signed private CA certificate into Amazon Web Services
|
|
1413
|
+
# Private CA. This action is used when you are using a chain of trust
|
|
1414
|
+
# whose root is located outside Amazon Web Services Private CA. Before
|
|
1415
|
+
# you can call this action, the following preparations must in place:
|
|
1389
1416
|
#
|
|
1390
|
-
# 1. In
|
|
1391
|
-
# to create the private CA
|
|
1392
|
-
# certificate.
|
|
1417
|
+
# 1. In Amazon Web Services Private CA, call the
|
|
1418
|
+
# [CreateCertificateAuthority][1] action to create the private CA
|
|
1419
|
+
# that you plan to back with the imported certificate.
|
|
1393
1420
|
#
|
|
1394
1421
|
# 2. Call the [GetCertificateAuthorityCsr][2] action to generate a
|
|
1395
1422
|
# certificate signing request (CSR).
|
|
@@ -1400,13 +1427,14 @@ module Aws::ACMPCA
|
|
|
1400
1427
|
# 4. Create a certificate chain and copy the signed certificate and the
|
|
1401
1428
|
# certificate chain to your working directory.
|
|
1402
1429
|
#
|
|
1403
|
-
#
|
|
1404
|
-
# certificate:
|
|
1430
|
+
# Amazon Web Services Private CA supports three scenarios for installing
|
|
1431
|
+
# a CA certificate:
|
|
1405
1432
|
#
|
|
1406
|
-
# * Installing a certificate for a root CA hosted by
|
|
1433
|
+
# * Installing a certificate for a root CA hosted by Amazon Web Services
|
|
1434
|
+
# Private CA.
|
|
1407
1435
|
#
|
|
1408
1436
|
# * Installing a subordinate CA certificate whose parent authority is
|
|
1409
|
-
# hosted by
|
|
1437
|
+
# hosted by Amazon Web Services Private CA.
|
|
1410
1438
|
#
|
|
1411
1439
|
# * Installing a subordinate CA certificate whose parent authority is
|
|
1412
1440
|
# externally hosted.
|
|
@@ -1434,8 +1462,8 @@ module Aws::ACMPCA
|
|
|
1434
1462
|
#
|
|
1435
1463
|
# *Enforcement of Critical Constraints*
|
|
1436
1464
|
#
|
|
1437
|
-
#
|
|
1438
|
-
# in the imported CA certificate or chain.
|
|
1465
|
+
# Amazon Web Services Private CA allows the following extensions to be
|
|
1466
|
+
# marked critical in the imported CA certificate or chain.
|
|
1439
1467
|
#
|
|
1440
1468
|
# * Basic constraints (*must* be marked critical)
|
|
1441
1469
|
#
|
|
@@ -1461,8 +1489,8 @@ module Aws::ACMPCA
|
|
|
1461
1489
|
#
|
|
1462
1490
|
# * Inhibit anyPolicy
|
|
1463
1491
|
#
|
|
1464
|
-
#
|
|
1465
|
-
# critical in an imported CA certificate or chain.
|
|
1492
|
+
# Amazon Web Services Private CA rejects the following extensions when
|
|
1493
|
+
# they are marked critical in an imported CA certificate or chain.
|
|
1466
1494
|
#
|
|
1467
1495
|
# * Name constraints
|
|
1468
1496
|
#
|
|
@@ -1478,8 +1506,8 @@ module Aws::ACMPCA
|
|
|
1478
1506
|
#
|
|
1479
1507
|
#
|
|
1480
1508
|
#
|
|
1481
|
-
# [1]: https://docs.aws.amazon.com/
|
|
1482
|
-
# [2]: https://docs.aws.amazon.com/
|
|
1509
|
+
# [1]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html
|
|
1510
|
+
# [2]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_GetCertificateAuthorityCsr.html
|
|
1483
1511
|
#
|
|
1484
1512
|
# @option params [required, String] :certificate_authority_arn
|
|
1485
1513
|
# The Amazon Resource Name (ARN) that was returned when you called
|
|
@@ -1490,7 +1518,7 @@ module Aws::ACMPCA
|
|
|
1490
1518
|
#
|
|
1491
1519
|
#
|
|
1492
1520
|
#
|
|
1493
|
-
# [1]: https://docs.aws.amazon.com/
|
|
1521
|
+
# [1]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html
|
|
1494
1522
|
#
|
|
1495
1523
|
# @option params [required, String, StringIO, File] :certificate
|
|
1496
1524
|
# The PEM-encoded certificate for a private CA. This may be a
|
|
@@ -1500,8 +1528,9 @@ module Aws::ACMPCA
|
|
|
1500
1528
|
# @option params [String, StringIO, File] :certificate_chain
|
|
1501
1529
|
# A PEM-encoded file that contains all of your certificates, other than
|
|
1502
1530
|
# the certificate you're importing, chaining up to your root CA. Your
|
|
1503
|
-
#
|
|
1504
|
-
# the chain, and each certificate in the chain signs the
|
|
1531
|
+
# Amazon Web Services Private CA-hosted or on-premises root certificate
|
|
1532
|
+
# is the last in the chain, and each certificate in the chain signs the
|
|
1533
|
+
# one preceding.
|
|
1505
1534
|
#
|
|
1506
1535
|
# This parameter must be supplied when you import a subordinate CA. When
|
|
1507
1536
|
# you import a root CA, there is no chain.
|
|
@@ -1532,14 +1561,14 @@ module Aws::ACMPCA
|
|
|
1532
1561
|
# specifying the ARN.
|
|
1533
1562
|
#
|
|
1534
1563
|
# <note markdown="1"> You cannot use the ACM **ListCertificateAuthorities** action to
|
|
1535
|
-
# retrieve the ARNs of the certificates that you issue by using
|
|
1536
|
-
# Private CA.
|
|
1564
|
+
# retrieve the ARNs of the certificates that you issue by using Amazon
|
|
1565
|
+
# Web Services Private CA.
|
|
1537
1566
|
#
|
|
1538
1567
|
# </note>
|
|
1539
1568
|
#
|
|
1540
1569
|
#
|
|
1541
1570
|
#
|
|
1542
|
-
# [1]: https://docs.aws.amazon.com/
|
|
1571
|
+
# [1]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_GetCertificate.html
|
|
1543
1572
|
#
|
|
1544
1573
|
# @option params [Types::ApiPassthrough] :api_passthrough
|
|
1545
1574
|
# Specifies X.509 certificate information to be included in the issued
|
|
@@ -1549,13 +1578,13 @@ module Aws::ACMPCA
|
|
|
1549
1578
|
# Certificate Templates][1].
|
|
1550
1579
|
#
|
|
1551
1580
|
# If conflicting or duplicate certificate information is supplied during
|
|
1552
|
-
# certificate issuance,
|
|
1553
|
-
# rules][2] to determine what information is used.
|
|
1581
|
+
# certificate issuance, Amazon Web Services Private CA applies [order of
|
|
1582
|
+
# operation rules][2] to determine what information is used.
|
|
1554
1583
|
#
|
|
1555
1584
|
#
|
|
1556
1585
|
#
|
|
1557
|
-
# [1]: https://docs.aws.amazon.com/
|
|
1558
|
-
# [2]: https://docs.aws.amazon.com/
|
|
1586
|
+
# [1]: https://docs.aws.amazon.com/privateca/latest/userguide/UsingTemplates.html
|
|
1587
|
+
# [2]: https://docs.aws.amazon.com/privateca/latest/userguide/UsingTemplates.html#template-order-of-operations
|
|
1559
1588
|
#
|
|
1560
1589
|
# @option params [required, String] :certificate_authority_arn
|
|
1561
1590
|
# The Amazon Resource Name (ARN) that was returned when you called
|
|
@@ -1566,7 +1595,7 @@ module Aws::ACMPCA
|
|
|
1566
1595
|
#
|
|
1567
1596
|
#
|
|
1568
1597
|
#
|
|
1569
|
-
# [1]: https://docs.aws.amazon.com/
|
|
1598
|
+
# [1]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html
|
|
1570
1599
|
#
|
|
1571
1600
|
# @option params [required, String, StringIO, File] :csr
|
|
1572
1601
|
# The certificate signing request (CSR) for the certificate you want to
|
|
@@ -1602,8 +1631,8 @@ module Aws::ACMPCA
|
|
|
1602
1631
|
#
|
|
1603
1632
|
# @option params [String] :template_arn
|
|
1604
1633
|
# Specifies a custom configuration template to use when issuing a
|
|
1605
|
-
# certificate. If this parameter is not provided,
|
|
1606
|
-
# defaults to the `EndEntityCertificate/V1` template. For CA
|
|
1634
|
+
# certificate. If this parameter is not provided, Amazon Web Services
|
|
1635
|
+
# Private CA defaults to the `EndEntityCertificate/V1` template. For CA
|
|
1607
1636
|
# certificates, you should choose the shortest path length that meets
|
|
1608
1637
|
# your needs. The path length is indicated by the PathLen*N* portion of
|
|
1609
1638
|
# the ARN, where *N* is the [CA depth][1].
|
|
@@ -1611,13 +1640,13 @@ module Aws::ACMPCA
|
|
|
1611
1640
|
# Note: The CA depth configured on a subordinate CA certificate must not
|
|
1612
1641
|
# exceed the limit set by its parents in the CA hierarchy.
|
|
1613
1642
|
#
|
|
1614
|
-
# For a list of `TemplateArn` values supported by
|
|
1615
|
-
# [Understanding Certificate Templates][2].
|
|
1643
|
+
# For a list of `TemplateArn` values supported by Amazon Web Services
|
|
1644
|
+
# Private CA, see [Understanding Certificate Templates][2].
|
|
1616
1645
|
#
|
|
1617
1646
|
#
|
|
1618
1647
|
#
|
|
1619
|
-
# [1]: https://docs.aws.amazon.com/
|
|
1620
|
-
# [2]: https://docs.aws.amazon.com/
|
|
1648
|
+
# [1]: https://docs.aws.amazon.com/privateca/latest/userguide/PcaTerms.html#terms-cadepth
|
|
1649
|
+
# [2]: https://docs.aws.amazon.com/privateca/latest/userguide/UsingTemplates.html
|
|
1621
1650
|
#
|
|
1622
1651
|
# @option params [required, Types::Validity] :validity
|
|
1623
1652
|
# Information describing the end of the validity period of the
|
|
@@ -1647,10 +1676,10 @@ module Aws::ACMPCA
|
|
|
1647
1676
|
# certificate. This parameter sets the “Not Before" date for the
|
|
1648
1677
|
# certificate.
|
|
1649
1678
|
#
|
|
1650
|
-
# By default, when issuing a certificate,
|
|
1651
|
-
# Before" date to the issuance time minus 60 minutes.
|
|
1652
|
-
# for clock inconsistencies across computer systems.
|
|
1653
|
-
# `ValidityNotBefore` parameter can be used to customize the “Not
|
|
1679
|
+
# By default, when issuing a certificate, Amazon Web Services Private CA
|
|
1680
|
+
# sets the "Not Before" date to the issuance time minus 60 minutes.
|
|
1681
|
+
# This compensates for clock inconsistencies across computer systems.
|
|
1682
|
+
# The `ValidityNotBefore` parameter can be used to customize the “Not
|
|
1654
1683
|
# Before” value.
|
|
1655
1684
|
#
|
|
1656
1685
|
# Unlike the `Validity` parameter, the `ValidityNotBefore` parameter is
|
|
@@ -1671,10 +1700,10 @@ module Aws::ACMPCA
|
|
|
1671
1700
|
# the **IssueCertificate** action. Idempotency tokens for
|
|
1672
1701
|
# **IssueCertificate** time out after one minute. Therefore, if you call
|
|
1673
1702
|
# **IssueCertificate** multiple times with the same idempotency token
|
|
1674
|
-
# within one minute,
|
|
1675
|
-
# only one certificate and will issue only one. If you
|
|
1676
|
-
# idempotency token for each call,
|
|
1677
|
-
# requesting multiple certificates.
|
|
1703
|
+
# within one minute, Amazon Web Services Private CA recognizes that you
|
|
1704
|
+
# are requesting only one certificate and will issue only one. If you
|
|
1705
|
+
# change the idempotency token for each call, Amazon Web Services
|
|
1706
|
+
# Private CA recognizes that you are requesting multiple certificates.
|
|
1678
1707
|
#
|
|
1679
1708
|
# @return [Types::IssueCertificateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1680
1709
|
#
|
|
@@ -1818,7 +1847,7 @@ module Aws::ACMPCA
|
|
|
1818
1847
|
#
|
|
1819
1848
|
#
|
|
1820
1849
|
#
|
|
1821
|
-
# [1]: https://docs.aws.amazon.com/
|
|
1850
|
+
# [1]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html
|
|
1822
1851
|
#
|
|
1823
1852
|
# @option params [String] :next_token
|
|
1824
1853
|
# Use this parameter when paginating results in a subsequent request
|
|
@@ -1966,14 +1995,14 @@ module Aws::ACMPCA
|
|
|
1966
1995
|
# accounts, then permissions cannot be used to enable automatic
|
|
1967
1996
|
# renewals. Instead, the ACM certificate owner must set up a
|
|
1968
1997
|
# resource-based policy to enable cross-account issuance and renewals.
|
|
1969
|
-
# For more information, see [Using a Resource Based Policy with
|
|
1970
|
-
# Private CA][3].
|
|
1998
|
+
# For more information, see [Using a Resource Based Policy with Amazon
|
|
1999
|
+
# Web Services Private CA][3].
|
|
1971
2000
|
#
|
|
1972
2001
|
#
|
|
1973
2002
|
#
|
|
1974
|
-
# [1]: https://docs.aws.amazon.com/
|
|
1975
|
-
# [2]: https://docs.aws.amazon.com/
|
|
1976
|
-
# [3]: https://docs.aws.amazon.com/
|
|
2003
|
+
# [1]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreatePermission.html
|
|
2004
|
+
# [2]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeletePermission.html
|
|
2005
|
+
# [3]: https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html
|
|
1977
2006
|
#
|
|
1978
2007
|
# @option params [required, String] :certificate_authority_arn
|
|
1979
2008
|
# The Amazon Resource Number (ARN) of the private CA to inspect. You can
|
|
@@ -1985,7 +2014,7 @@ module Aws::ACMPCA
|
|
|
1985
2014
|
#
|
|
1986
2015
|
#
|
|
1987
2016
|
#
|
|
1988
|
-
# [1]: https://docs.aws.amazon.com/
|
|
2017
|
+
# [1]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html
|
|
1989
2018
|
#
|
|
1990
2019
|
# @option params [String] :next_token
|
|
1991
2020
|
# When paginating results, use this parameter in a subsequent request
|
|
@@ -2044,8 +2073,8 @@ module Aws::ACMPCA
|
|
|
2044
2073
|
#
|
|
2045
2074
|
#
|
|
2046
2075
|
#
|
|
2047
|
-
# [1]: https://docs.aws.amazon.com/
|
|
2048
|
-
# [2]: https://docs.aws.amazon.com/
|
|
2076
|
+
# [1]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_TagCertificateAuthority.html
|
|
2077
|
+
# [2]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_UntagCertificateAuthority.html
|
|
2049
2078
|
#
|
|
2050
2079
|
# @option params [required, String] :certificate_authority_arn
|
|
2051
2080
|
# The Amazon Resource Name (ARN) that was returned when you called the
|
|
@@ -2056,7 +2085,7 @@ module Aws::ACMPCA
|
|
|
2056
2085
|
#
|
|
2057
2086
|
#
|
|
2058
2087
|
#
|
|
2059
|
-
# [1]: https://docs.aws.amazon.com/
|
|
2088
|
+
# [1]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html
|
|
2060
2089
|
#
|
|
2061
2090
|
# @option params [String] :next_token
|
|
2062
2091
|
# Use this parameter when paginating results in a subsequent request
|
|
@@ -2116,7 +2145,7 @@ module Aws::ACMPCA
|
|
|
2116
2145
|
# customer account, to Amazon Web Services Organizations, or to an
|
|
2117
2146
|
# Amazon Web Services Organizations unit. Policies are under the
|
|
2118
2147
|
# control of a CA administrator. For more information, see [Using a
|
|
2119
|
-
# Resource Based Policy with
|
|
2148
|
+
# Resource Based Policy with Amazon Web Services Private CA][4].
|
|
2120
2149
|
#
|
|
2121
2150
|
# * A policy permits a user of Certificate Manager (ACM) to issue ACM
|
|
2122
2151
|
# certificates signed by a CA in another account.
|
|
@@ -2124,8 +2153,8 @@ module Aws::ACMPCA
|
|
|
2124
2153
|
# * For ACM to manage automatic renewal of these certificates, the ACM
|
|
2125
2154
|
# user must configure a Service Linked Role (SLR). The SLR allows the
|
|
2126
2155
|
# ACM service to assume the identity of the user, subject to
|
|
2127
|
-
# confirmation against the
|
|
2128
|
-
# information, see [Using a Service Linked Role with ACM][5].
|
|
2156
|
+
# confirmation against the Amazon Web Services Private CA policy. For
|
|
2157
|
+
# more information, see [Using a Service Linked Role with ACM][5].
|
|
2129
2158
|
#
|
|
2130
2159
|
# * Updates made in Amazon Web Services Resource Manager (RAM) are
|
|
2131
2160
|
# reflected in policies. For more information, see [Attach a Policy
|
|
@@ -2133,10 +2162,10 @@ module Aws::ACMPCA
|
|
|
2133
2162
|
#
|
|
2134
2163
|
#
|
|
2135
2164
|
#
|
|
2136
|
-
# [1]: https://docs.aws.amazon.com/
|
|
2137
|
-
# [2]: https://docs.aws.amazon.com/
|
|
2138
|
-
# [3]: https://docs.aws.amazon.com/
|
|
2139
|
-
# [4]: https://docs.aws.amazon.com/
|
|
2165
|
+
# [1]: https://docs.aws.amazon.com/privateca/latest/userguide/pca-ram.html
|
|
2166
|
+
# [2]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_GetPolicy.html
|
|
2167
|
+
# [3]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeletePolicy.html
|
|
2168
|
+
# [4]: https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html
|
|
2140
2169
|
# [5]: https://docs.aws.amazon.com/acm/latest/userguide/acm-slr.html
|
|
2141
2170
|
#
|
|
2142
2171
|
# @option params [required, String] :resource_arn
|
|
@@ -2148,7 +2177,7 @@ module Aws::ACMPCA
|
|
|
2148
2177
|
#
|
|
2149
2178
|
#
|
|
2150
2179
|
#
|
|
2151
|
-
# [1]: https://docs.aws.amazon.com/
|
|
2180
|
+
# [1]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html
|
|
2152
2181
|
#
|
|
2153
2182
|
# @option params [required, String] :policy
|
|
2154
2183
|
# The path and file name of a JSON-formatted IAM policy to attach to the
|
|
@@ -2200,11 +2229,11 @@ module Aws::ACMPCA
|
|
|
2200
2229
|
#
|
|
2201
2230
|
#
|
|
2202
2231
|
#
|
|
2203
|
-
# [1]: https://docs.aws.amazon.com/
|
|
2204
|
-
# [2]: https://docs.aws.amazon.com/
|
|
2205
|
-
# [3]: https://docs.aws.amazon.com/
|
|
2206
|
-
# [4]: https://docs.aws.amazon.com/
|
|
2207
|
-
# [5]: https://docs.aws.amazon.com/
|
|
2232
|
+
# [1]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeleteCertificateAuthority.html
|
|
2233
|
+
# [2]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_DescribeCertificateAuthority.html
|
|
2234
|
+
# [3]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html
|
|
2235
|
+
# [4]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_UpdateCertificateAuthority.html
|
|
2236
|
+
# [5]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_ImportCertificateAuthorityCertificate.html
|
|
2208
2237
|
#
|
|
2209
2238
|
# @option params [required, String] :certificate_authority_arn
|
|
2210
2239
|
# The Amazon Resource Name (ARN) that was returned when you called the
|
|
@@ -2215,7 +2244,7 @@ module Aws::ACMPCA
|
|
|
2215
2244
|
#
|
|
2216
2245
|
#
|
|
2217
2246
|
#
|
|
2218
|
-
# [1]: https://docs.aws.amazon.com/
|
|
2247
|
+
# [1]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html
|
|
2219
2248
|
#
|
|
2220
2249
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
2221
2250
|
#
|
|
@@ -2234,26 +2263,29 @@ module Aws::ACMPCA
|
|
|
2234
2263
|
req.send_request(options)
|
|
2235
2264
|
end
|
|
2236
2265
|
|
|
2237
|
-
# Revokes a certificate that was issued inside
|
|
2238
|
-
# enable a certificate revocation list (CRL) when you
|
|
2239
|
-
# your private CA, information about the revoked
|
|
2240
|
-
# included in the CRL.
|
|
2241
|
-
# that you specify. A CRL is typically
|
|
2242
|
-
# after a certificate is revoked. If
|
|
2243
|
-
#
|
|
2244
|
-
#
|
|
2245
|
-
#
|
|
2246
|
-
#
|
|
2247
|
-
#
|
|
2248
|
-
#
|
|
2249
|
-
#
|
|
2250
|
-
#
|
|
2251
|
-
#
|
|
2266
|
+
# Revokes a certificate that was issued inside Amazon Web Services
|
|
2267
|
+
# Private CA. If you enable a certificate revocation list (CRL) when you
|
|
2268
|
+
# create or update your private CA, information about the revoked
|
|
2269
|
+
# certificates will be included in the CRL. Amazon Web Services Private
|
|
2270
|
+
# CA writes the CRL to an S3 bucket that you specify. A CRL is typically
|
|
2271
|
+
# updated approximately 30 minutes after a certificate is revoked. If
|
|
2272
|
+
# for any reason the CRL update fails, Amazon Web Services Private CA
|
|
2273
|
+
# attempts makes further attempts every 15 minutes. With Amazon
|
|
2274
|
+
# CloudWatch, you can create alarms for the metrics `CRLGenerated` and
|
|
2275
|
+
# `MisconfiguredCRLBucket`. For more information, see [Supported
|
|
2276
|
+
# CloudWatch Metrics][1].
|
|
2277
|
+
#
|
|
2278
|
+
# <note markdown="1"> Both Amazon Web Services Private CA and the IAM principal must have
|
|
2279
|
+
# permission to write to the S3 bucket that you specify. If the IAM
|
|
2280
|
+
# principal making the call does not have permission to write to the
|
|
2281
|
+
# bucket, then an exception is thrown. For more information, see [Access
|
|
2282
|
+
# policies for CRLs in Amazon S3][2].
|
|
2252
2283
|
#
|
|
2253
2284
|
# </note>
|
|
2254
2285
|
#
|
|
2255
|
-
#
|
|
2256
|
-
# For more information, see
|
|
2286
|
+
# Amazon Web Services Private CA also writes revocation information to
|
|
2287
|
+
# the audit report. For more information, see
|
|
2288
|
+
# [CreateCertificateAuthorityAuditReport][3].
|
|
2257
2289
|
#
|
|
2258
2290
|
# <note markdown="1"> You cannot revoke a root CA self-signed certificate.
|
|
2259
2291
|
#
|
|
@@ -2261,9 +2293,9 @@ module Aws::ACMPCA
|
|
|
2261
2293
|
#
|
|
2262
2294
|
#
|
|
2263
2295
|
#
|
|
2264
|
-
# [1]: https://docs.aws.amazon.com/
|
|
2265
|
-
# [2]: https://docs.aws.amazon.com/
|
|
2266
|
-
# [3]: https://docs.aws.amazon.com/
|
|
2296
|
+
# [1]: https://docs.aws.amazon.com/privateca/latest/userguide/PcaCloudWatch.html
|
|
2297
|
+
# [2]: https://docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html#s3-policies
|
|
2298
|
+
# [3]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthorityAuditReport.html
|
|
2267
2299
|
#
|
|
2268
2300
|
# @option params [required, String] :certificate_authority_arn
|
|
2269
2301
|
# Amazon Resource Name (ARN) of the private CA that issued the
|
|
@@ -2289,7 +2321,7 @@ module Aws::ACMPCA
|
|
|
2289
2321
|
#
|
|
2290
2322
|
#
|
|
2291
2323
|
#
|
|
2292
|
-
# [1]: https://docs.aws.amazon.com/
|
|
2324
|
+
# [1]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_GetCertificate.html
|
|
2293
2325
|
# [2]: https://docs.aws.amazon.com/acm/latest/APIReference/API_DescribeCertificate.html
|
|
2294
2326
|
#
|
|
2295
2327
|
# @option params [required, String] :revocation_reason
|
|
@@ -2325,10 +2357,19 @@ module Aws::ACMPCA
|
|
|
2325
2357
|
# the [UntagCertificateAuthority][1] action. Call the [ListTags][2]
|
|
2326
2358
|
# action to see what tags are associated with your CA.
|
|
2327
2359
|
#
|
|
2360
|
+
# <note markdown="1"> To attach tags to a private CA during the creation procedure, a CA
|
|
2361
|
+
# administrator must first associate an inline IAM policy with the
|
|
2362
|
+
# `CreateCertificateAuthority` action and explicitly allow tagging. For
|
|
2363
|
+
# more information, see [Attaching tags to a CA at the time of
|
|
2364
|
+
# creation][3].
|
|
2365
|
+
#
|
|
2366
|
+
# </note>
|
|
2367
|
+
#
|
|
2328
2368
|
#
|
|
2329
2369
|
#
|
|
2330
|
-
# [1]: https://docs.aws.amazon.com/
|
|
2331
|
-
# [2]: https://docs.aws.amazon.com/
|
|
2370
|
+
# [1]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_UntagCertificateAuthority.html
|
|
2371
|
+
# [2]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListTags.html
|
|
2372
|
+
# [3]: https://docs.aws.amazon.com/privateca/latest/userguide/auth-InlinePolicies.html#policy-tag-ca
|
|
2332
2373
|
#
|
|
2333
2374
|
# @option params [required, String] :certificate_authority_arn
|
|
2334
2375
|
# The Amazon Resource Name (ARN) that was returned when you called
|
|
@@ -2339,7 +2380,7 @@ module Aws::ACMPCA
|
|
|
2339
2380
|
#
|
|
2340
2381
|
#
|
|
2341
2382
|
#
|
|
2342
|
-
# [1]: https://docs.aws.amazon.com/
|
|
2383
|
+
# [1]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html
|
|
2343
2384
|
#
|
|
2344
2385
|
# @option params [required, Array<Types::Tag>] :tags
|
|
2345
2386
|
# List of tags to be associated with the CA.
|
|
@@ -2377,8 +2418,8 @@ module Aws::ACMPCA
|
|
|
2377
2418
|
#
|
|
2378
2419
|
#
|
|
2379
2420
|
#
|
|
2380
|
-
# [1]: https://docs.aws.amazon.com/
|
|
2381
|
-
# [2]: https://docs.aws.amazon.com/
|
|
2421
|
+
# [1]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_TagCertificateAuthority.html
|
|
2422
|
+
# [2]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListTags.html
|
|
2382
2423
|
#
|
|
2383
2424
|
# @option params [required, String] :certificate_authority_arn
|
|
2384
2425
|
# The Amazon Resource Name (ARN) that was returned when you called
|
|
@@ -2389,7 +2430,7 @@ module Aws::ACMPCA
|
|
|
2389
2430
|
#
|
|
2390
2431
|
#
|
|
2391
2432
|
#
|
|
2392
|
-
# [1]: https://docs.aws.amazon.com/
|
|
2433
|
+
# [1]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html
|
|
2393
2434
|
#
|
|
2394
2435
|
# @option params [required, Array<Types::Tag>] :tags
|
|
2395
2436
|
# List of tags to be removed from the CA.
|
|
@@ -2423,16 +2464,17 @@ module Aws::ACMPCA
|
|
|
2423
2464
|
# `ACTIVE` state or make a CA that is in the `DISABLED` state active
|
|
2424
2465
|
# again.
|
|
2425
2466
|
#
|
|
2426
|
-
# <note markdown="1"> Both
|
|
2427
|
-
# bucket that you specify. If the IAM
|
|
2428
|
-
# have permission to write to the
|
|
2429
|
-
# For more information, see [Access
|
|
2467
|
+
# <note markdown="1"> Both Amazon Web Services Private CA and the IAM principal must have
|
|
2468
|
+
# permission to write to the S3 bucket that you specify. If the IAM
|
|
2469
|
+
# principal making the call does not have permission to write to the
|
|
2470
|
+
# bucket, then an exception is thrown. For more information, see [Access
|
|
2471
|
+
# policies for CRLs in Amazon S3][1].
|
|
2430
2472
|
#
|
|
2431
2473
|
# </note>
|
|
2432
2474
|
#
|
|
2433
2475
|
#
|
|
2434
2476
|
#
|
|
2435
|
-
# [1]: https://docs.aws.amazon.com/
|
|
2477
|
+
# [1]: https://docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html#s3-policies
|
|
2436
2478
|
#
|
|
2437
2479
|
# @option params [required, String] :certificate_authority_arn
|
|
2438
2480
|
# Amazon Resource Name (ARN) of the private CA that issued the
|
|
@@ -2448,10 +2490,30 @@ module Aws::ACMPCA
|
|
|
2448
2490
|
# existing capibilites remain unchanged. For more information, see the
|
|
2449
2491
|
# [OcspConfiguration][1] and [CrlConfiguration][2] types.
|
|
2450
2492
|
#
|
|
2493
|
+
# <note markdown="1"> The following requirements apply to revocation configurations.
|
|
2494
|
+
#
|
|
2495
|
+
# * A configuration disabling CRLs or OCSP must contain only the
|
|
2496
|
+
# `Enabled=False` parameter, and will fail if other parameters such as
|
|
2497
|
+
# `CustomCname` or `ExpirationInDays` are included.
|
|
2498
|
+
#
|
|
2499
|
+
# * In a CRL configuration, the `S3BucketName` parameter must conform to
|
|
2500
|
+
# [Amazon S3 bucket naming rules][3].
|
|
2501
|
+
#
|
|
2502
|
+
# * A configuration containing a custom Canonical Name (CNAME) parameter
|
|
2503
|
+
# for CRLs or OCSP must conform to [RFC2396][4] restrictions on the
|
|
2504
|
+
# use of special characters in a CNAME.
|
|
2505
|
+
#
|
|
2506
|
+
# * In a CRL or OCSP configuration, the value of a CNAME parameter must
|
|
2507
|
+
# not include a protocol prefix such as "http://" or "https://".
|
|
2508
|
+
#
|
|
2509
|
+
# </note>
|
|
2510
|
+
#
|
|
2451
2511
|
#
|
|
2452
2512
|
#
|
|
2453
|
-
# [1]: https://docs.aws.amazon.com/
|
|
2454
|
-
# [2]: https://docs.aws.amazon.com/
|
|
2513
|
+
# [1]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_OcspConfiguration.html
|
|
2514
|
+
# [2]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_CrlConfiguration.html
|
|
2515
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html
|
|
2516
|
+
# [4]: https://www.ietf.org/rfc/rfc2396.txt
|
|
2455
2517
|
#
|
|
2456
2518
|
# @option params [String] :status
|
|
2457
2519
|
# Status of your private CA.
|
|
@@ -2466,13 +2528,13 @@ module Aws::ACMPCA
|
|
|
2466
2528
|
# crl_configuration: {
|
|
2467
2529
|
# enabled: false, # required
|
|
2468
2530
|
# expiration_in_days: 1,
|
|
2469
|
-
# custom_cname: "
|
|
2470
|
-
# s3_bucket_name: "
|
|
2531
|
+
# custom_cname: "CnameString",
|
|
2532
|
+
# s3_bucket_name: "S3BucketName3To255",
|
|
2471
2533
|
# s3_object_acl: "PUBLIC_READ", # accepts PUBLIC_READ, BUCKET_OWNER_FULL_CONTROL
|
|
2472
2534
|
# },
|
|
2473
2535
|
# ocsp_configuration: {
|
|
2474
2536
|
# enabled: false, # required
|
|
2475
|
-
# ocsp_custom_cname: "
|
|
2537
|
+
# ocsp_custom_cname: "CnameString",
|
|
2476
2538
|
# },
|
|
2477
2539
|
# },
|
|
2478
2540
|
# status: "CREATING", # accepts CREATING, PENDING_CERTIFICATE, ACTIVE, DELETED, DISABLED, EXPIRED, FAILED
|
|
@@ -2500,7 +2562,7 @@ module Aws::ACMPCA
|
|
|
2500
2562
|
params: params,
|
|
2501
2563
|
config: config)
|
|
2502
2564
|
context[:gem_name] = 'aws-sdk-acmpca'
|
|
2503
|
-
context[:gem_version] = '1.
|
|
2565
|
+
context[:gem_version] = '1.53.0'
|
|
2504
2566
|
Seahorse::Client::Request.new(handlers, context)
|
|
2505
2567
|
end
|
|
2506
2568
|
|