Skip to content

Commit b9a4897

Browse files
author
awstools
committed
feat(client-secrets-manager): Update endpoint rules and examples.
1 parent 53ee504 commit b9a4897

File tree

2 files changed

+218
-21
lines changed

2 files changed

+218
-21
lines changed

‎clients/client-secrets-manager/src/endpoint/ruleset.ts‎

Lines changed: 24 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -6,27 +6,35 @@ import { RuleSetObject } from "@smithy/types";
66
or see "smithy.rules#endpointRuleSet"
77
in codegen/sdk-codegen/aws-models/secrets-manager.json */
88

9-
const s="required",
10-
t="fn",
11-
u="argv",
12-
v="ref";
9+
const y="required",
10+
z="fn",
11+
A="argv",
12+
B="ref",
13+
C="properties",
14+
D="headers";
1315
const a=true,
1416
b="isSet",
1517
c="booleanEquals",
1618
d="error",
1719
e="endpoint",
1820
f="tree",
1921
g="PartitionResult",
20-
h={[s]:false,"type":"String"},
21-
i={[s]:true,"default":false,"type":"Boolean"},
22-
j={[v]:"Endpoint"},
23-
k={[t]:c,[u]:[{[v]:"UseFIPS"},true]},
24-
l={[t]:c,[u]:[{[v]:"UseDualStack"},true]},
25-
m={},
26-
n={[t]:"getAttr",[u]:[{[v]:g},"supportsFIPS"]},
27-
o={[t]:c,[u]:[true,{[t]:"getAttr",[u]:[{[v]:g},"supportsDualStack"]}]},
28-
p=[k],
29-
q=[l],
30-
r=[{[v]:"Region"}];
31-
const _data={version:"1.0",parameters:{Region:h,UseDualStack:i,UseFIPS:i,Endpoint:h},rules:[{conditions:[{[t]:b,[u]:[j]}],rules:[{conditions:p,error:"Invalid Configuration: FIPS and custom endpoint are not supported",type:d},{conditions:q,error:"Invalid Configuration: Dualstack and custom endpoint are not supported",type:d},{endpoint:{url:j,properties:m,headers:m},type:e}],type:f},{conditions:[{[t]:b,[u]:r}],rules:[{conditions:[{[t]:"aws.partition",[u]:r,assign:g}],rules:[{conditions:[k,l],rules:[{conditions:[{[t]:c,[u]:[a,n]},o],rules:[{endpoint:{url:"https://secretsmanager-fips.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:m,headers:m},type:e}],type:f},{error:"FIPS and DualStack are enabled, but this partition does not support one or both",type:d}],type:f},{conditions:p,rules:[{conditions:[{[t]:c,[u]:[n,a]}],rules:[{endpoint:{url:"https://secretsmanager-fips.{Region}.{PartitionResult#dnsSuffix}",properties:m,headers:m},type:e}],type:f},{error:"FIPS is enabled but this partition does not support FIPS",type:d}],type:f},{conditions:q,rules:[{conditions:[o],rules:[{endpoint:{url:"https://secretsmanager.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:m,headers:m},type:e}],type:f},{error:"DualStack is enabled but this partition does not support DualStack",type:d}],type:f},{endpoint:{url:"https://secretsmanager.{Region}.{PartitionResult#dnsSuffix}",properties:m,headers:m},type:e}],type:f}],type:f},{error:"Invalid Configuration: Missing Region",type:d}]};
22+
h="stringEquals",
23+
i={[y]:false,"type":"String"},
24+
j={[y]:true,"default":false,"type":"Boolean"},
25+
k={[B]:"Endpoint"},
26+
l={[z]:c,[A]:[{[B]:"UseFIPS"},true]},
27+
m={[z]:c,[A]:[{[B]:"UseDualStack"},true]},
28+
n={},
29+
o={[z]:"getAttr",[A]:[{[B]:g},"supportsFIPS"]},
30+
p={[z]:c,[A]:[true,{[z]:"getAttr",[A]:[{[B]:g},"supportsDualStack"]}]},
31+
q={[z]:"getAttr",[A]:[{[B]:g},"name"]},
32+
r={"url":"https://secretsmanager-fips.{Region}.amazonaws.com",[C]:{},[D]:{}},
33+
s={"url":"https://secretsmanager.{Region}.amazonaws.com",[C]:{},[D]:{}},
34+
t=[l],
35+
u=[m],
36+
v=[{[B]:"Region"}],
37+
w=[{[z]:h,[A]:["aws",q]}],
38+
x=[{[z]:h,[A]:["aws-us-gov",q]}];
39+
const _data={version:"1.0",parameters:{Region:i,UseDualStack:j,UseFIPS:j,Endpoint:i},rules:[{conditions:[{[z]:b,[A]:[k]}],rules:[{conditions:t,error:"Invalid Configuration: FIPS and custom endpoint are not supported",type:d},{conditions:u,error:"Invalid Configuration: Dualstack and custom endpoint are not supported",type:d},{endpoint:{url:k,[C]:n,[D]:n},type:e}],type:f},{conditions:[{[z]:b,[A]:v}],rules:[{conditions:[{[z]:"aws.partition",[A]:v,assign:g}],rules:[{conditions:[l,m],rules:[{conditions:[{[z]:c,[A]:[a,o]},p],rules:[{conditions:w,endpoint:r,type:e},{conditions:x,endpoint:r,type:e},{endpoint:{url:"https://secretsmanager-fips.{Region}.{PartitionResult#dualStackDnsSuffix}",[C]:n,[D]:n},type:e}],type:f},{error:"FIPS and DualStack are enabled, but this partition does not support one or both",type:d}],type:f},{conditions:t,rules:[{conditions:[{[z]:c,[A]:[o,a]}],rules:[{endpoint:{url:"https://secretsmanager-fips.{Region}.{PartitionResult#dnsSuffix}",[C]:n,[D]:n},type:e}],type:f},{error:"FIPS is enabled but this partition does not support FIPS",type:d}],type:f},{conditions:u,rules:[{conditions:[p],rules:[{conditions:w,endpoint:s,type:e},{conditions:[{[z]:h,[A]:["aws-cn",q]}],endpoint:{url:"https://secretsmanager.{Region}.amazonaws.com.cn",[C]:n,[D]:n},type:e},{conditions:x,endpoint:s,type:e},{endpoint:{url:"https://secretsmanager.{Region}.{PartitionResult#dualStackDnsSuffix}",[C]:n,[D]:n},type:e}],type:f},{error:"DualStack is enabled but this partition does not support DualStack",type:d}],type:f},{endpoint:{url:"https://secretsmanager.{Region}.{PartitionResult#dnsSuffix}",[C]:n,[D]:n},type:e}],type:f}],type:f},{error:"Invalid Configuration: Missing Region",type:d}]};
3240
export const ruleSet: RuleSetObject = _data;

‎codegen/sdk-codegen/aws-models/secrets-manager.json‎

Lines changed: 194 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2321,6 +2321,18 @@
23212321
"Name": "MyTestDatabaseSecret",
23222322
"VersionId": "EXAMPLE2-90ab-cdef-fedc-ba987SECRET2"
23232323
}
2324+
},
2325+
{
2326+
"title": "To request an immediate rotation for a secret",
2327+
"documentation": "The following example requests an immediate invocation of the secret's Lambda rotation function. It assumes that the specified secret already has rotation configured. The rotation function runs asynchronously in the background.",
2328+
"input": {
2329+
"SecretId": "MyTestDatabaseSecret"
2330+
},
2331+
"output": {
2332+
"ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3",
2333+
"Name": "MyTestDatabaseSecret",
2334+
"VersionId": "EXAMPLE2-90ab-cdef-fedc-ba987SECRET2"
2335+
}
23242336
}
23252337
]
23262338
}
@@ -3095,6 +3107,31 @@
30953107
"ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3",
30963108
"Name": "MyTestDatabaseSecret"
30973109
}
3110+
},
3111+
{
3112+
"title": "To update the KMS key associated with a secret",
3113+
"documentation": "This example shows how to update the KMS customer managed key (CMK) used to encrypt the secret value. The KMS CMK must be in the same region as the secret.",
3114+
"input": {
3115+
"SecretId": "MyTestDatabaseSecret",
3116+
"KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/EXAMPLE2-90ab-cdef-fedc-ba987EXAMPLE"
3117+
},
3118+
"output": {
3119+
"ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3",
3120+
"Name": "MyTestDatabaseSecret"
3121+
}
3122+
},
3123+
{
3124+
"title": "To create a new version of the encrypted secret value",
3125+
"documentation": "The following example shows how to create a new version of the secret by updating the SecretString field. Alternatively, you can use the put-secret-value operation.",
3126+
"input": {
3127+
"SecretId": "MyTestDatabaseSecret",
3128+
"SecretString": "{JSON STRING WITH CREDENTIALS}"
3129+
},
3130+
"output": {
3131+
"ARN": "aws:arn:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3",
3132+
"Name": "MyTestDatabaseSecret",
3133+
"VersionId": "EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE"
3134+
}
30983135
}
30993136
]
31003137
}
@@ -3211,6 +3248,33 @@
32113248
"ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3",
32123249
"Name": "MyTestDatabaseSecret"
32133250
}
3251+
},
3252+
{
3253+
"title": "To delete a staging label attached to a version of a secret",
3254+
"documentation": "The following example shows you how to delete a staging label that is attached to a version of a secret. You can review the results by running the operation ListSecretVersionIds and viewing the VersionStages response field for the affected version.",
3255+
"input": {
3256+
"SecretId": "MyTestDatabaseSecret",
3257+
"VersionStage": "STAGINGLABEL1",
3258+
"RemoveFromVersionId": "EXAMPLE1-90ab-cdef-fedc-ba987SECRET1"
3259+
},
3260+
"output": {
3261+
"ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3",
3262+
"Name": "MyTestDatabaseSecret"
3263+
}
3264+
},
3265+
{
3266+
"title": "To move a staging label from one version of a secret to another",
3267+
"documentation": "The following example shows you how to move a staging label that is attached to one version of a secret to a different version. You can review the results by running the operation ListSecretVersionIds and viewing the VersionStages response field for the affected version.",
3268+
"input": {
3269+
"SecretId": "MyTestDatabaseSecret",
3270+
"VersionStage": "AWSCURRENT",
3271+
"RemoveFromVersionId": "EXAMPLE1-90ab-cdef-fedc-ba987SECRET1",
3272+
"MoveToVersionId": "EXAMPLE2-90ab-cdef-fedc-ba987SECRET2"
3273+
},
3274+
"output": {
3275+
"ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3",
3276+
"Name": "MyTestDatabaseSecret"
3277+
}
32143278
}
32153279
]
32163280
}
@@ -3637,6 +3701,56 @@
36373701
}
36383702
],
36393703
"rules": [
3704+
{
3705+
"conditions": [
3706+
{
3707+
"fn": "stringEquals",
3708+
"argv": [
3709+
"aws",
3710+
{
3711+
"fn": "getAttr",
3712+
"argv": [
3713+
{
3714+
"ref": "PartitionResult"
3715+
},
3716+
"name"
3717+
]
3718+
}
3719+
]
3720+
}
3721+
],
3722+
"endpoint": {
3723+
"url": "https://secretsmanager-fips.{Region}.amazonaws.com",
3724+
"properties": {},
3725+
"headers": {}
3726+
},
3727+
"type": "endpoint"
3728+
},
3729+
{
3730+
"conditions": [
3731+
{
3732+
"fn": "stringEquals",
3733+
"argv": [
3734+
"aws-us-gov",
3735+
{
3736+
"fn": "getAttr",
3737+
"argv": [
3738+
{
3739+
"ref": "PartitionResult"
3740+
},
3741+
"name"
3742+
]
3743+
}
3744+
]
3745+
}
3746+
],
3747+
"endpoint": {
3748+
"url": "https://secretsmanager-fips.{Region}.amazonaws.com",
3749+
"properties": {},
3750+
"headers": {}
3751+
},
3752+
"type": "endpoint"
3753+
},
36403754
{
36413755
"conditions": [],
36423756
"endpoint": {
@@ -3741,6 +3855,81 @@
37413855
}
37423856
],
37433857
"rules": [
3858+
{
3859+
"conditions": [
3860+
{
3861+
"fn": "stringEquals",
3862+
"argv": [
3863+
"aws",
3864+
{
3865+
"fn": "getAttr",
3866+
"argv": [
3867+
{
3868+
"ref": "PartitionResult"
3869+
},
3870+
"name"
3871+
]
3872+
}
3873+
]
3874+
}
3875+
],
3876+
"endpoint": {
3877+
"url": "https://secretsmanager.{Region}.amazonaws.com",
3878+
"properties": {},
3879+
"headers": {}
3880+
},
3881+
"type": "endpoint"
3882+
},
3883+
{
3884+
"conditions": [
3885+
{
3886+
"fn": "stringEquals",
3887+
"argv": [
3888+
"aws-cn",
3889+
{
3890+
"fn": "getAttr",
3891+
"argv": [
3892+
{
3893+
"ref": "PartitionResult"
3894+
},
3895+
"name"
3896+
]
3897+
}
3898+
]
3899+
}
3900+
],
3901+
"endpoint": {
3902+
"url": "https://secretsmanager.{Region}.amazonaws.com.cn",
3903+
"properties": {},
3904+
"headers": {}
3905+
},
3906+
"type": "endpoint"
3907+
},
3908+
{
3909+
"conditions": [
3910+
{
3911+
"fn": "stringEquals",
3912+
"argv": [
3913+
"aws-us-gov",
3914+
{
3915+
"fn": "getAttr",
3916+
"argv": [
3917+
{
3918+
"ref": "PartitionResult"
3919+
},
3920+
"name"
3921+
]
3922+
}
3923+
]
3924+
}
3925+
],
3926+
"endpoint": {
3927+
"url": "https://secretsmanager.{Region}.amazonaws.com",
3928+
"properties": {},
3929+
"headers": {}
3930+
},
3931+
"type": "endpoint"
3932+
},
37443933
{
37453934
"conditions": [],
37463935
"endpoint": {
@@ -4140,7 +4329,7 @@
41404329
"documentation": "For region us-east-1 with FIPS enabled and DualStack enabled",
41414330
"expect": {
41424331
"endpoint": {
4143-
"url": "https://secretsmanager-fips.us-east-1.api.aws"
4332+
"url": "https://secretsmanager-fips.us-east-1.amazonaws.com"
41444333
}
41454334
},
41464335
"params": {
@@ -4153,7 +4342,7 @@
41534342
"documentation": "For region us-east-1 with FIPS disabled and DualStack enabled",
41544343
"expect": {
41554344
"endpoint": {
4156-
"url": "https://secretsmanager.us-east-1.api.aws"
4345+
"url": "https://secretsmanager.us-east-1.amazonaws.com"
41574346
}
41584347
},
41594348
"params": {
@@ -4218,7 +4407,7 @@
42184407
"documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled",
42194408
"expect": {
42204409
"endpoint": {
4221-
"url": "https://secretsmanager.cn-north-1.api.amazonwebservices.com.cn"
4410+
"url": "https://secretsmanager.cn-north-1.amazonaws.com.cn"
42224411
}
42234412
},
42244413
"params": {
@@ -4283,7 +4472,7 @@
42834472
"documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled",
42844473
"expect": {
42854474
"endpoint": {
4286-
"url": "https://secretsmanager-fips.us-gov-east-1.api.aws"
4475+
"url": "https://secretsmanager-fips.us-gov-east-1.amazonaws.com"
42874476
}
42884477
},
42894478
"params": {
@@ -4296,7 +4485,7 @@
42964485
"documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled",
42974486
"expect": {
42984487
"endpoint": {
4299-
"url": "https://secretsmanager.us-gov-east-1.api.aws"
4488+
"url": "https://secretsmanager.us-gov-east-1.amazonaws.com"
43004489
}
43014490
},
43024491
"params": {

0 commit comments

Comments
 (0)