@pgarbe/cdk-ecr-sync 0.5.23 → 0.5.24
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/.gitattributes +1 -0
- package/.jsii +5 -4
- package/lib/ecr-sync.js +1 -1
- package/node_modules/aws-sdk/CHANGELOG.md +92 -1
- package/node_modules/aws-sdk/README.md +1 -1
- package/node_modules/aws-sdk/apis/appstream-2016-12-01.min.json +358 -148
- package/node_modules/aws-sdk/apis/appsync-2017-07-25.min.json +76 -58
- package/node_modules/aws-sdk/apis/chime-sdk-messaging-2021-05-15.min.json +114 -110
- package/node_modules/aws-sdk/apis/cloudtrail-2013-11-01.min.json +499 -61
- package/node_modules/aws-sdk/apis/cloudtrail-2013-11-01.paginators.json +14 -0
- package/node_modules/aws-sdk/apis/compute-optimizer-2019-11-01.min.json +30 -15
- package/node_modules/aws-sdk/apis/customer-profiles-2020-08-15.min.json +36 -23
- package/node_modules/aws-sdk/apis/databrew-2017-07-25.min.json +125 -124
- package/node_modules/aws-sdk/apis/datasync-2018-11-09.min.json +117 -68
- package/node_modules/aws-sdk/apis/detective-2018-10-26.min.json +101 -9
- package/node_modules/aws-sdk/apis/detective-2018-10-26.paginators.json +5 -0
- package/node_modules/aws-sdk/apis/devops-guru-2020-12-01.min.json +18 -12
- package/node_modules/aws-sdk/apis/devops-guru-2020-12-01.paginators.json +2 -1
- package/node_modules/aws-sdk/apis/ec2-2016-11-15.min.json +1310 -997
- package/node_modules/aws-sdk/apis/ec2-2016-11-15.paginators.json +6 -0
- package/node_modules/aws-sdk/apis/eks-2017-11-01.min.json +54 -51
- package/node_modules/aws-sdk/apis/es-2015-01-01.min.json +58 -49
- package/node_modules/aws-sdk/apis/finspace-data-2020-07-13.min.json +29 -20
- package/node_modules/aws-sdk/apis/forecast-2018-06-26.min.json +3 -0
- package/node_modules/aws-sdk/apis/glue-2017-03-31.min.json +604 -411
- package/node_modules/aws-sdk/apis/glue-2017-03-31.paginators.json +5 -0
- package/node_modules/aws-sdk/apis/greengrassv2-2020-11-30.min.json +182 -29
- package/node_modules/aws-sdk/apis/honeycode-2020-03-01.min.json +141 -39
- package/node_modules/aws-sdk/apis/imagebuilder-2019-12-02.min.json +131 -76
- package/node_modules/aws-sdk/apis/iot-2015-05-28.min.json +258 -212
- package/node_modules/aws-sdk/apis/iotwireless-2020-11-22.min.json +132 -44
- package/node_modules/aws-sdk/apis/iotwireless-2020-11-22.paginators.json +5 -0
- package/node_modules/aws-sdk/apis/ivs-2020-07-14.min.json +31 -16
- package/node_modules/aws-sdk/apis/kendra-2019-02-03.min.json +11 -2
- package/node_modules/aws-sdk/apis/kendra-2019-02-03.paginators.json +5 -0
- package/node_modules/aws-sdk/apis/lakeformation-2017-03-31.min.json +129 -17
- package/node_modules/aws-sdk/apis/location-2020-11-19.min.json +308 -117
- package/node_modules/aws-sdk/apis/lookoutmetrics-2017-07-25.min.json +61 -31
- package/node_modules/aws-sdk/apis/lookoutmetrics-2017-07-25.paginators.json +5 -0
- package/node_modules/aws-sdk/apis/mediaconnect-2018-11-14.min.json +39 -0
- package/node_modules/aws-sdk/apis/mediaconvert-2017-08-29.min.json +70 -67
- package/node_modules/aws-sdk/apis/medialive-2017-10-14.min.json +194 -191
- package/node_modules/aws-sdk/apis/mediatailor-2018-04-23.min.json +8 -5
- package/node_modules/aws-sdk/apis/models.lex.v2-2020-08-07.min.json +284 -165
- package/node_modules/aws-sdk/apis/mwaa-2020-07-01.min.json +7 -6
- package/node_modules/aws-sdk/apis/nimble-2020-08-01.min.json +175 -123
- package/node_modules/aws-sdk/apis/opensearch-2021-01-01.min.json +58 -49
- package/node_modules/aws-sdk/apis/pi-2018-02-27.min.json +141 -7
- package/node_modules/aws-sdk/apis/pi-2018-02-27.paginators.json +20 -0
- package/node_modules/aws-sdk/apis/pinpoint-2016-12-01.min.json +18 -12
- package/node_modules/aws-sdk/apis/qldb-2019-01-02.min.json +20 -18
- package/node_modules/aws-sdk/apis/ram-2018-01-04.min.json +27 -0
- package/node_modules/aws-sdk/apis/ram-2018-01-04.paginators.json +5 -0
- package/node_modules/aws-sdk/apis/redshift-2012-12-01.min.json +2 -1
- package/node_modules/aws-sdk/apis/rekognition-2016-06-27.min.json +20 -19
- package/node_modules/aws-sdk/apis/runtime.lex.v2-2020-08-07.min.json +41 -8
- package/node_modules/aws-sdk/apis/s3-2006-03-01.examples.json +138 -138
- package/node_modules/aws-sdk/apis/sagemaker-2017-07-24.min.json +364 -297
- package/node_modules/aws-sdk/apis/securityhub-2018-10-26.min.json +733 -353
- package/node_modules/aws-sdk/apis/snowball-2016-06-30.examples.json +2 -2
- package/node_modules/aws-sdk/apis/ssm-2014-11-06.min.json +263 -255
- package/node_modules/aws-sdk/apis/transfer-2018-11-05.min.json +47 -43
- package/node_modules/aws-sdk/apis/workmail-2017-10-01.min.json +82 -27
- package/node_modules/aws-sdk/apis/workspaces-2015-04-08.min.json +139 -49
- package/node_modules/aws-sdk/clients/apigateway.d.ts +5 -5
- package/node_modules/aws-sdk/clients/applicationinsights.d.ts +1 -1
- package/node_modules/aws-sdk/clients/appstream.d.ts +262 -0
- package/node_modules/aws-sdk/clients/appsync.d.ts +25 -0
- package/node_modules/aws-sdk/clients/chimesdkmessaging.d.ts +12 -4
- package/node_modules/aws-sdk/clients/cloudtrail.d.ts +615 -13
- package/node_modules/aws-sdk/clients/computeoptimizer.d.ts +45 -13
- package/node_modules/aws-sdk/clients/configservice.d.ts +1 -1
- package/node_modules/aws-sdk/clients/costexplorer.d.ts +14 -14
- package/node_modules/aws-sdk/clients/customerprofiles.d.ts +30 -13
- package/node_modules/aws-sdk/clients/databrew.d.ts +6 -1
- package/node_modules/aws-sdk/clients/datasync.d.ts +68 -3
- package/node_modules/aws-sdk/clients/detective.d.ts +144 -40
- package/node_modules/aws-sdk/clients/devopsguru.d.ts +5 -1
- package/node_modules/aws-sdk/clients/ec2.d.ts +379 -37
- package/node_modules/aws-sdk/clients/ecs.d.ts +5 -5
- package/node_modules/aws-sdk/clients/eks.d.ts +15 -2
- package/node_modules/aws-sdk/clients/elasticache.d.ts +12 -12
- package/node_modules/aws-sdk/clients/es.d.ts +13 -0
- package/node_modules/aws-sdk/clients/finspacedata.d.ts +32 -14
- package/node_modules/aws-sdk/clients/fms.d.ts +6 -6
- package/node_modules/aws-sdk/clients/forecastservice.d.ts +43 -24
- package/node_modules/aws-sdk/clients/glue.d.ts +119 -0
- package/node_modules/aws-sdk/clients/greengrassv2.d.ts +133 -5
- package/node_modules/aws-sdk/clients/honeycode.d.ts +83 -3
- package/node_modules/aws-sdk/clients/imagebuilder.d.ts +100 -8
- package/node_modules/aws-sdk/clients/iot.d.ts +49 -1
- package/node_modules/aws-sdk/clients/ioteventsdata.d.ts +3 -3
- package/node_modules/aws-sdk/clients/iotwireless.d.ts +76 -0
- package/node_modules/aws-sdk/clients/ivs.d.ts +21 -1
- package/node_modules/aws-sdk/clients/kendra.d.ts +21 -4
- package/node_modules/aws-sdk/clients/lakeformation.d.ts +136 -1
- package/node_modules/aws-sdk/clients/lexmodelsv2.d.ts +174 -20
- package/node_modules/aws-sdk/clients/lexruntimev2.d.ts +28 -1
- package/node_modules/aws-sdk/clients/location.d.ts +169 -52
- package/node_modules/aws-sdk/clients/lookoutmetrics.d.ts +104 -22
- package/node_modules/aws-sdk/clients/mediaconnect.d.ts +51 -7
- package/node_modules/aws-sdk/clients/mediaconvert.d.ts +8 -3
- package/node_modules/aws-sdk/clients/medialive.d.ts +10 -1
- package/node_modules/aws-sdk/clients/mediatailor.d.ts +6 -2
- package/node_modules/aws-sdk/clients/mwaa.d.ts +101 -57
- package/node_modules/aws-sdk/clients/nimble.d.ts +76 -17
- package/node_modules/aws-sdk/clients/opensearch.d.ts +13 -0
- package/node_modules/aws-sdk/clients/pi.d.ts +202 -29
- package/node_modules/aws-sdk/clients/pinpoint.d.ts +4 -0
- package/node_modules/aws-sdk/clients/qldb.d.ts +28 -19
- package/node_modules/aws-sdk/clients/quicksight.d.ts +8 -8
- package/node_modules/aws-sdk/clients/ram.d.ts +33 -1
- package/node_modules/aws-sdk/clients/rds.d.ts +53 -53
- package/node_modules/aws-sdk/clients/redshift.d.ts +8 -4
- package/node_modules/aws-sdk/clients/rekognition.d.ts +13 -8
- package/node_modules/aws-sdk/clients/s3.d.ts +6 -6
- package/node_modules/aws-sdk/clients/s3control.d.ts +1 -1
- package/node_modules/aws-sdk/clients/sagemaker.d.ts +117 -10
- package/node_modules/aws-sdk/clients/secretsmanager.d.ts +175 -175
- package/node_modules/aws-sdk/clients/securityhub.d.ts +548 -3
- package/node_modules/aws-sdk/clients/ssm.d.ts +22 -11
- package/node_modules/aws-sdk/clients/storagegateway.d.ts +10 -10
- package/node_modules/aws-sdk/clients/transcribeservice.d.ts +33 -33
- package/node_modules/aws-sdk/clients/transfer.d.ts +15 -6
- package/node_modules/aws-sdk/clients/workmail.d.ts +65 -0
- package/node_modules/aws-sdk/clients/workspaces.d.ts +130 -0
- package/node_modules/aws-sdk/dist/aws-sdk-core-react-native.js +1 -1
- package/node_modules/aws-sdk/dist/aws-sdk-react-native.js +58 -58
- package/node_modules/aws-sdk/dist/aws-sdk.js +2727 -1673
- package/node_modules/aws-sdk/dist/aws-sdk.min.js +80 -80
- package/node_modules/aws-sdk/lib/core.js +1 -1
- package/node_modules/aws-sdk/package.json +1 -1
- package/node_modules/{readable-stream → jszip/node_modules/readable-stream}/.travis.yml +0 -0
- package/node_modules/{readable-stream → jszip/node_modules/readable-stream}/CONTRIBUTING.md +0 -0
- package/node_modules/{readable-stream → jszip/node_modules/readable-stream}/GOVERNANCE.md +0 -0
- package/node_modules/{readable-stream → jszip/node_modules/readable-stream}/LICENSE +0 -0
- package/node_modules/{readable-stream → jszip/node_modules/readable-stream}/README.md +0 -0
- package/node_modules/{readable-stream → jszip/node_modules/readable-stream}/doc/wg-meetings/2015-01-30.md +0 -0
- package/node_modules/{readable-stream → jszip/node_modules/readable-stream}/duplex-browser.js +0 -0
- package/node_modules/{readable-stream → jszip/node_modules/readable-stream}/duplex.js +0 -0
- package/node_modules/{readable-stream → jszip/node_modules/readable-stream}/lib/_stream_duplex.js +0 -0
- package/node_modules/{readable-stream → jszip/node_modules/readable-stream}/lib/_stream_passthrough.js +0 -0
- package/node_modules/{readable-stream → jszip/node_modules/readable-stream}/lib/_stream_readable.js +0 -0
- package/node_modules/{readable-stream → jszip/node_modules/readable-stream}/lib/_stream_transform.js +0 -0
- package/node_modules/{readable-stream → jszip/node_modules/readable-stream}/lib/_stream_writable.js +0 -0
- package/node_modules/{readable-stream → jszip/node_modules/readable-stream}/lib/internal/streams/BufferList.js +0 -0
- package/node_modules/{readable-stream → jszip/node_modules/readable-stream}/lib/internal/streams/destroy.js +0 -0
- package/node_modules/{readable-stream → jszip/node_modules/readable-stream}/lib/internal/streams/stream-browser.js +0 -0
- package/node_modules/{readable-stream → jszip/node_modules/readable-stream}/lib/internal/streams/stream.js +0 -0
- package/node_modules/{readable-stream → jszip/node_modules/readable-stream}/package.json +0 -0
- package/node_modules/{readable-stream → jszip/node_modules/readable-stream}/passthrough.js +0 -0
- package/node_modules/{readable-stream → jszip/node_modules/readable-stream}/readable-browser.js +0 -0
- package/node_modules/{readable-stream → jszip/node_modules/readable-stream}/readable.js +0 -0
- package/node_modules/{readable-stream → jszip/node_modules/readable-stream}/transform.js +0 -0
- package/node_modules/{readable-stream → jszip/node_modules/readable-stream}/writable-browser.js +0 -0
- package/node_modules/{readable-stream → jszip/node_modules/readable-stream}/writable.js +0 -0
- package/node_modules/{string_decoder → jszip/node_modules/string_decoder}/.travis.yml +0 -0
- package/node_modules/{string_decoder → jszip/node_modules/string_decoder}/LICENSE +0 -0
- package/node_modules/{string_decoder → jszip/node_modules/string_decoder}/README.md +0 -0
- package/node_modules/{string_decoder → jszip/node_modules/string_decoder}/lib/string_decoder.js +0 -0
- package/node_modules/{string_decoder → jszip/node_modules/string_decoder}/package.json +0 -0
- package/package.json +2 -2
|
@@ -12,179 +12,179 @@ declare class SecretsManager extends Service {
|
|
|
12
12
|
constructor(options?: SecretsManager.Types.ClientConfiguration)
|
|
13
13
|
config: Config & SecretsManager.Types.ClientConfiguration;
|
|
14
14
|
/**
|
|
15
|
-
*
|
|
15
|
+
* Turns off automatic rotation, and if a rotation is currently in progress, cancels the rotation. To turn on automatic rotation again, call RotateSecret. If you cancel a rotation in progress, it can leave the VersionStage labels in an unexpected state. Depending on the step of the rotation in progress, you might need to remove the staging label AWSPENDING from the partially created version, specified by the VersionId response value. We recommend you also evaluate the partially rotated new version to see if it should be deleted. You can delete a version by removing all staging labels from it.
|
|
16
16
|
*/
|
|
17
17
|
cancelRotateSecret(params: SecretsManager.Types.CancelRotateSecretRequest, callback?: (err: AWSError, data: SecretsManager.Types.CancelRotateSecretResponse) => void): Request<SecretsManager.Types.CancelRotateSecretResponse, AWSError>;
|
|
18
18
|
/**
|
|
19
|
-
*
|
|
19
|
+
* Turns off automatic rotation, and if a rotation is currently in progress, cancels the rotation. To turn on automatic rotation again, call RotateSecret. If you cancel a rotation in progress, it can leave the VersionStage labels in an unexpected state. Depending on the step of the rotation in progress, you might need to remove the staging label AWSPENDING from the partially created version, specified by the VersionId response value. We recommend you also evaluate the partially rotated new version to see if it should be deleted. You can delete a version by removing all staging labels from it.
|
|
20
20
|
*/
|
|
21
21
|
cancelRotateSecret(callback?: (err: AWSError, data: SecretsManager.Types.CancelRotateSecretResponse) => void): Request<SecretsManager.Types.CancelRotateSecretResponse, AWSError>;
|
|
22
22
|
/**
|
|
23
|
-
* Creates a new secret. A secret
|
|
23
|
+
* Creates a new secret. A secret is a set of credentials, such as a user name and password, that you store in an encrypted form in Secrets Manager. The secret also includes the connection information to access a database or other service, which Secrets Manager doesn't encrypt. A secret in Secrets Manager consists of both the protected secret data and the important information needed to manage the secret. For information about creating a secret in the console, see Create a secret. To create a secret, you can provide the secret value to be encrypted in either the SecretString parameter or the SecretBinary parameter, but not both. If you include SecretString or SecretBinary then Secrets Manager creates an initial secret version and automatically attaches the staging label AWSCURRENT to it. If you don't specify an KMS encryption key, Secrets Manager uses the Amazon Web Services managed key aws/secretsmanager. If this key doesn't already exist in your account, then Secrets Manager creates it for you automatically. All users and roles in the Amazon Web Services account automatically have access to use aws/secretsmanager. Creating aws/secretsmanager can result in a one-time significant delay in returning the result. If the secret is in a different Amazon Web Services account from the credentials calling the API, then you can't use aws/secretsmanager to encrypt the secret, and you must create and use a customer managed KMS key.
|
|
24
24
|
*/
|
|
25
25
|
createSecret(params: SecretsManager.Types.CreateSecretRequest, callback?: (err: AWSError, data: SecretsManager.Types.CreateSecretResponse) => void): Request<SecretsManager.Types.CreateSecretResponse, AWSError>;
|
|
26
26
|
/**
|
|
27
|
-
* Creates a new secret. A secret
|
|
27
|
+
* Creates a new secret. A secret is a set of credentials, such as a user name and password, that you store in an encrypted form in Secrets Manager. The secret also includes the connection information to access a database or other service, which Secrets Manager doesn't encrypt. A secret in Secrets Manager consists of both the protected secret data and the important information needed to manage the secret. For information about creating a secret in the console, see Create a secret. To create a secret, you can provide the secret value to be encrypted in either the SecretString parameter or the SecretBinary parameter, but not both. If you include SecretString or SecretBinary then Secrets Manager creates an initial secret version and automatically attaches the staging label AWSCURRENT to it. If you don't specify an KMS encryption key, Secrets Manager uses the Amazon Web Services managed key aws/secretsmanager. If this key doesn't already exist in your account, then Secrets Manager creates it for you automatically. All users and roles in the Amazon Web Services account automatically have access to use aws/secretsmanager. Creating aws/secretsmanager can result in a one-time significant delay in returning the result. If the secret is in a different Amazon Web Services account from the credentials calling the API, then you can't use aws/secretsmanager to encrypt the secret, and you must create and use a customer managed KMS key.
|
|
28
28
|
*/
|
|
29
29
|
createSecret(callback?: (err: AWSError, data: SecretsManager.Types.CreateSecretResponse) => void): Request<SecretsManager.Types.CreateSecretResponse, AWSError>;
|
|
30
30
|
/**
|
|
31
|
-
* Deletes the resource-based permission policy attached to the secret.
|
|
31
|
+
* Deletes the resource-based permission policy attached to the secret. To attach a policy to a secret, use PutResourcePolicy.
|
|
32
32
|
*/
|
|
33
33
|
deleteResourcePolicy(params: SecretsManager.Types.DeleteResourcePolicyRequest, callback?: (err: AWSError, data: SecretsManager.Types.DeleteResourcePolicyResponse) => void): Request<SecretsManager.Types.DeleteResourcePolicyResponse, AWSError>;
|
|
34
34
|
/**
|
|
35
|
-
* Deletes the resource-based permission policy attached to the secret.
|
|
35
|
+
* Deletes the resource-based permission policy attached to the secret. To attach a policy to a secret, use PutResourcePolicy.
|
|
36
36
|
*/
|
|
37
37
|
deleteResourcePolicy(callback?: (err: AWSError, data: SecretsManager.Types.DeleteResourcePolicyResponse) => void): Request<SecretsManager.Types.DeleteResourcePolicyResponse, AWSError>;
|
|
38
38
|
/**
|
|
39
|
-
* Deletes
|
|
39
|
+
* Deletes a secret and all of its versions. You can specify a recovery window during which you can restore the secret. The minimum recovery window is 7 days. The default recovery window is 30 days. Secrets Manager attaches a DeletionDate stamp to the secret that specifies the end of the recovery window. At the end of the recovery window, Secrets Manager deletes the secret permanently. For information about deleting a secret in the console, see https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_delete-secret.html. Secrets Manager performs the permanent secret deletion at the end of the waiting period as a background task with low priority. There is no guarantee of a specific time after the recovery window for the permanent delete to occur. At any time before recovery window ends, you can use RestoreSecret to remove the DeletionDate and cancel the deletion of the secret. In a secret scheduled for deletion, you cannot access the encrypted secret value. To access that information, first cancel the deletion with RestoreSecret and then retrieve the information.
|
|
40
40
|
*/
|
|
41
41
|
deleteSecret(params: SecretsManager.Types.DeleteSecretRequest, callback?: (err: AWSError, data: SecretsManager.Types.DeleteSecretResponse) => void): Request<SecretsManager.Types.DeleteSecretResponse, AWSError>;
|
|
42
42
|
/**
|
|
43
|
-
* Deletes
|
|
43
|
+
* Deletes a secret and all of its versions. You can specify a recovery window during which you can restore the secret. The minimum recovery window is 7 days. The default recovery window is 30 days. Secrets Manager attaches a DeletionDate stamp to the secret that specifies the end of the recovery window. At the end of the recovery window, Secrets Manager deletes the secret permanently. For information about deleting a secret in the console, see https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_delete-secret.html. Secrets Manager performs the permanent secret deletion at the end of the waiting period as a background task with low priority. There is no guarantee of a specific time after the recovery window for the permanent delete to occur. At any time before recovery window ends, you can use RestoreSecret to remove the DeletionDate and cancel the deletion of the secret. In a secret scheduled for deletion, you cannot access the encrypted secret value. To access that information, first cancel the deletion with RestoreSecret and then retrieve the information.
|
|
44
44
|
*/
|
|
45
45
|
deleteSecret(callback?: (err: AWSError, data: SecretsManager.Types.DeleteSecretResponse) => void): Request<SecretsManager.Types.DeleteSecretResponse, AWSError>;
|
|
46
46
|
/**
|
|
47
|
-
* Retrieves the details of a secret. It does not include the encrypted
|
|
47
|
+
* Retrieves the details of a secret. It does not include the encrypted secret value. Secrets Manager only returns fields that have a value in the response.
|
|
48
48
|
*/
|
|
49
49
|
describeSecret(params: SecretsManager.Types.DescribeSecretRequest, callback?: (err: AWSError, data: SecretsManager.Types.DescribeSecretResponse) => void): Request<SecretsManager.Types.DescribeSecretResponse, AWSError>;
|
|
50
50
|
/**
|
|
51
|
-
* Retrieves the details of a secret. It does not include the encrypted
|
|
51
|
+
* Retrieves the details of a secret. It does not include the encrypted secret value. Secrets Manager only returns fields that have a value in the response.
|
|
52
52
|
*/
|
|
53
53
|
describeSecret(callback?: (err: AWSError, data: SecretsManager.Types.DescribeSecretResponse) => void): Request<SecretsManager.Types.DescribeSecretResponse, AWSError>;
|
|
54
54
|
/**
|
|
55
|
-
* Generates a random password
|
|
55
|
+
* Generates a random password. We recommend that you specify the maximum length and include every character type that the system you are generating a password for can support.
|
|
56
56
|
*/
|
|
57
57
|
getRandomPassword(params: SecretsManager.Types.GetRandomPasswordRequest, callback?: (err: AWSError, data: SecretsManager.Types.GetRandomPasswordResponse) => void): Request<SecretsManager.Types.GetRandomPasswordResponse, AWSError>;
|
|
58
58
|
/**
|
|
59
|
-
* Generates a random password
|
|
59
|
+
* Generates a random password. We recommend that you specify the maximum length and include every character type that the system you are generating a password for can support.
|
|
60
60
|
*/
|
|
61
61
|
getRandomPassword(callback?: (err: AWSError, data: SecretsManager.Types.GetRandomPasswordResponse) => void): Request<SecretsManager.Types.GetRandomPasswordResponse, AWSError>;
|
|
62
62
|
/**
|
|
63
|
-
* Retrieves the JSON text of the resource-based policy document attached to the
|
|
63
|
+
* Retrieves the JSON text of the resource-based policy document attached to the secret. For more information about permissions policies attached to a secret, see Permissions policies attached to a secret.
|
|
64
64
|
*/
|
|
65
65
|
getResourcePolicy(params: SecretsManager.Types.GetResourcePolicyRequest, callback?: (err: AWSError, data: SecretsManager.Types.GetResourcePolicyResponse) => void): Request<SecretsManager.Types.GetResourcePolicyResponse, AWSError>;
|
|
66
66
|
/**
|
|
67
|
-
* Retrieves the JSON text of the resource-based policy document attached to the
|
|
67
|
+
* Retrieves the JSON text of the resource-based policy document attached to the secret. For more information about permissions policies attached to a secret, see Permissions policies attached to a secret.
|
|
68
68
|
*/
|
|
69
69
|
getResourcePolicy(callback?: (err: AWSError, data: SecretsManager.Types.GetResourcePolicyResponse) => void): Request<SecretsManager.Types.GetResourcePolicyResponse, AWSError>;
|
|
70
70
|
/**
|
|
71
|
-
* Retrieves the contents of the encrypted fields SecretString or SecretBinary from the specified version of a secret, whichever contains content.
|
|
71
|
+
* Retrieves the contents of the encrypted fields SecretString or SecretBinary from the specified version of a secret, whichever contains content. For information about retrieving the secret value in the console, see Retrieve secrets. To run this command, you must have secretsmanager:GetSecretValue permissions. If the secret is encrypted using a customer-managed key instead of the Amazon Web Services managed key aws/secretsmanager, then you also need kms:Decrypt permissions for that key.
|
|
72
72
|
*/
|
|
73
73
|
getSecretValue(params: SecretsManager.Types.GetSecretValueRequest, callback?: (err: AWSError, data: SecretsManager.Types.GetSecretValueResponse) => void): Request<SecretsManager.Types.GetSecretValueResponse, AWSError>;
|
|
74
74
|
/**
|
|
75
|
-
* Retrieves the contents of the encrypted fields SecretString or SecretBinary from the specified version of a secret, whichever contains content.
|
|
75
|
+
* Retrieves the contents of the encrypted fields SecretString or SecretBinary from the specified version of a secret, whichever contains content. For information about retrieving the secret value in the console, see Retrieve secrets. To run this command, you must have secretsmanager:GetSecretValue permissions. If the secret is encrypted using a customer-managed key instead of the Amazon Web Services managed key aws/secretsmanager, then you also need kms:Decrypt permissions for that key.
|
|
76
76
|
*/
|
|
77
77
|
getSecretValue(callback?: (err: AWSError, data: SecretsManager.Types.GetSecretValueResponse) => void): Request<SecretsManager.Types.GetSecretValueResponse, AWSError>;
|
|
78
78
|
/**
|
|
79
|
-
* Lists
|
|
79
|
+
* Lists the versions for a secret. To list the secrets in the account, use ListSecrets. To get the secret value from SecretString or SecretBinary, call GetSecretValue. Minimum permissions To run this command, you must have secretsmanager:ListSecretVersionIds permissions.
|
|
80
80
|
*/
|
|
81
81
|
listSecretVersionIds(params: SecretsManager.Types.ListSecretVersionIdsRequest, callback?: (err: AWSError, data: SecretsManager.Types.ListSecretVersionIdsResponse) => void): Request<SecretsManager.Types.ListSecretVersionIdsResponse, AWSError>;
|
|
82
82
|
/**
|
|
83
|
-
* Lists
|
|
83
|
+
* Lists the versions for a secret. To list the secrets in the account, use ListSecrets. To get the secret value from SecretString or SecretBinary, call GetSecretValue. Minimum permissions To run this command, you must have secretsmanager:ListSecretVersionIds permissions.
|
|
84
84
|
*/
|
|
85
85
|
listSecretVersionIds(callback?: (err: AWSError, data: SecretsManager.Types.ListSecretVersionIdsResponse) => void): Request<SecretsManager.Types.ListSecretVersionIdsResponse, AWSError>;
|
|
86
86
|
/**
|
|
87
|
-
* Lists
|
|
87
|
+
* Lists the secrets that are stored by Secrets Manager in the Amazon Web Services account. To list the versions of a secret, use ListSecretVersionIds. To get the secret value from SecretString or SecretBinary, call GetSecretValue. For information about finding secrets in the console, see Enhanced search capabilities for secrets in Secrets Manager. Minimum permissions To run this command, you must have secretsmanager:ListSecrets permissions.
|
|
88
88
|
*/
|
|
89
89
|
listSecrets(params: SecretsManager.Types.ListSecretsRequest, callback?: (err: AWSError, data: SecretsManager.Types.ListSecretsResponse) => void): Request<SecretsManager.Types.ListSecretsResponse, AWSError>;
|
|
90
90
|
/**
|
|
91
|
-
* Lists
|
|
91
|
+
* Lists the secrets that are stored by Secrets Manager in the Amazon Web Services account. To list the versions of a secret, use ListSecretVersionIds. To get the secret value from SecretString or SecretBinary, call GetSecretValue. For information about finding secrets in the console, see Enhanced search capabilities for secrets in Secrets Manager. Minimum permissions To run this command, you must have secretsmanager:ListSecrets permissions.
|
|
92
92
|
*/
|
|
93
93
|
listSecrets(callback?: (err: AWSError, data: SecretsManager.Types.ListSecretsResponse) => void): Request<SecretsManager.Types.ListSecretsResponse, AWSError>;
|
|
94
94
|
/**
|
|
95
|
-
* Attaches
|
|
95
|
+
* Attaches a resource-based permission policy to a secret. A resource-based policy is optional. For more information, see Authentication and access control for Secrets Manager For information about attaching a policy in the console, see Attach a permissions policy to a secret.
|
|
96
96
|
*/
|
|
97
97
|
putResourcePolicy(params: SecretsManager.Types.PutResourcePolicyRequest, callback?: (err: AWSError, data: SecretsManager.Types.PutResourcePolicyResponse) => void): Request<SecretsManager.Types.PutResourcePolicyResponse, AWSError>;
|
|
98
98
|
/**
|
|
99
|
-
* Attaches
|
|
99
|
+
* Attaches a resource-based permission policy to a secret. A resource-based policy is optional. For more information, see Authentication and access control for Secrets Manager For information about attaching a policy in the console, see Attach a permissions policy to a secret.
|
|
100
100
|
*/
|
|
101
101
|
putResourcePolicy(callback?: (err: AWSError, data: SecretsManager.Types.PutResourcePolicyResponse) => void): Request<SecretsManager.Types.PutResourcePolicyResponse, AWSError>;
|
|
102
102
|
/**
|
|
103
|
-
*
|
|
103
|
+
* Creates a new version with a new encrypted secret value and attaches it to the secret. The version can contain a new SecretString value or a new SecretBinary value. We recommend you avoid calling PutSecretValue at a sustained rate of more than once every 10 minutes. When you update the secret value, Secrets Manager creates a new version of the secret. Secrets Manager removes outdated versions when there are more than 100, but it does not remove versions created less than 24 hours ago. If you call PutSecretValue more than once every 10 minutes, you create more versions than Secrets Manager removes, and you will reach the quota for secret versions. You can specify the staging labels to attach to the new version in VersionStages. If you don't include VersionStages, then Secrets Manager automatically moves the staging label AWSCURRENT to this version. If this operation creates the first version for the secret, then Secrets Manager automatically attaches the staging label AWSCURRENT to it . If this operation moves the staging label AWSCURRENT from another version to this version, then Secrets Manager also automatically moves the staging label AWSPREVIOUS to the version that AWSCURRENT was removed from. This operation is idempotent. If a version with a VersionId with the same value as the ClientRequestToken parameter already exists, and you specify the same secret data, the operation succeeds but does nothing. However, if the secret data is different, then the operation fails because you can't modify an existing version; you can only create new ones.
|
|
104
104
|
*/
|
|
105
105
|
putSecretValue(params: SecretsManager.Types.PutSecretValueRequest, callback?: (err: AWSError, data: SecretsManager.Types.PutSecretValueResponse) => void): Request<SecretsManager.Types.PutSecretValueResponse, AWSError>;
|
|
106
106
|
/**
|
|
107
|
-
*
|
|
107
|
+
* Creates a new version with a new encrypted secret value and attaches it to the secret. The version can contain a new SecretString value or a new SecretBinary value. We recommend you avoid calling PutSecretValue at a sustained rate of more than once every 10 minutes. When you update the secret value, Secrets Manager creates a new version of the secret. Secrets Manager removes outdated versions when there are more than 100, but it does not remove versions created less than 24 hours ago. If you call PutSecretValue more than once every 10 minutes, you create more versions than Secrets Manager removes, and you will reach the quota for secret versions. You can specify the staging labels to attach to the new version in VersionStages. If you don't include VersionStages, then Secrets Manager automatically moves the staging label AWSCURRENT to this version. If this operation creates the first version for the secret, then Secrets Manager automatically attaches the staging label AWSCURRENT to it . If this operation moves the staging label AWSCURRENT from another version to this version, then Secrets Manager also automatically moves the staging label AWSPREVIOUS to the version that AWSCURRENT was removed from. This operation is idempotent. If a version with a VersionId with the same value as the ClientRequestToken parameter already exists, and you specify the same secret data, the operation succeeds but does nothing. However, if the secret data is different, then the operation fails because you can't modify an existing version; you can only create new ones.
|
|
108
108
|
*/
|
|
109
109
|
putSecretValue(callback?: (err: AWSError, data: SecretsManager.Types.PutSecretValueResponse) => void): Request<SecretsManager.Types.PutSecretValueResponse, AWSError>;
|
|
110
110
|
/**
|
|
111
|
-
*
|
|
111
|
+
* For a secret that is replicated to other Regions, deletes the secret replicas from the Regions you specify.
|
|
112
112
|
*/
|
|
113
113
|
removeRegionsFromReplication(params: SecretsManager.Types.RemoveRegionsFromReplicationRequest, callback?: (err: AWSError, data: SecretsManager.Types.RemoveRegionsFromReplicationResponse) => void): Request<SecretsManager.Types.RemoveRegionsFromReplicationResponse, AWSError>;
|
|
114
114
|
/**
|
|
115
|
-
*
|
|
115
|
+
* For a secret that is replicated to other Regions, deletes the secret replicas from the Regions you specify.
|
|
116
116
|
*/
|
|
117
117
|
removeRegionsFromReplication(callback?: (err: AWSError, data: SecretsManager.Types.RemoveRegionsFromReplicationResponse) => void): Request<SecretsManager.Types.RemoveRegionsFromReplicationResponse, AWSError>;
|
|
118
118
|
/**
|
|
119
|
-
*
|
|
119
|
+
* Replicates the secret to a new Regions. See Multi-Region secrets.
|
|
120
120
|
*/
|
|
121
121
|
replicateSecretToRegions(params: SecretsManager.Types.ReplicateSecretToRegionsRequest, callback?: (err: AWSError, data: SecretsManager.Types.ReplicateSecretToRegionsResponse) => void): Request<SecretsManager.Types.ReplicateSecretToRegionsResponse, AWSError>;
|
|
122
122
|
/**
|
|
123
|
-
*
|
|
123
|
+
* Replicates the secret to a new Regions. See Multi-Region secrets.
|
|
124
124
|
*/
|
|
125
125
|
replicateSecretToRegions(callback?: (err: AWSError, data: SecretsManager.Types.ReplicateSecretToRegionsResponse) => void): Request<SecretsManager.Types.ReplicateSecretToRegionsResponse, AWSError>;
|
|
126
126
|
/**
|
|
127
|
-
* Cancels the scheduled deletion of a secret by removing the DeletedDate time stamp.
|
|
127
|
+
* Cancels the scheduled deletion of a secret by removing the DeletedDate time stamp. You can access a secret again after it has been restored.
|
|
128
128
|
*/
|
|
129
129
|
restoreSecret(params: SecretsManager.Types.RestoreSecretRequest, callback?: (err: AWSError, data: SecretsManager.Types.RestoreSecretResponse) => void): Request<SecretsManager.Types.RestoreSecretResponse, AWSError>;
|
|
130
130
|
/**
|
|
131
|
-
* Cancels the scheduled deletion of a secret by removing the DeletedDate time stamp.
|
|
131
|
+
* Cancels the scheduled deletion of a secret by removing the DeletedDate time stamp. You can access a secret again after it has been restored.
|
|
132
132
|
*/
|
|
133
133
|
restoreSecret(callback?: (err: AWSError, data: SecretsManager.Types.RestoreSecretResponse) => void): Request<SecretsManager.Types.RestoreSecretResponse, AWSError>;
|
|
134
134
|
/**
|
|
135
|
-
* Configures and starts the asynchronous process of rotating
|
|
135
|
+
* Configures and starts the asynchronous process of rotating the secret. If you include the configuration parameters, the operation sets the values for the secret and then immediately starts a rotation. If you don't include the configuration parameters, the operation starts a rotation with the values already stored in the secret. For more information about rotation, see Rotate secrets. To configure rotation, you include the ARN of an Amazon Web Services Lambda function and the schedule for the rotation. The Lambda rotation function creates a new version of the secret and creates or updates the credentials on the database or service to match. After testing the new credentials, the function marks the new secret version with the staging label AWSCURRENT. Then anyone who retrieves the secret gets the new version. For more information, see How rotation works. When rotation is successful, the AWSPENDING staging label might be attached to the same version as the AWSCURRENT version, or it might not be attached to any version. If the AWSPENDING staging label is present but not attached to the same version as AWSCURRENT, then any later invocation of RotateSecret assumes that a previous rotation request is still in progress and returns an error. To run this command, you must have secretsmanager:RotateSecret permissions and lambda:InvokeFunction permissions on the function specified in the secret's metadata.
|
|
136
136
|
*/
|
|
137
137
|
rotateSecret(params: SecretsManager.Types.RotateSecretRequest, callback?: (err: AWSError, data: SecretsManager.Types.RotateSecretResponse) => void): Request<SecretsManager.Types.RotateSecretResponse, AWSError>;
|
|
138
138
|
/**
|
|
139
|
-
* Configures and starts the asynchronous process of rotating
|
|
139
|
+
* Configures and starts the asynchronous process of rotating the secret. If you include the configuration parameters, the operation sets the values for the secret and then immediately starts a rotation. If you don't include the configuration parameters, the operation starts a rotation with the values already stored in the secret. For more information about rotation, see Rotate secrets. To configure rotation, you include the ARN of an Amazon Web Services Lambda function and the schedule for the rotation. The Lambda rotation function creates a new version of the secret and creates or updates the credentials on the database or service to match. After testing the new credentials, the function marks the new secret version with the staging label AWSCURRENT. Then anyone who retrieves the secret gets the new version. For more information, see How rotation works. When rotation is successful, the AWSPENDING staging label might be attached to the same version as the AWSCURRENT version, or it might not be attached to any version. If the AWSPENDING staging label is present but not attached to the same version as AWSCURRENT, then any later invocation of RotateSecret assumes that a previous rotation request is still in progress and returns an error. To run this command, you must have secretsmanager:RotateSecret permissions and lambda:InvokeFunction permissions on the function specified in the secret's metadata.
|
|
140
140
|
*/
|
|
141
141
|
rotateSecret(callback?: (err: AWSError, data: SecretsManager.Types.RotateSecretResponse) => void): Request<SecretsManager.Types.RotateSecretResponse, AWSError>;
|
|
142
142
|
/**
|
|
143
|
-
* Removes the secret
|
|
143
|
+
* Removes the link between the replica secret and the primary secret and promotes the replica to a primary secret in the replica Region. You must call this operation from the Region in which you want to promote the replica to a primary secret.
|
|
144
144
|
*/
|
|
145
145
|
stopReplicationToReplica(params: SecretsManager.Types.StopReplicationToReplicaRequest, callback?: (err: AWSError, data: SecretsManager.Types.StopReplicationToReplicaResponse) => void): Request<SecretsManager.Types.StopReplicationToReplicaResponse, AWSError>;
|
|
146
146
|
/**
|
|
147
|
-
* Removes the secret
|
|
147
|
+
* Removes the link between the replica secret and the primary secret and promotes the replica to a primary secret in the replica Region. You must call this operation from the Region in which you want to promote the replica to a primary secret.
|
|
148
148
|
*/
|
|
149
149
|
stopReplicationToReplica(callback?: (err: AWSError, data: SecretsManager.Types.StopReplicationToReplicaResponse) => void): Request<SecretsManager.Types.StopReplicationToReplicaResponse, AWSError>;
|
|
150
150
|
/**
|
|
151
|
-
* Attaches
|
|
151
|
+
* Attaches tags to a secret. Tags consist of a key name and a value. Tags are part of the secret's metadata. They are not associated with specific versions of the secret. This operation appends tags to the existing list of tags. The following restrictions apply to tags: Maximum number of tags per secret: 50 Maximum key length: 127 Unicode characters in UTF-8 Maximum value length: 255 Unicode characters in UTF-8 Tag keys and values are case sensitive. Do not use the aws: prefix in your tag names or values because Amazon Web Services reserves it for Amazon Web Services use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit. If you use your tagging schema across multiple services and resources, other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @. If you use tags as part of your security strategy, then adding or removing a tag can change permissions. If successfully completing this operation would result in you losing your permissions for this secret, then the operation is blocked and returns an Access Denied error.
|
|
152
152
|
*/
|
|
153
153
|
tagResource(params: SecretsManager.Types.TagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
154
154
|
/**
|
|
155
|
-
* Attaches
|
|
155
|
+
* Attaches tags to a secret. Tags consist of a key name and a value. Tags are part of the secret's metadata. They are not associated with specific versions of the secret. This operation appends tags to the existing list of tags. The following restrictions apply to tags: Maximum number of tags per secret: 50 Maximum key length: 127 Unicode characters in UTF-8 Maximum value length: 255 Unicode characters in UTF-8 Tag keys and values are case sensitive. Do not use the aws: prefix in your tag names or values because Amazon Web Services reserves it for Amazon Web Services use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit. If you use your tagging schema across multiple services and resources, other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @. If you use tags as part of your security strategy, then adding or removing a tag can change permissions. If successfully completing this operation would result in you losing your permissions for this secret, then the operation is blocked and returns an Access Denied error.
|
|
156
156
|
*/
|
|
157
157
|
tagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
158
158
|
/**
|
|
159
|
-
* Removes
|
|
159
|
+
* Removes specific tags from a secret. This operation is idempotent. If a requested tag is not attached to the secret, no error is returned and the secret metadata is unchanged. If you use tags as part of your security strategy, then removing a tag can change permissions. If successfully completing this operation would result in you losing your permissions for this secret, then the operation is blocked and returns an Access Denied error.
|
|
160
160
|
*/
|
|
161
161
|
untagResource(params: SecretsManager.Types.UntagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
162
162
|
/**
|
|
163
|
-
* Removes
|
|
163
|
+
* Removes specific tags from a secret. This operation is idempotent. If a requested tag is not attached to the secret, no error is returned and the secret metadata is unchanged. If you use tags as part of your security strategy, then removing a tag can change permissions. If successfully completing this operation would result in you losing your permissions for this secret, then the operation is blocked and returns an Access Denied error.
|
|
164
164
|
*/
|
|
165
165
|
untagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
166
166
|
/**
|
|
167
|
-
* Modifies
|
|
167
|
+
* Modifies the details of a secret, including metadata and the secret value. To change the secret value, you can also use PutSecretValue. To change the rotation configuration of a secret, use RotateSecret instead. We recommend you avoid calling UpdateSecret at a sustained rate of more than once every 10 minutes. When you call UpdateSecret to update the secret value, Secrets Manager creates a new version of the secret. Secrets Manager removes outdated versions when there are more than 100, but it does not remove versions created less than 24 hours ago. If you update the secret value more than once every 10 minutes, you create more versions than Secrets Manager removes, and you will reach the quota for secret versions. If you include SecretString or SecretBinary to create a new secret version, Secrets Manager automatically attaches the staging label AWSCURRENT to the new version. If you call this operation with a VersionId that matches an existing version's ClientRequestToken, the operation results in an error. You can't modify an existing version, you can only create a new version. To remove a version, remove all staging labels from it. See UpdateSecretVersionStage. If you don't specify an KMS encryption key, Secrets Manager uses the Amazon Web Services managed key aws/secretsmanager. If this key doesn't already exist in your account, then Secrets Manager creates it for you automatically. All users and roles in the Amazon Web Services account automatically have access to use aws/secretsmanager. Creating aws/secretsmanager can result in a one-time significant delay in returning the result. If the secret is in a different Amazon Web Services account from the credentials calling the API, then you can't use aws/secretsmanager to encrypt the secret, and you must create and use a customer managed key. To run this command, you must have secretsmanager:UpdateSecret permissions. If you use a customer managed key, you must also have kms:GenerateDataKey and kms:Decrypt permissions .
|
|
168
168
|
*/
|
|
169
169
|
updateSecret(params: SecretsManager.Types.UpdateSecretRequest, callback?: (err: AWSError, data: SecretsManager.Types.UpdateSecretResponse) => void): Request<SecretsManager.Types.UpdateSecretResponse, AWSError>;
|
|
170
170
|
/**
|
|
171
|
-
* Modifies
|
|
171
|
+
* Modifies the details of a secret, including metadata and the secret value. To change the secret value, you can also use PutSecretValue. To change the rotation configuration of a secret, use RotateSecret instead. We recommend you avoid calling UpdateSecret at a sustained rate of more than once every 10 minutes. When you call UpdateSecret to update the secret value, Secrets Manager creates a new version of the secret. Secrets Manager removes outdated versions when there are more than 100, but it does not remove versions created less than 24 hours ago. If you update the secret value more than once every 10 minutes, you create more versions than Secrets Manager removes, and you will reach the quota for secret versions. If you include SecretString or SecretBinary to create a new secret version, Secrets Manager automatically attaches the staging label AWSCURRENT to the new version. If you call this operation with a VersionId that matches an existing version's ClientRequestToken, the operation results in an error. You can't modify an existing version, you can only create a new version. To remove a version, remove all staging labels from it. See UpdateSecretVersionStage. If you don't specify an KMS encryption key, Secrets Manager uses the Amazon Web Services managed key aws/secretsmanager. If this key doesn't already exist in your account, then Secrets Manager creates it for you automatically. All users and roles in the Amazon Web Services account automatically have access to use aws/secretsmanager. Creating aws/secretsmanager can result in a one-time significant delay in returning the result. If the secret is in a different Amazon Web Services account from the credentials calling the API, then you can't use aws/secretsmanager to encrypt the secret, and you must create and use a customer managed key. To run this command, you must have secretsmanager:UpdateSecret permissions. If you use a customer managed key, you must also have kms:GenerateDataKey and kms:Decrypt permissions .
|
|
172
172
|
*/
|
|
173
173
|
updateSecret(callback?: (err: AWSError, data: SecretsManager.Types.UpdateSecretResponse) => void): Request<SecretsManager.Types.UpdateSecretResponse, AWSError>;
|
|
174
174
|
/**
|
|
175
|
-
* Modifies the staging labels attached to a version of a secret.
|
|
175
|
+
* Modifies the staging labels attached to a version of a secret. Secrets Manager uses staging labels to track a version as it progresses through the secret rotation process. Each staging label can be attached to only one version at a time. To add a staging label to a version when it is already attached to another version, Secrets Manager first removes it from the other version first and then attaches it to this one. For more information about versions and staging labels, see Concepts: Version. The staging labels that you specify in the VersionStage parameter are added to the existing list of staging labels for the version. You can move the AWSCURRENT staging label to this version by including it in this call. Whenever you move AWSCURRENT, Secrets Manager automatically moves the label AWSPREVIOUS to the version that AWSCURRENT was removed from. If this action results in the last label being removed from a version, then the version is considered to be 'deprecated' and can be deleted by Secrets Manager.
|
|
176
176
|
*/
|
|
177
177
|
updateSecretVersionStage(params: SecretsManager.Types.UpdateSecretVersionStageRequest, callback?: (err: AWSError, data: SecretsManager.Types.UpdateSecretVersionStageResponse) => void): Request<SecretsManager.Types.UpdateSecretVersionStageResponse, AWSError>;
|
|
178
178
|
/**
|
|
179
|
-
* Modifies the staging labels attached to a version of a secret.
|
|
179
|
+
* Modifies the staging labels attached to a version of a secret. Secrets Manager uses staging labels to track a version as it progresses through the secret rotation process. Each staging label can be attached to only one version at a time. To add a staging label to a version when it is already attached to another version, Secrets Manager first removes it from the other version first and then attaches it to this one. For more information about versions and staging labels, see Concepts: Version. The staging labels that you specify in the VersionStage parameter are added to the existing list of staging labels for the version. You can move the AWSCURRENT staging label to this version by including it in this call. Whenever you move AWSCURRENT, Secrets Manager automatically moves the label AWSPREVIOUS to the version that AWSCURRENT was removed from. If this action results in the last label being removed from a version, then the version is considered to be 'deprecated' and can be deleted by Secrets Manager.
|
|
180
180
|
*/
|
|
181
181
|
updateSecretVersionStage(callback?: (err: AWSError, data: SecretsManager.Types.UpdateSecretVersionStageResponse) => void): Request<SecretsManager.Types.UpdateSecretVersionStageResponse, AWSError>;
|
|
182
182
|
/**
|
|
183
|
-
* Validates that
|
|
183
|
+
* Validates that a resource policy does not grant a wide range of principals access to your secret. A resource-based policy is optional for secrets. The API performs three checks when validating the policy: Sends a call to Zelkova, an automated reasoning engine, to ensure your resource policy does not allow broad access to your secret, for example policies that use a wildcard for the principal. Checks for correct syntax in a policy. Verifies the policy does not lock out a caller.
|
|
184
184
|
*/
|
|
185
185
|
validateResourcePolicy(params: SecretsManager.Types.ValidateResourcePolicyRequest, callback?: (err: AWSError, data: SecretsManager.Types.ValidateResourcePolicyResponse) => void): Request<SecretsManager.Types.ValidateResourcePolicyResponse, AWSError>;
|
|
186
186
|
/**
|
|
187
|
-
* Validates that
|
|
187
|
+
* Validates that a resource policy does not grant a wide range of principals access to your secret. A resource-based policy is optional for secrets. The API performs three checks when validating the policy: Sends a call to Zelkova, an automated reasoning engine, to ensure your resource policy does not allow broad access to your secret, for example policies that use a wildcard for the principal. Checks for correct syntax in a policy. Verifies the policy does not lock out a caller.
|
|
188
188
|
*/
|
|
189
189
|
validateResourcePolicy(callback?: (err: AWSError, data: SecretsManager.Types.ValidateResourcePolicyResponse) => void): Request<SecretsManager.Types.ValidateResourcePolicyResponse, AWSError>;
|
|
190
190
|
}
|
|
@@ -194,85 +194,85 @@ declare namespace SecretsManager {
|
|
|
194
194
|
export type BooleanType = boolean;
|
|
195
195
|
export interface CancelRotateSecretRequest {
|
|
196
196
|
/**
|
|
197
|
-
*
|
|
197
|
+
* The ARN or name of the secret. For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
|
|
198
198
|
*/
|
|
199
199
|
SecretId: SecretIdType;
|
|
200
200
|
}
|
|
201
201
|
export interface CancelRotateSecretResponse {
|
|
202
202
|
/**
|
|
203
|
-
* The ARN of the secret
|
|
203
|
+
* The ARN of the secret.
|
|
204
204
|
*/
|
|
205
205
|
ARN?: SecretARNType;
|
|
206
206
|
/**
|
|
207
|
-
* The
|
|
207
|
+
* The name of the secret.
|
|
208
208
|
*/
|
|
209
209
|
Name?: SecretNameType;
|
|
210
210
|
/**
|
|
211
|
-
* The unique identifier of the version of the secret created during the rotation. This version might not be complete, and should be evaluated for possible deletion.
|
|
211
|
+
* The unique identifier of the version of the secret created during the rotation. This version might not be complete, and should be evaluated for possible deletion. We recommend that you remove the VersionStage value AWSPENDING from this version so that Secrets Manager can delete it. Failing to clean up a cancelled rotation can block you from starting future rotations.
|
|
212
212
|
*/
|
|
213
213
|
VersionId?: SecretVersionIdType;
|
|
214
214
|
}
|
|
215
215
|
export type ClientRequestTokenType = string;
|
|
216
216
|
export interface CreateSecretRequest {
|
|
217
217
|
/**
|
|
218
|
-
*
|
|
218
|
+
* The name of the new secret. The secret name can contain ASCII letters, numbers, and the following characters: /_+=.@- Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters after the secret name at the end of the ARN.
|
|
219
219
|
*/
|
|
220
220
|
Name: NameType;
|
|
221
221
|
/**
|
|
222
|
-
*
|
|
222
|
+
* If you include SecretString or SecretBinary, then Secrets Manager creates an initial version for the secret, and this parameter specifies the unique identifier for the new version. If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken yourself for the new version and include the value in the request. This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a UUID-type value to ensure uniqueness of your versions within the specified secret. If the ClientRequestToken value isn't already associated with a version of the secret then a new version of the secret is created. If a version with this value already exists and the version SecretString and SecretBinary values are the same as those in the request, then the request is ignored. If a version with this value already exists and that version's SecretString and SecretBinary values are different from those in the request, then the request fails because you cannot modify an existing version. Instead, use PutSecretValue to create a new version. This value becomes the VersionId of the new version.
|
|
223
223
|
*/
|
|
224
224
|
ClientRequestToken?: ClientRequestTokenType;
|
|
225
225
|
/**
|
|
226
|
-
*
|
|
226
|
+
* The description of the secret.
|
|
227
227
|
*/
|
|
228
228
|
Description?: DescriptionType;
|
|
229
229
|
/**
|
|
230
|
-
*
|
|
230
|
+
* The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt the secret value in the secret. To use a KMS key in a different account, use the key ARN or the alias ARN. If you don't specify this value, then Secrets Manager uses the key aws/secretsmanager. If that key doesn't yet exist, then Secrets Manager creates it for you automatically the first time it encrypts the secret value. If the secret is in a different Amazon Web Services account from the credentials calling the API, then you can't use aws/secretsmanager to encrypt the secret, and you must create and use a customer managed KMS key.
|
|
231
231
|
*/
|
|
232
232
|
KmsKeyId?: KmsKeyIdType;
|
|
233
233
|
/**
|
|
234
|
-
*
|
|
234
|
+
* The binary data to encrypt and store in the new version of the secret. We recommend that you store your binary data in a file and then pass the contents of the file as a parameter. Either SecretString or SecretBinary must have a value, but not both. This parameter is not available in the Secrets Manager console.
|
|
235
235
|
*/
|
|
236
236
|
SecretBinary?: SecretBinaryType;
|
|
237
237
|
/**
|
|
238
|
-
*
|
|
238
|
+
* The text data to encrypt and store in this new version of the secret. We recommend you use a JSON structure of key/value pairs for your secret value. Either SecretString or SecretBinary must have a value, but not both. If you create a secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that a Lambda rotation function can parse.
|
|
239
239
|
*/
|
|
240
240
|
SecretString?: SecretStringType;
|
|
241
241
|
/**
|
|
242
|
-
*
|
|
242
|
+
* A list of tags to attach to the secret. Each tag is a key and value pair of strings in a JSON text string, for example: [{"Key":"CostCenter","Value":"12345"},{"Key":"environment","Value":"production"}] Secrets Manager tag key names are case sensitive. A tag with the key "ABC" is a different tag from one with key "abc". If you check tags in permissions policies as part of your security strategy, then adding or removing a tag can change permissions. If the completion of this operation would result in you losing your permissions for this secret, then Secrets Manager blocks the operation and returns an Access Denied error. For more information, see Control access to secrets using tags and Limit access to identities with tags that match secrets' tags. For information about how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters. If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text. The following restrictions apply to tags: Maximum number of tags per secret: 50 Maximum key length: 127 Unicode characters in UTF-8 Maximum value length: 255 Unicode characters in UTF-8 Tag keys and values are case sensitive. Do not use the aws: prefix in your tag names or values because Amazon Web Services reserves it for Amazon Web Services use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit. If you use your tagging schema across multiple services and resources, other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.
|
|
243
243
|
*/
|
|
244
244
|
Tags?: TagListType;
|
|
245
245
|
/**
|
|
246
|
-
*
|
|
246
|
+
* A list of Regions and KMS keys to replicate secrets.
|
|
247
247
|
*/
|
|
248
248
|
AddReplicaRegions?: AddReplicaRegionListType;
|
|
249
249
|
/**
|
|
250
|
-
*
|
|
250
|
+
* Specifies whether to overwrite a secret with the same name in the destination Region.
|
|
251
251
|
*/
|
|
252
252
|
ForceOverwriteReplicaSecret?: BooleanType;
|
|
253
253
|
}
|
|
254
254
|
export interface CreateSecretResponse {
|
|
255
255
|
/**
|
|
256
|
-
* The
|
|
256
|
+
* The ARN of the new secret. The ARN includes the name of the secret followed by six random characters. This ensures that if you create a new secret with the same name as a deleted secret, then users with access to the old secret don't get access to the new secret because the ARNs are different.
|
|
257
257
|
*/
|
|
258
258
|
ARN?: SecretARNType;
|
|
259
259
|
/**
|
|
260
|
-
* The
|
|
260
|
+
* The name of the new secret.
|
|
261
261
|
*/
|
|
262
262
|
Name?: SecretNameType;
|
|
263
263
|
/**
|
|
264
|
-
* The unique identifier associated with the version of the secret
|
|
264
|
+
* The unique identifier associated with the version of the new secret.
|
|
265
265
|
*/
|
|
266
266
|
VersionId?: SecretVersionIdType;
|
|
267
267
|
/**
|
|
268
|
-
*
|
|
268
|
+
* A list of the replicas of this secret and their status: Failed, which indicates that the replica was not created. InProgress, which indicates that Secrets Manager is in the process of creating the replica. InSync, which indicates that the replica was created.
|
|
269
269
|
*/
|
|
270
270
|
ReplicationStatus?: ReplicationStatusListType;
|
|
271
271
|
}
|
|
272
272
|
export type CreatedDateType = Date;
|
|
273
273
|
export interface DeleteResourcePolicyRequest {
|
|
274
274
|
/**
|
|
275
|
-
*
|
|
275
|
+
* The ARN or name of the secret to delete the attached resource-based policy for. For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
|
|
276
276
|
*/
|
|
277
277
|
SecretId: SecretIdType;
|
|
278
278
|
}
|
|
@@ -282,35 +282,35 @@ declare namespace SecretsManager {
|
|
|
282
282
|
*/
|
|
283
283
|
ARN?: SecretARNType;
|
|
284
284
|
/**
|
|
285
|
-
* The
|
|
285
|
+
* The name of the secret that the resource-based policy was deleted for.
|
|
286
286
|
*/
|
|
287
287
|
Name?: NameType;
|
|
288
288
|
}
|
|
289
289
|
export interface DeleteSecretRequest {
|
|
290
290
|
/**
|
|
291
|
-
*
|
|
291
|
+
* The ARN or name of the secret to delete. For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
|
|
292
292
|
*/
|
|
293
293
|
SecretId: SecretIdType;
|
|
294
294
|
/**
|
|
295
|
-
*
|
|
295
|
+
* The number of days from 7 to 30 that Secrets Manager waits before permanently deleting the secret. You can't use both this parameter and ForceDeleteWithoutRecovery in the same call. If you don't use either, then Secrets Manager defaults to a 30 day recovery window.
|
|
296
296
|
*/
|
|
297
297
|
RecoveryWindowInDays?: RecoveryWindowInDaysType;
|
|
298
298
|
/**
|
|
299
|
-
*
|
|
299
|
+
* Specifies whether to delete the secret without any recovery window. You can't use both this parameter and RecoveryWindowInDays in the same call. If you don't use either, then Secrets Manager defaults to a 30 day recovery window. Secrets Manager performs the actual deletion with an asynchronous background process, so there might be a short delay before the secret is permanently deleted. If you delete a secret and then immediately create a secret with the same name, use appropriate back off and retry logic. Use this parameter with caution. This parameter causes the operation to skip the normal recovery window before the permanent deletion that Secrets Manager would normally impose with the RecoveryWindowInDays parameter. If you delete a secret with the ForceDeleteWithouRecovery parameter, then you have no opportunity to recover the secret. You lose the secret permanently.
|
|
300
300
|
*/
|
|
301
301
|
ForceDeleteWithoutRecovery?: BooleanType;
|
|
302
302
|
}
|
|
303
303
|
export interface DeleteSecretResponse {
|
|
304
304
|
/**
|
|
305
|
-
* The ARN of the secret
|
|
305
|
+
* The ARN of the secret.
|
|
306
306
|
*/
|
|
307
307
|
ARN?: SecretARNType;
|
|
308
308
|
/**
|
|
309
|
-
* The
|
|
309
|
+
* The name of the secret.
|
|
310
310
|
*/
|
|
311
311
|
Name?: SecretNameType;
|
|
312
312
|
/**
|
|
313
|
-
* The date and time after which this secret can
|
|
313
|
+
* The date and time after which this secret Secrets Manager can permanently delete this secret, and it can no longer be restored. This value is the date and time of the delete request plus the number of days in RecoveryWindowInDays.
|
|
314
314
|
*/
|
|
315
315
|
DeletionDate?: DeletionDateType;
|
|
316
316
|
}
|
|
@@ -318,7 +318,7 @@ declare namespace SecretsManager {
|
|
|
318
318
|
export type DeletionDateType = Date;
|
|
319
319
|
export interface DescribeSecretRequest {
|
|
320
320
|
/**
|
|
321
|
-
* The
|
|
321
|
+
* The ARN or name of the secret. For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
|
|
322
322
|
*/
|
|
323
323
|
SecretId: SecretIdType;
|
|
324
324
|
}
|
|
@@ -328,31 +328,31 @@ declare namespace SecretsManager {
|
|
|
328
328
|
*/
|
|
329
329
|
ARN?: SecretARNType;
|
|
330
330
|
/**
|
|
331
|
-
* The
|
|
331
|
+
* The name of the secret.
|
|
332
332
|
*/
|
|
333
333
|
Name?: SecretNameType;
|
|
334
334
|
/**
|
|
335
|
-
* The
|
|
335
|
+
* The description of the secret.
|
|
336
336
|
*/
|
|
337
337
|
Description?: DescriptionType;
|
|
338
338
|
/**
|
|
339
|
-
* The ARN
|
|
339
|
+
* The ARN of the KMS key that Secrets Manager uses to encrypt the secret value. If the secret is encrypted with the Amazon Web Services managed key aws/secretsmanager, this field is omitted.
|
|
340
340
|
*/
|
|
341
341
|
KmsKeyId?: KmsKeyIdType;
|
|
342
342
|
/**
|
|
343
|
-
* Specifies whether automatic rotation is
|
|
343
|
+
* Specifies whether automatic rotation is turned on for this secret. To turn on rotation, use RotateSecret. To turn off rotation, use CancelRotateSecret.
|
|
344
344
|
*/
|
|
345
345
|
RotationEnabled?: RotationEnabledType;
|
|
346
346
|
/**
|
|
347
|
-
* The ARN of
|
|
347
|
+
* The ARN of the Lambda function that Secrets Manager invokes to rotate the secret.
|
|
348
348
|
*/
|
|
349
349
|
RotationLambdaARN?: RotationLambdaARNType;
|
|
350
350
|
/**
|
|
351
|
-
*
|
|
351
|
+
* The rotation schedule and Lambda function for this secret. If the secret previously had rotation turned on, but it is now turned off, this field shows the previous rotation schedule and rotation function. If the secret never had rotation turned on, this field is omitted.
|
|
352
352
|
*/
|
|
353
353
|
RotationRules?: RotationRulesType;
|
|
354
354
|
/**
|
|
355
|
-
* The last date and time that
|
|
355
|
+
* The last date and time that Secrets Manager rotated the secret. If the secret isn't configured for rotation, Secrets Manager returns null.
|
|
356
356
|
*/
|
|
357
357
|
LastRotatedDate?: LastRotatedDateType;
|
|
358
358
|
/**
|
|
@@ -360,35 +360,35 @@ declare namespace SecretsManager {
|
|
|
360
360
|
*/
|
|
361
361
|
LastChangedDate?: LastChangedDateType;
|
|
362
362
|
/**
|
|
363
|
-
* The last date that
|
|
363
|
+
* The last date that the secret value was retrieved. This value does not include the time. This field is omitted if the secret has never been retrieved.
|
|
364
364
|
*/
|
|
365
365
|
LastAccessedDate?: LastAccessedDateType;
|
|
366
366
|
/**
|
|
367
|
-
*
|
|
367
|
+
* The date the secret is scheduled for deletion. If it is not scheduled for deletion, this field is omitted. When you delete a secret, Secrets Manager requires a recovery window of at least 7 days before deleting the secret. Some time after the deleted date, Secrets Manager deletes the secret, including all of its versions. If a secret is scheduled for deletion, then its details, including the encrypted secret value, is not accessible. To cancel a scheduled deletion and restore access to the secret, use RestoreSecret.
|
|
368
368
|
*/
|
|
369
369
|
DeletedDate?: DeletedDateType;
|
|
370
370
|
/**
|
|
371
|
-
* The list of
|
|
371
|
+
* The list of tags attached to the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.
|
|
372
372
|
*/
|
|
373
373
|
Tags?: TagListType;
|
|
374
374
|
/**
|
|
375
|
-
* A list of
|
|
375
|
+
* A list of the versions of the secret that have staging labels attached. Versions that don't have staging labels are considered deprecated and Secrets Manager can delete them. Secrets Manager uses staging labels to indicate the status of a secret version during rotation. The three staging labels for rotation are: AWSCURRENT, which indicates the current version of the secret. AWSPENDING, which indicates the version of the secret that contains new secret information that will become the next current version when rotation finishes. During rotation, Secrets Manager creates an AWSPENDING version ID before creating the new secret version. To check if a secret version exists, call GetSecretValue. AWSPREVIOUS, which indicates the previous current version of the secret. You can use this as the last known good version. For more information about rotation and staging labels, see How rotation works.
|
|
376
376
|
*/
|
|
377
377
|
VersionIdsToStages?: SecretVersionsToStagesMapType;
|
|
378
378
|
/**
|
|
379
|
-
*
|
|
379
|
+
* The name of the service that created this secret.
|
|
380
380
|
*/
|
|
381
381
|
OwningService?: OwningServiceType;
|
|
382
382
|
/**
|
|
383
|
-
* The date
|
|
383
|
+
* The date the secret was created.
|
|
384
384
|
*/
|
|
385
385
|
CreatedDate?: TimestampType;
|
|
386
386
|
/**
|
|
387
|
-
*
|
|
387
|
+
* The Region the secret is in. If a secret is replicated to other Regions, the replicas are listed in ReplicationStatus.
|
|
388
388
|
*/
|
|
389
389
|
PrimaryRegion?: RegionType;
|
|
390
390
|
/**
|
|
391
|
-
*
|
|
391
|
+
* A list of the replicas of this secret and their status: Failed, which indicates that the replica was not created. InProgress, which indicates that Secrets Manager is in the process of creating the replica. InSync, which indicates that the replica was created.
|
|
392
392
|
*/
|
|
393
393
|
ReplicationStatus?: ReplicationStatusListType;
|
|
394
394
|
}
|
|
@@ -401,11 +401,11 @@ declare namespace SecretsManager {
|
|
|
401
401
|
export type ExcludeUppercaseType = boolean;
|
|
402
402
|
export interface Filter {
|
|
403
403
|
/**
|
|
404
|
-
*
|
|
404
|
+
* The following are keys you can use: description: Prefix match, not case-sensitive. name: Prefix match, case-sensitive. tag-key: Prefix match, case-sensitive. tag-value: Prefix match, case-sensitive. primary-region: Prefix match, case-sensitive. all: Breaks the filter value string into words and then searches all attributes for matches. Not case-sensitive.
|
|
405
405
|
*/
|
|
406
406
|
Key?: FilterNameStringType;
|
|
407
407
|
/**
|
|
408
|
-
*
|
|
408
|
+
* The keyword to filter for. You can prefix your search value with an exclamation mark (!) in order to perform negation filters.
|
|
409
409
|
*/
|
|
410
410
|
Values?: FilterValuesStringList;
|
|
411
411
|
}
|
|
@@ -415,47 +415,47 @@ declare namespace SecretsManager {
|
|
|
415
415
|
export type FiltersListType = Filter[];
|
|
416
416
|
export interface GetRandomPasswordRequest {
|
|
417
417
|
/**
|
|
418
|
-
* The
|
|
418
|
+
* The length of the password. If you don't include this parameter, the default length is 32 characters.
|
|
419
419
|
*/
|
|
420
420
|
PasswordLength?: PasswordLengthType;
|
|
421
421
|
/**
|
|
422
|
-
* A string
|
|
422
|
+
* A string of the characters that you don't want in the password.
|
|
423
423
|
*/
|
|
424
424
|
ExcludeCharacters?: ExcludeCharactersType;
|
|
425
425
|
/**
|
|
426
|
-
* Specifies
|
|
426
|
+
* Specifies whether to exclude numbers from the password. If you don't include this switch, the password can contain numbers.
|
|
427
427
|
*/
|
|
428
428
|
ExcludeNumbers?: ExcludeNumbersType;
|
|
429
429
|
/**
|
|
430
|
-
* Specifies
|
|
430
|
+
* Specifies whether to exclude the following punctuation characters from the password: ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~. If you don't include this switch, the password can contain punctuation.
|
|
431
431
|
*/
|
|
432
432
|
ExcludePunctuation?: ExcludePunctuationType;
|
|
433
433
|
/**
|
|
434
|
-
* Specifies
|
|
434
|
+
* Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password can contain uppercase letters.
|
|
435
435
|
*/
|
|
436
436
|
ExcludeUppercase?: ExcludeUppercaseType;
|
|
437
437
|
/**
|
|
438
|
-
* Specifies
|
|
438
|
+
* Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password can contain lowercase letters.
|
|
439
439
|
*/
|
|
440
440
|
ExcludeLowercase?: ExcludeLowercaseType;
|
|
441
441
|
/**
|
|
442
|
-
* Specifies
|
|
442
|
+
* Specifies whether to include the space character. If you include this switch, the password can contain space characters.
|
|
443
443
|
*/
|
|
444
444
|
IncludeSpace?: IncludeSpaceType;
|
|
445
445
|
/**
|
|
446
|
-
*
|
|
446
|
+
* Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation. If you don't include this switch, the password contains at least one of every character type.
|
|
447
447
|
*/
|
|
448
448
|
RequireEachIncludedType?: RequireEachIncludedTypeType;
|
|
449
449
|
}
|
|
450
450
|
export interface GetRandomPasswordResponse {
|
|
451
451
|
/**
|
|
452
|
-
* A string with the
|
|
452
|
+
* A string with the password.
|
|
453
453
|
*/
|
|
454
454
|
RandomPassword?: RandomPasswordType;
|
|
455
455
|
}
|
|
456
456
|
export interface GetResourcePolicyRequest {
|
|
457
457
|
/**
|
|
458
|
-
*
|
|
458
|
+
* The ARN or name of the secret to retrieve the attached resource-based policy for. For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
|
|
459
459
|
*/
|
|
460
460
|
SecretId: SecretIdType;
|
|
461
461
|
}
|
|
@@ -465,25 +465,25 @@ declare namespace SecretsManager {
|
|
|
465
465
|
*/
|
|
466
466
|
ARN?: SecretARNType;
|
|
467
467
|
/**
|
|
468
|
-
* The
|
|
468
|
+
* The name of the secret that the resource-based policy was retrieved for.
|
|
469
469
|
*/
|
|
470
470
|
Name?: NameType;
|
|
471
471
|
/**
|
|
472
|
-
* A JSON-formatted string that
|
|
472
|
+
* A JSON-formatted string that contains the permissions policy attached to the secret. For more information about permissions policies, see Authentication and access control for Secrets Manager.
|
|
473
473
|
*/
|
|
474
474
|
ResourcePolicy?: NonEmptyResourcePolicyType;
|
|
475
475
|
}
|
|
476
476
|
export interface GetSecretValueRequest {
|
|
477
477
|
/**
|
|
478
|
-
*
|
|
478
|
+
* The ARN or name of the secret to retrieve. For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
|
|
479
479
|
*/
|
|
480
480
|
SecretId: SecretIdType;
|
|
481
481
|
/**
|
|
482
|
-
*
|
|
482
|
+
* The unique identifier of the version of the secret to retrieve. If you include both this parameter and VersionStage, the two parameters must refer to the same secret version. If you don't specify either a VersionStage or VersionId, then Secrets Manager returns the AWSCURRENT version. This value is typically a UUID-type value with 32 hexadecimal digits.
|
|
483
483
|
*/
|
|
484
484
|
VersionId?: SecretVersionIdType;
|
|
485
485
|
/**
|
|
486
|
-
*
|
|
486
|
+
* The staging label of the version of the secret to retrieve. Secrets Manager uses staging labels to keep track of different versions during the rotation process. If you include both this parameter and VersionId, the two parameters must refer to the same secret version. If you don't specify either a VersionStage or VersionId, Secrets Manager returns the AWSCURRENT version.
|
|
487
487
|
*/
|
|
488
488
|
VersionStage?: SecretVersionStageType;
|
|
489
489
|
}
|
|
@@ -501,11 +501,11 @@ declare namespace SecretsManager {
|
|
|
501
501
|
*/
|
|
502
502
|
VersionId?: SecretVersionIdType;
|
|
503
503
|
/**
|
|
504
|
-
* The decrypted
|
|
504
|
+
* The decrypted secret value, if the secret value was originally provided as binary data in the form of a byte array. The response parameter represents the binary data as a base64-encoded string. If the secret was created by using the Secrets Manager console, or if the secret value was originally provided as a string, then this field is omitted. The secret value appears in SecretString instead.
|
|
505
505
|
*/
|
|
506
506
|
SecretBinary?: SecretBinaryType;
|
|
507
507
|
/**
|
|
508
|
-
* The decrypted
|
|
508
|
+
* The decrypted secret value, if the secret value was originally provided as a string or through the Secrets Manager console. If this secret was created by using the console, then Secrets Manager stores the information as a JSON structure of key/value pairs.
|
|
509
509
|
*/
|
|
510
510
|
SecretString?: SecretStringType;
|
|
511
511
|
/**
|
|
@@ -513,7 +513,7 @@ declare namespace SecretsManager {
|
|
|
513
513
|
*/
|
|
514
514
|
VersionStages?: SecretVersionStagesType;
|
|
515
515
|
/**
|
|
516
|
-
* The date and time that this version of the secret was created.
|
|
516
|
+
* The date and time that this version of the secret was created. If you don't specify which version in VersionId or VersionStage, then Secrets Manager uses the AWSCURRENT version.
|
|
517
517
|
*/
|
|
518
518
|
CreatedDate?: CreatedDateType;
|
|
519
519
|
}
|
|
@@ -525,51 +525,51 @@ declare namespace SecretsManager {
|
|
|
525
525
|
export type LastRotatedDateType = Date;
|
|
526
526
|
export interface ListSecretVersionIdsRequest {
|
|
527
527
|
/**
|
|
528
|
-
* The
|
|
528
|
+
* The ARN or name of the secret whose versions you want to list. For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
|
|
529
529
|
*/
|
|
530
530
|
SecretId: SecretIdType;
|
|
531
531
|
/**
|
|
532
|
-
*
|
|
532
|
+
* The number of results to include in the response. If there are more results available, in the response, Secrets Manager includes NextToken. To get the next results, call ListSecretVersionIds again with the value from NextToken.
|
|
533
533
|
*/
|
|
534
534
|
MaxResults?: MaxResultsType;
|
|
535
535
|
/**
|
|
536
|
-
*
|
|
536
|
+
* A token that indicates where the output should continue from, if a previous call did not show all results. To get the next results, call ListSecretVersionIds again with this value.
|
|
537
537
|
*/
|
|
538
538
|
NextToken?: NextTokenType;
|
|
539
539
|
/**
|
|
540
|
-
*
|
|
540
|
+
* Specifies whether to include versions of secrets that don't have any staging labels attached to them. Versions without staging labels are considered deprecated and are subject to deletion by Secrets Manager.
|
|
541
541
|
*/
|
|
542
542
|
IncludeDeprecated?: BooleanType;
|
|
543
543
|
}
|
|
544
544
|
export interface ListSecretVersionIdsResponse {
|
|
545
545
|
/**
|
|
546
|
-
*
|
|
546
|
+
* A list of the versions of the secret.
|
|
547
547
|
*/
|
|
548
548
|
Versions?: SecretVersionsListType;
|
|
549
549
|
/**
|
|
550
|
-
*
|
|
550
|
+
* Secrets Manager includes this value if there's more output available than what is included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a long list. To get the next results, call ListSecretVersionIds again with this value.
|
|
551
551
|
*/
|
|
552
552
|
NextToken?: NextTokenType;
|
|
553
553
|
/**
|
|
554
|
-
* The
|
|
554
|
+
* The ARN of the secret.
|
|
555
555
|
*/
|
|
556
556
|
ARN?: SecretARNType;
|
|
557
557
|
/**
|
|
558
|
-
* The
|
|
558
|
+
* The name of the secret.
|
|
559
559
|
*/
|
|
560
560
|
Name?: SecretNameType;
|
|
561
561
|
}
|
|
562
562
|
export interface ListSecretsRequest {
|
|
563
563
|
/**
|
|
564
|
-
*
|
|
564
|
+
* The number of results to include in the response. If there are more results available, in the response, Secrets Manager includes NextToken. To get the next results, call ListSecrets again with the value from NextToken.
|
|
565
565
|
*/
|
|
566
566
|
MaxResults?: MaxResultsType;
|
|
567
567
|
/**
|
|
568
|
-
*
|
|
568
|
+
* A token that indicates where the output should continue from, if a previous call did not show all results. To get the next results, call ListSecrets again with this value.
|
|
569
569
|
*/
|
|
570
570
|
NextToken?: NextTokenType;
|
|
571
571
|
/**
|
|
572
|
-
*
|
|
572
|
+
* The filters to apply to the list of secrets.
|
|
573
573
|
*/
|
|
574
574
|
Filters?: FiltersListType;
|
|
575
575
|
/**
|
|
@@ -583,7 +583,7 @@ declare namespace SecretsManager {
|
|
|
583
583
|
*/
|
|
584
584
|
SecretList?: SecretListType;
|
|
585
585
|
/**
|
|
586
|
-
*
|
|
586
|
+
* Secrets Manager includes this value if there's more output available than what is included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a long list. To get the next results, call ListSecrets again with this value.
|
|
587
587
|
*/
|
|
588
588
|
NextToken?: NextTokenType;
|
|
589
589
|
}
|
|
@@ -595,65 +595,65 @@ declare namespace SecretsManager {
|
|
|
595
595
|
export type PasswordLengthType = number;
|
|
596
596
|
export interface PutResourcePolicyRequest {
|
|
597
597
|
/**
|
|
598
|
-
*
|
|
598
|
+
* The ARN or name of the secret to attach the resource-based policy. For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
|
|
599
599
|
*/
|
|
600
600
|
SecretId: SecretIdType;
|
|
601
601
|
/**
|
|
602
|
-
* A JSON-formatted string
|
|
602
|
+
* A JSON-formatted string for an Amazon Web Services resource-based policy. For example policies, see Permissions policy examples.
|
|
603
603
|
*/
|
|
604
604
|
ResourcePolicy: NonEmptyResourcePolicyType;
|
|
605
605
|
/**
|
|
606
|
-
*
|
|
606
|
+
* Specifies whether to block resource-based policies that allow broad access to the secret. By default, Secrets Manager blocks policies that allow broad access, for example those that use a wildcard for the principal.
|
|
607
607
|
*/
|
|
608
608
|
BlockPublicPolicy?: BooleanType;
|
|
609
609
|
}
|
|
610
610
|
export interface PutResourcePolicyResponse {
|
|
611
611
|
/**
|
|
612
|
-
* The ARN of the secret
|
|
612
|
+
* The ARN of the secret.
|
|
613
613
|
*/
|
|
614
614
|
ARN?: SecretARNType;
|
|
615
615
|
/**
|
|
616
|
-
* The
|
|
616
|
+
* The name of the secret.
|
|
617
617
|
*/
|
|
618
618
|
Name?: NameType;
|
|
619
619
|
}
|
|
620
620
|
export interface PutSecretValueRequest {
|
|
621
621
|
/**
|
|
622
|
-
*
|
|
622
|
+
* The ARN or name of the secret to add a new version to. For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. If the secret doesn't already exist, use CreateSecret instead.
|
|
623
623
|
*/
|
|
624
624
|
SecretId: SecretIdType;
|
|
625
625
|
/**
|
|
626
|
-
*
|
|
626
|
+
* A unique identifier for the new version of the secret. If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty because they generate a random UUID for you. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken yourself for new versions and include that value in the request. This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function processing. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret. If the ClientRequestToken value isn't already associated with a version of the secret then a new version of the secret is created. If a version with this value already exists and that version's SecretString or SecretBinary values are the same as those in the request then the request is ignored. The operation is idempotent. If a version with this value already exists and the version of the SecretString and SecretBinary values are different from those in the request, then the request fails because you can't modify a secret version. You can only create new versions to store new secret values. This value becomes the VersionId of the new version.
|
|
627
627
|
*/
|
|
628
628
|
ClientRequestToken?: ClientRequestTokenType;
|
|
629
629
|
/**
|
|
630
|
-
*
|
|
630
|
+
* The binary data to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then pass the contents of the file as a parameter. You must include SecretBinary or SecretString, but not both. You can't access this value from the Secrets Manager console.
|
|
631
631
|
*/
|
|
632
632
|
SecretBinary?: SecretBinaryType;
|
|
633
633
|
/**
|
|
634
|
-
*
|
|
634
|
+
* The text to encrypt and store in the new version of the secret. You must include SecretBinary or SecretString, but not both. We recommend you create the secret string as JSON key/value pairs, as shown in the example.
|
|
635
635
|
*/
|
|
636
636
|
SecretString?: SecretStringType;
|
|
637
637
|
/**
|
|
638
|
-
*
|
|
638
|
+
* A list of staging labels to attach to this version of the secret. Secrets Manager uses staging labels to track versions of a secret through the rotation process. If you specify a staging label that's already associated with a different version of the same secret, then Secrets Manager removes the label from the other version and attaches it to this version. If you specify AWSCURRENT, and it is already attached to another version, then Secrets Manager also moves the staging label AWSPREVIOUS to the version that AWSCURRENT was removed from. If you don't include VersionStages, then Secrets Manager automatically moves the staging label AWSCURRENT to this version.
|
|
639
639
|
*/
|
|
640
640
|
VersionStages?: SecretVersionStagesType;
|
|
641
641
|
}
|
|
642
642
|
export interface PutSecretValueResponse {
|
|
643
643
|
/**
|
|
644
|
-
* The
|
|
644
|
+
* The ARN of the secret.
|
|
645
645
|
*/
|
|
646
646
|
ARN?: SecretARNType;
|
|
647
647
|
/**
|
|
648
|
-
* The
|
|
648
|
+
* The name of the secret.
|
|
649
649
|
*/
|
|
650
650
|
Name?: SecretNameType;
|
|
651
651
|
/**
|
|
652
|
-
* The unique identifier of the version of the secret
|
|
652
|
+
* The unique identifier of the version of the secret.
|
|
653
653
|
*/
|
|
654
654
|
VersionId?: SecretVersionIdType;
|
|
655
655
|
/**
|
|
656
|
-
* The list of staging labels that are currently attached to this version of the secret.
|
|
656
|
+
* The list of staging labels that are currently attached to this version of the secret. Secrets Manager uses staging labels to track a version as it progresses through the secret rotation process.
|
|
657
657
|
*/
|
|
658
658
|
VersionStages?: SecretVersionStagesType;
|
|
659
659
|
}
|
|
@@ -662,56 +662,56 @@ declare namespace SecretsManager {
|
|
|
662
662
|
export type RegionType = string;
|
|
663
663
|
export interface RemoveRegionsFromReplicationRequest {
|
|
664
664
|
/**
|
|
665
|
-
*
|
|
665
|
+
* The ARN or name of the secret.
|
|
666
666
|
*/
|
|
667
667
|
SecretId: SecretIdType;
|
|
668
668
|
/**
|
|
669
|
-
*
|
|
669
|
+
* The Regions of the replicas to remove.
|
|
670
670
|
*/
|
|
671
671
|
RemoveReplicaRegions: RemoveReplicaRegionListType;
|
|
672
672
|
}
|
|
673
673
|
export interface RemoveRegionsFromReplicationResponse {
|
|
674
674
|
/**
|
|
675
|
-
* The
|
|
675
|
+
* The ARN of the primary secret.
|
|
676
676
|
*/
|
|
677
677
|
ARN?: SecretARNType;
|
|
678
678
|
/**
|
|
679
|
-
*
|
|
679
|
+
* The status of replicas for this secret after you remove Regions.
|
|
680
680
|
*/
|
|
681
681
|
ReplicationStatus?: ReplicationStatusListType;
|
|
682
682
|
}
|
|
683
683
|
export type RemoveReplicaRegionListType = RegionType[];
|
|
684
684
|
export interface ReplicaRegionType {
|
|
685
685
|
/**
|
|
686
|
-
*
|
|
686
|
+
* A Region code. For a list of Region codes, see Name and code of Regions.
|
|
687
687
|
*/
|
|
688
688
|
Region?: RegionType;
|
|
689
689
|
/**
|
|
690
|
-
*
|
|
690
|
+
* The ARN, key ID, or alias of the KMS key to encrypt the secret. If you don't include this field, Secrets Manager uses aws/secretsmanager.
|
|
691
691
|
*/
|
|
692
692
|
KmsKeyId?: KmsKeyIdType;
|
|
693
693
|
}
|
|
694
694
|
export interface ReplicateSecretToRegionsRequest {
|
|
695
695
|
/**
|
|
696
|
-
*
|
|
696
|
+
* The ARN or name of the secret to replicate.
|
|
697
697
|
*/
|
|
698
698
|
SecretId: SecretIdType;
|
|
699
699
|
/**
|
|
700
|
-
*
|
|
700
|
+
* A list of Regions in which to replicate the secret.
|
|
701
701
|
*/
|
|
702
702
|
AddReplicaRegions: AddReplicaRegionListType;
|
|
703
703
|
/**
|
|
704
|
-
*
|
|
704
|
+
* Specifies whether to overwrite a secret with the same name in the destination Region.
|
|
705
705
|
*/
|
|
706
706
|
ForceOverwriteReplicaSecret?: BooleanType;
|
|
707
707
|
}
|
|
708
708
|
export interface ReplicateSecretToRegionsResponse {
|
|
709
709
|
/**
|
|
710
|
-
*
|
|
710
|
+
* The ARN of the primary secret.
|
|
711
711
|
*/
|
|
712
712
|
ARN?: SecretARNType;
|
|
713
713
|
/**
|
|
714
|
-
*
|
|
714
|
+
* The status of replication.
|
|
715
715
|
*/
|
|
716
716
|
ReplicationStatus?: ReplicationStatusListType;
|
|
717
717
|
}
|
|
@@ -741,7 +741,7 @@ declare namespace SecretsManager {
|
|
|
741
741
|
export type RequireEachIncludedTypeType = boolean;
|
|
742
742
|
export interface RestoreSecretRequest {
|
|
743
743
|
/**
|
|
744
|
-
*
|
|
744
|
+
* The ARN or name of the secret to restore. For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
|
|
745
745
|
*/
|
|
746
746
|
SecretId: SecretIdType;
|
|
747
747
|
}
|
|
@@ -751,21 +751,21 @@ declare namespace SecretsManager {
|
|
|
751
751
|
*/
|
|
752
752
|
ARN?: SecretARNType;
|
|
753
753
|
/**
|
|
754
|
-
* The
|
|
754
|
+
* The name of the secret that was restored.
|
|
755
755
|
*/
|
|
756
756
|
Name?: SecretNameType;
|
|
757
757
|
}
|
|
758
758
|
export interface RotateSecretRequest {
|
|
759
759
|
/**
|
|
760
|
-
*
|
|
760
|
+
* The ARN or name of the secret to rotate. For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
|
|
761
761
|
*/
|
|
762
762
|
SecretId: SecretIdType;
|
|
763
763
|
/**
|
|
764
|
-
*
|
|
764
|
+
* A unique identifier for the new version of the secret that helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during rotation. This value becomes the VersionId of the new version. If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request for this parameter. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken yourself for new versions and include that value in the request. You only need to specify this value if you implement your own retry logic and you want to ensure that Secrets Manager doesn't attempt to create a secret version twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
|
|
765
765
|
*/
|
|
766
766
|
ClientRequestToken?: ClientRequestTokenType;
|
|
767
767
|
/**
|
|
768
|
-
*
|
|
768
|
+
* The ARN of the Lambda rotation function that can rotate the secret.
|
|
769
769
|
*/
|
|
770
770
|
RotationLambdaARN?: RotationLambdaARNType;
|
|
771
771
|
/**
|
|
@@ -779,11 +779,11 @@ declare namespace SecretsManager {
|
|
|
779
779
|
*/
|
|
780
780
|
ARN?: SecretARNType;
|
|
781
781
|
/**
|
|
782
|
-
* The
|
|
782
|
+
* The name of the secret.
|
|
783
783
|
*/
|
|
784
784
|
Name?: SecretNameType;
|
|
785
785
|
/**
|
|
786
|
-
* The ID of the new version of the secret
|
|
786
|
+
* The ID of the new version of the secret.
|
|
787
787
|
*/
|
|
788
788
|
VersionId?: SecretVersionIdType;
|
|
789
789
|
}
|
|
@@ -800,7 +800,7 @@ declare namespace SecretsManager {
|
|
|
800
800
|
export type SecretIdType = string;
|
|
801
801
|
export interface SecretListEntry {
|
|
802
802
|
/**
|
|
803
|
-
* The Amazon Resource Name (ARN) of the secret.
|
|
803
|
+
* The Amazon Resource Name (ARN) of the secret.
|
|
804
804
|
*/
|
|
805
805
|
ARN?: SecretARNType;
|
|
806
806
|
/**
|
|
@@ -812,7 +812,7 @@ declare namespace SecretsManager {
|
|
|
812
812
|
*/
|
|
813
813
|
Description?: DescriptionType;
|
|
814
814
|
/**
|
|
815
|
-
* The ARN
|
|
815
|
+
* The ARN of the KMS key that Secrets Manager uses to encrypt the secret value. If the secret is encrypted with the Amazon Web Services managed key aws/secretsmanager, this field is omitted.
|
|
816
816
|
*/
|
|
817
817
|
KmsKeyId?: KmsKeyIdType;
|
|
818
818
|
/**
|
|
@@ -899,13 +899,13 @@ declare namespace SecretsManager {
|
|
|
899
899
|
export type StatusType = "InSync"|"Failed"|"InProgress"|string;
|
|
900
900
|
export interface StopReplicationToReplicaRequest {
|
|
901
901
|
/**
|
|
902
|
-
*
|
|
902
|
+
* The ARN of the primary secret.
|
|
903
903
|
*/
|
|
904
904
|
SecretId: SecretIdType;
|
|
905
905
|
}
|
|
906
906
|
export interface StopReplicationToReplicaResponse {
|
|
907
907
|
/**
|
|
908
|
-
*
|
|
908
|
+
* The ARN of the promoted secret. The ARN is the same as the original primary secret except the Region is changed.
|
|
909
909
|
*/
|
|
910
910
|
ARN?: SecretARNType;
|
|
911
911
|
}
|
|
@@ -924,11 +924,11 @@ declare namespace SecretsManager {
|
|
|
924
924
|
export type TagListType = Tag[];
|
|
925
925
|
export interface TagResourceRequest {
|
|
926
926
|
/**
|
|
927
|
-
* The identifier for the secret
|
|
927
|
+
* The identifier for the secret to attach tags to. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
|
|
928
928
|
*/
|
|
929
929
|
SecretId: SecretIdType;
|
|
930
930
|
/**
|
|
931
|
-
* The tags to attach to the secret. Each element in the list consists of a Key and a Value.
|
|
931
|
+
* The tags to attach to the secret as a JSON text string argument. Each element in the list consists of a Key and a Value. For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
|
|
932
932
|
*/
|
|
933
933
|
Tags: TagListType;
|
|
934
934
|
}
|
|
@@ -936,57 +936,57 @@ declare namespace SecretsManager {
|
|
|
936
936
|
export type TimestampType = Date;
|
|
937
937
|
export interface UntagResourceRequest {
|
|
938
938
|
/**
|
|
939
|
-
* The
|
|
939
|
+
* The ARN or name of the secret. For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
|
|
940
940
|
*/
|
|
941
941
|
SecretId: SecretIdType;
|
|
942
942
|
/**
|
|
943
|
-
* A list of tag key names to remove from the secret. You don't specify the value. Both the key and its associated value are removed. This parameter
|
|
943
|
+
* A list of tag key names to remove from the secret. You don't specify the value. Both the key and its associated value are removed. This parameter requires a JSON text string argument. For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
|
|
944
944
|
*/
|
|
945
945
|
TagKeys: TagKeyListType;
|
|
946
946
|
}
|
|
947
947
|
export interface UpdateSecretRequest {
|
|
948
948
|
/**
|
|
949
|
-
*
|
|
949
|
+
* The ARN or name of the secret. For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
|
|
950
950
|
*/
|
|
951
951
|
SecretId: SecretIdType;
|
|
952
952
|
/**
|
|
953
|
-
*
|
|
953
|
+
* If you include SecretString or SecretBinary, then Secrets Manager creates a new version for the secret, and this parameter specifies the unique identifier for the new version. If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken yourself for the new version and include the value in the request. This value becomes the VersionId of the new version.
|
|
954
954
|
*/
|
|
955
955
|
ClientRequestToken?: ClientRequestTokenType;
|
|
956
956
|
/**
|
|
957
|
-
*
|
|
957
|
+
* The description of the secret.
|
|
958
958
|
*/
|
|
959
959
|
Description?: DescriptionType;
|
|
960
960
|
/**
|
|
961
|
-
*
|
|
961
|
+
* The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt new secret versions as well as any existing versions the staging labels AWSCURRENT, AWSPENDING, or AWSPREVIOUS. For more information about versions and staging labels, see Concepts: Version. You can only use the Amazon Web Services managed key aws/secretsmanager if you call this operation using credentials from the same Amazon Web Services account that owns the secret. If the secret is in a different account, then you must use a customer managed key and provide the ARN of that KMS key in this field. The user making the call must have permissions to both the secret and the KMS key in their respective accounts.
|
|
962
962
|
*/
|
|
963
963
|
KmsKeyId?: KmsKeyIdType;
|
|
964
964
|
/**
|
|
965
|
-
*
|
|
965
|
+
* The binary data to encrypt and store in the new version of the secret. We recommend that you store your binary data in a file and then pass the contents of the file as a parameter. Either SecretBinary or SecretString must have a value, but not both. You can't access this parameter in the Secrets Manager console.
|
|
966
966
|
*/
|
|
967
967
|
SecretBinary?: SecretBinaryType;
|
|
968
968
|
/**
|
|
969
|
-
*
|
|
969
|
+
* The text data to encrypt and store in the new version of the secret. We recommend you use a JSON structure of key/value pairs for your secret value. Either SecretBinary or SecretString must have a value, but not both.
|
|
970
970
|
*/
|
|
971
971
|
SecretString?: SecretStringType;
|
|
972
972
|
}
|
|
973
973
|
export interface UpdateSecretResponse {
|
|
974
974
|
/**
|
|
975
|
-
* The ARN of the secret that was updated.
|
|
975
|
+
* The ARN of the secret that was updated.
|
|
976
976
|
*/
|
|
977
977
|
ARN?: SecretARNType;
|
|
978
978
|
/**
|
|
979
|
-
* The
|
|
979
|
+
* The name of the secret that was updated.
|
|
980
980
|
*/
|
|
981
981
|
Name?: SecretNameType;
|
|
982
982
|
/**
|
|
983
|
-
* If a new version of the secret
|
|
983
|
+
* If Secrets Manager created a new version of the secret during this operation, then VersionId contains the unique identifier of the new version.
|
|
984
984
|
*/
|
|
985
985
|
VersionId?: SecretVersionIdType;
|
|
986
986
|
}
|
|
987
987
|
export interface UpdateSecretVersionStageRequest {
|
|
988
988
|
/**
|
|
989
|
-
*
|
|
989
|
+
* The ARN or the name of the secret with the version and staging labelsto modify. For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
|
|
990
990
|
*/
|
|
991
991
|
SecretId: SecretIdType;
|
|
992
992
|
/**
|
|
@@ -994,41 +994,41 @@ declare namespace SecretsManager {
|
|
|
994
994
|
*/
|
|
995
995
|
VersionStage: SecretVersionStageType;
|
|
996
996
|
/**
|
|
997
|
-
*
|
|
997
|
+
* The ID of the version that the staging label is to be removed from. If the staging label you are trying to attach to one version is already attached to a different version, then you must include this parameter and specify the version that the label is to be removed from. If the label is attached and you either do not specify this parameter, or the version ID does not match, then the operation fails.
|
|
998
998
|
*/
|
|
999
999
|
RemoveFromVersionId?: SecretVersionIdType;
|
|
1000
1000
|
/**
|
|
1001
|
-
*
|
|
1001
|
+
* The ID of the version to add the staging label to. To remove a label from a version, then do not specify this parameter. If the staging label is already attached to a different version of the secret, then you must also specify the RemoveFromVersionId parameter.
|
|
1002
1002
|
*/
|
|
1003
1003
|
MoveToVersionId?: SecretVersionIdType;
|
|
1004
1004
|
}
|
|
1005
1005
|
export interface UpdateSecretVersionStageResponse {
|
|
1006
1006
|
/**
|
|
1007
|
-
* The ARN of the secret
|
|
1007
|
+
* The ARN of the secret that was updated.
|
|
1008
1008
|
*/
|
|
1009
1009
|
ARN?: SecretARNType;
|
|
1010
1010
|
/**
|
|
1011
|
-
* The
|
|
1011
|
+
* The name of the secret that was updated.
|
|
1012
1012
|
*/
|
|
1013
1013
|
Name?: SecretNameType;
|
|
1014
1014
|
}
|
|
1015
1015
|
export interface ValidateResourcePolicyRequest {
|
|
1016
1016
|
/**
|
|
1017
|
-
*
|
|
1017
|
+
* This field is reserved for internal use.
|
|
1018
1018
|
*/
|
|
1019
1019
|
SecretId?: SecretIdType;
|
|
1020
1020
|
/**
|
|
1021
|
-
* A JSON-formatted string
|
|
1021
|
+
* A JSON-formatted string that contains an Amazon Web Services resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For example policies, see Permissions policy examples.
|
|
1022
1022
|
*/
|
|
1023
1023
|
ResourcePolicy: NonEmptyResourcePolicyType;
|
|
1024
1024
|
}
|
|
1025
1025
|
export interface ValidateResourcePolicyResponse {
|
|
1026
1026
|
/**
|
|
1027
|
-
*
|
|
1027
|
+
* True if your policy passes validation, otherwise false.
|
|
1028
1028
|
*/
|
|
1029
1029
|
PolicyValidationPassed?: BooleanType;
|
|
1030
1030
|
/**
|
|
1031
|
-
*
|
|
1031
|
+
* Validation errors if your policy didn't pass validation.
|
|
1032
1032
|
*/
|
|
1033
1033
|
ValidationErrors?: ValidationErrorsType;
|
|
1034
1034
|
}
|