AWS IoT Device SDK C++ v2 1.44.1
AWS IoT Device SDK C++ v2
Loading...
Searching...
No Matches
Aws::Greengrass::GetSecretValueRequest Class Reference

#include <GreengrassCoreIpcModel.h>

Inheritance diagram for Aws::Greengrass::GetSecretValueRequest:
Aws::Eventstreamrpc::AbstractShapeBase

Public Member Functions

 GetSecretValueRequest () noexcept
 GetSecretValueRequest (const GetSecretValueRequest &)=default
void SetSecretId (const Aws::Crt::String &secretId) noexcept
Aws::Crt::Optional< Aws::Crt::StringGetSecretId () const noexcept
void SetVersionId (const Aws::Crt::String &versionId) noexcept
Aws::Crt::Optional< Aws::Crt::StringGetVersionId () const noexcept
void SetVersionStage (const Aws::Crt::String &versionStage) noexcept
Aws::Crt::Optional< Aws::Crt::StringGetVersionStage () const noexcept
void SetRefresh (const bool &refresh) noexcept
Aws::Crt::Optional< bool > GetRefresh () const noexcept
void SerializeToJsonObject (Aws::Crt::JsonObject &payloadObject) const noexcept override
bool operator< (const GetSecretValueRequest &) const noexcept
Public Member Functions inherited from Aws::Eventstreamrpc::AbstractShapeBase
 AbstractShapeBase () noexcept
virtual ~AbstractShapeBase () noexcept=default

Static Public Member Functions

static void s_loadFromJsonView (GetSecretValueRequest &, const Aws::Crt::JsonView &) noexcept
static Aws::Crt::ScopedResource< AbstractShapeBases_allocateFromPayload (Aws::Crt::StringView, Aws::Crt::Allocator *) noexcept
static void s_customDeleter (GetSecretValueRequest *) noexcept
Static Public Member Functions inherited from Aws::Eventstreamrpc::AbstractShapeBase
static void s_customDeleter (AbstractShapeBase *shape) noexcept

Static Public Attributes

static const char * MODEL_NAME = "aws.greengrass#GetSecretValueRequest"

Protected Member Functions

Aws::Crt::String GetModelName () const noexcept override

Additional Inherited Members

Protected Attributes inherited from Aws::Eventstreamrpc::AbstractShapeBase
Crt::Allocatorm_allocator

Constructor & Destructor Documentation

◆ GetSecretValueRequest() [1/2]

Aws::Greengrass::GetSecretValueRequest::GetSecretValueRequest ( )
inlinenoexcept

◆ GetSecretValueRequest() [2/2]

Aws::Greengrass::GetSecretValueRequest::GetSecretValueRequest ( const GetSecretValueRequest & )
default

Member Function Documentation

◆ GetModelName()

Aws::Crt::String Aws::Greengrass::GetSecretValueRequest::GetModelName ( ) const
overrideprotectedvirtualnoexcept

◆ GetRefresh()

Aws::Crt::Optional< bool > Aws::Greengrass::GetSecretValueRequest::GetRefresh ( ) const
inlinenoexcept

(Optional) Whether to fetch the latest secret from cloud when the request is handled. Defaults to false.

◆ GetSecretId()

Aws::Crt::Optional< Aws::Crt::String > Aws::Greengrass::GetSecretValueRequest::GetSecretId ( ) const
inlinenoexcept

The name of the secret to get. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

◆ GetVersionId()

Aws::Crt::Optional< Aws::Crt::String > Aws::Greengrass::GetSecretValueRequest::GetVersionId ( ) const
inlinenoexcept

(Optional) The ID of the version to get. If you don't specify versionId or versionStage, this operation defaults to the version with the AWSCURRENT label.

◆ GetVersionStage()

Aws::Crt::Optional< Aws::Crt::String > Aws::Greengrass::GetSecretValueRequest::GetVersionStage ( ) const
inlinenoexcept

(Optional) The staging label of the version to get. If you don't specify versionId or versionStage, this operation defaults to the version with the AWSCURRENT label.

◆ operator<()

bool Aws::Greengrass::GetSecretValueRequest::operator< ( const GetSecretValueRequest & ) const
noexcept

◆ s_allocateFromPayload()

Aws::Crt::ScopedResource< AbstractShapeBase > Aws::Greengrass::GetSecretValueRequest::s_allocateFromPayload ( Aws::Crt::StringView stringView,
Aws::Crt::Allocator * allocator )
staticnoexcept

◆ s_customDeleter()

void Aws::Greengrass::GetSecretValueRequest::s_customDeleter ( GetSecretValueRequest * shape)
staticnoexcept

◆ s_loadFromJsonView()

void Aws::Greengrass::GetSecretValueRequest::s_loadFromJsonView ( GetSecretValueRequest & getSecretValueRequest,
const Aws::Crt::JsonView & jsonView )
staticnoexcept

◆ SerializeToJsonObject()

void Aws::Greengrass::GetSecretValueRequest::SerializeToJsonObject ( Aws::Crt::JsonObject & payloadObject) const
overridevirtualnoexcept

◆ SetRefresh()

void Aws::Greengrass::GetSecretValueRequest::SetRefresh ( const bool & refresh)
inlinenoexcept

(Optional) Whether to fetch the latest secret from cloud when the request is handled. Defaults to false.

◆ SetSecretId()

void Aws::Greengrass::GetSecretValueRequest::SetSecretId ( const Aws::Crt::String & secretId)
inlinenoexcept

The name of the secret to get. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

◆ SetVersionId()

void Aws::Greengrass::GetSecretValueRequest::SetVersionId ( const Aws::Crt::String & versionId)
inlinenoexcept

(Optional) The ID of the version to get. If you don't specify versionId or versionStage, this operation defaults to the version with the AWSCURRENT label.

◆ SetVersionStage()

void Aws::Greengrass::GetSecretValueRequest::SetVersionStage ( const Aws::Crt::String & versionStage)
inlinenoexcept

(Optional) The staging label of the version to get. If you don't specify versionId or versionStage, this operation defaults to the version with the AWSCURRENT label.

Member Data Documentation

◆ MODEL_NAME

const char * Aws::Greengrass::GetSecretValueRequest::MODEL_NAME = "aws.greengrass#GetSecretValueRequest"
static

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