#[non_exhaustive]pub struct CreateSecretInput {
pub name: Option<String>,
pub client_request_token: Option<String>,
pub description: Option<String>,
pub kms_key_id: Option<String>,
pub secret_binary: Option<Blob>,
pub secret_string: Option<String>,
pub tags: Option<Vec<Tag>>,
pub add_replica_regions: Option<Vec<ReplicaRegionType>>,
pub force_overwrite_replica_secret: Option<bool>,
}
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.name: Option<String>
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.
client_request_token: Option<String>
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 generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
and include it 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
andSecretBinary
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
andSecretBinary
values are different from those in the request, then the request fails because you cannot modify an existing version. Instead, usePutSecretValue
to create a new version.
This value becomes the VersionId
of the new version.
description: Option<String>
The description of the secret.
kms_key_id: Option<String>
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.
secret_binary: Option<Blob>
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.
secret_string: Option<String>
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.
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.
For tag quotas and naming restrictions, see Service quotas for Tagging in the Amazon Web Services General Reference guide.
add_replica_regions: Option<Vec<ReplicaRegionType>>
A list of Regions and KMS keys to replicate secrets.
force_overwrite_replica_secret: Option<bool>
Specifies whether to overwrite a secret with the same name in the destination Region. By default, secrets aren't overwritten.
Implementations§
Source§impl CreateSecretInput
impl CreateSecretInput
Sourcepub fn name(&self) -> Option<&str>
pub fn name(&self) -> Option<&str>
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.
Sourcepub fn client_request_token(&self) -> Option<&str>
pub fn client_request_token(&self) -> Option<&str>
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 generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
and include it 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
andSecretBinary
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
andSecretBinary
values are different from those in the request, then the request fails because you cannot modify an existing version. Instead, usePutSecretValue
to create a new version.
This value becomes the VersionId
of the new version.
Sourcepub fn description(&self) -> Option<&str>
pub fn description(&self) -> Option<&str>
The description of the secret.
Sourcepub fn kms_key_id(&self) -> Option<&str>
pub fn kms_key_id(&self) -> Option<&str>
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.
Sourcepub fn secret_binary(&self) -> Option<&Blob>
pub fn secret_binary(&self) -> Option<&Blob>
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.
Sourcepub fn secret_string(&self) -> Option<&str>
pub fn secret_string(&self) -> Option<&str>
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.
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.
For tag quotas and naming restrictions, see Service quotas for Tagging in the Amazon Web Services General Reference guide.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tags.is_none()
.
Sourcepub fn add_replica_regions(&self) -> &[ReplicaRegionType]
pub fn add_replica_regions(&self) -> &[ReplicaRegionType]
A list of Regions and KMS keys to replicate secrets.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .add_replica_regions.is_none()
.
Sourcepub fn force_overwrite_replica_secret(&self) -> Option<bool>
pub fn force_overwrite_replica_secret(&self) -> Option<bool>
Specifies whether to overwrite a secret with the same name in the destination Region. By default, secrets aren't overwritten.
Source§impl CreateSecretInput
impl CreateSecretInput
Sourcepub fn builder() -> CreateSecretInputBuilder
pub fn builder() -> CreateSecretInputBuilder
Creates a new builder-style object to manufacture CreateSecretInput
.
Trait Implementations§
Source§impl Clone for CreateSecretInput
impl Clone for CreateSecretInput
Source§fn clone(&self) -> CreateSecretInput
fn clone(&self) -> CreateSecretInput
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for CreateSecretInput
impl Debug for CreateSecretInput
Source§impl PartialEq for CreateSecretInput
impl PartialEq for CreateSecretInput
impl StructuralPartialEq for CreateSecretInput
Auto Trait Implementations§
impl Freeze for CreateSecretInput
impl RefUnwindSafe for CreateSecretInput
impl Send for CreateSecretInput
impl Sync for CreateSecretInput
impl Unpin for CreateSecretInput
impl UnwindSafe for CreateSecretInput
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)