@aws-sdk/client-acm-pca 3.28.0 → 3.32.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/ACMPCA.ts +14 -7
- package/ACMPCAClient.ts +10 -5
- package/CHANGELOG.md +35 -0
- package/README.md +10 -5
- package/commands/CreateCertificateAuthorityCommand.ts +4 -2
- package/dist/cjs/ACMPCA.js +10 -5
- package/dist/cjs/ACMPCA.js.map +1 -1
- package/dist/cjs/ACMPCAClient.js +10 -5
- package/dist/cjs/ACMPCAClient.js.map +1 -1
- package/dist/cjs/commands/CreateCertificateAuthorityCommand.js +4 -2
- package/dist/cjs/commands/CreateCertificateAuthorityCommand.js.map +1 -1
- package/dist/cjs/models/models_0.js +11 -2
- package/dist/cjs/models/models_0.js.map +1 -1
- package/dist/cjs/package.json +32 -32
- package/dist/cjs/protocols/Aws_json1_1.js +28 -8
- package/dist/cjs/protocols/Aws_json1_1.js.map +1 -1
- package/dist/es/ACMPCA.js +10 -5
- package/dist/es/ACMPCA.js.map +1 -1
- package/dist/es/ACMPCAClient.js +10 -5
- package/dist/es/ACMPCAClient.js.map +1 -1
- package/dist/es/commands/CreateCertificateAuthorityCommand.js +4 -2
- package/dist/es/commands/CreateCertificateAuthorityCommand.js.map +1 -1
- package/dist/es/endpoints.js +1 -2
- package/dist/es/endpoints.js.map +1 -1
- package/dist/es/models/models_0.js +7 -0
- package/dist/es/models/models_0.js.map +1 -1
- package/dist/es/package.json +32 -32
- package/dist/es/protocols/Aws_json1_1.js +26 -10
- package/dist/es/protocols/Aws_json1_1.js.map +1 -1
- package/dist/types/ACMPCA.d.ts +14 -7
- package/dist/types/ACMPCAClient.d.ts +10 -5
- package/dist/types/commands/CreateCertificateAuthorityCommand.d.ts +4 -2
- package/dist/types/models/models_0.d.ts +72 -19
- package/dist/types/ts3.4/ACMPCA.d.ts +14 -7
- package/dist/types/ts3.4/ACMPCAClient.d.ts +10 -5
- package/dist/types/ts3.4/commands/CreateCertificateAuthorityCommand.d.ts +4 -2
- package/dist/types/ts3.4/models/models_0.d.ts +72 -19
- package/models/models_0.ts +78 -19
- package/package.json +32 -32
- package/protocols/Aws_json1_1.ts +36 -9
|
@@ -370,10 +370,17 @@ export declare enum S3ObjectAcl {
|
|
|
370
370
|
* <p>ACM Private CA assets that are stored in Amazon S3 can be protected with encryption.
|
|
371
371
|
* For more information, see <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaCreateCa.html#crl-encryption">Encrypting Your
|
|
372
372
|
* CRLs</a>.</p>
|
|
373
|
-
* <p>Your private CA uses the value in the <b>ExpirationInDays</b>
|
|
374
|
-
*
|
|
375
|
-
*
|
|
376
|
-
*
|
|
373
|
+
* <p>Your private CA uses the value in the <b>ExpirationInDays</b>
|
|
374
|
+
* parameter to calculate the <b>nextUpdate</b> field in the CRL.
|
|
375
|
+
* The CRL is refreshed at 1/2 the age of next update or when a certificate is revoked.
|
|
376
|
+
* When a certificate is revoked, it is recorded in the next CRL that is generated and in
|
|
377
|
+
* the next audit report. Only time valid certificates are listed in the CRL. Expired
|
|
378
|
+
* certificates are not included.</p>
|
|
379
|
+
*
|
|
380
|
+
* <p>A CRL is typically updated approximately 30 minutes after a certificate
|
|
381
|
+
* is revoked. If for any reason a CRL update fails, ACM Private CA makes further attempts
|
|
382
|
+
* every 15 minutes.</p>
|
|
383
|
+
*
|
|
377
384
|
* <p>CRLs contain the following fields:</p>
|
|
378
385
|
* <ul>
|
|
379
386
|
* <li>
|
|
@@ -465,6 +472,9 @@ export declare enum S3ObjectAcl {
|
|
|
465
472
|
* <code>openssl crl -inform DER -text -in <i>crl_path</i>
|
|
466
473
|
* -noout</code>
|
|
467
474
|
* </p>
|
|
475
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/crl-planning.html">Planning a certificate revocation list (CRL)</a>
|
|
476
|
+
* in the <i>AWS Certificate Manager Private Certificate Authority (PCA) User Guide</i>
|
|
477
|
+
* </p>
|
|
468
478
|
*/
|
|
469
479
|
export interface CrlConfiguration {
|
|
470
480
|
/**
|
|
@@ -489,9 +499,8 @@ export interface CrlConfiguration {
|
|
|
489
499
|
* <p>Name of the S3 bucket that contains the CRL. If you do not provide a value for the
|
|
490
500
|
* <b>CustomCname</b> argument, the name of your S3 bucket
|
|
491
501
|
* is placed into the <b>CRL Distribution Points</b> extension of
|
|
492
|
-
* the issued certificate. You can change the name of your bucket by calling the <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_UpdateCertificateAuthority.html">UpdateCertificateAuthority</a>
|
|
493
|
-
*
|
|
494
|
-
* allows ACM Private CA to write the CRL to your bucket.</p>
|
|
502
|
+
* the issued certificate. You can change the name of your bucket by calling the <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_UpdateCertificateAuthority.html">UpdateCertificateAuthority</a> operation. You must specify a <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaCreateCa.html#s3-policies">bucket
|
|
503
|
+
* policy</a> that allows ACM Private CA to write the CRL to your bucket.</p>
|
|
495
504
|
*/
|
|
496
505
|
S3BucketName?: string;
|
|
497
506
|
/**
|
|
@@ -519,17 +528,59 @@ export declare namespace CrlConfiguration {
|
|
|
519
528
|
*/
|
|
520
529
|
const filterSensitiveLog: (obj: CrlConfiguration) => any;
|
|
521
530
|
}
|
|
531
|
+
/**
|
|
532
|
+
* <p>Contains information to enable and configure Online Certificate Status Protocol (OCSP) for
|
|
533
|
+
* validating certificate revocation status.</p>
|
|
534
|
+
* <p>When you revoke a certificate, OCSP responses may take up to 60 minutes
|
|
535
|
+
* to reflect the new status.</p>
|
|
536
|
+
*/
|
|
537
|
+
export interface OcspConfiguration {
|
|
538
|
+
/**
|
|
539
|
+
* <p>Flag enabling use of the Online Certificate Status Protocol (OCSP) for validating
|
|
540
|
+
* certificate revocation status.</p>
|
|
541
|
+
*/
|
|
542
|
+
Enabled: boolean | undefined;
|
|
543
|
+
/**
|
|
544
|
+
* <p>By default, ACM Private CA injects an AWS domain into certificates being validated by the
|
|
545
|
+
* Online Certificate Status Protocol (OCSP). A customer can alternatively use this object
|
|
546
|
+
* to define a CNAME specifying a customized OCSP domain.</p>
|
|
547
|
+
* <p>Note: The value of the CNAME must not include a protocol prefix such as "http://" or
|
|
548
|
+
* "https://".</p>
|
|
549
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/ocsp-customize.html">Customizing Online Certificate
|
|
550
|
+
* Status Protocol (OCSP) </a> in the <i>AWS Certificate Manager Private Certificate Authority (PCA) User
|
|
551
|
+
* Guide</i>.</p>
|
|
552
|
+
*/
|
|
553
|
+
OcspCustomCname?: string;
|
|
554
|
+
}
|
|
555
|
+
export declare namespace OcspConfiguration {
|
|
556
|
+
/**
|
|
557
|
+
* @internal
|
|
558
|
+
*/
|
|
559
|
+
const filterSensitiveLog: (obj: OcspConfiguration) => any;
|
|
560
|
+
}
|
|
522
561
|
/**
|
|
523
562
|
* <p>Certificate revocation information used by the <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CreateCertificateAuthority.html">CreateCertificateAuthority</a> and <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_UpdateCertificateAuthority.html">UpdateCertificateAuthority</a> actions. Your private certificate authority (CA)
|
|
524
|
-
* can
|
|
525
|
-
*
|
|
563
|
+
* can configure Online Certificate Status Protocol (OCSP) support and/or maintain a
|
|
564
|
+
* certificate revocation list (CRL). OCSP returns validation information about
|
|
565
|
+
* certificates as requested by clients, and a CRL contains an updated list of certificates
|
|
566
|
+
* revoked by your CA. For more information, see <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_RevokeCertificate.html">RevokeCertificate</a> and <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/revocation-setup.html">Setting up a
|
|
567
|
+
* certificate revocation method</a> in the <i>AWS Certificate Manager Private Certificate Authority (PCA) User
|
|
568
|
+
* Guide</i>.</p>
|
|
526
569
|
*/
|
|
527
570
|
export interface RevocationConfiguration {
|
|
528
571
|
/**
|
|
529
|
-
* <p>Configuration of the certificate revocation list (CRL), if any, maintained by your
|
|
530
|
-
*
|
|
572
|
+
* <p>Configuration of the certificate revocation list (CRL), if any, maintained by your private
|
|
573
|
+
* CA. A CRL is typically updated approximately 30 minutes after a certificate
|
|
574
|
+
* is revoked. If for any reason a CRL update fails, ACM Private CA makes further attempts
|
|
575
|
+
* every 15 minutes.</p>
|
|
531
576
|
*/
|
|
532
577
|
CrlConfiguration?: CrlConfiguration;
|
|
578
|
+
/**
|
|
579
|
+
* <p>Configuration of Online Certificate Status Protocol (OCSP) support, if any, maintained by
|
|
580
|
+
* your private CA. When you revoke a certificate, OCSP responses may take up to 60 minutes
|
|
581
|
+
* to reflect the new status.</p>
|
|
582
|
+
*/
|
|
583
|
+
OcspConfiguration?: OcspConfiguration;
|
|
533
584
|
}
|
|
534
585
|
export declare namespace RevocationConfiguration {
|
|
535
586
|
/**
|
|
@@ -566,11 +617,10 @@ export interface CreateCertificateAuthorityRequest {
|
|
|
566
617
|
*/
|
|
567
618
|
CertificateAuthorityConfiguration: CertificateAuthorityConfiguration | undefined;
|
|
568
619
|
/**
|
|
569
|
-
* <p>Contains
|
|
570
|
-
*
|
|
571
|
-
*
|
|
572
|
-
*
|
|
573
|
-
* </p>
|
|
620
|
+
* <p>Contains information to enable Online Certificate Status Protocol (OCSP) support,
|
|
621
|
+
* to enable a certificate revocation list (CRL), to enable both, or to enable neither. The
|
|
622
|
+
* default is for both certificate validation mechanisms to be disabled. For more
|
|
623
|
+
* information, see the <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_OcspConfiguration.html">OcspConfiguration</a> and <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CrlConfiguration.html">CrlConfiguration</a> types.</p>
|
|
574
624
|
*/
|
|
575
625
|
RevocationConfiguration?: RevocationConfiguration;
|
|
576
626
|
/**
|
|
@@ -1037,8 +1087,8 @@ export interface CertificateAuthority {
|
|
|
1037
1087
|
*/
|
|
1038
1088
|
CertificateAuthorityConfiguration?: CertificateAuthorityConfiguration;
|
|
1039
1089
|
/**
|
|
1040
|
-
* <p>Information about the
|
|
1041
|
-
* private CA. </p>
|
|
1090
|
+
* <p>Information about the Online Certificate Status Protocol (OCSP) configuration or
|
|
1091
|
+
* certificate revocation list (CRL) created and maintained by your private CA. </p>
|
|
1042
1092
|
*/
|
|
1043
1093
|
RevocationConfiguration?: RevocationConfiguration;
|
|
1044
1094
|
/**
|
|
@@ -2067,7 +2117,10 @@ export interface UpdateCertificateAuthorityRequest {
|
|
|
2067
2117
|
*/
|
|
2068
2118
|
CertificateAuthorityArn: string | undefined;
|
|
2069
2119
|
/**
|
|
2070
|
-
* <p>
|
|
2120
|
+
* <p>Contains information to enable Online Certificate Status Protocol (OCSP) support,
|
|
2121
|
+
* to enable a certificate revocation list (CRL), to enable both, or to enable neither. If
|
|
2122
|
+
* this parameter is not supplied, existing capibilites remain unchanged. For more
|
|
2123
|
+
* information, see the <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_OcspConfiguration.html">OcspConfiguration</a> and <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CrlConfiguration.html">CrlConfiguration</a> types.</p>
|
|
2071
2124
|
*/
|
|
2072
2125
|
RevocationConfiguration?: RevocationConfiguration;
|
|
2073
2126
|
/**
|
|
@@ -32,20 +32,27 @@ import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types";
|
|
|
32
32
|
* tailored to the programming language or platform that you're using. For more
|
|
33
33
|
* information, see <a href="https://aws.amazon.com/tools/#SDKs">AWS
|
|
34
34
|
* SDKs</a>.</p>
|
|
35
|
-
* <
|
|
36
|
-
*
|
|
37
|
-
*
|
|
38
|
-
*
|
|
39
|
-
*
|
|
35
|
+
* <p>Each ACM Private CA API operation has a quota that determines the number of times the operation
|
|
36
|
+
* can be called per second. ACM Private CA throttles API requests at different rates depending
|
|
37
|
+
* on the operation. Throttling means that ACM Private CA rejects an otherwise valid request
|
|
38
|
+
* because the request exceeds the operation's quota for the number of requests per second.
|
|
39
|
+
* When a request is throttled, ACM Private CA returns a <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/CommonErrors.html">ThrottlingException</a> error. ACM Private CA does not guarantee a minimum request
|
|
40
|
+
* rate for APIs. </p>
|
|
41
|
+
*
|
|
42
|
+
* <p>To see an up-to-date list of your ACM Private CA quotas, or to request a quota increase,
|
|
43
|
+
* log into your AWS account and visit the <a href="https://console.aws.amazon.com/servicequotas/">Service Quotas</a>
|
|
44
|
+
* console.</p>
|
|
40
45
|
*/
|
|
41
46
|
export declare class ACMPCA extends ACMPCAClient {
|
|
42
47
|
/**
|
|
43
48
|
* <p>Creates a root or subordinate private certificate authority (CA). You must specify the
|
|
44
|
-
* CA configuration,
|
|
49
|
+
* CA configuration, an optional configuration for Online Certificate Status Protocol (OCSP)
|
|
50
|
+
* and/or a certificate revocation list (CRL), the CA type, and
|
|
45
51
|
* an optional idempotency token to avoid accidental creation of multiple CAs. The CA
|
|
46
52
|
* configuration specifies the name of the algorithm and key size to be used to create the
|
|
47
53
|
* CA private key, the type of signing algorithm that the CA uses, and X.500 subject
|
|
48
|
-
* information. The
|
|
54
|
+
* information. The OCSP configuration can optionally specify a custom URL for the OCSP responder.
|
|
55
|
+
* The CRL configuration specifies the CRL expiration period in days (the
|
|
49
56
|
* validity period of the CRL), the Amazon S3 bucket that will contain the CRL, and a CNAME
|
|
50
57
|
* alias for the S3 bucket that is included in certificates issued by the CA. If
|
|
51
58
|
* successful, this action returns the Amazon Resource Name (ARN) of the CA.</p>
|
|
@@ -145,11 +145,16 @@ export interface ACMPCAClientResolvedConfig extends ACMPCAClientResolvedConfigTy
|
|
|
145
145
|
* tailored to the programming language or platform that you're using. For more
|
|
146
146
|
* information, see <a href="https://aws.amazon.com/tools/#SDKs">AWS
|
|
147
147
|
* SDKs</a>.</p>
|
|
148
|
-
* <
|
|
149
|
-
*
|
|
150
|
-
*
|
|
151
|
-
*
|
|
152
|
-
*
|
|
148
|
+
* <p>Each ACM Private CA API operation has a quota that determines the number of times the operation
|
|
149
|
+
* can be called per second. ACM Private CA throttles API requests at different rates depending
|
|
150
|
+
* on the operation. Throttling means that ACM Private CA rejects an otherwise valid request
|
|
151
|
+
* because the request exceeds the operation's quota for the number of requests per second.
|
|
152
|
+
* When a request is throttled, ACM Private CA returns a <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/CommonErrors.html">ThrottlingException</a> error. ACM Private CA does not guarantee a minimum request
|
|
153
|
+
* rate for APIs. </p>
|
|
154
|
+
*
|
|
155
|
+
* <p>To see an up-to-date list of your ACM Private CA quotas, or to request a quota increase,
|
|
156
|
+
* log into your AWS account and visit the <a href="https://console.aws.amazon.com/servicequotas/">Service Quotas</a>
|
|
157
|
+
* console.</p>
|
|
153
158
|
*/
|
|
154
159
|
export declare class ACMPCAClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, ACMPCAClientResolvedConfig> {
|
|
155
160
|
/**
|
|
@@ -8,11 +8,13 @@ export interface CreateCertificateAuthorityCommandOutput extends CreateCertifica
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>Creates a root or subordinate private certificate authority (CA). You must specify the
|
|
11
|
-
* CA configuration,
|
|
11
|
+
* CA configuration, an optional configuration for Online Certificate Status Protocol (OCSP)
|
|
12
|
+
* and/or a certificate revocation list (CRL), the CA type, and
|
|
12
13
|
* an optional idempotency token to avoid accidental creation of multiple CAs. The CA
|
|
13
14
|
* configuration specifies the name of the algorithm and key size to be used to create the
|
|
14
15
|
* CA private key, the type of signing algorithm that the CA uses, and X.500 subject
|
|
15
|
-
* information. The
|
|
16
|
+
* information. The OCSP configuration can optionally specify a custom URL for the OCSP responder.
|
|
17
|
+
* The CRL configuration specifies the CRL expiration period in days (the
|
|
16
18
|
* validity period of the CRL), the Amazon S3 bucket that will contain the CRL, and a CNAME
|
|
17
19
|
* alias for the S3 bucket that is included in certificates issued by the CA. If
|
|
18
20
|
* successful, this action returns the Amazon Resource Name (ARN) of the CA.</p>
|
|
@@ -370,10 +370,17 @@ export declare enum S3ObjectAcl {
|
|
|
370
370
|
* <p>ACM Private CA assets that are stored in Amazon S3 can be protected with encryption.
|
|
371
371
|
* For more information, see <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaCreateCa.html#crl-encryption">Encrypting Your
|
|
372
372
|
* CRLs</a>.</p>
|
|
373
|
-
* <p>Your private CA uses the value in the <b>ExpirationInDays</b>
|
|
374
|
-
*
|
|
375
|
-
*
|
|
376
|
-
*
|
|
373
|
+
* <p>Your private CA uses the value in the <b>ExpirationInDays</b>
|
|
374
|
+
* parameter to calculate the <b>nextUpdate</b> field in the CRL.
|
|
375
|
+
* The CRL is refreshed at 1/2 the age of next update or when a certificate is revoked.
|
|
376
|
+
* When a certificate is revoked, it is recorded in the next CRL that is generated and in
|
|
377
|
+
* the next audit report. Only time valid certificates are listed in the CRL. Expired
|
|
378
|
+
* certificates are not included.</p>
|
|
379
|
+
*
|
|
380
|
+
* <p>A CRL is typically updated approximately 30 minutes after a certificate
|
|
381
|
+
* is revoked. If for any reason a CRL update fails, ACM Private CA makes further attempts
|
|
382
|
+
* every 15 minutes.</p>
|
|
383
|
+
*
|
|
377
384
|
* <p>CRLs contain the following fields:</p>
|
|
378
385
|
* <ul>
|
|
379
386
|
* <li>
|
|
@@ -465,6 +472,9 @@ export declare enum S3ObjectAcl {
|
|
|
465
472
|
* <code>openssl crl -inform DER -text -in <i>crl_path</i>
|
|
466
473
|
* -noout</code>
|
|
467
474
|
* </p>
|
|
475
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/crl-planning.html">Planning a certificate revocation list (CRL)</a>
|
|
476
|
+
* in the <i>AWS Certificate Manager Private Certificate Authority (PCA) User Guide</i>
|
|
477
|
+
* </p>
|
|
468
478
|
*/
|
|
469
479
|
export interface CrlConfiguration {
|
|
470
480
|
/**
|
|
@@ -489,9 +499,8 @@ export interface CrlConfiguration {
|
|
|
489
499
|
* <p>Name of the S3 bucket that contains the CRL. If you do not provide a value for the
|
|
490
500
|
* <b>CustomCname</b> argument, the name of your S3 bucket
|
|
491
501
|
* is placed into the <b>CRL Distribution Points</b> extension of
|
|
492
|
-
* the issued certificate. You can change the name of your bucket by calling the <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_UpdateCertificateAuthority.html">UpdateCertificateAuthority</a>
|
|
493
|
-
*
|
|
494
|
-
* allows ACM Private CA to write the CRL to your bucket.</p>
|
|
502
|
+
* the issued certificate. You can change the name of your bucket by calling the <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_UpdateCertificateAuthority.html">UpdateCertificateAuthority</a> operation. You must specify a <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaCreateCa.html#s3-policies">bucket
|
|
503
|
+
* policy</a> that allows ACM Private CA to write the CRL to your bucket.</p>
|
|
495
504
|
*/
|
|
496
505
|
S3BucketName?: string;
|
|
497
506
|
/**
|
|
@@ -519,17 +528,59 @@ export declare namespace CrlConfiguration {
|
|
|
519
528
|
*/
|
|
520
529
|
const filterSensitiveLog: (obj: CrlConfiguration) => any;
|
|
521
530
|
}
|
|
531
|
+
/**
|
|
532
|
+
* <p>Contains information to enable and configure Online Certificate Status Protocol (OCSP) for
|
|
533
|
+
* validating certificate revocation status.</p>
|
|
534
|
+
* <p>When you revoke a certificate, OCSP responses may take up to 60 minutes
|
|
535
|
+
* to reflect the new status.</p>
|
|
536
|
+
*/
|
|
537
|
+
export interface OcspConfiguration {
|
|
538
|
+
/**
|
|
539
|
+
* <p>Flag enabling use of the Online Certificate Status Protocol (OCSP) for validating
|
|
540
|
+
* certificate revocation status.</p>
|
|
541
|
+
*/
|
|
542
|
+
Enabled: boolean | undefined;
|
|
543
|
+
/**
|
|
544
|
+
* <p>By default, ACM Private CA injects an AWS domain into certificates being validated by the
|
|
545
|
+
* Online Certificate Status Protocol (OCSP). A customer can alternatively use this object
|
|
546
|
+
* to define a CNAME specifying a customized OCSP domain.</p>
|
|
547
|
+
* <p>Note: The value of the CNAME must not include a protocol prefix such as "http://" or
|
|
548
|
+
* "https://".</p>
|
|
549
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/ocsp-customize.html">Customizing Online Certificate
|
|
550
|
+
* Status Protocol (OCSP) </a> in the <i>AWS Certificate Manager Private Certificate Authority (PCA) User
|
|
551
|
+
* Guide</i>.</p>
|
|
552
|
+
*/
|
|
553
|
+
OcspCustomCname?: string;
|
|
554
|
+
}
|
|
555
|
+
export declare namespace OcspConfiguration {
|
|
556
|
+
/**
|
|
557
|
+
* @internal
|
|
558
|
+
*/
|
|
559
|
+
const filterSensitiveLog: (obj: OcspConfiguration) => any;
|
|
560
|
+
}
|
|
522
561
|
/**
|
|
523
562
|
* <p>Certificate revocation information used by the <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CreateCertificateAuthority.html">CreateCertificateAuthority</a> and <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_UpdateCertificateAuthority.html">UpdateCertificateAuthority</a> actions. Your private certificate authority (CA)
|
|
524
|
-
* can
|
|
525
|
-
*
|
|
563
|
+
* can configure Online Certificate Status Protocol (OCSP) support and/or maintain a
|
|
564
|
+
* certificate revocation list (CRL). OCSP returns validation information about
|
|
565
|
+
* certificates as requested by clients, and a CRL contains an updated list of certificates
|
|
566
|
+
* revoked by your CA. For more information, see <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_RevokeCertificate.html">RevokeCertificate</a> and <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/revocation-setup.html">Setting up a
|
|
567
|
+
* certificate revocation method</a> in the <i>AWS Certificate Manager Private Certificate Authority (PCA) User
|
|
568
|
+
* Guide</i>.</p>
|
|
526
569
|
*/
|
|
527
570
|
export interface RevocationConfiguration {
|
|
528
571
|
/**
|
|
529
|
-
* <p>Configuration of the certificate revocation list (CRL), if any, maintained by your
|
|
530
|
-
*
|
|
572
|
+
* <p>Configuration of the certificate revocation list (CRL), if any, maintained by your private
|
|
573
|
+
* CA. A CRL is typically updated approximately 30 minutes after a certificate
|
|
574
|
+
* is revoked. If for any reason a CRL update fails, ACM Private CA makes further attempts
|
|
575
|
+
* every 15 minutes.</p>
|
|
531
576
|
*/
|
|
532
577
|
CrlConfiguration?: CrlConfiguration;
|
|
578
|
+
/**
|
|
579
|
+
* <p>Configuration of Online Certificate Status Protocol (OCSP) support, if any, maintained by
|
|
580
|
+
* your private CA. When you revoke a certificate, OCSP responses may take up to 60 minutes
|
|
581
|
+
* to reflect the new status.</p>
|
|
582
|
+
*/
|
|
583
|
+
OcspConfiguration?: OcspConfiguration;
|
|
533
584
|
}
|
|
534
585
|
export declare namespace RevocationConfiguration {
|
|
535
586
|
/**
|
|
@@ -566,11 +617,10 @@ export interface CreateCertificateAuthorityRequest {
|
|
|
566
617
|
*/
|
|
567
618
|
CertificateAuthorityConfiguration: CertificateAuthorityConfiguration | undefined;
|
|
568
619
|
/**
|
|
569
|
-
* <p>Contains
|
|
570
|
-
*
|
|
571
|
-
*
|
|
572
|
-
*
|
|
573
|
-
* </p>
|
|
620
|
+
* <p>Contains information to enable Online Certificate Status Protocol (OCSP) support,
|
|
621
|
+
* to enable a certificate revocation list (CRL), to enable both, or to enable neither. The
|
|
622
|
+
* default is for both certificate validation mechanisms to be disabled. For more
|
|
623
|
+
* information, see the <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_OcspConfiguration.html">OcspConfiguration</a> and <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CrlConfiguration.html">CrlConfiguration</a> types.</p>
|
|
574
624
|
*/
|
|
575
625
|
RevocationConfiguration?: RevocationConfiguration;
|
|
576
626
|
/**
|
|
@@ -1037,8 +1087,8 @@ export interface CertificateAuthority {
|
|
|
1037
1087
|
*/
|
|
1038
1088
|
CertificateAuthorityConfiguration?: CertificateAuthorityConfiguration;
|
|
1039
1089
|
/**
|
|
1040
|
-
* <p>Information about the
|
|
1041
|
-
* private CA. </p>
|
|
1090
|
+
* <p>Information about the Online Certificate Status Protocol (OCSP) configuration or
|
|
1091
|
+
* certificate revocation list (CRL) created and maintained by your private CA. </p>
|
|
1042
1092
|
*/
|
|
1043
1093
|
RevocationConfiguration?: RevocationConfiguration;
|
|
1044
1094
|
/**
|
|
@@ -2067,7 +2117,10 @@ export interface UpdateCertificateAuthorityRequest {
|
|
|
2067
2117
|
*/
|
|
2068
2118
|
CertificateAuthorityArn: string | undefined;
|
|
2069
2119
|
/**
|
|
2070
|
-
* <p>
|
|
2120
|
+
* <p>Contains information to enable Online Certificate Status Protocol (OCSP) support,
|
|
2121
|
+
* to enable a certificate revocation list (CRL), to enable both, or to enable neither. If
|
|
2122
|
+
* this parameter is not supplied, existing capibilites remain unchanged. For more
|
|
2123
|
+
* information, see the <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_OcspConfiguration.html">OcspConfiguration</a> and <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CrlConfiguration.html">CrlConfiguration</a> types.</p>
|
|
2071
2124
|
*/
|
|
2072
2125
|
RevocationConfiguration?: RevocationConfiguration;
|
|
2073
2126
|
/**
|
package/models/models_0.ts
CHANGED
|
@@ -449,10 +449,17 @@ export enum S3ObjectAcl {
|
|
|
449
449
|
* <p>ACM Private CA assets that are stored in Amazon S3 can be protected with encryption.
|
|
450
450
|
* For more information, see <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaCreateCa.html#crl-encryption">Encrypting Your
|
|
451
451
|
* CRLs</a>.</p>
|
|
452
|
-
* <p>Your private CA uses the value in the <b>ExpirationInDays</b>
|
|
453
|
-
*
|
|
454
|
-
*
|
|
455
|
-
*
|
|
452
|
+
* <p>Your private CA uses the value in the <b>ExpirationInDays</b>
|
|
453
|
+
* parameter to calculate the <b>nextUpdate</b> field in the CRL.
|
|
454
|
+
* The CRL is refreshed at 1/2 the age of next update or when a certificate is revoked.
|
|
455
|
+
* When a certificate is revoked, it is recorded in the next CRL that is generated and in
|
|
456
|
+
* the next audit report. Only time valid certificates are listed in the CRL. Expired
|
|
457
|
+
* certificates are not included.</p>
|
|
458
|
+
*
|
|
459
|
+
* <p>A CRL is typically updated approximately 30 minutes after a certificate
|
|
460
|
+
* is revoked. If for any reason a CRL update fails, ACM Private CA makes further attempts
|
|
461
|
+
* every 15 minutes.</p>
|
|
462
|
+
*
|
|
456
463
|
* <p>CRLs contain the following fields:</p>
|
|
457
464
|
* <ul>
|
|
458
465
|
* <li>
|
|
@@ -544,6 +551,9 @@ export enum S3ObjectAcl {
|
|
|
544
551
|
* <code>openssl crl -inform DER -text -in <i>crl_path</i>
|
|
545
552
|
* -noout</code>
|
|
546
553
|
* </p>
|
|
554
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/crl-planning.html">Planning a certificate revocation list (CRL)</a>
|
|
555
|
+
* in the <i>AWS Certificate Manager Private Certificate Authority (PCA) User Guide</i>
|
|
556
|
+
* </p>
|
|
547
557
|
*/
|
|
548
558
|
export interface CrlConfiguration {
|
|
549
559
|
/**
|
|
@@ -571,9 +581,8 @@ export interface CrlConfiguration {
|
|
|
571
581
|
* <p>Name of the S3 bucket that contains the CRL. If you do not provide a value for the
|
|
572
582
|
* <b>CustomCname</b> argument, the name of your S3 bucket
|
|
573
583
|
* is placed into the <b>CRL Distribution Points</b> extension of
|
|
574
|
-
* the issued certificate. You can change the name of your bucket by calling the <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_UpdateCertificateAuthority.html">UpdateCertificateAuthority</a>
|
|
575
|
-
*
|
|
576
|
-
* allows ACM Private CA to write the CRL to your bucket.</p>
|
|
584
|
+
* the issued certificate. You can change the name of your bucket by calling the <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_UpdateCertificateAuthority.html">UpdateCertificateAuthority</a> operation. You must specify a <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaCreateCa.html#s3-policies">bucket
|
|
585
|
+
* policy</a> that allows ACM Private CA to write the CRL to your bucket.</p>
|
|
577
586
|
*/
|
|
578
587
|
S3BucketName?: string;
|
|
579
588
|
|
|
@@ -606,17 +615,65 @@ export namespace CrlConfiguration {
|
|
|
606
615
|
});
|
|
607
616
|
}
|
|
608
617
|
|
|
618
|
+
/**
|
|
619
|
+
* <p>Contains information to enable and configure Online Certificate Status Protocol (OCSP) for
|
|
620
|
+
* validating certificate revocation status.</p>
|
|
621
|
+
* <p>When you revoke a certificate, OCSP responses may take up to 60 minutes
|
|
622
|
+
* to reflect the new status.</p>
|
|
623
|
+
*/
|
|
624
|
+
export interface OcspConfiguration {
|
|
625
|
+
/**
|
|
626
|
+
* <p>Flag enabling use of the Online Certificate Status Protocol (OCSP) for validating
|
|
627
|
+
* certificate revocation status.</p>
|
|
628
|
+
*/
|
|
629
|
+
Enabled: boolean | undefined;
|
|
630
|
+
|
|
631
|
+
/**
|
|
632
|
+
* <p>By default, ACM Private CA injects an AWS domain into certificates being validated by the
|
|
633
|
+
* Online Certificate Status Protocol (OCSP). A customer can alternatively use this object
|
|
634
|
+
* to define a CNAME specifying a customized OCSP domain.</p>
|
|
635
|
+
* <p>Note: The value of the CNAME must not include a protocol prefix such as "http://" or
|
|
636
|
+
* "https://".</p>
|
|
637
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/ocsp-customize.html">Customizing Online Certificate
|
|
638
|
+
* Status Protocol (OCSP) </a> in the <i>AWS Certificate Manager Private Certificate Authority (PCA) User
|
|
639
|
+
* Guide</i>.</p>
|
|
640
|
+
*/
|
|
641
|
+
OcspCustomCname?: string;
|
|
642
|
+
}
|
|
643
|
+
|
|
644
|
+
export namespace OcspConfiguration {
|
|
645
|
+
/**
|
|
646
|
+
* @internal
|
|
647
|
+
*/
|
|
648
|
+
export const filterSensitiveLog = (obj: OcspConfiguration): any => ({
|
|
649
|
+
...obj,
|
|
650
|
+
});
|
|
651
|
+
}
|
|
652
|
+
|
|
609
653
|
/**
|
|
610
654
|
* <p>Certificate revocation information used by the <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CreateCertificateAuthority.html">CreateCertificateAuthority</a> and <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_UpdateCertificateAuthority.html">UpdateCertificateAuthority</a> actions. Your private certificate authority (CA)
|
|
611
|
-
* can
|
|
612
|
-
*
|
|
655
|
+
* can configure Online Certificate Status Protocol (OCSP) support and/or maintain a
|
|
656
|
+
* certificate revocation list (CRL). OCSP returns validation information about
|
|
657
|
+
* certificates as requested by clients, and a CRL contains an updated list of certificates
|
|
658
|
+
* revoked by your CA. For more information, see <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_RevokeCertificate.html">RevokeCertificate</a> and <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/revocation-setup.html">Setting up a
|
|
659
|
+
* certificate revocation method</a> in the <i>AWS Certificate Manager Private Certificate Authority (PCA) User
|
|
660
|
+
* Guide</i>.</p>
|
|
613
661
|
*/
|
|
614
662
|
export interface RevocationConfiguration {
|
|
615
663
|
/**
|
|
616
|
-
* <p>Configuration of the certificate revocation list (CRL), if any, maintained by your
|
|
617
|
-
*
|
|
664
|
+
* <p>Configuration of the certificate revocation list (CRL), if any, maintained by your private
|
|
665
|
+
* CA. A CRL is typically updated approximately 30 minutes after a certificate
|
|
666
|
+
* is revoked. If for any reason a CRL update fails, ACM Private CA makes further attempts
|
|
667
|
+
* every 15 minutes.</p>
|
|
618
668
|
*/
|
|
619
669
|
CrlConfiguration?: CrlConfiguration;
|
|
670
|
+
|
|
671
|
+
/**
|
|
672
|
+
* <p>Configuration of Online Certificate Status Protocol (OCSP) support, if any, maintained by
|
|
673
|
+
* your private CA. When you revoke a certificate, OCSP responses may take up to 60 minutes
|
|
674
|
+
* to reflect the new status.</p>
|
|
675
|
+
*/
|
|
676
|
+
OcspConfiguration?: OcspConfiguration;
|
|
620
677
|
}
|
|
621
678
|
|
|
622
679
|
export namespace RevocationConfiguration {
|
|
@@ -663,11 +720,10 @@ export interface CreateCertificateAuthorityRequest {
|
|
|
663
720
|
CertificateAuthorityConfiguration: CertificateAuthorityConfiguration | undefined;
|
|
664
721
|
|
|
665
722
|
/**
|
|
666
|
-
* <p>Contains
|
|
667
|
-
*
|
|
668
|
-
*
|
|
669
|
-
*
|
|
670
|
-
* </p>
|
|
723
|
+
* <p>Contains information to enable Online Certificate Status Protocol (OCSP) support,
|
|
724
|
+
* to enable a certificate revocation list (CRL), to enable both, or to enable neither. The
|
|
725
|
+
* default is for both certificate validation mechanisms to be disabled. For more
|
|
726
|
+
* information, see the <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_OcspConfiguration.html">OcspConfiguration</a> and <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CrlConfiguration.html">CrlConfiguration</a> types.</p>
|
|
671
727
|
*/
|
|
672
728
|
RevocationConfiguration?: RevocationConfiguration;
|
|
673
729
|
|
|
@@ -1246,8 +1302,8 @@ export interface CertificateAuthority {
|
|
|
1246
1302
|
CertificateAuthorityConfiguration?: CertificateAuthorityConfiguration;
|
|
1247
1303
|
|
|
1248
1304
|
/**
|
|
1249
|
-
* <p>Information about the
|
|
1250
|
-
* private CA. </p>
|
|
1305
|
+
* <p>Information about the Online Certificate Status Protocol (OCSP) configuration or
|
|
1306
|
+
* certificate revocation list (CRL) created and maintained by your private CA. </p>
|
|
1251
1307
|
*/
|
|
1252
1308
|
RevocationConfiguration?: RevocationConfiguration;
|
|
1253
1309
|
|
|
@@ -2492,7 +2548,10 @@ export interface UpdateCertificateAuthorityRequest {
|
|
|
2492
2548
|
CertificateAuthorityArn: string | undefined;
|
|
2493
2549
|
|
|
2494
2550
|
/**
|
|
2495
|
-
* <p>
|
|
2551
|
+
* <p>Contains information to enable Online Certificate Status Protocol (OCSP) support,
|
|
2552
|
+
* to enable a certificate revocation list (CRL), to enable both, or to enable neither. If
|
|
2553
|
+
* this parameter is not supplied, existing capibilites remain unchanged. For more
|
|
2554
|
+
* information, see the <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_OcspConfiguration.html">OcspConfiguration</a> and <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CrlConfiguration.html">CrlConfiguration</a> types.</p>
|
|
2496
2555
|
*/
|
|
2497
2556
|
RevocationConfiguration?: RevocationConfiguration;
|
|
2498
2557
|
|