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

#include <PutSecretValueRequest.h>

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

Public Member Functions

 PutSecretValueRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetSecretId () const
 
bool SecretIdHasBeenSet () const
 
void SetSecretId (const Aws::String &value)
 
void SetSecretId (Aws::String &&value)
 
void SetSecretId (const char *value)
 
PutSecretValueRequestWithSecretId (const Aws::String &value)
 
PutSecretValueRequestWithSecretId (Aws::String &&value)
 
PutSecretValueRequestWithSecretId (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)
 
PutSecretValueRequestWithClientRequestToken (const Aws::String &value)
 
PutSecretValueRequestWithClientRequestToken (Aws::String &&value)
 
PutSecretValueRequestWithClientRequestToken (const char *value)
 
const Aws::Utils::CryptoBufferGetSecretBinary () const
 
bool SecretBinaryHasBeenSet () const
 
void SetSecretBinary (const Aws::Utils::CryptoBuffer &value)
 
void SetSecretBinary (Aws::Utils::CryptoBuffer &&value)
 
PutSecretValueRequestWithSecretBinary (const Aws::Utils::CryptoBuffer &value)
 
PutSecretValueRequestWithSecretBinary (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)
 
PutSecretValueRequestWithSecretString (const Aws::String &value)
 
PutSecretValueRequestWithSecretString (Aws::String &&value)
 
PutSecretValueRequestWithSecretString (const char *value)
 
const Aws::Vector< Aws::String > & GetVersionStages () const
 
bool VersionStagesHasBeenSet () const
 
void SetVersionStages (const Aws::Vector< Aws::String > &value)
 
void SetVersionStages (Aws::Vector< Aws::String > &&value)
 
PutSecretValueRequestWithVersionStages (const Aws::Vector< Aws::String > &value)
 
PutSecretValueRequestWithVersionStages (Aws::Vector< Aws::String > &&value)
 
PutSecretValueRequestAddVersionStages (const Aws::String &value)
 
PutSecretValueRequestAddVersionStages (Aws::String &&value)
 
PutSecretValueRequestAddVersionStages (const char *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 24 of file PutSecretValueRequest.h.

Constructor & Destructor Documentation

◆ PutSecretValueRequest()

Aws::SecretsManager::Model::PutSecretValueRequest::PutSecretValueRequest ( )

Member Function Documentation

◆ AddVersionStages() [1/3]

PutSecretValueRequest& Aws::SecretsManager::Model::PutSecretValueRequest::AddVersionStages ( Aws::String &&  value)
inline

(Optional) Specifies a list of staging labels that are attached to this version of the secret. These staging labels are used to track the versions through the rotation process by the Lambda rotation function.

A staging label must be unique to a single version of the secret. If you specify a staging label that's already associated with a different version of the same secret then that staging label is automatically removed from the other version and attached to this version.

If you do not specify a value for VersionStages then Secrets Manager automatically moves the staging label AWSCURRENT to this new version.

Definition at line 636 of file PutSecretValueRequest.h.

◆ AddVersionStages() [2/3]

PutSecretValueRequest& Aws::SecretsManager::Model::PutSecretValueRequest::AddVersionStages ( const Aws::String value)
inline

(Optional) Specifies a list of staging labels that are attached to this version of the secret. These staging labels are used to track the versions through the rotation process by the Lambda rotation function.

A staging label must be unique to a single version of the secret. If you specify a staging label that's already associated with a different version of the same secret then that staging label is automatically removed from the other version and attached to this version.

If you do not specify a value for VersionStages then Secrets Manager automatically moves the staging label AWSCURRENT to this new version.

Definition at line 623 of file PutSecretValueRequest.h.

◆ AddVersionStages() [3/3]

PutSecretValueRequest& Aws::SecretsManager::Model::PutSecretValueRequest::AddVersionStages ( const char *  value)
inline

(Optional) Specifies a list of staging labels that are attached to this version of the secret. These staging labels are used to track the versions through the rotation process by the Lambda rotation function.

A staging label must be unique to a single version of the secret. If you specify a staging label that's already associated with a different version of the same secret then that staging label is automatically removed from the other version and attached to this version.

If you do not specify a value for VersionStages then Secrets Manager automatically moves the staging label AWSCURRENT to this new version.

Definition at line 649 of file PutSecretValueRequest.h.

◆ ClientRequestTokenHasBeenSet()

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

(Optional) Specifies a unique identifier for the new version of the secret.

If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken yourself for new versions and include that value in the request.

This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function's processing. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.

  • If the ClientRequestToken value isn't already associated with a version of the secret then a new version of the secret is created.

  • If a version with this value already exists and that version's SecretString or SecretBinary values are the same as those in the request then the request is ignored (the operation is idempotent).

  • If a version with this value already exists and the version of the SecretString and SecretBinary values are different from those in the request then the request fails because you cannot modify an existing secret version. You can only create new versions to store new secret values.

This value becomes the VersionId of the new version.

Definition at line 159 of file PutSecretValueRequest.h.

◆ GetClientRequestToken()

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

(Optional) Specifies a unique identifier for the new version of the secret.

If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken yourself for new versions and include that value in the request.

This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function's processing. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.

  • If the ClientRequestToken value isn't already associated with a version of the secret then a new version of the secret is created.

  • If a version with this value already exists and that version's SecretString or SecretBinary values are the same as those in the request then the request is ignored (the operation is idempotent).

  • If a version with this value already exists and the version of the SecretString and SecretBinary values are different from those in the request then the request fails because you cannot modify an existing secret version. You can only create new versions to store new secret values.

This value becomes the VersionId of the new version.

Definition at line 131 of file PutSecretValueRequest.h.

◆ GetRequestSpecificHeaders()

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

◆ GetSecretBinary()

const Aws::Utils::CryptoBuffer& Aws::SecretsManager::Model::PutSecretValueRequest::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 SecretBinary or SecretString must have a value, but not both. They cannot both be empty.

This parameter is not accessible if the secret using the Secrets Manager console.

Definition at line 339 of file PutSecretValueRequest.h.

◆ GetSecretId()

const Aws::String& Aws::SecretsManager::Model::PutSecretValueRequest::GetSecretId ( ) const
inline

Specifies the secret to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. The secret must already exist.

For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.

Definition at line 46 of file PutSecretValueRequest.h.

◆ GetSecretString()

const Aws::String& Aws::SecretsManager::Model::PutSecretValueRequest::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 this 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 default 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 more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.

Definition at line 412 of file PutSecretValueRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 33 of file PutSecretValueRequest.h.

◆ GetVersionStages()

const Aws::Vector<Aws::String>& Aws::SecretsManager::Model::PutSecretValueRequest::GetVersionStages ( ) const
inline

(Optional) Specifies a list of staging labels that are attached to this version of the secret. These staging labels are used to track the versions through the rotation process by the Lambda rotation function.

A staging label must be unique to a single version of the secret. If you specify a staging label that's already associated with a different version of the same secret then that staging label is automatically removed from the other version and attached to this version.

If you do not specify a value for VersionStages then Secrets Manager automatically moves the staging label AWSCURRENT to this new version.

Definition at line 545 of file PutSecretValueRequest.h.

◆ SecretBinaryHasBeenSet()

bool Aws::SecretsManager::Model::PutSecretValueRequest::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 SecretBinary or SecretString must have a value, but not both. They cannot both be empty.

This parameter is not accessible if the secret using the Secrets Manager console.

Definition at line 350 of file PutSecretValueRequest.h.

◆ SecretIdHasBeenSet()

bool Aws::SecretsManager::Model::PutSecretValueRequest::SecretIdHasBeenSet ( ) const
inline

Specifies the secret to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. The secret must already exist.

For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.

Definition at line 54 of file PutSecretValueRequest.h.

◆ SecretStringHasBeenSet()

bool Aws::SecretsManager::Model::PutSecretValueRequest::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 this 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 default 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 more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.

Definition at line 429 of file PutSecretValueRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetClientRequestToken() [1/3]

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

(Optional) Specifies a unique identifier for the new version of the secret.

If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken yourself for new versions and include that value in the request.

This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function's processing. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.

  • If the ClientRequestToken value isn't already associated with a version of the secret then a new version of the secret is created.

  • If a version with this value already exists and that version's SecretString or SecretBinary values are the same as those in the request then the request is ignored (the operation is idempotent).

  • If a version with this value already exists and the version of the SecretString and SecretBinary values are different from those in the request then the request fails because you cannot modify an existing secret version. You can only create new versions to store new secret values.

This value becomes the VersionId of the new version.

Definition at line 215 of file PutSecretValueRequest.h.

◆ SetClientRequestToken() [2/3]

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

(Optional) Specifies a unique identifier for the new version of the secret.

If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken yourself for new versions and include that value in the request.

This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function's processing. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.

  • If the ClientRequestToken value isn't already associated with a version of the secret then a new version of the secret is created.

  • If a version with this value already exists and that version's SecretString or SecretBinary values are the same as those in the request then the request is ignored (the operation is idempotent).

  • If a version with this value already exists and the version of the SecretString and SecretBinary values are different from those in the request then the request fails because you cannot modify an existing secret version. You can only create new versions to store new secret values.

This value becomes the VersionId of the new version.

Definition at line 187 of file PutSecretValueRequest.h.

◆ SetClientRequestToken() [3/3]

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

(Optional) Specifies a unique identifier for the new version of the secret.

If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken yourself for new versions and include that value in the request.

This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function's processing. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.

  • If the ClientRequestToken value isn't already associated with a version of the secret then a new version of the secret is created.

  • If a version with this value already exists and that version's SecretString or SecretBinary values are the same as those in the request then the request is ignored (the operation is idempotent).

  • If a version with this value already exists and the version of the SecretString and SecretBinary values are different from those in the request then the request fails because you cannot modify an existing secret version. You can only create new versions to store new secret values.

This value becomes the VersionId of the new version.

Definition at line 243 of file PutSecretValueRequest.h.

◆ SetSecretBinary() [1/2]

void Aws::SecretsManager::Model::PutSecretValueRequest::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 SecretBinary or SecretString must have a value, but not both. They cannot both be empty.

This parameter is not accessible if the secret using the Secrets Manager console.

Definition at line 372 of file PutSecretValueRequest.h.

◆ SetSecretBinary() [2/2]

void Aws::SecretsManager::Model::PutSecretValueRequest::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 SecretBinary or SecretString must have a value, but not both. They cannot both be empty.

This parameter is not accessible if the secret using the Secrets Manager console.

Definition at line 361 of file PutSecretValueRequest.h.

◆ SetSecretId() [1/3]

void Aws::SecretsManager::Model::PutSecretValueRequest::SetSecretId ( Aws::String &&  value)
inline

Specifies the secret to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. The secret must already exist.

For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.

Definition at line 70 of file PutSecretValueRequest.h.

◆ SetSecretId() [2/3]

void Aws::SecretsManager::Model::PutSecretValueRequest::SetSecretId ( const Aws::String value)
inline

Specifies the secret to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. The secret must already exist.

For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.

Definition at line 62 of file PutSecretValueRequest.h.

◆ SetSecretId() [3/3]

void Aws::SecretsManager::Model::PutSecretValueRequest::SetSecretId ( const char *  value)
inline

Specifies the secret to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. The secret must already exist.

For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.

Definition at line 78 of file PutSecretValueRequest.h.

◆ SetSecretString() [1/3]

void Aws::SecretsManager::Model::PutSecretValueRequest::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 this 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 default 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 more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.

Definition at line 463 of file PutSecretValueRequest.h.

◆ SetSecretString() [2/3]

void Aws::SecretsManager::Model::PutSecretValueRequest::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 this 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 default 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 more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.

Definition at line 446 of file PutSecretValueRequest.h.

◆ SetSecretString() [3/3]

void Aws::SecretsManager::Model::PutSecretValueRequest::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 this 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 default 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 more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.

Definition at line 480 of file PutSecretValueRequest.h.

◆ SetVersionStages() [1/2]

void Aws::SecretsManager::Model::PutSecretValueRequest::SetVersionStages ( Aws::Vector< Aws::String > &&  value)
inline

(Optional) Specifies a list of staging labels that are attached to this version of the secret. These staging labels are used to track the versions through the rotation process by the Lambda rotation function.

A staging label must be unique to a single version of the secret. If you specify a staging label that's already associated with a different version of the same secret then that staging label is automatically removed from the other version and attached to this version.

If you do not specify a value for VersionStages then Secrets Manager automatically moves the staging label AWSCURRENT to this new version.

Definition at line 584 of file PutSecretValueRequest.h.

◆ SetVersionStages() [2/2]

void Aws::SecretsManager::Model::PutSecretValueRequest::SetVersionStages ( const Aws::Vector< Aws::String > &  value)
inline

(Optional) Specifies a list of staging labels that are attached to this version of the secret. These staging labels are used to track the versions through the rotation process by the Lambda rotation function.

A staging label must be unique to a single version of the secret. If you specify a staging label that's already associated with a different version of the same secret then that staging label is automatically removed from the other version and attached to this version.

If you do not specify a value for VersionStages then Secrets Manager automatically moves the staging label AWSCURRENT to this new version.

Definition at line 571 of file PutSecretValueRequest.h.

◆ VersionStagesHasBeenSet()

bool Aws::SecretsManager::Model::PutSecretValueRequest::VersionStagesHasBeenSet ( ) const
inline

(Optional) Specifies a list of staging labels that are attached to this version of the secret. These staging labels are used to track the versions through the rotation process by the Lambda rotation function.

A staging label must be unique to a single version of the secret. If you specify a staging label that's already associated with a different version of the same secret then that staging label is automatically removed from the other version and attached to this version.

If you do not specify a value for VersionStages then Secrets Manager automatically moves the staging label AWSCURRENT to this new version.

Definition at line 558 of file PutSecretValueRequest.h.

◆ WithClientRequestToken() [1/3]

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

(Optional) Specifies a unique identifier for the new version of the secret.

If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken yourself for new versions and include that value in the request.

This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function's processing. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.

  • If the ClientRequestToken value isn't already associated with a version of the secret then a new version of the secret is created.

  • If a version with this value already exists and that version's SecretString or SecretBinary values are the same as those in the request then the request is ignored (the operation is idempotent).

  • If a version with this value already exists and the version of the SecretString and SecretBinary values are different from those in the request then the request fails because you cannot modify an existing secret version. You can only create new versions to store new secret values.

This value becomes the VersionId of the new version.

Definition at line 299 of file PutSecretValueRequest.h.

◆ WithClientRequestToken() [2/3]

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

(Optional) Specifies a unique identifier for the new version of the secret.

If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken yourself for new versions and include that value in the request.

This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function's processing. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.

  • If the ClientRequestToken value isn't already associated with a version of the secret then a new version of the secret is created.

  • If a version with this value already exists and that version's SecretString or SecretBinary values are the same as those in the request then the request is ignored (the operation is idempotent).

  • If a version with this value already exists and the version of the SecretString and SecretBinary values are different from those in the request then the request fails because you cannot modify an existing secret version. You can only create new versions to store new secret values.

This value becomes the VersionId of the new version.

Definition at line 271 of file PutSecretValueRequest.h.

◆ WithClientRequestToken() [3/3]

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

(Optional) Specifies a unique identifier for the new version of the secret.

If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken yourself for new versions and include that value in the request.

This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function's processing. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.

  • If the ClientRequestToken value isn't already associated with a version of the secret then a new version of the secret is created.

  • If a version with this value already exists and that version's SecretString or SecretBinary values are the same as those in the request then the request is ignored (the operation is idempotent).

  • If a version with this value already exists and the version of the SecretString and SecretBinary values are different from those in the request then the request fails because you cannot modify an existing secret version. You can only create new versions to store new secret values.

This value becomes the VersionId of the new version.

Definition at line 327 of file PutSecretValueRequest.h.

◆ WithSecretBinary() [1/2]

PutSecretValueRequest& Aws::SecretsManager::Model::PutSecretValueRequest::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 SecretBinary or SecretString must have a value, but not both. They cannot both be empty.

This parameter is not accessible if the secret using the Secrets Manager console.

Definition at line 394 of file PutSecretValueRequest.h.

◆ WithSecretBinary() [2/2]

PutSecretValueRequest& Aws::SecretsManager::Model::PutSecretValueRequest::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 SecretBinary or SecretString must have a value, but not both. They cannot both be empty.

This parameter is not accessible if the secret using the Secrets Manager console.

Definition at line 383 of file PutSecretValueRequest.h.

◆ WithSecretId() [1/3]

PutSecretValueRequest& Aws::SecretsManager::Model::PutSecretValueRequest::WithSecretId ( Aws::String &&  value)
inline

Specifies the secret to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. The secret must already exist.

For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.

Definition at line 94 of file PutSecretValueRequest.h.

◆ WithSecretId() [2/3]

PutSecretValueRequest& Aws::SecretsManager::Model::PutSecretValueRequest::WithSecretId ( const Aws::String value)
inline

Specifies the secret to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. The secret must already exist.

For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.

Definition at line 86 of file PutSecretValueRequest.h.

◆ WithSecretId() [3/3]

PutSecretValueRequest& Aws::SecretsManager::Model::PutSecretValueRequest::WithSecretId ( const char *  value)
inline

Specifies the secret to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. The secret must already exist.

For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.

Definition at line 102 of file PutSecretValueRequest.h.

◆ WithSecretString() [1/3]

PutSecretValueRequest& Aws::SecretsManager::Model::PutSecretValueRequest::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 this 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 default 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 more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.

Definition at line 514 of file PutSecretValueRequest.h.

◆ WithSecretString() [2/3]

PutSecretValueRequest& Aws::SecretsManager::Model::PutSecretValueRequest::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 this 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 default 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 more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.

Definition at line 497 of file PutSecretValueRequest.h.

◆ WithSecretString() [3/3]

PutSecretValueRequest& Aws::SecretsManager::Model::PutSecretValueRequest::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 this 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 default 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 more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.

Definition at line 531 of file PutSecretValueRequest.h.

◆ WithVersionStages() [1/2]

PutSecretValueRequest& Aws::SecretsManager::Model::PutSecretValueRequest::WithVersionStages ( Aws::Vector< Aws::String > &&  value)
inline

(Optional) Specifies a list of staging labels that are attached to this version of the secret. These staging labels are used to track the versions through the rotation process by the Lambda rotation function.

A staging label must be unique to a single version of the secret. If you specify a staging label that's already associated with a different version of the same secret then that staging label is automatically removed from the other version and attached to this version.

If you do not specify a value for VersionStages then Secrets Manager automatically moves the staging label AWSCURRENT to this new version.

Definition at line 610 of file PutSecretValueRequest.h.

◆ WithVersionStages() [2/2]

PutSecretValueRequest& Aws::SecretsManager::Model::PutSecretValueRequest::WithVersionStages ( const Aws::Vector< Aws::String > &  value)
inline

(Optional) Specifies a list of staging labels that are attached to this version of the secret. These staging labels are used to track the versions through the rotation process by the Lambda rotation function.

A staging label must be unique to a single version of the secret. If you specify a staging label that's already associated with a different version of the same secret then that staging label is automatically removed from the other version and attached to this version.

If you do not specify a value for VersionStages then Secrets Manager automatically moves the staging label AWSCURRENT to this new version.

Definition at line 597 of file PutSecretValueRequest.h.


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