AWS SDK for C++  1.9.1
AWS SDK for C++
Public Member Functions | List of all members
Aws::SecretsManager::Model::CreateSecretRequest Class Reference

#include <CreateSecretRequest.h>

+ Inheritance diagram for Aws::SecretsManager::Model::CreateSecretRequest:

Public Member Functions

 CreateSecretRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
CreateSecretRequestWithName (const Aws::String &value)
 
CreateSecretRequestWithName (Aws::String &&value)
 
CreateSecretRequestWithName (const char *value)
 
const Aws::StringGetClientRequestToken () const
 
bool ClientRequestTokenHasBeenSet () const
 
void SetClientRequestToken (const Aws::String &value)
 
void SetClientRequestToken (Aws::String &&value)
 
void SetClientRequestToken (const char *value)
 
CreateSecretRequestWithClientRequestToken (const Aws::String &value)
 
CreateSecretRequestWithClientRequestToken (Aws::String &&value)
 
CreateSecretRequestWithClientRequestToken (const char *value)
 
const Aws::StringGetDescription () const
 
bool DescriptionHasBeenSet () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
CreateSecretRequestWithDescription (const Aws::String &value)
 
CreateSecretRequestWithDescription (Aws::String &&value)
 
CreateSecretRequestWithDescription (const char *value)
 
const Aws::StringGetKmsKeyId () const
 
bool KmsKeyIdHasBeenSet () const
 
void SetKmsKeyId (const Aws::String &value)
 
void SetKmsKeyId (Aws::String &&value)
 
void SetKmsKeyId (const char *value)
 
CreateSecretRequestWithKmsKeyId (const Aws::String &value)
 
CreateSecretRequestWithKmsKeyId (Aws::String &&value)
 
CreateSecretRequestWithKmsKeyId (const char *value)
 
const Aws::Utils::CryptoBufferGetSecretBinary () const
 
bool SecretBinaryHasBeenSet () const
 
void SetSecretBinary (const Aws::Utils::CryptoBuffer &value)
 
void SetSecretBinary (Aws::Utils::CryptoBuffer &&value)
 
CreateSecretRequestWithSecretBinary (const Aws::Utils::CryptoBuffer &value)
 
CreateSecretRequestWithSecretBinary (Aws::Utils::CryptoBuffer &&value)
 
const Aws::StringGetSecretString () const
 
bool SecretStringHasBeenSet () const
 
void SetSecretString (const Aws::String &value)
 
void SetSecretString (Aws::String &&value)
 
void SetSecretString (const char *value)
 
CreateSecretRequestWithSecretString (const Aws::String &value)
 
CreateSecretRequestWithSecretString (Aws::String &&value)
 
CreateSecretRequestWithSecretString (const char *value)
 
const Aws::Vector< Tag > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< Tag > &value)
 
void SetTags (Aws::Vector< Tag > &&value)
 
CreateSecretRequestWithTags (const Aws::Vector< Tag > &value)
 
CreateSecretRequestWithTags (Aws::Vector< Tag > &&value)
 
CreateSecretRequestAddTags (const Tag &value)
 
CreateSecretRequestAddTags (Tag &&value)
 
const Aws::Vector< ReplicaRegionType > & GetAddReplicaRegions () const
 
bool AddReplicaRegionsHasBeenSet () const
 
void SetAddReplicaRegions (const Aws::Vector< ReplicaRegionType > &value)
 
void SetAddReplicaRegions (Aws::Vector< ReplicaRegionType > &&value)
 
CreateSecretRequestWithAddReplicaRegions (const Aws::Vector< ReplicaRegionType > &value)
 
CreateSecretRequestWithAddReplicaRegions (Aws::Vector< ReplicaRegionType > &&value)
 
CreateSecretRequestAddAddReplicaRegions (const ReplicaRegionType &value)
 
CreateSecretRequestAddAddReplicaRegions (ReplicaRegionType &&value)
 
bool GetForceOverwriteReplicaSecret () const
 
bool ForceOverwriteReplicaSecretHasBeenSet () const
 
void SetForceOverwriteReplicaSecret (bool value)
 
CreateSecretRequestWithForceOverwriteReplicaSecret (bool value)
 
- Public Member Functions inherited from Aws::SecretsManager::SecretsManagerRequest
virtual ~SecretsManagerRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 26 of file CreateSecretRequest.h.

Constructor & Destructor Documentation

◆ CreateSecretRequest()

Aws::SecretsManager::Model::CreateSecretRequest::CreateSecretRequest ( )

Member Function Documentation

◆ AddAddReplicaRegions() [1/2]

CreateSecretRequest& Aws::SecretsManager::Model::CreateSecretRequest::AddAddReplicaRegions ( const ReplicaRegionType value)
inline

(Optional) Add a list of regions to replicate secrets. Secrets Manager replicates the KMSKeyID objects to the list of regions specified in the parameter.

Definition at line 1120 of file CreateSecretRequest.h.

◆ AddAddReplicaRegions() [2/2]

CreateSecretRequest& Aws::SecretsManager::Model::CreateSecretRequest::AddAddReplicaRegions ( ReplicaRegionType &&  value)
inline

(Optional) Add a list of regions to replicate secrets. Secrets Manager replicates the KMSKeyID objects to the list of regions specified in the parameter.

Definition at line 1127 of file CreateSecretRequest.h.

◆ AddReplicaRegionsHasBeenSet()

bool Aws::SecretsManager::Model::CreateSecretRequest::AddReplicaRegionsHasBeenSet ( ) const
inline

(Optional) Add a list of regions to replicate secrets. Secrets Manager replicates the KMSKeyID objects to the list of regions specified in the parameter.

Definition at line 1085 of file CreateSecretRequest.h.

◆ AddTags() [1/2]

CreateSecretRequest& Aws::SecretsManager::Model::CreateSecretRequest::AddTags ( const Tag value)
inline

(Optional) Specifies a list of user-defined tags that are attached to the secret. Each tag is a "Key" and "Value" pair of strings. This operation only appends tags to the existing list of tags. To remove tags, you must use UntagResource.

  • 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 IAM policy Condition elements as part of your security strategy, then adding or removing a tag can change permissions. If the successful completion of this operation would result in you losing your permissions for this secret, then this operation is blocked and returns an Access Denied error.

This parameter requires a JSON text string argument. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the AWS CLI User Guide. For example:

[{"Key":"CostCenter","Value":"12345"},{"Key":"environment","Value":"production"}]

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 basic 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 AWS reserves it for AWS 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, remember other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / .

Definition at line 1036 of file CreateSecretRequest.h.

◆ AddTags() [2/2]

CreateSecretRequest& Aws::SecretsManager::Model::CreateSecretRequest::AddTags ( Tag &&  value)
inline

(Optional) Specifies a list of user-defined tags that are attached to the secret. Each tag is a "Key" and "Value" pair of strings. This operation only appends tags to the existing list of tags. To remove tags, you must use UntagResource.

  • 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 IAM policy Condition elements as part of your security strategy, then adding or removing a tag can change permissions. If the successful completion of this operation would result in you losing your permissions for this secret, then this operation is blocked and returns an Access Denied error.

This parameter requires a JSON text string argument. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the AWS CLI User Guide. For example:

[{"Key":"CostCenter","Value":"12345"},{"Key":"environment","Value":"production"}]

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 basic 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 AWS reserves it for AWS 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, remember other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / .

Definition at line 1070 of file CreateSecretRequest.h.

◆ ClientRequestTokenHasBeenSet()

bool Aws::SecretsManager::Model::CreateSecretRequest::ClientRequestTokenHasBeenSet ( ) const
inline

(Optional) If you include SecretString or SecretBinary, then an initial version is created as part of the secret, and this parameter specifies a unique identifier for the new version.

If you use the AWS CLI or one of the AWS SDK 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.

Definition at line 181 of file CreateSecretRequest.h.

◆ DescriptionHasBeenSet()

bool Aws::SecretsManager::Model::CreateSecretRequest::DescriptionHasBeenSet ( ) const
inline

(Optional) Specifies a user-provided description of the secret.

Definition at line 372 of file CreateSecretRequest.h.

◆ ForceOverwriteReplicaSecretHasBeenSet()

bool Aws::SecretsManager::Model::CreateSecretRequest::ForceOverwriteReplicaSecretHasBeenSet ( ) const
inline

(Optional) If set, the replication overwrites a secret with the same name in the destination region.

Definition at line 1140 of file CreateSecretRequest.h.

◆ GetAddReplicaRegions()

const Aws::Vector<ReplicaRegionType>& Aws::SecretsManager::Model::CreateSecretRequest::GetAddReplicaRegions ( ) const
inline

(Optional) Add a list of regions to replicate secrets. Secrets Manager replicates the KMSKeyID objects to the list of regions specified in the parameter.

Definition at line 1078 of file CreateSecretRequest.h.

◆ GetClientRequestToken()

const Aws::String& Aws::SecretsManager::Model::CreateSecretRequest::GetClientRequestToken ( ) const
inline

(Optional) If you include SecretString or SecretBinary, then an initial version is created as part of the secret, and this parameter specifies a unique identifier for the new version.

If you use the AWS CLI or one of the AWS SDK 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.

Definition at line 151 of file CreateSecretRequest.h.

◆ GetDescription()

const Aws::String& Aws::SecretsManager::Model::CreateSecretRequest::GetDescription ( ) const
inline

(Optional) Specifies a user-provided description of the secret.

Definition at line 367 of file CreateSecretRequest.h.

◆ GetForceOverwriteReplicaSecret()

bool Aws::SecretsManager::Model::CreateSecretRequest::GetForceOverwriteReplicaSecret ( ) const
inline

(Optional) If set, the replication overwrites a secret with the same name in the destination region.

Definition at line 1134 of file CreateSecretRequest.h.

◆ GetKmsKeyId()

const Aws::String& Aws::SecretsManager::Model::CreateSecretRequest::GetKmsKeyId ( ) const
inline

(Optional) Specifies the ARN, Key ID, or alias of the AWS KMS customer master key (CMK) to be used to encrypt the SecretString or SecretBinary values in the versions stored in this secret.

You can specify any of the supported ways to identify a AWS KMS key ID. If you need to reference a CMK in a different account, you can use only the key ARN or the alias ARN.

If you don't specify this value, then Secrets Manager defaults to using the AWS account's default CMK (the one named aws/secretsmanager). If a AWS KMS CMK with that name doesn't yet exist, then Secrets Manager creates it for you automatically the first time it needs to encrypt a version's SecretString or SecretBinary fields.

You can use the account default CMK to encrypt and decrypt only if you call this operation using credentials from the same account that owns the secret. If the secret resides in a different account, then you must create a custom CMK and specify the ARN in this field.

Definition at line 422 of file CreateSecretRequest.h.

◆ GetName()

const Aws::String& Aws::SecretsManager::Model::CreateSecretRequest::GetName ( ) const
inline

Specifies the friendly name of the new secret.

The secret name must be ASCII letters, digits, or 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 at the end of the ARN.

Definition at line 50 of file CreateSecretRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::SecretsManager::Model::CreateSecretRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

◆ GetSecretBinary()

const Aws::Utils::CryptoBuffer& Aws::SecretsManager::Model::CreateSecretRequest::GetSecretBinary ( ) const
inline

(Optional) Specifies binary data that you want 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 use the appropriate technique for your tool to pass the contents of the file as a parameter.

Either SecretString or SecretBinary must have a value, but not both. They cannot both be empty.

This parameter is not available using the Secrets Manager console. It can be accessed only by using the AWS CLI or one of the AWS SDKs.

Definition at line 568 of file CreateSecretRequest.h.

◆ GetSecretString()

const Aws::String& Aws::SecretsManager::Model::CreateSecretRequest::GetSecretString ( ) const
inline

(Optional) Specifies text data that you want to encrypt and store in this new version of the secret.

Either SecretString or SecretBinary must have a value, but not both. They cannot both be empty.

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 the Lambda rotation function knows how to parse.

For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the AWS CLI User Guide. For example:

{"username":"bob","password":"abc123xyz456"}

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.

Definition at line 650 of file CreateSecretRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::SecretsManager::Model::CreateSecretRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 35 of file CreateSecretRequest.h.

◆ GetTags()

const Aws::Vector<Tag>& Aws::SecretsManager::Model::CreateSecretRequest::GetTags ( ) const
inline

(Optional) Specifies a list of user-defined tags that are attached to the secret. Each tag is a "Key" and "Value" pair of strings. This operation only appends tags to the existing list of tags. To remove tags, you must use UntagResource.

  • 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 IAM policy Condition elements as part of your security strategy, then adding or removing a tag can change permissions. If the successful completion of this operation would result in you losing your permissions for this secret, then this operation is blocked and returns an Access Denied error.

This parameter requires a JSON text string argument. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the AWS CLI User Guide. For example:

[{"Key":"CostCenter","Value":"12345"},{"Key":"environment","Value":"production"}]

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 basic 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 AWS reserves it for AWS 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, remember other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / .

Definition at line 832 of file CreateSecretRequest.h.

◆ KmsKeyIdHasBeenSet()

bool Aws::SecretsManager::Model::CreateSecretRequest::KmsKeyIdHasBeenSet ( ) const
inline

(Optional) Specifies the ARN, Key ID, or alias of the AWS KMS customer master key (CMK) to be used to encrypt the SecretString or SecretBinary values in the versions stored in this secret.

You can specify any of the supported ways to identify a AWS KMS key ID. If you need to reference a CMK in a different account, you can use only the key ARN or the alias ARN.

If you don't specify this value, then Secrets Manager defaults to using the AWS account's default CMK (the one named aws/secretsmanager). If a AWS KMS CMK with that name doesn't yet exist, then Secrets Manager creates it for you automatically the first time it needs to encrypt a version's SecretString or SecretBinary fields.

You can use the account default CMK to encrypt and decrypt only if you call this operation using credentials from the same account that owns the secret. If the secret resides in a different account, then you must create a custom CMK and specify the ARN in this field.

Definition at line 441 of file CreateSecretRequest.h.

◆ NameHasBeenSet()

bool Aws::SecretsManager::Model::CreateSecretRequest::NameHasBeenSet ( ) const
inline

Specifies the friendly name of the new secret.

The secret name must be ASCII letters, digits, or 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 at the end of the ARN.

Definition at line 60 of file CreateSecretRequest.h.

◆ SecretBinaryHasBeenSet()

bool Aws::SecretsManager::Model::CreateSecretRequest::SecretBinaryHasBeenSet ( ) const
inline

(Optional) Specifies binary data that you want 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 use the appropriate technique for your tool to pass the contents of the file as a parameter.

Either SecretString or SecretBinary must have a value, but not both. They cannot both be empty.

This parameter is not available using the Secrets Manager console. It can be accessed only by using the AWS CLI or one of the AWS SDKs.

Definition at line 580 of file CreateSecretRequest.h.

◆ SecretStringHasBeenSet()

bool Aws::SecretsManager::Model::CreateSecretRequest::SecretStringHasBeenSet ( ) const
inline

(Optional) Specifies text data that you want to encrypt and store in this new version of the secret.

Either SecretString or SecretBinary must have a value, but not both. They cannot both be empty.

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 the Lambda rotation function knows how to parse.

For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the AWS CLI User Guide. For example:

{"username":"bob","password":"abc123xyz456"}

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.

Definition at line 671 of file CreateSecretRequest.h.

◆ SerializePayload()

Aws::String Aws::SecretsManager::Model::CreateSecretRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAddReplicaRegions() [1/2]

void Aws::SecretsManager::Model::CreateSecretRequest::SetAddReplicaRegions ( Aws::Vector< ReplicaRegionType > &&  value)
inline

(Optional) Add a list of regions to replicate secrets. Secrets Manager replicates the KMSKeyID objects to the list of regions specified in the parameter.

Definition at line 1099 of file CreateSecretRequest.h.

◆ SetAddReplicaRegions() [2/2]

void Aws::SecretsManager::Model::CreateSecretRequest::SetAddReplicaRegions ( const Aws::Vector< ReplicaRegionType > &  value)
inline

(Optional) Add a list of regions to replicate secrets. Secrets Manager replicates the KMSKeyID objects to the list of regions specified in the parameter.

Definition at line 1092 of file CreateSecretRequest.h.

◆ SetClientRequestToken() [1/3]

void Aws::SecretsManager::Model::CreateSecretRequest::SetClientRequestToken ( Aws::String &&  value)
inline

(Optional) If you include SecretString or SecretBinary, then an initial version is created as part of the secret, and this parameter specifies a unique identifier for the new version.

If you use the AWS CLI or one of the AWS SDK 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.

Definition at line 241 of file CreateSecretRequest.h.

◆ SetClientRequestToken() [2/3]

void Aws::SecretsManager::Model::CreateSecretRequest::SetClientRequestToken ( const Aws::String value)
inline

(Optional) If you include SecretString or SecretBinary, then an initial version is created as part of the secret, and this parameter specifies a unique identifier for the new version.

If you use the AWS CLI or one of the AWS SDK 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.

Definition at line 211 of file CreateSecretRequest.h.

◆ SetClientRequestToken() [3/3]

void Aws::SecretsManager::Model::CreateSecretRequest::SetClientRequestToken ( const char *  value)
inline

(Optional) If you include SecretString or SecretBinary, then an initial version is created as part of the secret, and this parameter specifies a unique identifier for the new version.

If you use the AWS CLI or one of the AWS SDK 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.

Definition at line 271 of file CreateSecretRequest.h.

◆ SetDescription() [1/3]

void Aws::SecretsManager::Model::CreateSecretRequest::SetDescription ( Aws::String &&  value)
inline

(Optional) Specifies a user-provided description of the secret.

Definition at line 382 of file CreateSecretRequest.h.

◆ SetDescription() [2/3]

void Aws::SecretsManager::Model::CreateSecretRequest::SetDescription ( const Aws::String value)
inline

(Optional) Specifies a user-provided description of the secret.

Definition at line 377 of file CreateSecretRequest.h.

◆ SetDescription() [3/3]

void Aws::SecretsManager::Model::CreateSecretRequest::SetDescription ( const char *  value)
inline

(Optional) Specifies a user-provided description of the secret.

Definition at line 387 of file CreateSecretRequest.h.

◆ SetForceOverwriteReplicaSecret()

void Aws::SecretsManager::Model::CreateSecretRequest::SetForceOverwriteReplicaSecret ( bool  value)
inline

(Optional) If set, the replication overwrites a secret with the same name in the destination region.

Definition at line 1146 of file CreateSecretRequest.h.

◆ SetKmsKeyId() [1/3]

void Aws::SecretsManager::Model::CreateSecretRequest::SetKmsKeyId ( Aws::String &&  value)
inline

(Optional) Specifies the ARN, Key ID, or alias of the AWS KMS customer master key (CMK) to be used to encrypt the SecretString or SecretBinary values in the versions stored in this secret.

You can specify any of the supported ways to identify a AWS KMS key ID. If you need to reference a CMK in a different account, you can use only the key ARN or the alias ARN.

If you don't specify this value, then Secrets Manager defaults to using the AWS account's default CMK (the one named aws/secretsmanager). If a AWS KMS CMK with that name doesn't yet exist, then Secrets Manager creates it for you automatically the first time it needs to encrypt a version's SecretString or SecretBinary fields.

You can use the account default CMK to encrypt and decrypt only if you call this operation using credentials from the same account that owns the secret. If the secret resides in a different account, then you must create a custom CMK and specify the ARN in this field.

Definition at line 479 of file CreateSecretRequest.h.

◆ SetKmsKeyId() [2/3]

void Aws::SecretsManager::Model::CreateSecretRequest::SetKmsKeyId ( const Aws::String value)
inline

(Optional) Specifies the ARN, Key ID, or alias of the AWS KMS customer master key (CMK) to be used to encrypt the SecretString or SecretBinary values in the versions stored in this secret.

You can specify any of the supported ways to identify a AWS KMS key ID. If you need to reference a CMK in a different account, you can use only the key ARN or the alias ARN.

If you don't specify this value, then Secrets Manager defaults to using the AWS account's default CMK (the one named aws/secretsmanager). If a AWS KMS CMK with that name doesn't yet exist, then Secrets Manager creates it for you automatically the first time it needs to encrypt a version's SecretString or SecretBinary fields.

You can use the account default CMK to encrypt and decrypt only if you call this operation using credentials from the same account that owns the secret. If the secret resides in a different account, then you must create a custom CMK and specify the ARN in this field.

Definition at line 460 of file CreateSecretRequest.h.

◆ SetKmsKeyId() [3/3]

void Aws::SecretsManager::Model::CreateSecretRequest::SetKmsKeyId ( const char *  value)
inline

(Optional) Specifies the ARN, Key ID, or alias of the AWS KMS customer master key (CMK) to be used to encrypt the SecretString or SecretBinary values in the versions stored in this secret.

You can specify any of the supported ways to identify a AWS KMS key ID. If you need to reference a CMK in a different account, you can use only the key ARN or the alias ARN.

If you don't specify this value, then Secrets Manager defaults to using the AWS account's default CMK (the one named aws/secretsmanager). If a AWS KMS CMK with that name doesn't yet exist, then Secrets Manager creates it for you automatically the first time it needs to encrypt a version's SecretString or SecretBinary fields.

You can use the account default CMK to encrypt and decrypt only if you call this operation using credentials from the same account that owns the secret. If the secret resides in a different account, then you must create a custom CMK and specify the ARN in this field.

Definition at line 498 of file CreateSecretRequest.h.

◆ SetName() [1/3]

void Aws::SecretsManager::Model::CreateSecretRequest::SetName ( Aws::String &&  value)
inline

Specifies the friendly name of the new secret.

The secret name must be ASCII letters, digits, or 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 at the end of the ARN.

Definition at line 80 of file CreateSecretRequest.h.

◆ SetName() [2/3]

void Aws::SecretsManager::Model::CreateSecretRequest::SetName ( const Aws::String value)
inline

Specifies the friendly name of the new secret.

The secret name must be ASCII letters, digits, or 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 at the end of the ARN.

Definition at line 70 of file CreateSecretRequest.h.

◆ SetName() [3/3]

void Aws::SecretsManager::Model::CreateSecretRequest::SetName ( const char *  value)
inline

Specifies the friendly name of the new secret.

The secret name must be ASCII letters, digits, or 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 at the end of the ARN.

Definition at line 90 of file CreateSecretRequest.h.

◆ SetSecretBinary() [1/2]

void Aws::SecretsManager::Model::CreateSecretRequest::SetSecretBinary ( Aws::Utils::CryptoBuffer &&  value)
inline

(Optional) Specifies binary data that you want 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 use the appropriate technique for your tool to pass the contents of the file as a parameter.

Either SecretString or SecretBinary must have a value, but not both. They cannot both be empty.

This parameter is not available using the Secrets Manager console. It can be accessed only by using the AWS CLI or one of the AWS SDKs.

Definition at line 604 of file CreateSecretRequest.h.

◆ SetSecretBinary() [2/2]

void Aws::SecretsManager::Model::CreateSecretRequest::SetSecretBinary ( const Aws::Utils::CryptoBuffer value)
inline

(Optional) Specifies binary data that you want 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 use the appropriate technique for your tool to pass the contents of the file as a parameter.

Either SecretString or SecretBinary must have a value, but not both. They cannot both be empty.

This parameter is not available using the Secrets Manager console. It can be accessed only by using the AWS CLI or one of the AWS SDKs.

Definition at line 592 of file CreateSecretRequest.h.

◆ SetSecretString() [1/3]

void Aws::SecretsManager::Model::CreateSecretRequest::SetSecretString ( Aws::String &&  value)
inline

(Optional) Specifies text data that you want to encrypt and store in this new version of the secret.

Either SecretString or SecretBinary must have a value, but not both. They cannot both be empty.

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 the Lambda rotation function knows how to parse.

For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the AWS CLI User Guide. For example:

{"username":"bob","password":"abc123xyz456"}

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.

Definition at line 713 of file CreateSecretRequest.h.

◆ SetSecretString() [2/3]

void Aws::SecretsManager::Model::CreateSecretRequest::SetSecretString ( const Aws::String value)
inline

(Optional) Specifies text data that you want to encrypt and store in this new version of the secret.

Either SecretString or SecretBinary must have a value, but not both. They cannot both be empty.

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 the Lambda rotation function knows how to parse.

For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the AWS CLI User Guide. For example:

{"username":"bob","password":"abc123xyz456"}

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.

Definition at line 692 of file CreateSecretRequest.h.

◆ SetSecretString() [3/3]

void Aws::SecretsManager::Model::CreateSecretRequest::SetSecretString ( const char *  value)
inline

(Optional) Specifies text data that you want to encrypt and store in this new version of the secret.

Either SecretString or SecretBinary must have a value, but not both. They cannot both be empty.

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 the Lambda rotation function knows how to parse.

For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the AWS CLI User Guide. For example:

{"username":"bob","password":"abc123xyz456"}

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.

Definition at line 734 of file CreateSecretRequest.h.

◆ SetTags() [1/2]

void Aws::SecretsManager::Model::CreateSecretRequest::SetTags ( Aws::Vector< Tag > &&  value)
inline

(Optional) Specifies a list of user-defined tags that are attached to the secret. Each tag is a "Key" and "Value" pair of strings. This operation only appends tags to the existing list of tags. To remove tags, you must use UntagResource.

  • 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 IAM policy Condition elements as part of your security strategy, then adding or removing a tag can change permissions. If the successful completion of this operation would result in you losing your permissions for this secret, then this operation is blocked and returns an Access Denied error.

This parameter requires a JSON text string argument. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the AWS CLI User Guide. For example:

[{"Key":"CostCenter","Value":"12345"},{"Key":"environment","Value":"production"}]

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 basic 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 AWS reserves it for AWS 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, remember other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / .

Definition at line 934 of file CreateSecretRequest.h.

◆ SetTags() [2/2]

void Aws::SecretsManager::Model::CreateSecretRequest::SetTags ( const Aws::Vector< Tag > &  value)
inline

(Optional) Specifies a list of user-defined tags that are attached to the secret. Each tag is a "Key" and "Value" pair of strings. This operation only appends tags to the existing list of tags. To remove tags, you must use UntagResource.

  • 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 IAM policy Condition elements as part of your security strategy, then adding or removing a tag can change permissions. If the successful completion of this operation would result in you losing your permissions for this secret, then this operation is blocked and returns an Access Denied error.

This parameter requires a JSON text string argument. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the AWS CLI User Guide. For example:

[{"Key":"CostCenter","Value":"12345"},{"Key":"environment","Value":"production"}]

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 basic 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 AWS reserves it for AWS 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, remember other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / .

Definition at line 900 of file CreateSecretRequest.h.

◆ TagsHasBeenSet()

bool Aws::SecretsManager::Model::CreateSecretRequest::TagsHasBeenSet ( ) const
inline

(Optional) Specifies a list of user-defined tags that are attached to the secret. Each tag is a "Key" and "Value" pair of strings. This operation only appends tags to the existing list of tags. To remove tags, you must use UntagResource.

  • 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 IAM policy Condition elements as part of your security strategy, then adding or removing a tag can change permissions. If the successful completion of this operation would result in you losing your permissions for this secret, then this operation is blocked and returns an Access Denied error.

This parameter requires a JSON text string argument. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the AWS CLI User Guide. For example:

[{"Key":"CostCenter","Value":"12345"},{"Key":"environment","Value":"production"}]

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 basic 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 AWS reserves it for AWS 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, remember other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / .

Definition at line 866 of file CreateSecretRequest.h.

◆ WithAddReplicaRegions() [1/2]

CreateSecretRequest& Aws::SecretsManager::Model::CreateSecretRequest::WithAddReplicaRegions ( Aws::Vector< ReplicaRegionType > &&  value)
inline

(Optional) Add a list of regions to replicate secrets. Secrets Manager replicates the KMSKeyID objects to the list of regions specified in the parameter.

Definition at line 1113 of file CreateSecretRequest.h.

◆ WithAddReplicaRegions() [2/2]

CreateSecretRequest& Aws::SecretsManager::Model::CreateSecretRequest::WithAddReplicaRegions ( const Aws::Vector< ReplicaRegionType > &  value)
inline

(Optional) Add a list of regions to replicate secrets. Secrets Manager replicates the KMSKeyID objects to the list of regions specified in the parameter.

Definition at line 1106 of file CreateSecretRequest.h.

◆ WithClientRequestToken() [1/3]

CreateSecretRequest& Aws::SecretsManager::Model::CreateSecretRequest::WithClientRequestToken ( Aws::String &&  value)
inline

(Optional) If you include SecretString or SecretBinary, then an initial version is created as part of the secret, and this parameter specifies a unique identifier for the new version.

If you use the AWS CLI or one of the AWS SDK 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.

Definition at line 331 of file CreateSecretRequest.h.

◆ WithClientRequestToken() [2/3]

CreateSecretRequest& Aws::SecretsManager::Model::CreateSecretRequest::WithClientRequestToken ( const Aws::String value)
inline

(Optional) If you include SecretString or SecretBinary, then an initial version is created as part of the secret, and this parameter specifies a unique identifier for the new version.

If you use the AWS CLI or one of the AWS SDK 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.

Definition at line 301 of file CreateSecretRequest.h.

◆ WithClientRequestToken() [3/3]

CreateSecretRequest& Aws::SecretsManager::Model::CreateSecretRequest::WithClientRequestToken ( const char *  value)
inline

(Optional) If you include SecretString or SecretBinary, then an initial version is created as part of the secret, and this parameter specifies a unique identifier for the new version.

If you use the AWS CLI or one of the AWS SDK 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.

Definition at line 361 of file CreateSecretRequest.h.

◆ WithDescription() [1/3]

CreateSecretRequest& Aws::SecretsManager::Model::CreateSecretRequest::WithDescription ( Aws::String &&  value)
inline

(Optional) Specifies a user-provided description of the secret.

Definition at line 397 of file CreateSecretRequest.h.

◆ WithDescription() [2/3]

CreateSecretRequest& Aws::SecretsManager::Model::CreateSecretRequest::WithDescription ( const Aws::String value)
inline

(Optional) Specifies a user-provided description of the secret.

Definition at line 392 of file CreateSecretRequest.h.

◆ WithDescription() [3/3]

CreateSecretRequest& Aws::SecretsManager::Model::CreateSecretRequest::WithDescription ( const char *  value)
inline

(Optional) Specifies a user-provided description of the secret.

Definition at line 402 of file CreateSecretRequest.h.

◆ WithForceOverwriteReplicaSecret()

CreateSecretRequest& Aws::SecretsManager::Model::CreateSecretRequest::WithForceOverwriteReplicaSecret ( bool  value)
inline

(Optional) If set, the replication overwrites a secret with the same name in the destination region.

Definition at line 1152 of file CreateSecretRequest.h.

◆ WithKmsKeyId() [1/3]

CreateSecretRequest& Aws::SecretsManager::Model::CreateSecretRequest::WithKmsKeyId ( Aws::String &&  value)
inline

(Optional) Specifies the ARN, Key ID, or alias of the AWS KMS customer master key (CMK) to be used to encrypt the SecretString or SecretBinary values in the versions stored in this secret.

You can specify any of the supported ways to identify a AWS KMS key ID. If you need to reference a CMK in a different account, you can use only the key ARN or the alias ARN.

If you don't specify this value, then Secrets Manager defaults to using the AWS account's default CMK (the one named aws/secretsmanager). If a AWS KMS CMK with that name doesn't yet exist, then Secrets Manager creates it for you automatically the first time it needs to encrypt a version's SecretString or SecretBinary fields.

You can use the account default CMK to encrypt and decrypt only if you call this operation using credentials from the same account that owns the secret. If the secret resides in a different account, then you must create a custom CMK and specify the ARN in this field.

Definition at line 536 of file CreateSecretRequest.h.

◆ WithKmsKeyId() [2/3]

CreateSecretRequest& Aws::SecretsManager::Model::CreateSecretRequest::WithKmsKeyId ( const Aws::String value)
inline

(Optional) Specifies the ARN, Key ID, or alias of the AWS KMS customer master key (CMK) to be used to encrypt the SecretString or SecretBinary values in the versions stored in this secret.

You can specify any of the supported ways to identify a AWS KMS key ID. If you need to reference a CMK in a different account, you can use only the key ARN or the alias ARN.

If you don't specify this value, then Secrets Manager defaults to using the AWS account's default CMK (the one named aws/secretsmanager). If a AWS KMS CMK with that name doesn't yet exist, then Secrets Manager creates it for you automatically the first time it needs to encrypt a version's SecretString or SecretBinary fields.

You can use the account default CMK to encrypt and decrypt only if you call this operation using credentials from the same account that owns the secret. If the secret resides in a different account, then you must create a custom CMK and specify the ARN in this field.

Definition at line 517 of file CreateSecretRequest.h.

◆ WithKmsKeyId() [3/3]

CreateSecretRequest& Aws::SecretsManager::Model::CreateSecretRequest::WithKmsKeyId ( const char *  value)
inline

(Optional) Specifies the ARN, Key ID, or alias of the AWS KMS customer master key (CMK) to be used to encrypt the SecretString or SecretBinary values in the versions stored in this secret.

You can specify any of the supported ways to identify a AWS KMS key ID. If you need to reference a CMK in a different account, you can use only the key ARN or the alias ARN.

If you don't specify this value, then Secrets Manager defaults to using the AWS account's default CMK (the one named aws/secretsmanager). If a AWS KMS CMK with that name doesn't yet exist, then Secrets Manager creates it for you automatically the first time it needs to encrypt a version's SecretString or SecretBinary fields.

You can use the account default CMK to encrypt and decrypt only if you call this operation using credentials from the same account that owns the secret. If the secret resides in a different account, then you must create a custom CMK and specify the ARN in this field.

Definition at line 555 of file CreateSecretRequest.h.

◆ WithName() [1/3]

CreateSecretRequest& Aws::SecretsManager::Model::CreateSecretRequest::WithName ( Aws::String &&  value)
inline

Specifies the friendly name of the new secret.

The secret name must be ASCII letters, digits, or 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 at the end of the ARN.

Definition at line 110 of file CreateSecretRequest.h.

◆ WithName() [2/3]

CreateSecretRequest& Aws::SecretsManager::Model::CreateSecretRequest::WithName ( const Aws::String value)
inline

Specifies the friendly name of the new secret.

The secret name must be ASCII letters, digits, or 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 at the end of the ARN.

Definition at line 100 of file CreateSecretRequest.h.

◆ WithName() [3/3]

CreateSecretRequest& Aws::SecretsManager::Model::CreateSecretRequest::WithName ( const char *  value)
inline

Specifies the friendly name of the new secret.

The secret name must be ASCII letters, digits, or 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 at the end of the ARN.

Definition at line 120 of file CreateSecretRequest.h.

◆ WithSecretBinary() [1/2]

CreateSecretRequest& Aws::SecretsManager::Model::CreateSecretRequest::WithSecretBinary ( Aws::Utils::CryptoBuffer &&  value)
inline

(Optional) Specifies binary data that you want 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 use the appropriate technique for your tool to pass the contents of the file as a parameter.

Either SecretString or SecretBinary must have a value, but not both. They cannot both be empty.

This parameter is not available using the Secrets Manager console. It can be accessed only by using the AWS CLI or one of the AWS SDKs.

Definition at line 628 of file CreateSecretRequest.h.

◆ WithSecretBinary() [2/2]

CreateSecretRequest& Aws::SecretsManager::Model::CreateSecretRequest::WithSecretBinary ( const Aws::Utils::CryptoBuffer value)
inline

(Optional) Specifies binary data that you want 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 use the appropriate technique for your tool to pass the contents of the file as a parameter.

Either SecretString or SecretBinary must have a value, but not both. They cannot both be empty.

This parameter is not available using the Secrets Manager console. It can be accessed only by using the AWS CLI or one of the AWS SDKs.

Definition at line 616 of file CreateSecretRequest.h.

◆ WithSecretString() [1/3]

CreateSecretRequest& Aws::SecretsManager::Model::CreateSecretRequest::WithSecretString ( Aws::String &&  value)
inline

(Optional) Specifies text data that you want to encrypt and store in this new version of the secret.

Either SecretString or SecretBinary must have a value, but not both. They cannot both be empty.

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 the Lambda rotation function knows how to parse.

For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the AWS CLI User Guide. For example:

{"username":"bob","password":"abc123xyz456"}

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.

Definition at line 776 of file CreateSecretRequest.h.

◆ WithSecretString() [2/3]

CreateSecretRequest& Aws::SecretsManager::Model::CreateSecretRequest::WithSecretString ( const Aws::String value)
inline

(Optional) Specifies text data that you want to encrypt and store in this new version of the secret.

Either SecretString or SecretBinary must have a value, but not both. They cannot both be empty.

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 the Lambda rotation function knows how to parse.

For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the AWS CLI User Guide. For example:

{"username":"bob","password":"abc123xyz456"}

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.

Definition at line 755 of file CreateSecretRequest.h.

◆ WithSecretString() [3/3]

CreateSecretRequest& Aws::SecretsManager::Model::CreateSecretRequest::WithSecretString ( const char *  value)
inline

(Optional) Specifies text data that you want to encrypt and store in this new version of the secret.

Either SecretString or SecretBinary must have a value, but not both. They cannot both be empty.

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 the Lambda rotation function knows how to parse.

For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the AWS CLI User Guide. For example:

{"username":"bob","password":"abc123xyz456"}

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.

Definition at line 797 of file CreateSecretRequest.h.

◆ WithTags() [1/2]

CreateSecretRequest& Aws::SecretsManager::Model::CreateSecretRequest::WithTags ( Aws::Vector< Tag > &&  value)
inline

(Optional) Specifies a list of user-defined tags that are attached to the secret. Each tag is a "Key" and "Value" pair of strings. This operation only appends tags to the existing list of tags. To remove tags, you must use UntagResource.

  • 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 IAM policy Condition elements as part of your security strategy, then adding or removing a tag can change permissions. If the successful completion of this operation would result in you losing your permissions for this secret, then this operation is blocked and returns an Access Denied error.

This parameter requires a JSON text string argument. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the AWS CLI User Guide. For example:

[{"Key":"CostCenter","Value":"12345"},{"Key":"environment","Value":"production"}]

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 basic 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 AWS reserves it for AWS 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, remember other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / .

Definition at line 1002 of file CreateSecretRequest.h.

◆ WithTags() [2/2]

CreateSecretRequest& Aws::SecretsManager::Model::CreateSecretRequest::WithTags ( const Aws::Vector< Tag > &  value)
inline

(Optional) Specifies a list of user-defined tags that are attached to the secret. Each tag is a "Key" and "Value" pair of strings. This operation only appends tags to the existing list of tags. To remove tags, you must use UntagResource.

  • 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 IAM policy Condition elements as part of your security strategy, then adding or removing a tag can change permissions. If the successful completion of this operation would result in you losing your permissions for this secret, then this operation is blocked and returns an Access Denied error.

This parameter requires a JSON text string argument. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the AWS CLI User Guide. For example:

[{"Key":"CostCenter","Value":"12345"},{"Key":"environment","Value":"production"}]

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 basic 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 AWS reserves it for AWS 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, remember other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / .

Definition at line 968 of file CreateSecretRequest.h.


The documentation for this class was generated from the following file: