Skip to content

Commit 8983d46

Browse files
author
awstools
committed
docs(client-acm-pca): Private Certificate Authority (PCA) documentation updates
1 parent af66246 commit 8983d46

File tree

2 files changed

+21
-9
lines changed

2 files changed

+21
-9
lines changed

Diff for: clients/client-acm-pca/src/models/models_0.ts

+19-7
Original file line numberDiff line numberDiff line change
@@ -724,26 +724,38 @@ export interface CrlConfiguration {
724724
CrlDistributionPointExtensionConfiguration?: CrlDistributionPointExtensionConfiguration | undefined;
725725

726726
/**
727-
* <p>Choose whether to use a partitioned or complete CRL. Your choice determines the maximum number of certificates that the certificate authority can issue and revoke, as described in the <a href="https://docs.aws.amazon.com/general/latest/gr/pca.html#limits_pca-connector-ad">Amazon Web Services Private CA quotas</a>.</p>
727+
* <p>Specifies whether to create a complete or partitioned CRL. This setting determines the maximum
728+
* number of certificates that the certificate authority can issue and revoke. For more information, see
729+
* <a href="privateca/latest/userguide/pca.html#limits_pca">Amazon Web Services Private CA quotas</a>.</p>
728730
* <ul>
729731
* <li>
730732
* <p>
731-
* <code>PARTITIONED</code> - The default setting. Partitioned CRLs are an especially good option for devices that have limited processing power or storage capacity, such as certain IoT devices. Compared to complete CRLs, partitioned CRLs dramatically increase the number of certificates your private CA can issue. Each certificate that Amazon Web Services Private CA issues is bound to a specific CRL partition through the CRL distribution point (CDP) defined in <a href="https://datatracker.ietf.org/doc/html/rfc5280">RFC 5280</a>.</p>
732-
* <important>
733-
* <p>To make sure that your client fetches the CRL from a valid endpoint, we recommend that you programmatically validate that the CRL's issuing distribution point (IDP) URI matches the certificate's CDP URI. Amazon Web Services Private CA marks the IDP extension as critical, which your client must be able to process.</p>
734-
* </important>
733+
* <code>COMPLETE</code> - The default setting. Amazon Web Services Private CA maintains a single CRL file for all unexpired
734+
* certificates issued by a CA that have been revoked for any reason. Each certificate that Amazon Web Services Private CA
735+
* issues is bound to a specific CRL through its CRL distribution point (CDP) extension, defined in <a href="https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.9">
736+
* RFC 5280</a>.</p>
735737
* </li>
736738
* <li>
737739
* <p>
738-
* <code>COMPLETE</code> - Amazon Web Services Private CA maintains a single CRL file for all unexpired certificates issued by a CA that have been revoked for any reason.</p>
740+
* <code>PARTITIONED</code> - Compared to complete CRLs, partitioned CRLs
741+
* dramatically increase the number of certificates your private CA can issue. </p>
742+
* <important>
743+
* <p> When using partitioned CRLs, you must validate that the CRL's associated
744+
* issuing distribution point (IDP) URI matches the certificate's CDP URI to ensure
745+
* the right CRL has been fetched. Amazon Web Services Private CA marks the IDP extension as critical,
746+
* which your client must be able to process.
747+
* </p>
748+
* </important>
739749
* </li>
740750
* </ul>
741751
* @public
742752
*/
743753
CrlType?: CrlType | undefined;
744754

745755
/**
746-
* <p>Designates a custom file path in S3 for CRL(s). For example, <code>http://&lt;CustomName&gt;/&lt;CustomPath&gt;/&lt;CrlPartition_GUID&gt;.crl</code>. You can change the custom path up to five times.</p>
756+
* <p>Designates a custom file path in S3 for CRL(s). For example, <code>http://&lt;CustomName&gt;/
757+
* &lt;CustomPath&gt;/&lt;CrlPartition_GUID&gt;.crl</code>.
758+
* </p>
747759
* @public
748760
*/
749761
CustomPath?: string | undefined;

Diff for: codegen/sdk-codegen/aws-models/acm-pca.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -2008,13 +2008,13 @@
20082008
"CrlType": {
20092009
"target": "com.amazonaws.acmpca#CrlType",
20102010
"traits": {
2011-
"smithy.api#documentation": "<p>Choose whether to use a partitioned or complete CRL. Your choice determines the maximum number of certificates that the certificate authority can issue and revoke, as described in the <a href=\"https://docs.aws.amazon.com/general/latest/gr/pca.html#limits_pca-connector-ad\">Amazon Web Services Private CA quotas</a>.</p>\n <ul>\n <li>\n <p>\n <code>PARTITIONED</code> - The default setting. Partitioned CRLs are an especially good option for devices that have limited processing power or storage capacity, such as certain IoT devices. Compared to complete CRLs, partitioned CRLs dramatically increase the number of certificates your private CA can issue. Each certificate that Amazon Web Services Private CA issues is bound to a specific CRL partition through the CRL distribution point (CDP) defined in <a href=\"https://datatracker.ietf.org/doc/html/rfc5280\">RFC 5280</a>.</p>\n <important>\n <p>To make sure that your client fetches the CRL from a valid endpoint, we recommend that you programmatically validate that the CRL's issuing distribution point (IDP) URI matches the certificate's CDP URI. Amazon Web Services Private CA marks the IDP extension as critical, which your client must be able to process.</p>\n </important>\n </li>\n <li>\n <p>\n <code>COMPLETE</code> - Amazon Web Services Private CA maintains a single CRL file for all unexpired certificates issued by a CA that have been revoked for any reason.</p>\n </li>\n </ul>"
2011+
"smithy.api#documentation": "<p>Specifies whether to create a complete or partitioned CRL. This setting determines the maximum \n\t\tnumber of certificates that the certificate authority can issue and revoke. For more information, see\n\t\t<a href=\"privateca/latest/userguide/pca.html#limits_pca\">Amazon Web Services Private CA quotas</a>.</p>\n <ul>\n <li>\n <p>\n <code>COMPLETE</code> - The default setting. Amazon Web Services Private CA maintains a single CRL file for all unexpired \n\t\t\t\tcertificates issued by a CA that have been revoked for any reason. Each certificate that Amazon Web Services Private CA\n\t\t\tissues is bound to a specific CRL through its CRL distribution point (CDP) extension, defined in <a href=\"https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.9\">\n\t\t\t\tRFC 5280</a>.</p>\n </li>\n <li>\n <p>\n <code>PARTITIONED</code> - Compared to complete CRLs, partitioned CRLs\n\t\t\tdramatically increase the number of certificates your private CA can issue. </p>\n <important>\n <p> When using partitioned CRLs, you must validate that the CRL's associated\n\t\t\t\t\t\tissuing distribution point (IDP) URI matches the certificate's CDP URI to ensure\n\t\t\t\t\t\tthe right CRL has been fetched. Amazon Web Services Private CA marks the IDP extension as critical, \n\t\t\t\t\t\twhich your client must be able to process.\n\t\t\t\t\t</p>\n </important>\n </li>\n </ul>"
20122012
}
20132013
},
20142014
"CustomPath": {
20152015
"target": "com.amazonaws.acmpca#CrlPathString",
20162016
"traits": {
2017-
"smithy.api#documentation": "<p>Designates a custom file path in S3 for CRL(s). For example, <code>http://&lt;CustomName&gt;/&lt;CustomPath&gt;/&lt;CrlPartition_GUID&gt;.crl</code>. You can change the custom path up to five times.</p>"
2017+
"smithy.api#documentation": "<p>Designates a custom file path in S3 for CRL(s). For example, <code>http://&lt;CustomName&gt;/\n\t\t\t&lt;CustomPath&gt;/&lt;CrlPartition_GUID&gt;.crl</code>. \n\t\t</p>"
20182018
}
20192019
}
20202020
},

0 commit comments

Comments
 (0)