/
models_0.ts
2680 lines (2403 loc) · 94.9 KB
/
models_0.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// smithy-typescript generated code
import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
import { ACMPCAServiceException as __BaseException } from "./ACMPCAServiceException";
/**
* <p>Defines the X.500 relative distinguished name (RDN).</p>
*/
export interface CustomAttribute {
/**
* <p>Specifies the object identifier (OID) of the attribute type of the relative
* distinguished name (RDN).</p>
*/
ObjectIdentifier: string | undefined;
/**
* <p></p>
* <p>Specifies the attribute value of relative distinguished name (RDN).</p>
*/
Value: string | undefined;
}
/**
* <p>Contains information about the certificate subject. The <code>Subject</code> field in
* the certificate identifies the entity that owns or controls the public key in the
* certificate. The entity can be a user, computer, device, or service. The <code>Subject
* </code>must contain an X.500 distinguished name (DN). A DN is a sequence of relative
* distinguished names (RDNs). The RDNs are separated by commas in the certificate.</p>
*/
export interface ASN1Subject {
/**
* <p>Two-digit code that specifies the country in which the certificate subject
* located.</p>
*/
Country?: string;
/**
* <p>Legal name of the organization with which the certificate subject is affiliated.
* </p>
*/
Organization?: string;
/**
* <p>A subdivision or unit of the organization (such as sales or finance) with which the
* certificate subject is affiliated.</p>
*/
OrganizationalUnit?: string;
/**
* <p>Disambiguating information for the certificate subject.</p>
*/
DistinguishedNameQualifier?: string;
/**
* <p>State in which the subject of the certificate is located.</p>
*/
State?: string;
/**
* <p>For CA and end-entity certificates in a private PKI, the common name (CN) can be any
* string within the length limit. </p>
* <p>Note: In publicly trusted certificates, the common name must be a fully qualified
* domain name (FQDN) associated with the certificate subject.</p>
*/
CommonName?: string;
/**
* <p>The certificate serial number.</p>
*/
SerialNumber?: string;
/**
* <p>The locality (such as a city or town) in which the certificate subject is
* located.</p>
*/
Locality?: string;
/**
* <p>A title such as Mr. or Ms., which is pre-pended to the name to refer formally to the
* certificate subject.</p>
*/
Title?: string;
/**
* <p>Family name. In the US and the UK, for example, the surname of an individual is
* ordered last. In Asian cultures the surname is typically ordered first.</p>
*/
Surname?: string;
/**
* <p>First name.</p>
*/
GivenName?: string;
/**
* <p>Concatenation that typically contains the first letter of the <b>GivenName</b>, the first letter of the middle name if one exists, and the
* first letter of the <b>Surname</b>.</p>
*/
Initials?: string;
/**
* <p>Typically a shortened version of a longer <b>GivenName</b>.
* For example, Jonathan is often shortened to John. Elizabeth is often shortened to Beth,
* Liz, or Eliza.</p>
*/
Pseudonym?: string;
/**
* <p>Typically a qualifier appended to the name of an individual. Examples include Jr. for
* junior, Sr. for senior, and III for third.</p>
*/
GenerationQualifier?: string;
/**
* <p></p>
* <p>Contains a sequence of one or more X.500 relative distinguished names (RDNs), each of
* which consists of an object identifier (OID) and a value. For more information, see
* NIST’s definition of <a href="https://csrc.nist.gov/glossary/term/Object_Identifier">Object Identifier (OID)</a>.</p>
* <note>
* <p>Custom attributes cannot be used in combination with standard attributes.</p>
* </note>
*/
CustomAttributes?: CustomAttribute[];
}
/**
* <p>Describes an Electronic Data Interchange (EDI) entity as described in as defined in
* <a href="https://datatracker.ietf.org/doc/html/rfc5280">Subject Alternative
* Name</a> in RFC 5280.</p>
*/
export interface EdiPartyName {
/**
* <p>Specifies the party name.</p>
*/
PartyName: string | undefined;
/**
* <p>Specifies the name assigner.</p>
*/
NameAssigner?: string;
}
/**
* <p>Defines a custom ASN.1 X.400 <code>GeneralName</code> using an object identifier (OID)
* and value. The OID must satisfy the regular expression shown below. For more
* information, see NIST's definition of <a href="https://csrc.nist.gov/glossary/term/Object_Identifier">Object Identifier
* (OID)</a>.</p>
*/
export interface OtherName {
/**
* <p>Specifies an OID. </p>
*/
TypeId: string | undefined;
/**
* <p>Specifies an OID value.</p>
*/
Value: string | undefined;
}
/**
* <p>Describes an ASN.1 X.400 <code>GeneralName</code> as defined in <a href="https://datatracker.ietf.org/doc/html/rfc5280">RFC 5280</a>. Only one of
* the following naming options should be provided. Providing more than one option results
* in an <code>InvalidArgsException</code> error.</p>
*/
export interface GeneralName {
/**
* <p>Represents <code>GeneralName</code> using an <code>OtherName</code> object.</p>
*/
OtherName?: OtherName;
/**
* <p>Represents <code>GeneralName</code> as an <a href="https://datatracker.ietf.org/doc/html/rfc822">RFC 822</a> email
* address.</p>
*/
Rfc822Name?: string;
/**
* <p>Represents <code>GeneralName</code> as a DNS name.</p>
*/
DnsName?: string;
/**
* <p>Contains information about the certificate subject. The <code>Subject</code> field in
* the certificate identifies the entity that owns or controls the public key in the
* certificate. The entity can be a user, computer, device, or service. The <code>Subject
* </code>must contain an X.500 distinguished name (DN). A DN is a sequence of relative
* distinguished names (RDNs). The RDNs are separated by commas in the certificate.</p>
*/
DirectoryName?: ASN1Subject;
/**
* <p>Represents <code>GeneralName</code> as an <code>EdiPartyName</code> object.</p>
*/
EdiPartyName?: EdiPartyName;
/**
* <p>Represents <code>GeneralName</code> as a URI.</p>
*/
UniformResourceIdentifier?: string;
/**
* <p>Represents <code>GeneralName</code> as an IPv4 or IPv6 address.</p>
*/
IpAddress?: string;
/**
* <p> Represents <code>GeneralName</code> as an object identifier (OID).</p>
*/
RegisteredId?: string;
}
export enum AccessMethodType {
CA_REPOSITORY = "CA_REPOSITORY",
RESOURCE_PKI_MANIFEST = "RESOURCE_PKI_MANIFEST",
RESOURCE_PKI_NOTIFY = "RESOURCE_PKI_NOTIFY",
}
/**
* <p>Describes the type and format of extension access. Only one of
* <code>CustomObjectIdentifier</code> or <code>AccessMethodType</code> may be
* provided. Providing both results in <code>InvalidArgsException</code>.</p>
*/
export interface AccessMethod {
/**
* <p>An object identifier (OID) specifying the <code>AccessMethod</code>. The OID must
* satisfy the regular expression shown below. For more information, see NIST's definition
* of <a href="https://csrc.nist.gov/glossary/term/Object_Identifier">Object Identifier
* (OID)</a>.</p>
*/
CustomObjectIdentifier?: string;
/**
* <p>Specifies the <code>AccessMethod</code>.</p>
*/
AccessMethodType?: AccessMethodType | string;
}
/**
* <p>Provides access information used by the <code>authorityInfoAccess</code> and
* <code>subjectInfoAccess</code> extensions described in <a href="https://datatracker.ietf.org/doc/html/rfc5280">RFC 5280</a>.</p>
*/
export interface AccessDescription {
/**
* <p>The type and format of <code>AccessDescription</code> information.</p>
*/
AccessMethod: AccessMethod | undefined;
/**
* <p>The location of <code>AccessDescription</code> information.</p>
*/
AccessLocation: GeneralName | undefined;
}
/**
* <p>Defines one or more purposes for which the key contained in the certificate can be
* used. Default value for each option is false.</p>
*/
export interface KeyUsage {
/**
* <p> Key can be used for digital signing.</p>
*/
DigitalSignature?: boolean;
/**
* <p>Key can be used for non-repudiation.</p>
*/
NonRepudiation?: boolean;
/**
* <p>Key can be used to encipher data.</p>
*/
KeyEncipherment?: boolean;
/**
* <p>Key can be used to decipher data.</p>
*/
DataEncipherment?: boolean;
/**
* <p>Key can be used in a key-agreement protocol.</p>
*/
KeyAgreement?: boolean;
/**
* <p>Key can be used to sign certificates.</p>
*/
KeyCertSign?: boolean;
/**
* <p>Key can be used to sign CRLs.</p>
*/
CRLSign?: boolean;
/**
* <p>Key can be used only to encipher data.</p>
*/
EncipherOnly?: boolean;
/**
* <p>Key can be used only to decipher data.</p>
*/
DecipherOnly?: boolean;
}
/**
* <p>Describes the certificate extensions to be added to the certificate signing request
* (CSR).</p>
*/
export interface CsrExtensions {
/**
* <p>Indicates the purpose of the certificate and of the key contained in the
* certificate.</p>
*/
KeyUsage?: KeyUsage;
/**
* <p>For CA certificates, provides a path to additional information pertaining to the CA,
* such as revocation and policy. For more information, see <a href="https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.2.2">Subject
* Information Access</a> in RFC 5280.</p>
*/
SubjectInformationAccess?: AccessDescription[];
}
export enum KeyAlgorithm {
EC_prime256v1 = "EC_prime256v1",
EC_secp384r1 = "EC_secp384r1",
RSA_2048 = "RSA_2048",
RSA_4096 = "RSA_4096",
}
export enum SigningAlgorithm {
SHA256WITHECDSA = "SHA256WITHECDSA",
SHA256WITHRSA = "SHA256WITHRSA",
SHA384WITHECDSA = "SHA384WITHECDSA",
SHA384WITHRSA = "SHA384WITHRSA",
SHA512WITHECDSA = "SHA512WITHECDSA",
SHA512WITHRSA = "SHA512WITHRSA",
}
/**
* <p>Contains configuration information for your private certificate authority (CA). This
* includes information about the class of public key algorithm and the key pair that your
* private CA creates when it issues a certificate. It also includes the signature
* algorithm that it uses when issuing certificates, and its X.500 distinguished name. You
* must specify this information when you call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html">CreateCertificateAuthority</a> action. </p>
*/
export interface CertificateAuthorityConfiguration {
/**
* <p>Type of the public key algorithm and size, in bits, of the key pair that your CA
* creates when it issues a certificate. When you create a subordinate CA, you must use a
* key algorithm supported by the parent CA.</p>
*/
KeyAlgorithm: KeyAlgorithm | string | undefined;
/**
* <p>Name of the algorithm your private CA uses to sign certificate requests.</p>
* <p>This parameter should not be confused with the <code>SigningAlgorithm</code> parameter
* used to sign certificates when they are issued.</p>
*/
SigningAlgorithm: SigningAlgorithm | string | undefined;
/**
* <p>Structure that contains X.500 distinguished name information for your private
* CA.</p>
*/
Subject: ASN1Subject | undefined;
/**
* <p>Specifies information to be added to the extension section of the certificate signing
* request (CSR).</p>
*/
CsrExtensions?: CsrExtensions;
}
export enum CertificateAuthorityType {
ROOT = "ROOT",
SUBORDINATE = "SUBORDINATE",
}
export enum KeyStorageSecurityStandard {
FIPS_140_2_LEVEL_2_OR_HIGHER = "FIPS_140_2_LEVEL_2_OR_HIGHER",
FIPS_140_2_LEVEL_3_OR_HIGHER = "FIPS_140_2_LEVEL_3_OR_HIGHER",
}
export enum S3ObjectAcl {
BUCKET_OWNER_FULL_CONTROL = "BUCKET_OWNER_FULL_CONTROL",
PUBLIC_READ = "PUBLIC_READ",
}
/**
* <p>Contains configuration information for a certificate revocation list (CRL). Your
* private certificate authority (CA) creates base CRLs. Delta CRLs are not supported. You
* can enable CRLs for your new or an existing private CA by setting the <b>Enabled</b> parameter to <code>true</code>. Your private CA
* writes CRLs to an S3 bucket that you specify in the <b>S3BucketName</b> parameter. You can hide the name of your bucket by
* specifying a value for the <b>CustomCname</b> parameter. Your
* private CA copies the CNAME or the S3 bucket name to the <b>CRL
* Distribution Points</b> extension of each certificate it issues. Your S3
* bucket policy must give write permission to Amazon Web Services Private CA. </p>
* <p>Amazon Web Services Private CA assets that are stored in Amazon S3 can be protected with encryption.
* For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/PcaCreateCa.html#crl-encryption">Encrypting Your
* CRLs</a>.</p>
* <p>Your private CA uses the value in the <b>ExpirationInDays</b> parameter to calculate the <b>nextUpdate</b> field in the CRL. The CRL is refreshed prior to a
* certificate's expiration date or when a certificate is revoked. When a certificate is
* revoked, it appears in the CRL until the certificate expires, and then in one additional
* CRL after expiration, and it always appears in the audit report.</p>
* <p>A CRL is typically updated approximately 30 minutes after a certificate
* is revoked. If for any reason a CRL update fails, Amazon Web Services Private CA makes further attempts
* every 15 minutes.</p>
* <p>CRLs contain the following fields:</p>
* <ul>
* <li>
* <p>
* <b>Version</b>: The current version number defined
* in RFC 5280 is V2. The integer value is 0x1. </p>
* </li>
* <li>
* <p>
* <b>Signature Algorithm</b>: The name of the
* algorithm used to sign the CRL.</p>
* </li>
* <li>
* <p>
* <b>Issuer</b>: The X.500 distinguished name of your
* private CA that issued the CRL.</p>
* </li>
* <li>
* <p>
* <b>Last Update</b>: The issue date and time of this
* CRL.</p>
* </li>
* <li>
* <p>
* <b>Next Update</b>: The day and time by which the
* next CRL will be issued.</p>
* </li>
* <li>
* <p>
* <b>Revoked Certificates</b>: List of revoked
* certificates. Each list item contains the following information.</p>
* <ul>
* <li>
* <p>
* <b>Serial Number</b>: The serial number, in
* hexadecimal format, of the revoked certificate.</p>
* </li>
* <li>
* <p>
* <b>Revocation Date</b>: Date and time the
* certificate was revoked.</p>
* </li>
* <li>
* <p>
* <b>CRL Entry Extensions</b>: Optional
* extensions for the CRL entry.</p>
* <ul>
* <li>
* <p>
* <b>X509v3 CRL Reason Code</b>:
* Reason the certificate was revoked.</p>
* </li>
* </ul>
* </li>
* </ul>
* </li>
* <li>
* <p>
* <b>CRL Extensions</b>: Optional extensions for the
* CRL.</p>
* <ul>
* <li>
* <p>
* <b>X509v3 Authority Key Identifier</b>:
* Identifies the public key associated with the private key used to sign
* the certificate.</p>
* </li>
* <li>
* <p>
* <b>X509v3 CRL Number:</b>: Decimal sequence
* number for the CRL.</p>
* </li>
* </ul>
* </li>
* <li>
* <p>
* <b>Signature Algorithm</b>: Algorithm used by your
* private CA to sign the CRL.</p>
* </li>
* <li>
* <p>
* <b>Signature Value</b>: Signature computed over the
* CRL.</p>
* </li>
* </ul>
* <p>Certificate revocation lists created by Amazon Web Services Private CA are DER-encoded. You can use the
* following OpenSSL command to list a CRL.</p>
* <p>
* <code>openssl crl -inform DER -text -in <i>crl_path</i>
* -noout</code>
* </p>
* <p>For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html">Planning a certificate revocation list
* (CRL)</a> in the <i>Amazon Web Services Private Certificate Authority User Guide</i>
* </p>
*/
export interface CrlConfiguration {
/**
* <p>Boolean value that specifies whether certificate revocation lists (CRLs) are enabled.
* You can use this value to enable certificate revocation for a new CA when you call the
* <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html">CreateCertificateAuthority</a> action or for an existing CA when you call the
* <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_UpdateCertificateAuthority.html">UpdateCertificateAuthority</a> action. </p>
*/
Enabled: boolean | undefined;
/**
* <p>Validity period of the CRL in days.</p>
*/
ExpirationInDays?: number;
/**
* <p>Name inserted into the certificate <b>CRL Distribution
* Points</b> extension that enables the use of an alias for the CRL
* distribution point. Use this value if you don't want the name of your S3 bucket to be
* public.</p>
* <note>
* <p>The content of a Canonical Name (CNAME) record must conform to <a href="https://www.ietf.org/rfc/rfc2396.txt">RFC2396</a> restrictions on the
* use of special characters in URIs. Additionally, the value of the CNAME must not
* include a protocol prefix such as "http://" or "https://".</p>
* </note>
*/
CustomCname?: string;
/**
* <p>Name of the S3 bucket that contains the CRL. If you do not provide a value for the
* <b>CustomCname</b> argument, the name of your S3 bucket
* is placed into the <b>CRL Distribution Points</b> extension of
* the issued certificate. You can change the name of your bucket by calling the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_UpdateCertificateAuthority.html">UpdateCertificateAuthority</a> operation. You must specify a <a href="https://docs.aws.amazon.com/privateca/latest/userguide/PcaCreateCa.html#s3-policies">bucket
* policy</a> that allows Amazon Web Services Private CA to write the CRL to your bucket.</p>
* <note>
* <p>The <code>S3BucketName</code> parameter must conform to the <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html">S3
* bucket naming rules</a>.</p>
* </note>
*/
S3BucketName?: string;
/**
* <p>Determines whether the CRL will be publicly readable or privately held in the CRL
* Amazon S3 bucket. If you choose PUBLIC_READ, the CRL will be accessible over the public
* internet. If you choose BUCKET_OWNER_FULL_CONTROL, only the owner of the CRL S3 bucket
* can access the CRL, and your PKI clients may need an alternative method of access. </p>
* <p>If no value is specified, the default is <code>PUBLIC_READ</code>.</p>
* <p>
* <i>Note:</i> This default can cause CA creation to fail in some
* circumstances. If you have have enabled the Block Public Access (BPA) feature in your S3
* account, then you must specify the value of this parameter as
* <code>BUCKET_OWNER_FULL_CONTROL</code>, and not doing so results in an error. If you
* have disabled BPA in S3, then you can specify either
* <code>BUCKET_OWNER_FULL_CONTROL</code> or <code>PUBLIC_READ</code> as the
* value.</p>
* <p>For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/PcaCreateCa.html#s3-bpa">Blocking public access to the S3
* bucket</a>.</p>
*/
S3ObjectAcl?: S3ObjectAcl | string;
}
/**
* <p>Contains information to enable and configure Online Certificate Status Protocol (OCSP)
* for validating certificate revocation status.</p>
* <p>When you revoke a certificate, OCSP responses may take up to 60 minutes
* to reflect the new status.</p>
*/
export interface OcspConfiguration {
/**
* <p>Flag enabling use of the Online Certificate Status Protocol (OCSP) for validating
* certificate revocation status.</p>
*/
Enabled: boolean | undefined;
/**
* <p>By default, Amazon Web Services Private CA injects an Amazon Web Services domain into certificates being validated by
* the Online Certificate Status Protocol (OCSP). A customer can alternatively use this
* object to define a CNAME specifying a customized OCSP domain.</p>
* <note>
* <p>The content of a Canonical Name (CNAME) record must conform to <a href="https://www.ietf.org/rfc/rfc2396.txt">RFC2396</a> restrictions on the
* use of special characters in URIs. Additionally, the value of the CNAME must not
* include a protocol prefix such as "http://" or "https://".</p>
* </note>
* <p>For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/ocsp-customize.html">Customizing Online Certificate Status Protocol
* (OCSP) </a> in the <i>Amazon Web Services Private Certificate Authority User Guide</i>.</p>
*/
OcspCustomCname?: string;
}
/**
* <p>Certificate revocation information used by the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html">CreateCertificateAuthority</a> and <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_UpdateCertificateAuthority.html">UpdateCertificateAuthority</a> actions. Your private certificate authority (CA)
* can configure Online Certificate Status Protocol (OCSP) support and/or maintain a
* certificate revocation list (CRL). OCSP returns validation information about
* certificates as requested by clients, and a CRL contains an updated list of certificates
* revoked by your CA. For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_RevokeCertificate.html">RevokeCertificate</a> and <a href="https://docs.aws.amazon.com/privateca/latest/userguide/revocation-setup.html">Setting up a
* certificate revocation method</a> in the <i>Amazon Web Services Private Certificate Authority User
* Guide</i>.</p>
*/
export interface RevocationConfiguration {
/**
* <p>Configuration of the certificate revocation list (CRL), if any, maintained by your
* private CA. A CRL is typically updated approximately 30 minutes after a certificate
* is revoked. If for any reason a CRL update fails, Amazon Web Services Private CA makes further attempts
* every 15 minutes.</p>
*/
CrlConfiguration?: CrlConfiguration;
/**
* <p>Configuration of Online Certificate Status Protocol (OCSP) support, if any, maintained
* by your private CA. When you revoke a certificate, OCSP responses may take up to 60 minutes
* to reflect the new status.</p>
*/
OcspConfiguration?: OcspConfiguration;
}
/**
* <p>Tags are labels that you can use to identify and organize your private CAs. Each tag
* consists of a key and an optional value. You can associate up to 50 tags with a private
* CA. To add one or more tags to a private CA, call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_TagCertificateAuthority.html">TagCertificateAuthority</a>
* action. To remove a tag, call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_UntagCertificateAuthority.html">UntagCertificateAuthority</a> action. </p>
*/
export interface Tag {
/**
* <p>Key (name) of the tag.</p>
*/
Key: string | undefined;
/**
* <p>Value of the tag.</p>
*/
Value?: string;
}
export enum CertificateAuthorityUsageMode {
GENERAL_PURPOSE = "GENERAL_PURPOSE",
SHORT_LIVED_CERTIFICATE = "SHORT_LIVED_CERTIFICATE",
}
export interface CreateCertificateAuthorityRequest {
/**
* <p>Name and bit size of the private key algorithm, the name of the signing algorithm, and
* X.500 certificate subject information.</p>
*/
CertificateAuthorityConfiguration: CertificateAuthorityConfiguration | undefined;
/**
* <p>Contains information to enable Online Certificate Status Protocol (OCSP) support, to
* enable a certificate revocation list (CRL), to enable both, or to enable neither. The
* default is for both certificate validation mechanisms to be disabled. </p>
* <note>
* <p>The following requirements apply to revocation configurations.</p>
* <ul>
* <li>
* <p>A configuration disabling CRLs or OCSP must contain only the <code>Enabled=False</code>
* parameter, and will fail if other parameters such as <code>CustomCname</code> or
* <code>ExpirationInDays</code> are included.</p>
* </li>
* <li>
* <p>In a CRL configuration, the <code>S3BucketName</code> parameter must conform to
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html">Amazon S3
* bucket naming rules</a>.</p>
* </li>
* <li>
* <p>A configuration containing a custom Canonical
* Name (CNAME) parameter for CRLs or OCSP must conform to <a href="https://www.ietf.org/rfc/rfc2396.txt">RFC2396</a> restrictions
* on the use of special characters in a CNAME. </p>
* </li>
* <li>
* <p>In a CRL or OCSP configuration, the value of a CNAME parameter must not include a
* protocol prefix such as "http://" or "https://".</p>
* </li>
* </ul>
* </note>
* <p> For more information, see the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_OcspConfiguration.html">OcspConfiguration</a> and <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CrlConfiguration.html">CrlConfiguration</a>
* types.</p>
*/
RevocationConfiguration?: RevocationConfiguration;
/**
* <p>The type of the certificate authority.</p>
*/
CertificateAuthorityType: CertificateAuthorityType | string | undefined;
/**
* <p>Custom string that can be used to distinguish between calls to the <b>CreateCertificateAuthority</b> action. Idempotency tokens for
* <b>CreateCertificateAuthority</b> time out after five
* minutes. Therefore, if you call <b>CreateCertificateAuthority</b> multiple times with the same idempotency
* token within five minutes, Amazon Web Services Private CA recognizes that you are requesting only
* certificate authority and will issue only one. If you change the idempotency token for
* each call, Amazon Web Services Private CA recognizes that you are requesting multiple certificate
* authorities.</p>
*/
IdempotencyToken?: string;
/**
* <p>Specifies a cryptographic key management compliance standard used for handling CA
* keys.</p>
* <p>Default: FIPS_140_2_LEVEL_3_OR_HIGHER</p>
* <p>
* <i>Note:</i>
* <code>FIPS_140_2_LEVEL_3_OR_HIGHER</code> is not supported in the following
* Regions:</p>
* <ul>
* <li>
* <p>ap-northeast-3</p>
* </li>
* <li>
* <p>ap-southeast-3</p>
* </li>
* </ul>
* <p>When creating a CA in these Regions, you must provide
* <code>FIPS_140_2_LEVEL_2_OR_HIGHER</code> as the argument for
* <code>KeyStorageSecurityStandard</code>. Failure to do this results in an
* <code>InvalidArgsException</code> with the message, "A certificate authority cannot
* be created in this region with the specified security standard."</p>
*/
KeyStorageSecurityStandard?: KeyStorageSecurityStandard | string;
/**
* <p>Key-value pairs that will be attached to the new private CA. You can associate up to
* 50 tags with a private CA. For information using tags with IAM to manage permissions,
* see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_iam-tags.html">Controlling Access Using IAM Tags</a>.</p>
*/
Tags?: Tag[];
/**
* <p>Specifies whether the CA issues general-purpose certificates that typically require a
* revocation mechanism, or short-lived certificates that may optionally omit revocation
* because they expire quickly. Short-lived certificate validity is limited to seven
* days.</p>
* <p>The default value is GENERAL_PURPOSE.</p>
*/
UsageMode?: CertificateAuthorityUsageMode | string;
}
export interface CreateCertificateAuthorityResponse {
/**
* <p>If successful, the Amazon Resource Name (ARN) of the certificate authority (CA). This
* is of the form: </p>
* <p>
* <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i>
* </code>.
* </p>
*/
CertificateAuthorityArn?: string;
}
/**
* <p>One or more of the specified arguments was not valid.</p>
*/
export class InvalidArgsException extends __BaseException {
readonly name: "InvalidArgsException" = "InvalidArgsException";
readonly $fault: "client" = "client";
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<InvalidArgsException, __BaseException>) {
super({
name: "InvalidArgsException",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, InvalidArgsException.prototype);
}
}
/**
* <p>The resource policy is invalid or is missing a required statement. For general
* information about IAM policy and statement structure, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json">Overview of JSON Policies</a>.</p>
*/
export class InvalidPolicyException extends __BaseException {
readonly name: "InvalidPolicyException" = "InvalidPolicyException";
readonly $fault: "client" = "client";
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<InvalidPolicyException, __BaseException>) {
super({
name: "InvalidPolicyException",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, InvalidPolicyException.prototype);
}
}
/**
* <p>The tag associated with the CA is not valid. The invalid argument is contained in the
* message field.</p>
*/
export class InvalidTagException extends __BaseException {
readonly name: "InvalidTagException" = "InvalidTagException";
readonly $fault: "client" = "client";
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<InvalidTagException, __BaseException>) {
super({
name: "InvalidTagException",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, InvalidTagException.prototype);
}
}
/**
* <p>An Amazon Web Services Private CA quota has been exceeded. See the exception message returned to determine
* the quota that was exceeded.</p>
*/
export class LimitExceededException extends __BaseException {
readonly name: "LimitExceededException" = "LimitExceededException";
readonly $fault: "client" = "client";
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>) {
super({
name: "LimitExceededException",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, LimitExceededException.prototype);
}
}
export enum AuditReportResponseFormat {
CSV = "CSV",
JSON = "JSON",
}
export interface CreateCertificateAuthorityAuditReportRequest {
/**
* <p>The Amazon Resource Name (ARN) of the CA to be audited. This is of the form:</p>
* <p>
* <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i>
* </code>.</p>
*/
CertificateAuthorityArn: string | undefined;
/**
* <p>The name of the S3 bucket that will contain the audit report.</p>
*/
S3BucketName: string | undefined;
/**
* <p>The format in which to create the report. This can be either <b>JSON</b> or <b>CSV</b>.</p>
*/
AuditReportResponseFormat: AuditReportResponseFormat | string | undefined;
}
export interface CreateCertificateAuthorityAuditReportResponse {
/**
* <p>An alphanumeric string that contains a report identifier.</p>
*/
AuditReportId?: string;
/**
* <p>The <b>key</b> that uniquely identifies the report file in
* your S3 bucket.</p>
*/
S3Key?: string;
}
/**
* <p>The requested Amazon Resource Name (ARN) does not refer to an existing
* resource.</p>
*/
export class InvalidArnException extends __BaseException {
readonly name: "InvalidArnException" = "InvalidArnException";
readonly $fault: "client" = "client";
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<InvalidArnException, __BaseException>) {
super({
name: "InvalidArnException",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, InvalidArnException.prototype);
}
}
/**
* <p>The state of the private CA does not allow this action to occur.</p>
*/
export class InvalidStateException extends __BaseException {
readonly name: "InvalidStateException" = "InvalidStateException";
readonly $fault: "client" = "client";
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<InvalidStateException, __BaseException>) {
super({
name: "InvalidStateException",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, InvalidStateException.prototype);
}
}
/**
* <p>The request has failed for an unspecified reason.</p>
*/
export class RequestFailedException extends __BaseException {
readonly name: "RequestFailedException" = "RequestFailedException";
readonly $fault: "client" = "client";
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<RequestFailedException, __BaseException>) {
super({
name: "RequestFailedException",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, RequestFailedException.prototype);
}
}
/**
* <p>Your request is already in progress.</p>
*/
export class RequestInProgressException extends __BaseException {
readonly name: "RequestInProgressException" = "RequestInProgressException";
readonly $fault: "client" = "client";
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<RequestInProgressException, __BaseException>) {
super({
name: "RequestInProgressException",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, RequestInProgressException.prototype);
}
}
/**
* <p>A resource such as a private CA, S3 bucket, certificate, audit report, or policy
* cannot be found.</p>
*/
export class ResourceNotFoundException extends __BaseException {
readonly name: "ResourceNotFoundException" = "ResourceNotFoundException";
readonly $fault: "client" = "client";
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>) {
super({
name: "ResourceNotFoundException",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, ResourceNotFoundException.prototype);
}
}
export enum ActionType {
GetCertificate = "GetCertificate",
IssueCertificate = "IssueCertificate",
ListPermissions = "ListPermissions",
}
export interface CreatePermissionRequest {
/**
* <p>The Amazon Resource Name (ARN) of the CA that grants the permissions. You can find the
* ARN by calling the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html">ListCertificateAuthorities</a> action. This must have the following form: </p>
* <p>
* <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i>
* </code>.
* </p>
*/
CertificateAuthorityArn: string | undefined;
/**
* <p>The Amazon Web Services service or identity that receives the permission. At this time, the only
* valid principal is <code>acm.amazonaws.com</code>.</p>
*/
Principal: string | undefined;
/**
* <p>The ID of the calling account.</p>
*/
SourceAccount?: string;
/**
* <p>The actions that the specified Amazon Web Services service principal can use. These include
* <code>IssueCertificate</code>, <code>GetCertificate</code>, and
* <code>ListPermissions</code>.</p>
*/
Actions: (ActionType | string)[] | undefined;
}