AWS SDK for C++  1.9.16
AWS SDK for C++
Public Member Functions | List of all members
Aws::QLDB::Model::CreateLedgerRequest Class Reference

#include <CreateLedgerRequest.h>

+ Inheritance diagram for Aws::QLDB::Model::CreateLedgerRequest:

Public Member Functions

 CreateLedgerRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
CreateLedgerRequestWithName (const Aws::String &value)
 
CreateLedgerRequestWithName (Aws::String &&value)
 
CreateLedgerRequestWithName (const char *value)
 
const Aws::Map< Aws::String, Aws::String > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetTags (Aws::Map< Aws::String, Aws::String > &&value)
 
CreateLedgerRequestWithTags (const Aws::Map< Aws::String, Aws::String > &value)
 
CreateLedgerRequestWithTags (Aws::Map< Aws::String, Aws::String > &&value)
 
CreateLedgerRequestAddTags (const Aws::String &key, const Aws::String &value)
 
CreateLedgerRequestAddTags (Aws::String &&key, const Aws::String &value)
 
CreateLedgerRequestAddTags (const Aws::String &key, Aws::String &&value)
 
CreateLedgerRequestAddTags (Aws::String &&key, Aws::String &&value)
 
CreateLedgerRequestAddTags (const char *key, Aws::String &&value)
 
CreateLedgerRequestAddTags (Aws::String &&key, const char *value)
 
CreateLedgerRequestAddTags (const char *key, const char *value)
 
const PermissionsModeGetPermissionsMode () const
 
bool PermissionsModeHasBeenSet () const
 
void SetPermissionsMode (const PermissionsMode &value)
 
void SetPermissionsMode (PermissionsMode &&value)
 
CreateLedgerRequestWithPermissionsMode (const PermissionsMode &value)
 
CreateLedgerRequestWithPermissionsMode (PermissionsMode &&value)
 
bool GetDeletionProtection () const
 
bool DeletionProtectionHasBeenSet () const
 
void SetDeletionProtection (bool value)
 
CreateLedgerRequestWithDeletionProtection (bool value)
 
- Public Member Functions inherited from Aws::QLDB::QLDBRequest
virtual ~QLDBRequest ()
 
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::QLDB::QLDBRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 
- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 23 of file CreateLedgerRequest.h.

Constructor & Destructor Documentation

◆ CreateLedgerRequest()

Aws::QLDB::Model::CreateLedgerRequest::CreateLedgerRequest ( )

Member Function Documentation

◆ AddTags() [1/7]

CreateLedgerRequest& Aws::QLDB::Model::CreateLedgerRequest::AddTags ( Aws::String &&  key,
Aws::String &&  value 
)
inline

The key-value pairs to add as tags to the ledger that you want to create. Tag keys are case sensitive. Tag values are case sensitive and can be null.

Definition at line 168 of file CreateLedgerRequest.h.

◆ AddTags() [2/7]

CreateLedgerRequest& Aws::QLDB::Model::CreateLedgerRequest::AddTags ( Aws::String &&  key,
const Aws::String value 
)
inline

The key-value pairs to add as tags to the ledger that you want to create. Tag keys are case sensitive. Tag values are case sensitive and can be null.

Definition at line 156 of file CreateLedgerRequest.h.

◆ AddTags() [3/7]

CreateLedgerRequest& Aws::QLDB::Model::CreateLedgerRequest::AddTags ( Aws::String &&  key,
const char *  value 
)
inline

The key-value pairs to add as tags to the ledger that you want to create. Tag keys are case sensitive. Tag values are case sensitive and can be null.

Definition at line 180 of file CreateLedgerRequest.h.

◆ AddTags() [4/7]

CreateLedgerRequest& Aws::QLDB::Model::CreateLedgerRequest::AddTags ( const Aws::String key,
Aws::String &&  value 
)
inline

The key-value pairs to add as tags to the ledger that you want to create. Tag keys are case sensitive. Tag values are case sensitive and can be null.

Definition at line 162 of file CreateLedgerRequest.h.

◆ AddTags() [5/7]

CreateLedgerRequest& Aws::QLDB::Model::CreateLedgerRequest::AddTags ( const Aws::String key,
const Aws::String value 
)
inline

The key-value pairs to add as tags to the ledger that you want to create. Tag keys are case sensitive. Tag values are case sensitive and can be null.

Definition at line 150 of file CreateLedgerRequest.h.

◆ AddTags() [6/7]

CreateLedgerRequest& Aws::QLDB::Model::CreateLedgerRequest::AddTags ( const char *  key,
Aws::String &&  value 
)
inline

The key-value pairs to add as tags to the ledger that you want to create. Tag keys are case sensitive. Tag values are case sensitive and can be null.

Definition at line 174 of file CreateLedgerRequest.h.

◆ AddTags() [7/7]

CreateLedgerRequest& Aws::QLDB::Model::CreateLedgerRequest::AddTags ( const char *  key,
const char *  value 
)
inline

The key-value pairs to add as tags to the ledger that you want to create. Tag keys are case sensitive. Tag values are case sensitive and can be null.

Definition at line 186 of file CreateLedgerRequest.h.

◆ DeletionProtectionHasBeenSet()

bool Aws::QLDB::Model::CreateLedgerRequest::DeletionProtectionHasBeenSet ( ) const
inline

The flag that prevents a ledger from being deleted by any user. If not provided on ledger creation, this feature is enabled (true) by default.

If deletion protection is enabled, you must first disable it before you can delete the ledger using the QLDB API or the AWS Command Line Interface (AWS CLI). You can disable it by calling the UpdateLedger operation to set the flag to false. The QLDB console disables deletion protection for you when you use it to delete a ledger.

Definition at line 240 of file CreateLedgerRequest.h.

◆ GetDeletionProtection()

bool Aws::QLDB::Model::CreateLedgerRequest::GetDeletionProtection ( ) const
inline

The flag that prevents a ledger from being deleted by any user. If not provided on ledger creation, this feature is enabled (true) by default.

If deletion protection is enabled, you must first disable it before you can delete the ledger using the QLDB API or the AWS Command Line Interface (AWS CLI). You can disable it by calling the UpdateLedger operation to set the flag to false. The QLDB console disables deletion protection for you when you use it to delete a ledger.

Definition at line 229 of file CreateLedgerRequest.h.

◆ GetName()

const Aws::String& Aws::QLDB::Model::CreateLedgerRequest::GetName ( ) const
inline

The name of the ledger that you want to create. The name must be unique among all of your ledgers in the current AWS Region.

Naming constraints for ledger names are defined in Quotas in Amazon QLDB in the Amazon QLDB Developer Guide.

Definition at line 44 of file CreateLedgerRequest.h.

◆ GetPermissionsMode()

const PermissionsMode& Aws::QLDB::Model::CreateLedgerRequest::GetPermissionsMode ( ) const
inline

The permissions mode to assign to the ledger that you want to create.

Definition at line 192 of file CreateLedgerRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::QLDB::Model::CreateLedgerRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 32 of file CreateLedgerRequest.h.

◆ GetTags()

const Aws::Map<Aws::String, Aws::String>& Aws::QLDB::Model::CreateLedgerRequest::GetTags ( ) const
inline

The key-value pairs to add as tags to the ledger that you want to create. Tag keys are case sensitive. Tag values are case sensitive and can be null.

Definition at line 114 of file CreateLedgerRequest.h.

◆ NameHasBeenSet()

bool Aws::QLDB::Model::CreateLedgerRequest::NameHasBeenSet ( ) const
inline

The name of the ledger that you want to create. The name must be unique among all of your ledgers in the current AWS Region.

Naming constraints for ledger names are defined in Quotas in Amazon QLDB in the Amazon QLDB Developer Guide.

Definition at line 53 of file CreateLedgerRequest.h.

◆ PermissionsModeHasBeenSet()

bool Aws::QLDB::Model::CreateLedgerRequest::PermissionsModeHasBeenSet ( ) const
inline

The permissions mode to assign to the ledger that you want to create.

Definition at line 197 of file CreateLedgerRequest.h.

◆ SerializePayload()

Aws::String Aws::QLDB::Model::CreateLedgerRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDeletionProtection()

void Aws::QLDB::Model::CreateLedgerRequest::SetDeletionProtection ( bool  value)
inline

The flag that prevents a ledger from being deleted by any user. If not provided on ledger creation, this feature is enabled (true) by default.

If deletion protection is enabled, you must first disable it before you can delete the ledger using the QLDB API or the AWS Command Line Interface (AWS CLI). You can disable it by calling the UpdateLedger operation to set the flag to false. The QLDB console disables deletion protection for you when you use it to delete a ledger.

Definition at line 251 of file CreateLedgerRequest.h.

◆ SetName() [1/3]

void Aws::QLDB::Model::CreateLedgerRequest::SetName ( Aws::String &&  value)
inline

The name of the ledger that you want to create. The name must be unique among all of your ledgers in the current AWS Region.

Naming constraints for ledger names are defined in Quotas in Amazon QLDB in the Amazon QLDB Developer Guide.

Definition at line 71 of file CreateLedgerRequest.h.

◆ SetName() [2/3]

void Aws::QLDB::Model::CreateLedgerRequest::SetName ( const Aws::String value)
inline

The name of the ledger that you want to create. The name must be unique among all of your ledgers in the current AWS Region.

Naming constraints for ledger names are defined in Quotas in Amazon QLDB in the Amazon QLDB Developer Guide.

Definition at line 62 of file CreateLedgerRequest.h.

◆ SetName() [3/3]

void Aws::QLDB::Model::CreateLedgerRequest::SetName ( const char *  value)
inline

The name of the ledger that you want to create. The name must be unique among all of your ledgers in the current AWS Region.

Naming constraints for ledger names are defined in Quotas in Amazon QLDB in the Amazon QLDB Developer Guide.

Definition at line 80 of file CreateLedgerRequest.h.

◆ SetPermissionsMode() [1/2]

void Aws::QLDB::Model::CreateLedgerRequest::SetPermissionsMode ( const PermissionsMode value)
inline

The permissions mode to assign to the ledger that you want to create.

Definition at line 202 of file CreateLedgerRequest.h.

◆ SetPermissionsMode() [2/2]

void Aws::QLDB::Model::CreateLedgerRequest::SetPermissionsMode ( PermissionsMode &&  value)
inline

The permissions mode to assign to the ledger that you want to create.

Definition at line 207 of file CreateLedgerRequest.h.

◆ SetTags() [1/2]

void Aws::QLDB::Model::CreateLedgerRequest::SetTags ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

The key-value pairs to add as tags to the ledger that you want to create. Tag keys are case sensitive. Tag values are case sensitive and can be null.

Definition at line 132 of file CreateLedgerRequest.h.

◆ SetTags() [2/2]

void Aws::QLDB::Model::CreateLedgerRequest::SetTags ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

The key-value pairs to add as tags to the ledger that you want to create. Tag keys are case sensitive. Tag values are case sensitive and can be null.

Definition at line 126 of file CreateLedgerRequest.h.

◆ TagsHasBeenSet()

bool Aws::QLDB::Model::CreateLedgerRequest::TagsHasBeenSet ( ) const
inline

The key-value pairs to add as tags to the ledger that you want to create. Tag keys are case sensitive. Tag values are case sensitive and can be null.

Definition at line 120 of file CreateLedgerRequest.h.

◆ WithDeletionProtection()

CreateLedgerRequest& Aws::QLDB::Model::CreateLedgerRequest::WithDeletionProtection ( bool  value)
inline

The flag that prevents a ledger from being deleted by any user. If not provided on ledger creation, this feature is enabled (true) by default.

If deletion protection is enabled, you must first disable it before you can delete the ledger using the QLDB API or the AWS Command Line Interface (AWS CLI). You can disable it by calling the UpdateLedger operation to set the flag to false. The QLDB console disables deletion protection for you when you use it to delete a ledger.

Definition at line 262 of file CreateLedgerRequest.h.

◆ WithName() [1/3]

CreateLedgerRequest& Aws::QLDB::Model::CreateLedgerRequest::WithName ( Aws::String &&  value)
inline

The name of the ledger that you want to create. The name must be unique among all of your ledgers in the current AWS Region.

Naming constraints for ledger names are defined in Quotas in Amazon QLDB in the Amazon QLDB Developer Guide.

Definition at line 98 of file CreateLedgerRequest.h.

◆ WithName() [2/3]

CreateLedgerRequest& Aws::QLDB::Model::CreateLedgerRequest::WithName ( const Aws::String value)
inline

The name of the ledger that you want to create. The name must be unique among all of your ledgers in the current AWS Region.

Naming constraints for ledger names are defined in Quotas in Amazon QLDB in the Amazon QLDB Developer Guide.

Definition at line 89 of file CreateLedgerRequest.h.

◆ WithName() [3/3]

CreateLedgerRequest& Aws::QLDB::Model::CreateLedgerRequest::WithName ( const char *  value)
inline

The name of the ledger that you want to create. The name must be unique among all of your ledgers in the current AWS Region.

Naming constraints for ledger names are defined in Quotas in Amazon QLDB in the Amazon QLDB Developer Guide.

Definition at line 107 of file CreateLedgerRequest.h.

◆ WithPermissionsMode() [1/2]

CreateLedgerRequest& Aws::QLDB::Model::CreateLedgerRequest::WithPermissionsMode ( const PermissionsMode value)
inline

The permissions mode to assign to the ledger that you want to create.

Definition at line 212 of file CreateLedgerRequest.h.

◆ WithPermissionsMode() [2/2]

CreateLedgerRequest& Aws::QLDB::Model::CreateLedgerRequest::WithPermissionsMode ( PermissionsMode &&  value)
inline

The permissions mode to assign to the ledger that you want to create.

Definition at line 217 of file CreateLedgerRequest.h.

◆ WithTags() [1/2]

CreateLedgerRequest& Aws::QLDB::Model::CreateLedgerRequest::WithTags ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

The key-value pairs to add as tags to the ledger that you want to create. Tag keys are case sensitive. Tag values are case sensitive and can be null.

Definition at line 144 of file CreateLedgerRequest.h.

◆ WithTags() [2/2]

CreateLedgerRequest& Aws::QLDB::Model::CreateLedgerRequest::WithTags ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

The key-value pairs to add as tags to the ledger that you want to create. Tag keys are case sensitive. Tag values are case sensitive and can be null.

Definition at line 138 of file CreateLedgerRequest.h.


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