| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.SecretsManager.CreateSecret
Description
Creates a new secret. A secret can be a password, a set of credentials such as a user name and password, an OAuth token, or other secret information 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.
For database credentials you want to rotate, for Secrets Manager to be
able to rotate the secret, you must make sure the JSON you store in the
SecretString matches the
JSON structure of a database secret.
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.
Secrets Manager generates a CloudTrail log entry when you call this
action. Do not include sensitive information in request parameters
except SecretBinary or SecretString because it might be logged. For
more information, see
Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:CreateSecret. If you include
tags in the secret, you also need secretsmanager:TagResource. For more
information, see
IAM policy actions for Secrets Manager
and
Authentication and access control in Secrets Manager.
To encrypt the secret with a KMS key other than aws/secretsmanager,
you need kms:GenerateDataKey and kms:Decrypt permission to the key.
Synopsis
- data CreateSecret = CreateSecret' {}
- newCreateSecret :: Text -> CreateSecret
- createSecret_addReplicaRegions :: Lens' CreateSecret (Maybe (NonEmpty ReplicaRegionType))
- createSecret_clientRequestToken :: Lens' CreateSecret (Maybe Text)
- createSecret_description :: Lens' CreateSecret (Maybe Text)
- createSecret_forceOverwriteReplicaSecret :: Lens' CreateSecret (Maybe Bool)
- createSecret_kmsKeyId :: Lens' CreateSecret (Maybe Text)
- createSecret_secretBinary :: Lens' CreateSecret (Maybe ByteString)
- createSecret_secretString :: Lens' CreateSecret (Maybe Text)
- createSecret_tags :: Lens' CreateSecret (Maybe [Tag])
- createSecret_name :: Lens' CreateSecret Text
- data CreateSecretResponse = CreateSecretResponse' {
- arn :: Maybe Text
- name :: Maybe Text
- replicationStatus :: Maybe [ReplicationStatusType]
- versionId :: Maybe Text
- httpStatus :: Int
- newCreateSecretResponse :: Int -> CreateSecretResponse
- createSecretResponse_arn :: Lens' CreateSecretResponse (Maybe Text)
- createSecretResponse_name :: Lens' CreateSecretResponse (Maybe Text)
- createSecretResponse_replicationStatus :: Lens' CreateSecretResponse (Maybe [ReplicationStatusType])
- createSecretResponse_versionId :: Lens' CreateSecretResponse (Maybe Text)
- createSecretResponse_httpStatus :: Lens' CreateSecretResponse Int
Creating a Request
data CreateSecret Source #
See: newCreateSecret smart constructor.
Constructors
| CreateSecret' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> CreateSecret |
Create a value of CreateSecret with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:addReplicaRegions:CreateSecret', createSecret_addReplicaRegions - A list of Regions and KMS keys to replicate secrets.
$sel:clientRequestToken:CreateSecret', createSecret_clientRequestToken - 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
ClientRequestTokenvalue 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
SecretStringandSecretBinaryvalues 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
SecretStringandSecretBinaryvalues 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.
CreateSecret, createSecret_description - The description of the secret.
$sel:forceOverwriteReplicaSecret:CreateSecret', createSecret_forceOverwriteReplicaSecret - Specifies whether to overwrite a secret with the same name in the
destination Region.
CreateSecret, createSecret_kmsKeyId - The ARN, key ID, or alias of the KMS key that Secrets Manager uses to
encrypt the secret value in the secret. An alias is always prefixed by
alias/, for example alias/aws/secretsmanager. For more
information, see
About aliases.
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.
$sel:secretBinary:CreateSecret', createSecret_secretBinary - 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.--
-- Note: This Lens automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens accepts and returns only raw unencoded data.
$sel:secretString:CreateSecret', createSecret_secretString - 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.
CreateSecret, createSecret_tags - 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: + - = . _ : / @.
CreateSecret, createSecret_name - 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.
Request Lenses
createSecret_addReplicaRegions :: Lens' CreateSecret (Maybe (NonEmpty ReplicaRegionType)) Source #
A list of Regions and KMS keys to replicate secrets.
createSecret_clientRequestToken :: Lens' CreateSecret (Maybe Text) Source #
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
ClientRequestTokenvalue 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
SecretStringandSecretBinaryvalues 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
SecretStringandSecretBinaryvalues 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.
createSecret_description :: Lens' CreateSecret (Maybe Text) Source #
The description of the secret.
createSecret_forceOverwriteReplicaSecret :: Lens' CreateSecret (Maybe Bool) Source #
Specifies whether to overwrite a secret with the same name in the destination Region.
createSecret_kmsKeyId :: Lens' CreateSecret (Maybe Text) Source #
The ARN, key ID, or alias of the KMS key that Secrets Manager uses to
encrypt the secret value in the secret. An alias is always prefixed by
alias/, for example alias/aws/secretsmanager. For more
information, see
About aliases.
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.
createSecret_secretBinary :: Lens' CreateSecret (Maybe ByteString) Source #
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.--
-- Note: This Lens automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens accepts and returns only raw unencoded data.
createSecret_secretString :: Lens' CreateSecret (Maybe Text) Source #
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.
createSecret_tags :: Lens' CreateSecret (Maybe [Tag]) Source #
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: + - = . _ : / @.
createSecret_name :: Lens' CreateSecret Text Source #
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.
Destructuring the Response
data CreateSecretResponse Source #
See: newCreateSecretResponse smart constructor.
Constructors
| CreateSecretResponse' | |
Fields
| |
Instances
newCreateSecretResponse Source #
Arguments
| :: Int | |
| -> CreateSecretResponse |
Create a value of CreateSecretResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateSecretResponse, createSecretResponse_arn - 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.
CreateSecret, createSecretResponse_name - The name of the new secret.
$sel:replicationStatus:CreateSecretResponse', createSecretResponse_replicationStatus - 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.
CreateSecretResponse, createSecretResponse_versionId - The unique identifier associated with the version of the new secret.
$sel:httpStatus:CreateSecretResponse', createSecretResponse_httpStatus - The response's http status code.
Response Lenses
createSecretResponse_arn :: Lens' CreateSecretResponse (Maybe Text) Source #
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.
createSecretResponse_name :: Lens' CreateSecretResponse (Maybe Text) Source #
The name of the new secret.
createSecretResponse_replicationStatus :: Lens' CreateSecretResponse (Maybe [ReplicationStatusType]) Source #
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.
createSecretResponse_versionId :: Lens' CreateSecretResponse (Maybe Text) Source #
The unique identifier associated with the version of the new secret.
createSecretResponse_httpStatus :: Lens' CreateSecretResponse Int Source #
The response's http status code.