AWS SDK for C++  1.9.130
AWS SDK for C++
Public Member Functions | List of all members
Aws::APIGateway::Model::ClientCertificate Class Reference

#include <ClientCertificate.h>

Public Member Functions

 ClientCertificate ()
 
 ClientCertificate (Aws::Utils::Json::JsonView jsonValue)
 
ClientCertificateoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetClientCertificateId () const
 
bool ClientCertificateIdHasBeenSet () const
 
void SetClientCertificateId (const Aws::String &value)
 
void SetClientCertificateId (Aws::String &&value)
 
void SetClientCertificateId (const char *value)
 
ClientCertificateWithClientCertificateId (const Aws::String &value)
 
ClientCertificateWithClientCertificateId (Aws::String &&value)
 
ClientCertificateWithClientCertificateId (const char *value)
 
const Aws::StringGetDescription () const
 
bool DescriptionHasBeenSet () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
ClientCertificateWithDescription (const Aws::String &value)
 
ClientCertificateWithDescription (Aws::String &&value)
 
ClientCertificateWithDescription (const char *value)
 
const Aws::StringGetPemEncodedCertificate () const
 
bool PemEncodedCertificateHasBeenSet () const
 
void SetPemEncodedCertificate (const Aws::String &value)
 
void SetPemEncodedCertificate (Aws::String &&value)
 
void SetPemEncodedCertificate (const char *value)
 
ClientCertificateWithPemEncodedCertificate (const Aws::String &value)
 
ClientCertificateWithPemEncodedCertificate (Aws::String &&value)
 
ClientCertificateWithPemEncodedCertificate (const char *value)
 
const Aws::Utils::DateTimeGetCreatedDate () const
 
bool CreatedDateHasBeenSet () const
 
void SetCreatedDate (const Aws::Utils::DateTime &value)
 
void SetCreatedDate (Aws::Utils::DateTime &&value)
 
ClientCertificateWithCreatedDate (const Aws::Utils::DateTime &value)
 
ClientCertificateWithCreatedDate (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetExpirationDate () const
 
bool ExpirationDateHasBeenSet () const
 
void SetExpirationDate (const Aws::Utils::DateTime &value)
 
void SetExpirationDate (Aws::Utils::DateTime &&value)
 
ClientCertificateWithExpirationDate (const Aws::Utils::DateTime &value)
 
ClientCertificateWithExpirationDate (Aws::Utils::DateTime &&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)
 
ClientCertificateWithTags (const Aws::Map< Aws::String, Aws::String > &value)
 
ClientCertificateWithTags (Aws::Map< Aws::String, Aws::String > &&value)
 
ClientCertificateAddTags (const Aws::String &key, const Aws::String &value)
 
ClientCertificateAddTags (Aws::String &&key, const Aws::String &value)
 
ClientCertificateAddTags (const Aws::String &key, Aws::String &&value)
 
ClientCertificateAddTags (Aws::String &&key, Aws::String &&value)
 
ClientCertificateAddTags (const char *key, Aws::String &&value)
 
ClientCertificateAddTags (Aws::String &&key, const char *value)
 
ClientCertificateAddTags (const char *key, const char *value)
 

Detailed Description

Represents a client certificate used to configure client-side SSL authentication while sending requests to the integration endpoint.

Client certificates are used to authenticate an API by the backend server. To authenticate an API client (or user), use IAM roles and policies, a custom Authorizer or an Amazon Cognito user pool.

See Also:

AWS API Reference

Definition at line 40 of file ClientCertificate.h.

Constructor & Destructor Documentation

◆ ClientCertificate() [1/2]

Aws::APIGateway::Model::ClientCertificate::ClientCertificate ( )

◆ ClientCertificate() [2/2]

Aws::APIGateway::Model::ClientCertificate::ClientCertificate ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddTags() [1/7]

ClientCertificate& Aws::APIGateway::Model::ClientCertificate::AddTags ( Aws::String &&  key,
Aws::String &&  value 
)
inline

The collection of tags. Each tag element is associated with a given resource.

Definition at line 300 of file ClientCertificate.h.

◆ AddTags() [2/7]

ClientCertificate& Aws::APIGateway::Model::ClientCertificate::AddTags ( Aws::String &&  key,
const Aws::String value 
)
inline

The collection of tags. Each tag element is associated with a given resource.

Definition at line 288 of file ClientCertificate.h.

◆ AddTags() [3/7]

ClientCertificate& Aws::APIGateway::Model::ClientCertificate::AddTags ( Aws::String &&  key,
const char *  value 
)
inline

The collection of tags. Each tag element is associated with a given resource.

Definition at line 312 of file ClientCertificate.h.

◆ AddTags() [4/7]

ClientCertificate& Aws::APIGateway::Model::ClientCertificate::AddTags ( const Aws::String key,
Aws::String &&  value 
)
inline

The collection of tags. Each tag element is associated with a given resource.

Definition at line 294 of file ClientCertificate.h.

◆ AddTags() [5/7]

ClientCertificate& Aws::APIGateway::Model::ClientCertificate::AddTags ( const Aws::String key,
const Aws::String value 
)
inline

The collection of tags. Each tag element is associated with a given resource.

Definition at line 282 of file ClientCertificate.h.

◆ AddTags() [6/7]

ClientCertificate& Aws::APIGateway::Model::ClientCertificate::AddTags ( const char *  key,
Aws::String &&  value 
)
inline

The collection of tags. Each tag element is associated with a given resource.

Definition at line 306 of file ClientCertificate.h.

◆ AddTags() [7/7]

ClientCertificate& Aws::APIGateway::Model::ClientCertificate::AddTags ( const char *  key,
const char *  value 
)
inline

The collection of tags. Each tag element is associated with a given resource.

Definition at line 318 of file ClientCertificate.h.

◆ ClientCertificateIdHasBeenSet()

bool Aws::APIGateway::Model::ClientCertificate::ClientCertificateIdHasBeenSet ( ) const
inline

The identifier of the client certificate.

Definition at line 57 of file ClientCertificate.h.

◆ CreatedDateHasBeenSet()

bool Aws::APIGateway::Model::ClientCertificate::CreatedDateHasBeenSet ( ) const
inline

The timestamp when the client certificate was created.

Definition at line 188 of file ClientCertificate.h.

◆ DescriptionHasBeenSet()

bool Aws::APIGateway::Model::ClientCertificate::DescriptionHasBeenSet ( ) const
inline

The description of the client certificate.

Definition at line 98 of file ClientCertificate.h.

◆ ExpirationDateHasBeenSet()

bool Aws::APIGateway::Model::ClientCertificate::ExpirationDateHasBeenSet ( ) const
inline

The timestamp when the client certificate will expire.

Definition at line 219 of file ClientCertificate.h.

◆ GetClientCertificateId()

const Aws::String& Aws::APIGateway::Model::ClientCertificate::GetClientCertificateId ( ) const
inline

The identifier of the client certificate.

Definition at line 52 of file ClientCertificate.h.

◆ GetCreatedDate()

const Aws::Utils::DateTime& Aws::APIGateway::Model::ClientCertificate::GetCreatedDate ( ) const
inline

The timestamp when the client certificate was created.

Definition at line 183 of file ClientCertificate.h.

◆ GetDescription()

const Aws::String& Aws::APIGateway::Model::ClientCertificate::GetDescription ( ) const
inline

The description of the client certificate.

Definition at line 93 of file ClientCertificate.h.

◆ GetExpirationDate()

const Aws::Utils::DateTime& Aws::APIGateway::Model::ClientCertificate::GetExpirationDate ( ) const
inline

The timestamp when the client certificate will expire.

Definition at line 214 of file ClientCertificate.h.

◆ GetPemEncodedCertificate()

const Aws::String& Aws::APIGateway::Model::ClientCertificate::GetPemEncodedCertificate ( ) const
inline

The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint .

Definition at line 135 of file ClientCertificate.h.

◆ GetTags()

const Aws::Map<Aws::String, Aws::String>& Aws::APIGateway::Model::ClientCertificate::GetTags ( ) const
inline

The collection of tags. Each tag element is associated with a given resource.

Definition at line 246 of file ClientCertificate.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::APIGateway::Model::ClientCertificate::Jsonize ( ) const

◆ operator=()

ClientCertificate& Aws::APIGateway::Model::ClientCertificate::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ PemEncodedCertificateHasBeenSet()

bool Aws::APIGateway::Model::ClientCertificate::PemEncodedCertificateHasBeenSet ( ) const
inline

The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint .

Definition at line 141 of file ClientCertificate.h.

◆ SetClientCertificateId() [1/3]

void Aws::APIGateway::Model::ClientCertificate::SetClientCertificateId ( Aws::String &&  value)
inline

The identifier of the client certificate.

Definition at line 67 of file ClientCertificate.h.

◆ SetClientCertificateId() [2/3]

void Aws::APIGateway::Model::ClientCertificate::SetClientCertificateId ( const Aws::String value)
inline

The identifier of the client certificate.

Definition at line 62 of file ClientCertificate.h.

◆ SetClientCertificateId() [3/3]

void Aws::APIGateway::Model::ClientCertificate::SetClientCertificateId ( const char *  value)
inline

The identifier of the client certificate.

Definition at line 72 of file ClientCertificate.h.

◆ SetCreatedDate() [1/2]

void Aws::APIGateway::Model::ClientCertificate::SetCreatedDate ( Aws::Utils::DateTime &&  value)
inline

The timestamp when the client certificate was created.

Definition at line 198 of file ClientCertificate.h.

◆ SetCreatedDate() [2/2]

void Aws::APIGateway::Model::ClientCertificate::SetCreatedDate ( const Aws::Utils::DateTime value)
inline

The timestamp when the client certificate was created.

Definition at line 193 of file ClientCertificate.h.

◆ SetDescription() [1/3]

void Aws::APIGateway::Model::ClientCertificate::SetDescription ( Aws::String &&  value)
inline

The description of the client certificate.

Definition at line 108 of file ClientCertificate.h.

◆ SetDescription() [2/3]

void Aws::APIGateway::Model::ClientCertificate::SetDescription ( const Aws::String value)
inline

The description of the client certificate.

Definition at line 103 of file ClientCertificate.h.

◆ SetDescription() [3/3]

void Aws::APIGateway::Model::ClientCertificate::SetDescription ( const char *  value)
inline

The description of the client certificate.

Definition at line 113 of file ClientCertificate.h.

◆ SetExpirationDate() [1/2]

void Aws::APIGateway::Model::ClientCertificate::SetExpirationDate ( Aws::Utils::DateTime &&  value)
inline

The timestamp when the client certificate will expire.

Definition at line 229 of file ClientCertificate.h.

◆ SetExpirationDate() [2/2]

void Aws::APIGateway::Model::ClientCertificate::SetExpirationDate ( const Aws::Utils::DateTime value)
inline

The timestamp when the client certificate will expire.

Definition at line 224 of file ClientCertificate.h.

◆ SetPemEncodedCertificate() [1/3]

void Aws::APIGateway::Model::ClientCertificate::SetPemEncodedCertificate ( Aws::String &&  value)
inline

The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint .

Definition at line 153 of file ClientCertificate.h.

◆ SetPemEncodedCertificate() [2/3]

void Aws::APIGateway::Model::ClientCertificate::SetPemEncodedCertificate ( const Aws::String value)
inline

The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint .

Definition at line 147 of file ClientCertificate.h.

◆ SetPemEncodedCertificate() [3/3]

void Aws::APIGateway::Model::ClientCertificate::SetPemEncodedCertificate ( const char *  value)
inline

The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint .

Definition at line 159 of file ClientCertificate.h.

◆ SetTags() [1/2]

void Aws::APIGateway::Model::ClientCertificate::SetTags ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

The collection of tags. Each tag element is associated with a given resource.

Definition at line 264 of file ClientCertificate.h.

◆ SetTags() [2/2]

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

The collection of tags. Each tag element is associated with a given resource.

Definition at line 258 of file ClientCertificate.h.

◆ TagsHasBeenSet()

bool Aws::APIGateway::Model::ClientCertificate::TagsHasBeenSet ( ) const
inline

The collection of tags. Each tag element is associated with a given resource.

Definition at line 252 of file ClientCertificate.h.

◆ WithClientCertificateId() [1/3]

ClientCertificate& Aws::APIGateway::Model::ClientCertificate::WithClientCertificateId ( Aws::String &&  value)
inline

The identifier of the client certificate.

Definition at line 82 of file ClientCertificate.h.

◆ WithClientCertificateId() [2/3]

ClientCertificate& Aws::APIGateway::Model::ClientCertificate::WithClientCertificateId ( const Aws::String value)
inline

The identifier of the client certificate.

Definition at line 77 of file ClientCertificate.h.

◆ WithClientCertificateId() [3/3]

ClientCertificate& Aws::APIGateway::Model::ClientCertificate::WithClientCertificateId ( const char *  value)
inline

The identifier of the client certificate.

Definition at line 87 of file ClientCertificate.h.

◆ WithCreatedDate() [1/2]

ClientCertificate& Aws::APIGateway::Model::ClientCertificate::WithCreatedDate ( Aws::Utils::DateTime &&  value)
inline

The timestamp when the client certificate was created.

Definition at line 208 of file ClientCertificate.h.

◆ WithCreatedDate() [2/2]

ClientCertificate& Aws::APIGateway::Model::ClientCertificate::WithCreatedDate ( const Aws::Utils::DateTime value)
inline

The timestamp when the client certificate was created.

Definition at line 203 of file ClientCertificate.h.

◆ WithDescription() [1/3]

ClientCertificate& Aws::APIGateway::Model::ClientCertificate::WithDescription ( Aws::String &&  value)
inline

The description of the client certificate.

Definition at line 123 of file ClientCertificate.h.

◆ WithDescription() [2/3]

ClientCertificate& Aws::APIGateway::Model::ClientCertificate::WithDescription ( const Aws::String value)
inline

The description of the client certificate.

Definition at line 118 of file ClientCertificate.h.

◆ WithDescription() [3/3]

ClientCertificate& Aws::APIGateway::Model::ClientCertificate::WithDescription ( const char *  value)
inline

The description of the client certificate.

Definition at line 128 of file ClientCertificate.h.

◆ WithExpirationDate() [1/2]

ClientCertificate& Aws::APIGateway::Model::ClientCertificate::WithExpirationDate ( Aws::Utils::DateTime &&  value)
inline

The timestamp when the client certificate will expire.

Definition at line 239 of file ClientCertificate.h.

◆ WithExpirationDate() [2/2]

ClientCertificate& Aws::APIGateway::Model::ClientCertificate::WithExpirationDate ( const Aws::Utils::DateTime value)
inline

The timestamp when the client certificate will expire.

Definition at line 234 of file ClientCertificate.h.

◆ WithPemEncodedCertificate() [1/3]

ClientCertificate& Aws::APIGateway::Model::ClientCertificate::WithPemEncodedCertificate ( Aws::String &&  value)
inline

The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint .

Definition at line 171 of file ClientCertificate.h.

◆ WithPemEncodedCertificate() [2/3]

ClientCertificate& Aws::APIGateway::Model::ClientCertificate::WithPemEncodedCertificate ( const Aws::String value)
inline

The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint .

Definition at line 165 of file ClientCertificate.h.

◆ WithPemEncodedCertificate() [3/3]

ClientCertificate& Aws::APIGateway::Model::ClientCertificate::WithPemEncodedCertificate ( const char *  value)
inline

The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint .

Definition at line 177 of file ClientCertificate.h.

◆ WithTags() [1/2]

ClientCertificate& Aws::APIGateway::Model::ClientCertificate::WithTags ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

The collection of tags. Each tag element is associated with a given resource.

Definition at line 276 of file ClientCertificate.h.

◆ WithTags() [2/2]

ClientCertificate& Aws::APIGateway::Model::ClientCertificate::WithTags ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

The collection of tags. Each tag element is associated with a given resource.

Definition at line 270 of file ClientCertificate.h.


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