Struct aws_sdk_secretsmanager::input::CreateSecretInput
source · [−]#[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: 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 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
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.
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.
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: + - = . _ : / @.
add_replica_regions: Option<Vec<ReplicaRegionType>>
A list of Regions and KMS keys to replicate secrets.
force_overwrite_replica_secret: bool
Specifies whether to overwrite a secret with the same name in the destination Region.
Implementations
sourceimpl CreateSecretInput
impl CreateSecretInput
sourcepub async fn make_operation(
self,
_config: &Config
) -> Result<Operation<CreateSecret, AwsErrorRetryPolicy>, BuildError>
pub async fn make_operation(
self,
_config: &Config
) -> Result<Operation<CreateSecret, AwsErrorRetryPolicy>, BuildError>
Consumes the builder and constructs an Operation<CreateSecret
>
sourcepub fn builder() -> Builder
pub fn builder() -> Builder
Creates a new builder-style object to manufacture CreateSecretInput
sourceimpl 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 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
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.
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.
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: + - = . _ : / @.
sourcepub fn add_replica_regions(&self) -> Option<&[ReplicaRegionType]>
pub fn add_replica_regions(&self) -> Option<&[ReplicaRegionType]>
A list of Regions and KMS keys to replicate secrets.
sourcepub fn force_overwrite_replica_secret(&self) -> bool
pub fn force_overwrite_replica_secret(&self) -> bool
Specifies whether to overwrite a secret with the same name in the destination Region.
Trait Implementations
sourceimpl Clone for CreateSecretInput
impl Clone for CreateSecretInput
sourcefn clone(&self) -> CreateSecretInput
fn clone(&self) -> CreateSecretInput
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for CreateSecretInput
impl Debug for CreateSecretInput
sourceimpl PartialEq<CreateSecretInput> for CreateSecretInput
impl PartialEq<CreateSecretInput> for CreateSecretInput
sourcefn eq(&self, other: &CreateSecretInput) -> bool
fn eq(&self, other: &CreateSecretInput) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &CreateSecretInput) -> bool
fn ne(&self, other: &CreateSecretInput) -> bool
This method tests for !=
.
impl StructuralPartialEq for CreateSecretInput
Auto Trait Implementations
impl RefUnwindSafe for CreateSecretInput
impl Send for CreateSecretInput
impl Sync for CreateSecretInput
impl Unpin for CreateSecretInput
impl UnwindSafe for CreateSecretInput
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more