Skip to content

Commit 72364d2

Browse files
author
awstools
committed
docs(client-acm-pca): Document-only update to refresh CLI documentation for AWS Private CA. No change to the service.
1 parent 20a210e commit 72364d2

File tree

4 files changed

+567
-1511
lines changed

4 files changed

+567
-1511
lines changed

clients/client-acm-pca/src/endpoint/EndpointParameters.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ export const resolveClientEndpointParameters = <T>(
2525
};
2626

2727
export interface EndpointParameters extends __EndpointParameters {
28-
Region: string;
28+
Region?: string;
2929
UseDualStack?: boolean;
3030
UseFIPS?: boolean;
3131
Endpoint?: string;

clients/client-acm-pca/src/endpoint/ruleset.ts

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -6,27 +6,27 @@ import { RuleSetObject } from "@aws-sdk/util-endpoints";
66
or see "smithy.rules#endpointRuleSet"
77
in codegen/sdk-codegen/aws-models/acm-pca.json */
88

9-
const t="fn",
9+
const s="required",
10+
t="fn",
1011
u="argv",
1112
v="ref";
12-
const a=true,
13-
b=false,
14-
c="String",
15-
d="PartitionResult",
16-
e="tree",
17-
f="error",
18-
g="endpoint",
19-
h="getAttr",
20-
i={"required":true,"default":false,"type":"Boolean"},
21-
j={[v]:"Endpoint"},
22-
k={[t]:"booleanEquals",[u]:[{[v]:"UseFIPS"},true]},
23-
l={[t]:"booleanEquals",[u]:[{[v]:"UseDualStack"},true]},
24-
m={},
25-
n={[t]:"booleanEquals",[u]:[true,{[t]:h,[u]:[{[v]:d},"supportsFIPS"]}]},
26-
o={[v]:d},
27-
p={[t]:"booleanEquals",[u]:[true,{[t]:h,[u]:[o,"supportsDualStack"]}]},
28-
q={"url":"https://acm-pca.{Region}.{PartitionResult#dnsSuffix}","properties":{},"headers":{}},
29-
r=[k],
30-
s=[l];
31-
const _data={version:"1.0",parameters:{Region:{required:a,type:c},UseDualStack:i,UseFIPS:i,Endpoint:{required:b,type:c}},rules:[{conditions:[{[t]:"aws.partition",[u]:[{[v]:"Region"}],assign:d}],type:e,rules:[{conditions:[{[t]:"isSet",[u]:[j]}],type:e,rules:[{conditions:r,error:"Invalid Configuration: FIPS and custom endpoint are not supported",type:f},{type:e,rules:[{conditions:s,error:"Invalid Configuration: Dualstack and custom endpoint are not supported",type:f},{endpoint:{url:j,properties:m,headers:m},type:g}]}]},{conditions:[k,l],type:e,rules:[{conditions:[n,p],type:e,rules:[{endpoint:{url:"https://acm-pca-fips.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:m,headers:m},type:g}]},{error:"FIPS and DualStack are enabled, but this partition does not support one or both",type:f}]},{conditions:r,type:e,rules:[{conditions:[n],type:e,rules:[{type:e,rules:[{conditions:[{[t]:"stringEquals",[u]:["aws-us-gov",{[t]:h,[u]:[o,"name"]}]}],endpoint:q,type:g},{endpoint:{url:"https://acm-pca-fips.{Region}.{PartitionResult#dnsSuffix}",properties:m,headers:m},type:g}]}]},{error:"FIPS is enabled but this partition does not support FIPS",type:f}]},{conditions:s,type:e,rules:[{conditions:[p],type:e,rules:[{endpoint:{url:"https://acm-pca.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:m,headers:m},type:g}]},{error:"DualStack is enabled but this partition does not support DualStack",type:f}]},{endpoint:q,type:g}]}]};
13+
const a="isSet",
14+
b="tree",
15+
c="error",
16+
d="endpoint",
17+
e="PartitionResult",
18+
f="getAttr",
19+
g={[s]:false,"type":"String"},
20+
h={[s]:true,"default":false,"type":"Boolean"},
21+
i={[v]:"Endpoint"},
22+
j={[t]:"booleanEquals",[u]:[{[v]:"UseFIPS"},true]},
23+
k={[t]:"booleanEquals",[u]:[{[v]:"UseDualStack"},true]},
24+
l={},
25+
m={[t]:"booleanEquals",[u]:[true,{[t]:f,[u]:[{[v]:e},"supportsFIPS"]}]},
26+
n={[v]:e},
27+
o={[t]:"booleanEquals",[u]:[true,{[t]:f,[u]:[n,"supportsDualStack"]}]},
28+
p=[j],
29+
q=[k],
30+
r=[{[v]:"Region"}];
31+
const _data={version:"1.0",parameters:{Region:g,UseDualStack:h,UseFIPS:h,Endpoint:g},rules:[{conditions:[{[t]:a,[u]:[i]}],type:b,rules:[{conditions:p,error:"Invalid Configuration: FIPS and custom endpoint are not supported",type:c},{type:b,rules:[{conditions:q,error:"Invalid Configuration: Dualstack and custom endpoint are not supported",type:c},{endpoint:{url:i,properties:l,headers:l},type:d}]}]},{type:b,rules:[{conditions:[{[t]:a,[u]:r}],type:b,rules:[{conditions:[{[t]:"aws.partition",[u]:r,assign:e}],type:b,rules:[{conditions:[j,k],type:b,rules:[{conditions:[m,o],type:b,rules:[{type:b,rules:[{endpoint:{url:"https://acm-pca-fips.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:l,headers:l},type:d}]}]},{error:"FIPS and DualStack are enabled, but this partition does not support one or both",type:c}]},{conditions:p,type:b,rules:[{conditions:[m],type:b,rules:[{type:b,rules:[{conditions:[{[t]:"stringEquals",[u]:["aws-us-gov",{[t]:f,[u]:[n,"name"]}]}],endpoint:{url:"https://acm-pca.{Region}.amazonaws.com",properties:l,headers:l},type:d},{endpoint:{url:"https://acm-pca-fips.{Region}.{PartitionResult#dnsSuffix}",properties:l,headers:l},type:d}]}]},{error:"FIPS is enabled but this partition does not support FIPS",type:c}]},{conditions:q,type:b,rules:[{conditions:[o],type:b,rules:[{type:b,rules:[{endpoint:{url:"https://acm-pca.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:l,headers:l},type:d}]}]},{error:"DualStack is enabled but this partition does not support DualStack",type:c}]},{type:b,rules:[{endpoint:{url:"https://acm-pca.{Region}.{PartitionResult#dnsSuffix}",properties:l,headers:l},type:d}]}]}]},{error:"Invalid Configuration: Missing Region",type:c}]}]};
3232
export const ruleSet: RuleSetObject = _data;

clients/client-acm-pca/src/models/models_0.ts

Lines changed: 13 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -780,23 +780,15 @@ export interface CreateCertificateAuthorityRequest {
780780
* <p>Specifies a cryptographic key management compliance standard used for handling CA
781781
* keys.</p>
782782
* <p>Default: FIPS_140_2_LEVEL_3_OR_HIGHER</p>
783-
* <p>
784-
* <i>Note:</i>
785-
* <code>FIPS_140_2_LEVEL_3_OR_HIGHER</code> is not supported in the following
786-
* Regions:</p>
787-
* <ul>
788-
* <li>
789-
* <p>ap-northeast-3</p>
790-
* </li>
791-
* <li>
792-
* <p>ap-southeast-3</p>
793-
* </li>
794-
* </ul>
795-
* <p>When creating a CA in these Regions, you must provide
796-
* <code>FIPS_140_2_LEVEL_2_OR_HIGHER</code> as the argument for
797-
* <code>KeyStorageSecurityStandard</code>. Failure to do this results in an
798-
* <code>InvalidArgsException</code> with the message, "A certificate authority cannot
799-
* be created in this region with the specified security standard."</p>
783+
* <note>
784+
* <p>Some Amazon Web Services Regions do not support the default. When creating a CA in these Regions, you
785+
* must provide <code>FIPS_140_2_LEVEL_2_OR_HIGHER</code> as the argument for
786+
* <code>KeyStorageSecurityStandard</code>. Failure to do this results in an
787+
* <code>InvalidArgsException</code> with the message, "A certificate authority
788+
* cannot be created in this region with the specified security standard."</p>
789+
* <p>For information about security standard support in various Regions, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/data-protection.html#private-keys">Storage
790+
* and security compliance of Amazon Web Services Private CA private keys</a>.</p>
791+
* </note>
800792
*/
801793
KeyStorageSecurityStandard?: KeyStorageSecurityStandard | string;
802794

@@ -2018,8 +2010,8 @@ export interface IssueCertificateRequest {
20182010
* <p>This parameter should not be confused with the <code>SigningAlgorithm</code> parameter
20192011
* used to sign a CSR in the <code>CreateCertificateAuthority</code> action.</p>
20202012
* <note>
2021-
* <p>The specified signing algorithm family (RSA or ECDSA) much match the algorithm
2022-
* family of the CA's secret key.</p>
2013+
* <p>The specified signing algorithm family (RSA or ECDSA) must match the algorithm family of
2014+
* the CA's secret key.</p>
20232015
* </note>
20242016
*/
20252017
SigningAlgorithm: SigningAlgorithm | string | undefined;
@@ -2067,7 +2059,8 @@ export interface IssueCertificateRequest {
20672059
* parameter is optional.</p>
20682060
* <p>The <code>ValidityNotBefore</code> value is expressed as an explicit date and time,
20692061
* using the <code>Validity</code> type value <code>ABSOLUTE</code>. For more information,
2070-
* see <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_Validity.html">Validity</a> in this API reference and <a href="https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.5">Validity</a>
2062+
* see <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_Validity.html">Validity</a> in
2063+
* this API reference and <a href="https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.5">Validity</a>
20712064
* in RFC 5280.</p>
20722065
*/
20732066
ValidityNotBefore?: Validity;

0 commit comments

Comments
 (0)