414 lines
24 KiB
C++
414 lines
24 KiB
C++
/**
|
||
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
|
||
* SPDX-License-Identifier: Apache-2.0.
|
||
*/
|
||
|
||
#pragma once
|
||
#include <aws/secretsmanager/SecretsManager_EXPORTS.h>
|
||
#include <aws/secretsmanager/SecretsManagerRequest.h>
|
||
#include <aws/core/utils/memory/stl/AWSString.h>
|
||
#include <utility>
|
||
|
||
namespace Aws
|
||
{
|
||
namespace SecretsManager
|
||
{
|
||
namespace Model
|
||
{
|
||
|
||
/**
|
||
*/
|
||
class AWS_SECRETSMANAGER_API GetSecretValueRequest : public SecretsManagerRequest
|
||
{
|
||
public:
|
||
GetSecretValueRequest();
|
||
|
||
// Service request name is the Operation name which will send this request out,
|
||
// each operation should has unique request name, so that we can get operation's name from this request.
|
||
// Note: this is not true for response, multiple operations may have the same response name,
|
||
// so we can not get operation's name from response.
|
||
inline virtual const char* GetServiceRequestName() const override { return "GetSecretValue"; }
|
||
|
||
Aws::String SerializePayload() const override;
|
||
|
||
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override;
|
||
|
||
|
||
/**
|
||
* <p>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.</p> <p>If you specify an ARN, we generally recommend that you
|
||
* specify a complete ARN. You can specify a partial ARN too—for example, if you
|
||
* don’t include the final hyphen and six random characters that Secrets Manager
|
||
* adds at the end of the ARN when you created the secret. A partial ARN match can
|
||
* work as long as it uniquely matches only one secret. However, if your secret has
|
||
* a name that ends in a hyphen followed by six characters (before Secrets Manager
|
||
* adds the hyphen and six characters to the ARN) and you try to use that as a
|
||
* partial ARN, then those characters cause Secrets Manager to assume that you’re
|
||
* specifying a complete ARN. This confusion can cause unexpected results. To avoid
|
||
* this situation, we recommend that you don’t create secret names ending with a
|
||
* hyphen followed by six characters.</p> <p>If you specify an incomplete ARN
|
||
* without the random suffix, and instead provide the 'friendly name', you
|
||
* <i>must</i> not include the random suffix. If you do include the random suffix
|
||
* added by Secrets Manager, you receive either a <i>ResourceNotFoundException</i>
|
||
* or an <i>AccessDeniedException</i> error, depending on your permissions.</p>
|
||
*
|
||
*/
|
||
inline const Aws::String& GetSecretId() const{ return m_secretId; }
|
||
|
||
/**
|
||
* <p>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.</p> <p>If you specify an ARN, we generally recommend that you
|
||
* specify a complete ARN. You can specify a partial ARN too—for example, if you
|
||
* don’t include the final hyphen and six random characters that Secrets Manager
|
||
* adds at the end of the ARN when you created the secret. A partial ARN match can
|
||
* work as long as it uniquely matches only one secret. However, if your secret has
|
||
* a name that ends in a hyphen followed by six characters (before Secrets Manager
|
||
* adds the hyphen and six characters to the ARN) and you try to use that as a
|
||
* partial ARN, then those characters cause Secrets Manager to assume that you’re
|
||
* specifying a complete ARN. This confusion can cause unexpected results. To avoid
|
||
* this situation, we recommend that you don’t create secret names ending with a
|
||
* hyphen followed by six characters.</p> <p>If you specify an incomplete ARN
|
||
* without the random suffix, and instead provide the 'friendly name', you
|
||
* <i>must</i> not include the random suffix. If you do include the random suffix
|
||
* added by Secrets Manager, you receive either a <i>ResourceNotFoundException</i>
|
||
* or an <i>AccessDeniedException</i> error, depending on your permissions.</p>
|
||
*
|
||
*/
|
||
inline bool SecretIdHasBeenSet() const { return m_secretIdHasBeenSet; }
|
||
|
||
/**
|
||
* <p>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.</p> <p>If you specify an ARN, we generally recommend that you
|
||
* specify a complete ARN. You can specify a partial ARN too—for example, if you
|
||
* don’t include the final hyphen and six random characters that Secrets Manager
|
||
* adds at the end of the ARN when you created the secret. A partial ARN match can
|
||
* work as long as it uniquely matches only one secret. However, if your secret has
|
||
* a name that ends in a hyphen followed by six characters (before Secrets Manager
|
||
* adds the hyphen and six characters to the ARN) and you try to use that as a
|
||
* partial ARN, then those characters cause Secrets Manager to assume that you’re
|
||
* specifying a complete ARN. This confusion can cause unexpected results. To avoid
|
||
* this situation, we recommend that you don’t create secret names ending with a
|
||
* hyphen followed by six characters.</p> <p>If you specify an incomplete ARN
|
||
* without the random suffix, and instead provide the 'friendly name', you
|
||
* <i>must</i> not include the random suffix. If you do include the random suffix
|
||
* added by Secrets Manager, you receive either a <i>ResourceNotFoundException</i>
|
||
* or an <i>AccessDeniedException</i> error, depending on your permissions.</p>
|
||
*
|
||
*/
|
||
inline void SetSecretId(const Aws::String& value) { m_secretIdHasBeenSet = true; m_secretId = value; }
|
||
|
||
/**
|
||
* <p>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.</p> <p>If you specify an ARN, we generally recommend that you
|
||
* specify a complete ARN. You can specify a partial ARN too—for example, if you
|
||
* don’t include the final hyphen and six random characters that Secrets Manager
|
||
* adds at the end of the ARN when you created the secret. A partial ARN match can
|
||
* work as long as it uniquely matches only one secret. However, if your secret has
|
||
* a name that ends in a hyphen followed by six characters (before Secrets Manager
|
||
* adds the hyphen and six characters to the ARN) and you try to use that as a
|
||
* partial ARN, then those characters cause Secrets Manager to assume that you’re
|
||
* specifying a complete ARN. This confusion can cause unexpected results. To avoid
|
||
* this situation, we recommend that you don’t create secret names ending with a
|
||
* hyphen followed by six characters.</p> <p>If you specify an incomplete ARN
|
||
* without the random suffix, and instead provide the 'friendly name', you
|
||
* <i>must</i> not include the random suffix. If you do include the random suffix
|
||
* added by Secrets Manager, you receive either a <i>ResourceNotFoundException</i>
|
||
* or an <i>AccessDeniedException</i> error, depending on your permissions.</p>
|
||
*
|
||
*/
|
||
inline void SetSecretId(Aws::String&& value) { m_secretIdHasBeenSet = true; m_secretId = std::move(value); }
|
||
|
||
/**
|
||
* <p>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.</p> <p>If you specify an ARN, we generally recommend that you
|
||
* specify a complete ARN. You can specify a partial ARN too—for example, if you
|
||
* don’t include the final hyphen and six random characters that Secrets Manager
|
||
* adds at the end of the ARN when you created the secret. A partial ARN match can
|
||
* work as long as it uniquely matches only one secret. However, if your secret has
|
||
* a name that ends in a hyphen followed by six characters (before Secrets Manager
|
||
* adds the hyphen and six characters to the ARN) and you try to use that as a
|
||
* partial ARN, then those characters cause Secrets Manager to assume that you’re
|
||
* specifying a complete ARN. This confusion can cause unexpected results. To avoid
|
||
* this situation, we recommend that you don’t create secret names ending with a
|
||
* hyphen followed by six characters.</p> <p>If you specify an incomplete ARN
|
||
* without the random suffix, and instead provide the 'friendly name', you
|
||
* <i>must</i> not include the random suffix. If you do include the random suffix
|
||
* added by Secrets Manager, you receive either a <i>ResourceNotFoundException</i>
|
||
* or an <i>AccessDeniedException</i> error, depending on your permissions.</p>
|
||
*
|
||
*/
|
||
inline void SetSecretId(const char* value) { m_secretIdHasBeenSet = true; m_secretId.assign(value); }
|
||
|
||
/**
|
||
* <p>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.</p> <p>If you specify an ARN, we generally recommend that you
|
||
* specify a complete ARN. You can specify a partial ARN too—for example, if you
|
||
* don’t include the final hyphen and six random characters that Secrets Manager
|
||
* adds at the end of the ARN when you created the secret. A partial ARN match can
|
||
* work as long as it uniquely matches only one secret. However, if your secret has
|
||
* a name that ends in a hyphen followed by six characters (before Secrets Manager
|
||
* adds the hyphen and six characters to the ARN) and you try to use that as a
|
||
* partial ARN, then those characters cause Secrets Manager to assume that you’re
|
||
* specifying a complete ARN. This confusion can cause unexpected results. To avoid
|
||
* this situation, we recommend that you don’t create secret names ending with a
|
||
* hyphen followed by six characters.</p> <p>If you specify an incomplete ARN
|
||
* without the random suffix, and instead provide the 'friendly name', you
|
||
* <i>must</i> not include the random suffix. If you do include the random suffix
|
||
* added by Secrets Manager, you receive either a <i>ResourceNotFoundException</i>
|
||
* or an <i>AccessDeniedException</i> error, depending on your permissions.</p>
|
||
*
|
||
*/
|
||
inline GetSecretValueRequest& WithSecretId(const Aws::String& value) { SetSecretId(value); return *this;}
|
||
|
||
/**
|
||
* <p>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.</p> <p>If you specify an ARN, we generally recommend that you
|
||
* specify a complete ARN. You can specify a partial ARN too—for example, if you
|
||
* don’t include the final hyphen and six random characters that Secrets Manager
|
||
* adds at the end of the ARN when you created the secret. A partial ARN match can
|
||
* work as long as it uniquely matches only one secret. However, if your secret has
|
||
* a name that ends in a hyphen followed by six characters (before Secrets Manager
|
||
* adds the hyphen and six characters to the ARN) and you try to use that as a
|
||
* partial ARN, then those characters cause Secrets Manager to assume that you’re
|
||
* specifying a complete ARN. This confusion can cause unexpected results. To avoid
|
||
* this situation, we recommend that you don’t create secret names ending with a
|
||
* hyphen followed by six characters.</p> <p>If you specify an incomplete ARN
|
||
* without the random suffix, and instead provide the 'friendly name', you
|
||
* <i>must</i> not include the random suffix. If you do include the random suffix
|
||
* added by Secrets Manager, you receive either a <i>ResourceNotFoundException</i>
|
||
* or an <i>AccessDeniedException</i> error, depending on your permissions.</p>
|
||
*
|
||
*/
|
||
inline GetSecretValueRequest& WithSecretId(Aws::String&& value) { SetSecretId(std::move(value)); return *this;}
|
||
|
||
/**
|
||
* <p>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.</p> <p>If you specify an ARN, we generally recommend that you
|
||
* specify a complete ARN. You can specify a partial ARN too—for example, if you
|
||
* don’t include the final hyphen and six random characters that Secrets Manager
|
||
* adds at the end of the ARN when you created the secret. A partial ARN match can
|
||
* work as long as it uniquely matches only one secret. However, if your secret has
|
||
* a name that ends in a hyphen followed by six characters (before Secrets Manager
|
||
* adds the hyphen and six characters to the ARN) and you try to use that as a
|
||
* partial ARN, then those characters cause Secrets Manager to assume that you’re
|
||
* specifying a complete ARN. This confusion can cause unexpected results. To avoid
|
||
* this situation, we recommend that you don’t create secret names ending with a
|
||
* hyphen followed by six characters.</p> <p>If you specify an incomplete ARN
|
||
* without the random suffix, and instead provide the 'friendly name', you
|
||
* <i>must</i> not include the random suffix. If you do include the random suffix
|
||
* added by Secrets Manager, you receive either a <i>ResourceNotFoundException</i>
|
||
* or an <i>AccessDeniedException</i> error, depending on your permissions.</p>
|
||
*
|
||
*/
|
||
inline GetSecretValueRequest& WithSecretId(const char* value) { SetSecretId(value); return *this;}
|
||
|
||
|
||
/**
|
||
* <p>Specifies the unique identifier of the version of the secret that you want to
|
||
* retrieve. If you specify this parameter then don't specify
|
||
* <code>VersionStage</code>. If you don't specify either a
|
||
* <code>VersionStage</code> or <code>VersionId</code> then the default is to
|
||
* perform the operation on the version with the <code>VersionStage</code> value of
|
||
* <code>AWSCURRENT</code>.</p> <p>This value is typically a <a
|
||
* href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID-type</a>
|
||
* value with 32 hexadecimal digits.</p>
|
||
*/
|
||
inline const Aws::String& GetVersionId() const{ return m_versionId; }
|
||
|
||
/**
|
||
* <p>Specifies the unique identifier of the version of the secret that you want to
|
||
* retrieve. If you specify this parameter then don't specify
|
||
* <code>VersionStage</code>. If you don't specify either a
|
||
* <code>VersionStage</code> or <code>VersionId</code> then the default is to
|
||
* perform the operation on the version with the <code>VersionStage</code> value of
|
||
* <code>AWSCURRENT</code>.</p> <p>This value is typically a <a
|
||
* href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID-type</a>
|
||
* value with 32 hexadecimal digits.</p>
|
||
*/
|
||
inline bool VersionIdHasBeenSet() const { return m_versionIdHasBeenSet; }
|
||
|
||
/**
|
||
* <p>Specifies the unique identifier of the version of the secret that you want to
|
||
* retrieve. If you specify this parameter then don't specify
|
||
* <code>VersionStage</code>. If you don't specify either a
|
||
* <code>VersionStage</code> or <code>VersionId</code> then the default is to
|
||
* perform the operation on the version with the <code>VersionStage</code> value of
|
||
* <code>AWSCURRENT</code>.</p> <p>This value is typically a <a
|
||
* href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID-type</a>
|
||
* value with 32 hexadecimal digits.</p>
|
||
*/
|
||
inline void SetVersionId(const Aws::String& value) { m_versionIdHasBeenSet = true; m_versionId = value; }
|
||
|
||
/**
|
||
* <p>Specifies the unique identifier of the version of the secret that you want to
|
||
* retrieve. If you specify this parameter then don't specify
|
||
* <code>VersionStage</code>. If you don't specify either a
|
||
* <code>VersionStage</code> or <code>VersionId</code> then the default is to
|
||
* perform the operation on the version with the <code>VersionStage</code> value of
|
||
* <code>AWSCURRENT</code>.</p> <p>This value is typically a <a
|
||
* href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID-type</a>
|
||
* value with 32 hexadecimal digits.</p>
|
||
*/
|
||
inline void SetVersionId(Aws::String&& value) { m_versionIdHasBeenSet = true; m_versionId = std::move(value); }
|
||
|
||
/**
|
||
* <p>Specifies the unique identifier of the version of the secret that you want to
|
||
* retrieve. If you specify this parameter then don't specify
|
||
* <code>VersionStage</code>. If you don't specify either a
|
||
* <code>VersionStage</code> or <code>VersionId</code> then the default is to
|
||
* perform the operation on the version with the <code>VersionStage</code> value of
|
||
* <code>AWSCURRENT</code>.</p> <p>This value is typically a <a
|
||
* href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID-type</a>
|
||
* value with 32 hexadecimal digits.</p>
|
||
*/
|
||
inline void SetVersionId(const char* value) { m_versionIdHasBeenSet = true; m_versionId.assign(value); }
|
||
|
||
/**
|
||
* <p>Specifies the unique identifier of the version of the secret that you want to
|
||
* retrieve. If you specify this parameter then don't specify
|
||
* <code>VersionStage</code>. If you don't specify either a
|
||
* <code>VersionStage</code> or <code>VersionId</code> then the default is to
|
||
* perform the operation on the version with the <code>VersionStage</code> value of
|
||
* <code>AWSCURRENT</code>.</p> <p>This value is typically a <a
|
||
* href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID-type</a>
|
||
* value with 32 hexadecimal digits.</p>
|
||
*/
|
||
inline GetSecretValueRequest& WithVersionId(const Aws::String& value) { SetVersionId(value); return *this;}
|
||
|
||
/**
|
||
* <p>Specifies the unique identifier of the version of the secret that you want to
|
||
* retrieve. If you specify this parameter then don't specify
|
||
* <code>VersionStage</code>. If you don't specify either a
|
||
* <code>VersionStage</code> or <code>VersionId</code> then the default is to
|
||
* perform the operation on the version with the <code>VersionStage</code> value of
|
||
* <code>AWSCURRENT</code>.</p> <p>This value is typically a <a
|
||
* href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID-type</a>
|
||
* value with 32 hexadecimal digits.</p>
|
||
*/
|
||
inline GetSecretValueRequest& WithVersionId(Aws::String&& value) { SetVersionId(std::move(value)); return *this;}
|
||
|
||
/**
|
||
* <p>Specifies the unique identifier of the version of the secret that you want to
|
||
* retrieve. If you specify this parameter then don't specify
|
||
* <code>VersionStage</code>. If you don't specify either a
|
||
* <code>VersionStage</code> or <code>VersionId</code> then the default is to
|
||
* perform the operation on the version with the <code>VersionStage</code> value of
|
||
* <code>AWSCURRENT</code>.</p> <p>This value is typically a <a
|
||
* href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID-type</a>
|
||
* value with 32 hexadecimal digits.</p>
|
||
*/
|
||
inline GetSecretValueRequest& WithVersionId(const char* value) { SetVersionId(value); return *this;}
|
||
|
||
|
||
/**
|
||
* <p>Specifies the secret version that you want to retrieve by the staging label
|
||
* attached to the version.</p> <p>Staging labels are used to keep track of
|
||
* different versions during the rotation process. If you use this parameter then
|
||
* don't specify <code>VersionId</code>. If you don't specify either a
|
||
* <code>VersionStage</code> or <code>VersionId</code>, then the default is to
|
||
* perform the operation on the version with the <code>VersionStage</code> value of
|
||
* <code>AWSCURRENT</code>.</p>
|
||
*/
|
||
inline const Aws::String& GetVersionStage() const{ return m_versionStage; }
|
||
|
||
/**
|
||
* <p>Specifies the secret version that you want to retrieve by the staging label
|
||
* attached to the version.</p> <p>Staging labels are used to keep track of
|
||
* different versions during the rotation process. If you use this parameter then
|
||
* don't specify <code>VersionId</code>. If you don't specify either a
|
||
* <code>VersionStage</code> or <code>VersionId</code>, then the default is to
|
||
* perform the operation on the version with the <code>VersionStage</code> value of
|
||
* <code>AWSCURRENT</code>.</p>
|
||
*/
|
||
inline bool VersionStageHasBeenSet() const { return m_versionStageHasBeenSet; }
|
||
|
||
/**
|
||
* <p>Specifies the secret version that you want to retrieve by the staging label
|
||
* attached to the version.</p> <p>Staging labels are used to keep track of
|
||
* different versions during the rotation process. If you use this parameter then
|
||
* don't specify <code>VersionId</code>. If you don't specify either a
|
||
* <code>VersionStage</code> or <code>VersionId</code>, then the default is to
|
||
* perform the operation on the version with the <code>VersionStage</code> value of
|
||
* <code>AWSCURRENT</code>.</p>
|
||
*/
|
||
inline void SetVersionStage(const Aws::String& value) { m_versionStageHasBeenSet = true; m_versionStage = value; }
|
||
|
||
/**
|
||
* <p>Specifies the secret version that you want to retrieve by the staging label
|
||
* attached to the version.</p> <p>Staging labels are used to keep track of
|
||
* different versions during the rotation process. If you use this parameter then
|
||
* don't specify <code>VersionId</code>. If you don't specify either a
|
||
* <code>VersionStage</code> or <code>VersionId</code>, then the default is to
|
||
* perform the operation on the version with the <code>VersionStage</code> value of
|
||
* <code>AWSCURRENT</code>.</p>
|
||
*/
|
||
inline void SetVersionStage(Aws::String&& value) { m_versionStageHasBeenSet = true; m_versionStage = std::move(value); }
|
||
|
||
/**
|
||
* <p>Specifies the secret version that you want to retrieve by the staging label
|
||
* attached to the version.</p> <p>Staging labels are used to keep track of
|
||
* different versions during the rotation process. If you use this parameter then
|
||
* don't specify <code>VersionId</code>. If you don't specify either a
|
||
* <code>VersionStage</code> or <code>VersionId</code>, then the default is to
|
||
* perform the operation on the version with the <code>VersionStage</code> value of
|
||
* <code>AWSCURRENT</code>.</p>
|
||
*/
|
||
inline void SetVersionStage(const char* value) { m_versionStageHasBeenSet = true; m_versionStage.assign(value); }
|
||
|
||
/**
|
||
* <p>Specifies the secret version that you want to retrieve by the staging label
|
||
* attached to the version.</p> <p>Staging labels are used to keep track of
|
||
* different versions during the rotation process. If you use this parameter then
|
||
* don't specify <code>VersionId</code>. If you don't specify either a
|
||
* <code>VersionStage</code> or <code>VersionId</code>, then the default is to
|
||
* perform the operation on the version with the <code>VersionStage</code> value of
|
||
* <code>AWSCURRENT</code>.</p>
|
||
*/
|
||
inline GetSecretValueRequest& WithVersionStage(const Aws::String& value) { SetVersionStage(value); return *this;}
|
||
|
||
/**
|
||
* <p>Specifies the secret version that you want to retrieve by the staging label
|
||
* attached to the version.</p> <p>Staging labels are used to keep track of
|
||
* different versions during the rotation process. If you use this parameter then
|
||
* don't specify <code>VersionId</code>. If you don't specify either a
|
||
* <code>VersionStage</code> or <code>VersionId</code>, then the default is to
|
||
* perform the operation on the version with the <code>VersionStage</code> value of
|
||
* <code>AWSCURRENT</code>.</p>
|
||
*/
|
||
inline GetSecretValueRequest& WithVersionStage(Aws::String&& value) { SetVersionStage(std::move(value)); return *this;}
|
||
|
||
/**
|
||
* <p>Specifies the secret version that you want to retrieve by the staging label
|
||
* attached to the version.</p> <p>Staging labels are used to keep track of
|
||
* different versions during the rotation process. If you use this parameter then
|
||
* don't specify <code>VersionId</code>. If you don't specify either a
|
||
* <code>VersionStage</code> or <code>VersionId</code>, then the default is to
|
||
* perform the operation on the version with the <code>VersionStage</code> value of
|
||
* <code>AWSCURRENT</code>.</p>
|
||
*/
|
||
inline GetSecretValueRequest& WithVersionStage(const char* value) { SetVersionStage(value); return *this;}
|
||
|
||
private:
|
||
|
||
Aws::String m_secretId;
|
||
bool m_secretIdHasBeenSet;
|
||
|
||
Aws::String m_versionId;
|
||
bool m_versionIdHasBeenSet;
|
||
|
||
Aws::String m_versionStage;
|
||
bool m_versionStageHasBeenSet;
|
||
};
|
||
|
||
} // namespace Model
|
||
} // namespace SecretsManager
|
||
} // namespace Aws
|