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

#include <DeleteSecretRequest.h>

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

Public Member Functions

 DeleteSecretRequest ()
 
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)
 
DeleteSecretRequestWithSecretId (const Aws::String &value)
 
DeleteSecretRequestWithSecretId (Aws::String &&value)
 
DeleteSecretRequestWithSecretId (const char *value)
 
long long GetRecoveryWindowInDays () const
 
bool RecoveryWindowInDaysHasBeenSet () const
 
void SetRecoveryWindowInDays (long long value)
 
DeleteSecretRequestWithRecoveryWindowInDays (long long value)
 
bool GetForceDeleteWithoutRecovery () const
 
bool ForceDeleteWithoutRecoveryHasBeenSet () const
 
void SetForceDeleteWithoutRecovery (bool value)
 
DeleteSecretRequestWithForceDeleteWithoutRecovery (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 21 of file DeleteSecretRequest.h.

Constructor & Destructor Documentation

◆ DeleteSecretRequest()

Aws::SecretsManager::Model::DeleteSecretRequest::DeleteSecretRequest ( )

Member Function Documentation

◆ ForceDeleteWithoutRecoveryHasBeenSet()

bool Aws::SecretsManager::Model::DeleteSecretRequest::ForceDeleteWithoutRecoveryHasBeenSet ( ) const
inline

(Optional) Specifies that the secret is to be deleted without any recovery window. You can't use both this parameter and the RecoveryWindowInDays parameter in the same API call.

An asynchronous background process performs the actual deletion, so there can be a short delay before the operation completes. If you write code to delete and then immediately recreate a secret with the same name, ensure that your code includes appropriate back off and retry logic.

Use this parameter with caution. This parameter causes the operation to skip the normal waiting period before the permanent deletion that Amazon Web Services would normally impose with the RecoveryWindowInDays parameter. If you delete a secret with the ForceDeleteWithouRecovery parameter, then you have no opportunity to recover the secret. You lose the secret permanently.

If you use this parameter and include a previously deleted or nonexistent secret, the operation does not return the error ResourceNotFoundException in order to correctly handle retries.

Definition at line 165 of file DeleteSecretRequest.h.

◆ GetForceDeleteWithoutRecovery()

bool Aws::SecretsManager::Model::DeleteSecretRequest::GetForceDeleteWithoutRecovery ( ) const
inline

(Optional) Specifies that the secret is to be deleted without any recovery window. You can't use both this parameter and the RecoveryWindowInDays parameter in the same API call.

An asynchronous background process performs the actual deletion, so there can be a short delay before the operation completes. If you write code to delete and then immediately recreate a secret with the same name, ensure that your code includes appropriate back off and retry logic.

Use this parameter with caution. This parameter causes the operation to skip the normal waiting period before the permanent deletion that Amazon Web Services would normally impose with the RecoveryWindowInDays parameter. If you delete a secret with the ForceDeleteWithouRecovery parameter, then you have no opportunity to recover the secret. You lose the secret permanently.

If you use this parameter and include a previously deleted or nonexistent secret, the operation does not return the error ResourceNotFoundException in order to correctly handle retries.

Definition at line 145 of file DeleteSecretRequest.h.

◆ GetRecoveryWindowInDays()

long long Aws::SecretsManager::Model::DeleteSecretRequest::GetRecoveryWindowInDays ( ) const
inline

(Optional) Specifies the number of days that Secrets Manager waits before Secrets Manager can delete the secret. You can't use both this parameter and the ForceDeleteWithoutRecovery parameter in the same API call.

This value can range from 7 to 30 days with a default value of 30.

Definition at line 100 of file DeleteSecretRequest.h.

◆ GetRequestSpecificHeaders()

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

◆ GetSecretId()

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

Specifies the secret to delete. 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 42 of file DeleteSecretRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 30 of file DeleteSecretRequest.h.

◆ RecoveryWindowInDaysHasBeenSet()

bool Aws::SecretsManager::Model::DeleteSecretRequest::RecoveryWindowInDaysHasBeenSet ( ) const
inline

(Optional) Specifies the number of days that Secrets Manager waits before Secrets Manager can delete the secret. You can't use both this parameter and the ForceDeleteWithoutRecovery parameter in the same API call.

This value can range from 7 to 30 days with a default value of 30.

Definition at line 108 of file DeleteSecretRequest.h.

◆ SecretIdHasBeenSet()

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

Specifies the secret to delete. 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 49 of file DeleteSecretRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetForceDeleteWithoutRecovery()

void Aws::SecretsManager::Model::DeleteSecretRequest::SetForceDeleteWithoutRecovery ( bool  value)
inline

(Optional) Specifies that the secret is to be deleted without any recovery window. You can't use both this parameter and the RecoveryWindowInDays parameter in the same API call.

An asynchronous background process performs the actual deletion, so there can be a short delay before the operation completes. If you write code to delete and then immediately recreate a secret with the same name, ensure that your code includes appropriate back off and retry logic.

Use this parameter with caution. This parameter causes the operation to skip the normal waiting period before the permanent deletion that Amazon Web Services would normally impose with the RecoveryWindowInDays parameter. If you delete a secret with the ForceDeleteWithouRecovery parameter, then you have no opportunity to recover the secret. You lose the secret permanently.

If you use this parameter and include a previously deleted or nonexistent secret, the operation does not return the error ResourceNotFoundException in order to correctly handle retries.

Definition at line 185 of file DeleteSecretRequest.h.

◆ SetRecoveryWindowInDays()

void Aws::SecretsManager::Model::DeleteSecretRequest::SetRecoveryWindowInDays ( long long  value)
inline

(Optional) Specifies the number of days that Secrets Manager waits before Secrets Manager can delete the secret. You can't use both this parameter and the ForceDeleteWithoutRecovery parameter in the same API call.

This value can range from 7 to 30 days with a default value of 30.

Definition at line 116 of file DeleteSecretRequest.h.

◆ SetSecretId() [1/3]

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

Specifies the secret to delete. 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 63 of file DeleteSecretRequest.h.

◆ SetSecretId() [2/3]

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

Specifies the secret to delete. 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 56 of file DeleteSecretRequest.h.

◆ SetSecretId() [3/3]

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

Specifies the secret to delete. 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 70 of file DeleteSecretRequest.h.

◆ WithForceDeleteWithoutRecovery()

DeleteSecretRequest& Aws::SecretsManager::Model::DeleteSecretRequest::WithForceDeleteWithoutRecovery ( bool  value)
inline

(Optional) Specifies that the secret is to be deleted without any recovery window. You can't use both this parameter and the RecoveryWindowInDays parameter in the same API call.

An asynchronous background process performs the actual deletion, so there can be a short delay before the operation completes. If you write code to delete and then immediately recreate a secret with the same name, ensure that your code includes appropriate back off and retry logic.

Use this parameter with caution. This parameter causes the operation to skip the normal waiting period before the permanent deletion that Amazon Web Services would normally impose with the RecoveryWindowInDays parameter. If you delete a secret with the ForceDeleteWithouRecovery parameter, then you have no opportunity to recover the secret. You lose the secret permanently.

If you use this parameter and include a previously deleted or nonexistent secret, the operation does not return the error ResourceNotFoundException in order to correctly handle retries.

Definition at line 205 of file DeleteSecretRequest.h.

◆ WithRecoveryWindowInDays()

DeleteSecretRequest& Aws::SecretsManager::Model::DeleteSecretRequest::WithRecoveryWindowInDays ( long long  value)
inline

(Optional) Specifies the number of days that Secrets Manager waits before Secrets Manager can delete the secret. You can't use both this parameter and the ForceDeleteWithoutRecovery parameter in the same API call.

This value can range from 7 to 30 days with a default value of 30.

Definition at line 124 of file DeleteSecretRequest.h.

◆ WithSecretId() [1/3]

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

Specifies the secret to delete. 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 84 of file DeleteSecretRequest.h.

◆ WithSecretId() [2/3]

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

Specifies the secret to delete. 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 77 of file DeleteSecretRequest.h.

◆ WithSecretId() [3/3]

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

Specifies the secret to delete. 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 91 of file DeleteSecretRequest.h.


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