AWS SDK for C++  1.9.69
AWS SDK for C++
Public Member Functions | List of all members
Aws::XRay::Model::PutEncryptionConfigRequest Class Reference

#include <PutEncryptionConfigRequest.h>

+ Inheritance diagram for Aws::XRay::Model::PutEncryptionConfigRequest:

Public Member Functions

 PutEncryptionConfigRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetKeyId () const
 
bool KeyIdHasBeenSet () const
 
void SetKeyId (const Aws::String &value)
 
void SetKeyId (Aws::String &&value)
 
void SetKeyId (const char *value)
 
PutEncryptionConfigRequestWithKeyId (const Aws::String &value)
 
PutEncryptionConfigRequestWithKeyId (Aws::String &&value)
 
PutEncryptionConfigRequestWithKeyId (const char *value)
 
const EncryptionTypeGetType () const
 
bool TypeHasBeenSet () const
 
void SetType (const EncryptionType &value)
 
void SetType (EncryptionType &&value)
 
PutEncryptionConfigRequestWithType (const EncryptionType &value)
 
PutEncryptionConfigRequestWithType (EncryptionType &&value)
 
- Public Member Functions inherited from Aws::XRay::XRayRequest
virtual ~XRayRequest ()
 
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::XRay::XRayRequest
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 22 of file PutEncryptionConfigRequest.h.

Constructor & Destructor Documentation

◆ PutEncryptionConfigRequest()

Aws::XRay::Model::PutEncryptionConfigRequest::PutEncryptionConfigRequest ( )

Member Function Documentation

◆ GetKeyId()

const Aws::String& Aws::XRay::Model::PutEncryptionConfigRequest::GetKeyId ( ) const
inline

An AWS KMS customer master key (CMK) in one of the following formats:

  • Alias - The name of the key. For example, alias/MyKey.

  • Key ID - The KMS key ID of the key. For example, ae4aa6d49-a4d8-9df9-a475-4ff6d7898456. AWS X-Ray does not support asymmetric CMKs.

  • ARN - The full Amazon Resource Name of the key ID or alias. For example, arn:aws:kms:us-east-2:123456789012:key/ae4aa6d49-a4d8-9df9-a475-4ff6d7898456. Use this format to specify a key in a different account.

Omit this key if you set Type to NONE.

Definition at line 47 of file PutEncryptionConfigRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::XRay::Model::PutEncryptionConfigRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 31 of file PutEncryptionConfigRequest.h.

◆ GetType()

const EncryptionType& Aws::XRay::Model::PutEncryptionConfigRequest::GetType ( ) const
inline

The type of encryption. Set to KMS to use your own key for encryption. Set to NONE for default encryption.

Definition at line 145 of file PutEncryptionConfigRequest.h.

◆ KeyIdHasBeenSet()

bool Aws::XRay::Model::PutEncryptionConfigRequest::KeyIdHasBeenSet ( ) const
inline

An AWS KMS customer master key (CMK) in one of the following formats:

  • Alias - The name of the key. For example, alias/MyKey.

  • Key ID - The KMS key ID of the key. For example, ae4aa6d49-a4d8-9df9-a475-4ff6d7898456. AWS X-Ray does not support asymmetric CMKs.

  • ARN - The full Amazon Resource Name of the key ID or alias. For example, arn:aws:kms:us-east-2:123456789012:key/ae4aa6d49-a4d8-9df9-a475-4ff6d7898456. Use this format to specify a key in a different account.

Omit this key if you set Type to NONE.

Definition at line 60 of file PutEncryptionConfigRequest.h.

◆ SerializePayload()

Aws::String Aws::XRay::Model::PutEncryptionConfigRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetKeyId() [1/3]

void Aws::XRay::Model::PutEncryptionConfigRequest::SetKeyId ( Aws::String &&  value)
inline

An AWS KMS customer master key (CMK) in one of the following formats:

  • Alias - The name of the key. For example, alias/MyKey.

  • Key ID - The KMS key ID of the key. For example, ae4aa6d49-a4d8-9df9-a475-4ff6d7898456. AWS X-Ray does not support asymmetric CMKs.

  • ARN - The full Amazon Resource Name of the key ID or alias. For example, arn:aws:kms:us-east-2:123456789012:key/ae4aa6d49-a4d8-9df9-a475-4ff6d7898456. Use this format to specify a key in a different account.

Omit this key if you set Type to NONE.

Definition at line 86 of file PutEncryptionConfigRequest.h.

◆ SetKeyId() [2/3]

void Aws::XRay::Model::PutEncryptionConfigRequest::SetKeyId ( const Aws::String value)
inline

An AWS KMS customer master key (CMK) in one of the following formats:

  • Alias - The name of the key. For example, alias/MyKey.

  • Key ID - The KMS key ID of the key. For example, ae4aa6d49-a4d8-9df9-a475-4ff6d7898456. AWS X-Ray does not support asymmetric CMKs.

  • ARN - The full Amazon Resource Name of the key ID or alias. For example, arn:aws:kms:us-east-2:123456789012:key/ae4aa6d49-a4d8-9df9-a475-4ff6d7898456. Use this format to specify a key in a different account.

Omit this key if you set Type to NONE.

Definition at line 73 of file PutEncryptionConfigRequest.h.

◆ SetKeyId() [3/3]

void Aws::XRay::Model::PutEncryptionConfigRequest::SetKeyId ( const char *  value)
inline

An AWS KMS customer master key (CMK) in one of the following formats:

  • Alias - The name of the key. For example, alias/MyKey.

  • Key ID - The KMS key ID of the key. For example, ae4aa6d49-a4d8-9df9-a475-4ff6d7898456. AWS X-Ray does not support asymmetric CMKs.

  • ARN - The full Amazon Resource Name of the key ID or alias. For example, arn:aws:kms:us-east-2:123456789012:key/ae4aa6d49-a4d8-9df9-a475-4ff6d7898456. Use this format to specify a key in a different account.

Omit this key if you set Type to NONE.

Definition at line 99 of file PutEncryptionConfigRequest.h.

◆ SetType() [1/2]

void Aws::XRay::Model::PutEncryptionConfigRequest::SetType ( const EncryptionType value)
inline

The type of encryption. Set to KMS to use your own key for encryption. Set to NONE for default encryption.

Definition at line 157 of file PutEncryptionConfigRequest.h.

◆ SetType() [2/2]

void Aws::XRay::Model::PutEncryptionConfigRequest::SetType ( EncryptionType &&  value)
inline

The type of encryption. Set to KMS to use your own key for encryption. Set to NONE for default encryption.

Definition at line 163 of file PutEncryptionConfigRequest.h.

◆ TypeHasBeenSet()

bool Aws::XRay::Model::PutEncryptionConfigRequest::TypeHasBeenSet ( ) const
inline

The type of encryption. Set to KMS to use your own key for encryption. Set to NONE for default encryption.

Definition at line 151 of file PutEncryptionConfigRequest.h.

◆ WithKeyId() [1/3]

PutEncryptionConfigRequest& Aws::XRay::Model::PutEncryptionConfigRequest::WithKeyId ( Aws::String &&  value)
inline

An AWS KMS customer master key (CMK) in one of the following formats:

  • Alias - The name of the key. For example, alias/MyKey.

  • Key ID - The KMS key ID of the key. For example, ae4aa6d49-a4d8-9df9-a475-4ff6d7898456. AWS X-Ray does not support asymmetric CMKs.

  • ARN - The full Amazon Resource Name of the key ID or alias. For example, arn:aws:kms:us-east-2:123456789012:key/ae4aa6d49-a4d8-9df9-a475-4ff6d7898456. Use this format to specify a key in a different account.

Omit this key if you set Type to NONE.

Definition at line 125 of file PutEncryptionConfigRequest.h.

◆ WithKeyId() [2/3]

PutEncryptionConfigRequest& Aws::XRay::Model::PutEncryptionConfigRequest::WithKeyId ( const Aws::String value)
inline

An AWS KMS customer master key (CMK) in one of the following formats:

  • Alias - The name of the key. For example, alias/MyKey.

  • Key ID - The KMS key ID of the key. For example, ae4aa6d49-a4d8-9df9-a475-4ff6d7898456. AWS X-Ray does not support asymmetric CMKs.

  • ARN - The full Amazon Resource Name of the key ID or alias. For example, arn:aws:kms:us-east-2:123456789012:key/ae4aa6d49-a4d8-9df9-a475-4ff6d7898456. Use this format to specify a key in a different account.

Omit this key if you set Type to NONE.

Definition at line 112 of file PutEncryptionConfigRequest.h.

◆ WithKeyId() [3/3]

PutEncryptionConfigRequest& Aws::XRay::Model::PutEncryptionConfigRequest::WithKeyId ( const char *  value)
inline

An AWS KMS customer master key (CMK) in one of the following formats:

  • Alias - The name of the key. For example, alias/MyKey.

  • Key ID - The KMS key ID of the key. For example, ae4aa6d49-a4d8-9df9-a475-4ff6d7898456. AWS X-Ray does not support asymmetric CMKs.

  • ARN - The full Amazon Resource Name of the key ID or alias. For example, arn:aws:kms:us-east-2:123456789012:key/ae4aa6d49-a4d8-9df9-a475-4ff6d7898456. Use this format to specify a key in a different account.

Omit this key if you set Type to NONE.

Definition at line 138 of file PutEncryptionConfigRequest.h.

◆ WithType() [1/2]

PutEncryptionConfigRequest& Aws::XRay::Model::PutEncryptionConfigRequest::WithType ( const EncryptionType value)
inline

The type of encryption. Set to KMS to use your own key for encryption. Set to NONE for default encryption.

Definition at line 169 of file PutEncryptionConfigRequest.h.

◆ WithType() [2/2]

PutEncryptionConfigRequest& Aws::XRay::Model::PutEncryptionConfigRequest::WithType ( EncryptionType &&  value)
inline

The type of encryption. Set to KMS to use your own key for encryption. Set to NONE for default encryption.

Definition at line 175 of file PutEncryptionConfigRequest.h.


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