AWS SDK for C++  1.7.233
AWS SDK for C++
Public Member Functions | Protected Member Functions | List of all members
Aws::EC2::Model::ModifyEbsDefaultKmsKeyIdRequest Class Reference

#include <ModifyEbsDefaultKmsKeyIdRequest.h>

+ Inheritance diagram for Aws::EC2::Model::ModifyEbsDefaultKmsKeyIdRequest:

Public Member Functions

 ModifyEbsDefaultKmsKeyIdRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetKmsKeyId () const
 
bool KmsKeyIdHasBeenSet () const
 
void SetKmsKeyId (const Aws::String &value)
 
void SetKmsKeyId (Aws::String &&value)
 
void SetKmsKeyId (const char *value)
 
ModifyEbsDefaultKmsKeyIdRequestWithKmsKeyId (const Aws::String &value)
 
ModifyEbsDefaultKmsKeyIdRequestWithKmsKeyId (Aws::String &&value)
 
ModifyEbsDefaultKmsKeyIdRequestWithKmsKeyId (const char *value)
 
bool GetDryRun () const
 
bool DryRunHasBeenSet () const
 
void SetDryRun (bool value)
 
ModifyEbsDefaultKmsKeyIdRequestWithDryRun (bool value)
 
- Public Member Functions inherited from Aws::EC2::EC2Request
virtual ~EC2Request ()
 
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
 

Protected Member Functions

void DumpBodyToUrl (Aws::Http::URI &uri) const override
 
- Protected Member Functions inherited from Aws::EC2::EC2Request
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 

Detailed Description

Definition at line 31 of file ModifyEbsDefaultKmsKeyIdRequest.h.

Constructor & Destructor Documentation

◆ ModifyEbsDefaultKmsKeyIdRequest()

Aws::EC2::Model::ModifyEbsDefaultKmsKeyIdRequest::ModifyEbsDefaultKmsKeyIdRequest ( )

Member Function Documentation

◆ DryRunHasBeenSet()

bool Aws::EC2::Model::ModifyEbsDefaultKmsKeyIdRequest::DryRunHasBeenSet ( ) const
inline

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Definition at line 200 of file ModifyEbsDefaultKmsKeyIdRequest.h.

◆ DumpBodyToUrl()

void Aws::EC2::Model::ModifyEbsDefaultKmsKeyIdRequest::DumpBodyToUrl ( Aws::Http::URI uri) const
overrideprotectedvirtual

Default does nothing. Override this to convert what would otherwise be the payload of the request to a query string format.

Reimplemented from Aws::AmazonWebServiceRequest.

◆ GetDryRun()

bool Aws::EC2::Model::ModifyEbsDefaultKmsKeyIdRequest::GetDryRun ( ) const
inline

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Definition at line 192 of file ModifyEbsDefaultKmsKeyIdRequest.h.

◆ GetKmsKeyId()

const Aws::String& Aws::EC2::Model::ModifyEbsDefaultKmsKeyIdRequest::GetKmsKeyId ( ) const
inline

The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption. If this parameter is not specified, your AWS managed CMK for EBS is used. If KmsKeyId is specified, the encrypted state must be true.

You can specify the CMK using any of the following:

  • Key ID. For example, key/1234abcd-12ab-34cd-56ef-1234567890ab.

  • Key alias. For example, alias/ExampleAlias.

  • Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.

  • Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

AWS authenticates the CMK asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.

Definition at line 64 of file ModifyEbsDefaultKmsKeyIdRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::EC2::Model::ModifyEbsDefaultKmsKeyIdRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 40 of file ModifyEbsDefaultKmsKeyIdRequest.h.

◆ KmsKeyIdHasBeenSet()

bool Aws::EC2::Model::ModifyEbsDefaultKmsKeyIdRequest::KmsKeyIdHasBeenSet ( ) const
inline

The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption. If this parameter is not specified, your AWS managed CMK for EBS is used. If KmsKeyId is specified, the encrypted state must be true.

You can specify the CMK using any of the following:

  • Key ID. For example, key/1234abcd-12ab-34cd-56ef-1234567890ab.

  • Key alias. For example, alias/ExampleAlias.

  • Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.

  • Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

AWS authenticates the CMK asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.

Definition at line 81 of file ModifyEbsDefaultKmsKeyIdRequest.h.

◆ SerializePayload()

Aws::String Aws::EC2::Model::ModifyEbsDefaultKmsKeyIdRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDryRun()

void Aws::EC2::Model::ModifyEbsDefaultKmsKeyIdRequest::SetDryRun ( bool  value)
inline

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Definition at line 208 of file ModifyEbsDefaultKmsKeyIdRequest.h.

◆ SetKmsKeyId() [1/3]

void Aws::EC2::Model::ModifyEbsDefaultKmsKeyIdRequest::SetKmsKeyId ( const Aws::String value)
inline

The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption. If this parameter is not specified, your AWS managed CMK for EBS is used. If KmsKeyId is specified, the encrypted state must be true.

You can specify the CMK using any of the following:

  • Key ID. For example, key/1234abcd-12ab-34cd-56ef-1234567890ab.

  • Key alias. For example, alias/ExampleAlias.

  • Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.

  • Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

AWS authenticates the CMK asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.

Definition at line 98 of file ModifyEbsDefaultKmsKeyIdRequest.h.

◆ SetKmsKeyId() [2/3]

void Aws::EC2::Model::ModifyEbsDefaultKmsKeyIdRequest::SetKmsKeyId ( Aws::String &&  value)
inline

The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption. If this parameter is not specified, your AWS managed CMK for EBS is used. If KmsKeyId is specified, the encrypted state must be true.

You can specify the CMK using any of the following:

  • Key ID. For example, key/1234abcd-12ab-34cd-56ef-1234567890ab.

  • Key alias. For example, alias/ExampleAlias.

  • Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.

  • Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

AWS authenticates the CMK asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.

Definition at line 115 of file ModifyEbsDefaultKmsKeyIdRequest.h.

◆ SetKmsKeyId() [3/3]

void Aws::EC2::Model::ModifyEbsDefaultKmsKeyIdRequest::SetKmsKeyId ( const char *  value)
inline

The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption. If this parameter is not specified, your AWS managed CMK for EBS is used. If KmsKeyId is specified, the encrypted state must be true.

You can specify the CMK using any of the following:

  • Key ID. For example, key/1234abcd-12ab-34cd-56ef-1234567890ab.

  • Key alias. For example, alias/ExampleAlias.

  • Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.

  • Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

AWS authenticates the CMK asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.

Definition at line 132 of file ModifyEbsDefaultKmsKeyIdRequest.h.

◆ WithDryRun()

ModifyEbsDefaultKmsKeyIdRequest& Aws::EC2::Model::ModifyEbsDefaultKmsKeyIdRequest::WithDryRun ( bool  value)
inline

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Definition at line 216 of file ModifyEbsDefaultKmsKeyIdRequest.h.

◆ WithKmsKeyId() [1/3]

ModifyEbsDefaultKmsKeyIdRequest& Aws::EC2::Model::ModifyEbsDefaultKmsKeyIdRequest::WithKmsKeyId ( const Aws::String value)
inline

The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption. If this parameter is not specified, your AWS managed CMK for EBS is used. If KmsKeyId is specified, the encrypted state must be true.

You can specify the CMK using any of the following:

  • Key ID. For example, key/1234abcd-12ab-34cd-56ef-1234567890ab.

  • Key alias. For example, alias/ExampleAlias.

  • Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.

  • Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

AWS authenticates the CMK asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.

Definition at line 149 of file ModifyEbsDefaultKmsKeyIdRequest.h.

◆ WithKmsKeyId() [2/3]

ModifyEbsDefaultKmsKeyIdRequest& Aws::EC2::Model::ModifyEbsDefaultKmsKeyIdRequest::WithKmsKeyId ( Aws::String &&  value)
inline

The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption. If this parameter is not specified, your AWS managed CMK for EBS is used. If KmsKeyId is specified, the encrypted state must be true.

You can specify the CMK using any of the following:

  • Key ID. For example, key/1234abcd-12ab-34cd-56ef-1234567890ab.

  • Key alias. For example, alias/ExampleAlias.

  • Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.

  • Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

AWS authenticates the CMK asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.

Definition at line 166 of file ModifyEbsDefaultKmsKeyIdRequest.h.

◆ WithKmsKeyId() [3/3]

ModifyEbsDefaultKmsKeyIdRequest& Aws::EC2::Model::ModifyEbsDefaultKmsKeyIdRequest::WithKmsKeyId ( const char *  value)
inline

The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption. If this parameter is not specified, your AWS managed CMK for EBS is used. If KmsKeyId is specified, the encrypted state must be true.

You can specify the CMK using any of the following:

  • Key ID. For example, key/1234abcd-12ab-34cd-56ef-1234567890ab.

  • Key alias. For example, alias/ExampleAlias.

  • Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.

  • Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

AWS authenticates the CMK asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.

Definition at line 183 of file ModifyEbsDefaultKmsKeyIdRequest.h.


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