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

#include <GetSecretValueRequest.h>

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

Public Member Functions

 GetSecretValueRequest ()
 
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)
 
GetSecretValueRequestWithSecretId (const Aws::String &value)
 
GetSecretValueRequestWithSecretId (Aws::String &&value)
 
GetSecretValueRequestWithSecretId (const char *value)
 
const Aws::StringGetVersionId () const
 
bool VersionIdHasBeenSet () const
 
void SetVersionId (const Aws::String &value)
 
void SetVersionId (Aws::String &&value)
 
void SetVersionId (const char *value)
 
GetSecretValueRequestWithVersionId (const Aws::String &value)
 
GetSecretValueRequestWithVersionId (Aws::String &&value)
 
GetSecretValueRequestWithVersionId (const char *value)
 
const Aws::StringGetVersionStage () const
 
bool VersionStageHasBeenSet () const
 
void SetVersionStage (const Aws::String &value)
 
void SetVersionStage (Aws::String &&value)
 
void SetVersionStage (const char *value)
 
GetSecretValueRequestWithVersionStage (const Aws::String &value)
 
GetSecretValueRequestWithVersionStage (Aws::String &&value)
 
GetSecretValueRequestWithVersionStage (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 21 of file GetSecretValueRequest.h.

Constructor & Destructor Documentation

◆ GetSecretValueRequest()

Aws::SecretsManager::Model::GetSecretValueRequest::GetSecretValueRequest ( )

Member Function Documentation

◆ GetRequestSpecificHeaders()

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

◆ GetSecretId()

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

Specifies the secret containing the version that you want to retrieve. 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 43 of file GetSecretValueRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 30 of file GetSecretValueRequest.h.

◆ GetVersionId()

const Aws::String& Aws::SecretsManager::Model::GetSecretValueRequest::GetVersionId ( ) const
inline

Specifies the unique identifier of the version of the secret that you want to retrieve. If you specify both this parameter and VersionStage, the two parameters must refer to the same secret version. If you don't specify either a VersionStage or VersionId then the default is to perform the operation on the version with the VersionStage value of AWSCURRENT.

This value is typically a UUID-type value with 32 hexadecimal digits.

Definition at line 112 of file GetSecretValueRequest.h.

◆ GetVersionStage()

const Aws::String& Aws::SecretsManager::Model::GetSecretValueRequest::GetVersionStage ( ) const
inline

Specifies the secret version that you want to retrieve by the staging label attached to the version.

Staging labels are used to keep track of different versions during the rotation process. If you specify both this parameter and VersionId, the two parameters must refer to the same secret version . If you don't specify either a VersionStage or VersionId, then the default is to perform the operation on the version with the VersionStage value of AWSCURRENT.

Definition at line 208 of file GetSecretValueRequest.h.

◆ SecretIdHasBeenSet()

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

Specifies the secret containing the version that you want to retrieve. 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 GetSecretValueRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetSecretId() [1/3]

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

Specifies the secret containing the version that you want to retrieve. 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 67 of file GetSecretValueRequest.h.

◆ SetSecretId() [2/3]

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

Specifies the secret containing the version that you want to retrieve. 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 59 of file GetSecretValueRequest.h.

◆ SetSecretId() [3/3]

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

Specifies the secret containing the version that you want to retrieve. 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 75 of file GetSecretValueRequest.h.

◆ SetVersionId() [1/3]

void Aws::SecretsManager::Model::GetSecretValueRequest::SetVersionId ( Aws::String &&  value)
inline

Specifies the unique identifier of the version of the secret that you want to retrieve. If you specify both this parameter and VersionStage, the two parameters must refer to the same secret version. If you don't specify either a VersionStage or VersionId then the default is to perform the operation on the version with the VersionStage value of AWSCURRENT.

This value is typically a UUID-type value with 32 hexadecimal digits.

Definition at line 148 of file GetSecretValueRequest.h.

◆ SetVersionId() [2/3]

void Aws::SecretsManager::Model::GetSecretValueRequest::SetVersionId ( const Aws::String value)
inline

Specifies the unique identifier of the version of the secret that you want to retrieve. If you specify both this parameter and VersionStage, the two parameters must refer to the same secret version. If you don't specify either a VersionStage or VersionId then the default is to perform the operation on the version with the VersionStage value of AWSCURRENT.

This value is typically a UUID-type value with 32 hexadecimal digits.

Definition at line 136 of file GetSecretValueRequest.h.

◆ SetVersionId() [3/3]

void Aws::SecretsManager::Model::GetSecretValueRequest::SetVersionId ( const char *  value)
inline

Specifies the unique identifier of the version of the secret that you want to retrieve. If you specify both this parameter and VersionStage, the two parameters must refer to the same secret version. If you don't specify either a VersionStage or VersionId then the default is to perform the operation on the version with the VersionStage value of AWSCURRENT.

This value is typically a UUID-type value with 32 hexadecimal digits.

Definition at line 160 of file GetSecretValueRequest.h.

◆ SetVersionStage() [1/3]

void Aws::SecretsManager::Model::GetSecretValueRequest::SetVersionStage ( Aws::String &&  value)
inline

Specifies the secret version that you want to retrieve by the staging label attached to the version.

Staging labels are used to keep track of different versions during the rotation process. If you specify both this parameter and VersionId, the two parameters must refer to the same secret version . If you don't specify either a VersionStage or VersionId, then the default is to perform the operation on the version with the VersionStage value of AWSCURRENT.

Definition at line 241 of file GetSecretValueRequest.h.

◆ SetVersionStage() [2/3]

void Aws::SecretsManager::Model::GetSecretValueRequest::SetVersionStage ( const Aws::String value)
inline

Specifies the secret version that you want to retrieve by the staging label attached to the version.

Staging labels are used to keep track of different versions during the rotation process. If you specify both this parameter and VersionId, the two parameters must refer to the same secret version . If you don't specify either a VersionStage or VersionId, then the default is to perform the operation on the version with the VersionStage value of AWSCURRENT.

Definition at line 230 of file GetSecretValueRequest.h.

◆ SetVersionStage() [3/3]

void Aws::SecretsManager::Model::GetSecretValueRequest::SetVersionStage ( const char *  value)
inline

Specifies the secret version that you want to retrieve by the staging label attached to the version.

Staging labels are used to keep track of different versions during the rotation process. If you specify both this parameter and VersionId, the two parameters must refer to the same secret version . If you don't specify either a VersionStage or VersionId, then the default is to perform the operation on the version with the VersionStage value of AWSCURRENT.

Definition at line 252 of file GetSecretValueRequest.h.

◆ VersionIdHasBeenSet()

bool Aws::SecretsManager::Model::GetSecretValueRequest::VersionIdHasBeenSet ( ) const
inline

Specifies the unique identifier of the version of the secret that you want to retrieve. If you specify both this parameter and VersionStage, the two parameters must refer to the same secret version. If you don't specify either a VersionStage or VersionId then the default is to perform the operation on the version with the VersionStage value of AWSCURRENT.

This value is typically a UUID-type value with 32 hexadecimal digits.

Definition at line 124 of file GetSecretValueRequest.h.

◆ VersionStageHasBeenSet()

bool Aws::SecretsManager::Model::GetSecretValueRequest::VersionStageHasBeenSet ( ) const
inline

Specifies the secret version that you want to retrieve by the staging label attached to the version.

Staging labels are used to keep track of different versions during the rotation process. If you specify both this parameter and VersionId, the two parameters must refer to the same secret version . If you don't specify either a VersionStage or VersionId, then the default is to perform the operation on the version with the VersionStage value of AWSCURRENT.

Definition at line 219 of file GetSecretValueRequest.h.

◆ WithSecretId() [1/3]

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

Specifies the secret containing the version that you want to retrieve. 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 GetSecretValueRequest.h.

◆ WithSecretId() [2/3]

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

Specifies the secret containing the version that you want to retrieve. 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 83 of file GetSecretValueRequest.h.

◆ WithSecretId() [3/3]

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

Specifies the secret containing the version that you want to retrieve. 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 99 of file GetSecretValueRequest.h.

◆ WithVersionId() [1/3]

GetSecretValueRequest& Aws::SecretsManager::Model::GetSecretValueRequest::WithVersionId ( Aws::String &&  value)
inline

Specifies the unique identifier of the version of the secret that you want to retrieve. If you specify both this parameter and VersionStage, the two parameters must refer to the same secret version. If you don't specify either a VersionStage or VersionId then the default is to perform the operation on the version with the VersionStage value of AWSCURRENT.

This value is typically a UUID-type value with 32 hexadecimal digits.

Definition at line 184 of file GetSecretValueRequest.h.

◆ WithVersionId() [2/3]

GetSecretValueRequest& Aws::SecretsManager::Model::GetSecretValueRequest::WithVersionId ( const Aws::String value)
inline

Specifies the unique identifier of the version of the secret that you want to retrieve. If you specify both this parameter and VersionStage, the two parameters must refer to the same secret version. If you don't specify either a VersionStage or VersionId then the default is to perform the operation on the version with the VersionStage value of AWSCURRENT.

This value is typically a UUID-type value with 32 hexadecimal digits.

Definition at line 172 of file GetSecretValueRequest.h.

◆ WithVersionId() [3/3]

GetSecretValueRequest& Aws::SecretsManager::Model::GetSecretValueRequest::WithVersionId ( const char *  value)
inline

Specifies the unique identifier of the version of the secret that you want to retrieve. If you specify both this parameter and VersionStage, the two parameters must refer to the same secret version. If you don't specify either a VersionStage or VersionId then the default is to perform the operation on the version with the VersionStage value of AWSCURRENT.

This value is typically a UUID-type value with 32 hexadecimal digits.

Definition at line 196 of file GetSecretValueRequest.h.

◆ WithVersionStage() [1/3]

GetSecretValueRequest& Aws::SecretsManager::Model::GetSecretValueRequest::WithVersionStage ( Aws::String &&  value)
inline

Specifies the secret version that you want to retrieve by the staging label attached to the version.

Staging labels are used to keep track of different versions during the rotation process. If you specify both this parameter and VersionId, the two parameters must refer to the same secret version . If you don't specify either a VersionStage or VersionId, then the default is to perform the operation on the version with the VersionStage value of AWSCURRENT.

Definition at line 274 of file GetSecretValueRequest.h.

◆ WithVersionStage() [2/3]

GetSecretValueRequest& Aws::SecretsManager::Model::GetSecretValueRequest::WithVersionStage ( const Aws::String value)
inline

Specifies the secret version that you want to retrieve by the staging label attached to the version.

Staging labels are used to keep track of different versions during the rotation process. If you specify both this parameter and VersionId, the two parameters must refer to the same secret version . If you don't specify either a VersionStage or VersionId, then the default is to perform the operation on the version with the VersionStage value of AWSCURRENT.

Definition at line 263 of file GetSecretValueRequest.h.

◆ WithVersionStage() [3/3]

GetSecretValueRequest& Aws::SecretsManager::Model::GetSecretValueRequest::WithVersionStage ( const char *  value)
inline

Specifies the secret version that you want to retrieve by the staging label attached to the version.

Staging labels are used to keep track of different versions during the rotation process. If you specify both this parameter and VersionId, the two parameters must refer to the same secret version . If you don't specify either a VersionStage or VersionId, then the default is to perform the operation on the version with the VersionStage value of AWSCURRENT.

Definition at line 285 of file GetSecretValueRequest.h.


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