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

#include <RotateSecretRequest.h>

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

Public Member Functions

 RotateSecretRequest ()
 
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)
 
RotateSecretRequestWithSecretId (const Aws::String &value)
 
RotateSecretRequestWithSecretId (Aws::String &&value)
 
RotateSecretRequestWithSecretId (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)
 
RotateSecretRequestWithClientRequestToken (const Aws::String &value)
 
RotateSecretRequestWithClientRequestToken (Aws::String &&value)
 
RotateSecretRequestWithClientRequestToken (const char *value)
 
const Aws::StringGetRotationLambdaARN () const
 
bool RotationLambdaARNHasBeenSet () const
 
void SetRotationLambdaARN (const Aws::String &value)
 
void SetRotationLambdaARN (Aws::String &&value)
 
void SetRotationLambdaARN (const char *value)
 
RotateSecretRequestWithRotationLambdaARN (const Aws::String &value)
 
RotateSecretRequestWithRotationLambdaARN (Aws::String &&value)
 
RotateSecretRequestWithRotationLambdaARN (const char *value)
 
const RotationRulesTypeGetRotationRules () const
 
bool RotationRulesHasBeenSet () const
 
void SetRotationRules (const RotationRulesType &value)
 
void SetRotationRules (RotationRulesType &&value)
 
RotateSecretRequestWithRotationRules (const RotationRulesType &value)
 
RotateSecretRequestWithRotationRules (RotationRulesType &&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 23 of file RotateSecretRequest.h.

Constructor & Destructor Documentation

◆ RotateSecretRequest()

Aws::SecretsManager::Model::RotateSecretRequest::RotateSecretRequest ( )

Member Function Documentation

◆ ClientRequestTokenHasBeenSet()

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

(Optional) Specifies a unique identifier for the new version of the secret that helps ensure idempotency.

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 for this parameter. 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.

You only need to specify your own value if you implement your own retry logic and want to ensure that a given secret is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.

Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the function's processing. This value becomes the VersionId of the new version.

Definition at line 132 of file RotateSecretRequest.h.

◆ GetClientRequestToken()

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

(Optional) Specifies a unique identifier for the new version of the secret that helps ensure idempotency.

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 for this parameter. 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.

You only need to specify your own value if you implement your own retry logic and want to ensure that a given secret is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.

Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the function's processing. This value becomes the VersionId of the new version.

Definition at line 113 of file RotateSecretRequest.h.

◆ GetRequestSpecificHeaders()

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

◆ GetRotationLambdaARN()

const Aws::String& Aws::SecretsManager::Model::RotateSecretRequest::GetRotationLambdaARN ( ) const
inline

(Optional) Specifies the ARN of the Lambda function that can rotate the secret.

Definition at line 253 of file RotateSecretRequest.h.

◆ GetRotationRules()

const RotationRulesType& Aws::SecretsManager::Model::RotateSecretRequest::GetRotationRules ( ) const
inline

A structure that defines the rotation configuration for this secret.

Definition at line 301 of file RotateSecretRequest.h.

◆ GetSecretId()

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

Specifies the secret that you want to rotate. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

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

Definition at line 44 of file RotateSecretRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 32 of file RotateSecretRequest.h.

◆ RotationLambdaARNHasBeenSet()

bool Aws::SecretsManager::Model::RotateSecretRequest::RotationLambdaARNHasBeenSet ( ) const
inline

(Optional) Specifies the ARN of the Lambda function that can rotate the secret.

Definition at line 259 of file RotateSecretRequest.h.

◆ RotationRulesHasBeenSet()

bool Aws::SecretsManager::Model::RotateSecretRequest::RotationRulesHasBeenSet ( ) const
inline

A structure that defines the rotation configuration for this secret.

Definition at line 306 of file RotateSecretRequest.h.

◆ SecretIdHasBeenSet()

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

Specifies the secret that you want to rotate. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

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

Definition at line 51 of file RotateSecretRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetClientRequestToken() [1/3]

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

(Optional) Specifies a unique identifier for the new version of the secret that helps ensure idempotency.

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 for this parameter. 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.

You only need to specify your own value if you implement your own retry logic and want to ensure that a given secret is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.

Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the function's processing. This value becomes the VersionId of the new version.

Definition at line 170 of file RotateSecretRequest.h.

◆ SetClientRequestToken() [2/3]

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

(Optional) Specifies a unique identifier for the new version of the secret that helps ensure idempotency.

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 for this parameter. 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.

You only need to specify your own value if you implement your own retry logic and want to ensure that a given secret is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.

Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the function's processing. This value becomes the VersionId of the new version.

Definition at line 151 of file RotateSecretRequest.h.

◆ SetClientRequestToken() [3/3]

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

(Optional) Specifies a unique identifier for the new version of the secret that helps ensure idempotency.

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 for this parameter. 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.

You only need to specify your own value if you implement your own retry logic and want to ensure that a given secret is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.

Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the function's processing. This value becomes the VersionId of the new version.

Definition at line 189 of file RotateSecretRequest.h.

◆ SetRotationLambdaARN() [1/3]

void Aws::SecretsManager::Model::RotateSecretRequest::SetRotationLambdaARN ( Aws::String &&  value)
inline

(Optional) Specifies the ARN of the Lambda function that can rotate the secret.

Definition at line 271 of file RotateSecretRequest.h.

◆ SetRotationLambdaARN() [2/3]

void Aws::SecretsManager::Model::RotateSecretRequest::SetRotationLambdaARN ( const Aws::String value)
inline

(Optional) Specifies the ARN of the Lambda function that can rotate the secret.

Definition at line 265 of file RotateSecretRequest.h.

◆ SetRotationLambdaARN() [3/3]

void Aws::SecretsManager::Model::RotateSecretRequest::SetRotationLambdaARN ( const char *  value)
inline

(Optional) Specifies the ARN of the Lambda function that can rotate the secret.

Definition at line 277 of file RotateSecretRequest.h.

◆ SetRotationRules() [1/2]

void Aws::SecretsManager::Model::RotateSecretRequest::SetRotationRules ( const RotationRulesType value)
inline

A structure that defines the rotation configuration for this secret.

Definition at line 311 of file RotateSecretRequest.h.

◆ SetRotationRules() [2/2]

void Aws::SecretsManager::Model::RotateSecretRequest::SetRotationRules ( RotationRulesType &&  value)
inline

A structure that defines the rotation configuration for this secret.

Definition at line 316 of file RotateSecretRequest.h.

◆ SetSecretId() [1/3]

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

Specifies the secret that you want to rotate. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

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

Definition at line 65 of file RotateSecretRequest.h.

◆ SetSecretId() [2/3]

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

Specifies the secret that you want to rotate. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

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

Definition at line 58 of file RotateSecretRequest.h.

◆ SetSecretId() [3/3]

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

Specifies the secret that you want to rotate. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

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

Definition at line 72 of file RotateSecretRequest.h.

◆ WithClientRequestToken() [1/3]

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

(Optional) Specifies a unique identifier for the new version of the secret that helps ensure idempotency.

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 for this parameter. 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.

You only need to specify your own value if you implement your own retry logic and want to ensure that a given secret is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.

Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the function's processing. This value becomes the VersionId of the new version.

Definition at line 227 of file RotateSecretRequest.h.

◆ WithClientRequestToken() [2/3]

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

(Optional) Specifies a unique identifier for the new version of the secret that helps ensure idempotency.

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 for this parameter. 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.

You only need to specify your own value if you implement your own retry logic and want to ensure that a given secret is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.

Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the function's processing. This value becomes the VersionId of the new version.

Definition at line 208 of file RotateSecretRequest.h.

◆ WithClientRequestToken() [3/3]

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

(Optional) Specifies a unique identifier for the new version of the secret that helps ensure idempotency.

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 for this parameter. 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.

You only need to specify your own value if you implement your own retry logic and want to ensure that a given secret is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.

Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the function's processing. This value becomes the VersionId of the new version.

Definition at line 246 of file RotateSecretRequest.h.

◆ WithRotationLambdaARN() [1/3]

RotateSecretRequest& Aws::SecretsManager::Model::RotateSecretRequest::WithRotationLambdaARN ( Aws::String &&  value)
inline

(Optional) Specifies the ARN of the Lambda function that can rotate the secret.

Definition at line 289 of file RotateSecretRequest.h.

◆ WithRotationLambdaARN() [2/3]

RotateSecretRequest& Aws::SecretsManager::Model::RotateSecretRequest::WithRotationLambdaARN ( const Aws::String value)
inline

(Optional) Specifies the ARN of the Lambda function that can rotate the secret.

Definition at line 283 of file RotateSecretRequest.h.

◆ WithRotationLambdaARN() [3/3]

RotateSecretRequest& Aws::SecretsManager::Model::RotateSecretRequest::WithRotationLambdaARN ( const char *  value)
inline

(Optional) Specifies the ARN of the Lambda function that can rotate the secret.

Definition at line 295 of file RotateSecretRequest.h.

◆ WithRotationRules() [1/2]

RotateSecretRequest& Aws::SecretsManager::Model::RotateSecretRequest::WithRotationRules ( const RotationRulesType value)
inline

A structure that defines the rotation configuration for this secret.

Definition at line 321 of file RotateSecretRequest.h.

◆ WithRotationRules() [2/2]

RotateSecretRequest& Aws::SecretsManager::Model::RotateSecretRequest::WithRotationRules ( RotationRulesType &&  value)
inline

A structure that defines the rotation configuration for this secret.

Definition at line 326 of file RotateSecretRequest.h.

◆ WithSecretId() [1/3]

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

Specifies the secret that you want to rotate. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

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

Definition at line 86 of file RotateSecretRequest.h.

◆ WithSecretId() [2/3]

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

Specifies the secret that you want to rotate. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

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

Definition at line 79 of file RotateSecretRequest.h.

◆ WithSecretId() [3/3]

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

Specifies the secret that you want to rotate. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

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

Definition at line 93 of file RotateSecretRequest.h.


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