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

#include <CreateSnapshotRequest.h>

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

Public Member Functions

 CreateSnapshotRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetDescription () const
 
bool DescriptionHasBeenSet () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
CreateSnapshotRequestWithDescription (const Aws::String &value)
 
CreateSnapshotRequestWithDescription (Aws::String &&value)
 
CreateSnapshotRequestWithDescription (const char *value)
 
const Aws::StringGetOutpostArn () const
 
bool OutpostArnHasBeenSet () const
 
void SetOutpostArn (const Aws::String &value)
 
void SetOutpostArn (Aws::String &&value)
 
void SetOutpostArn (const char *value)
 
CreateSnapshotRequestWithOutpostArn (const Aws::String &value)
 
CreateSnapshotRequestWithOutpostArn (Aws::String &&value)
 
CreateSnapshotRequestWithOutpostArn (const char *value)
 
const Aws::StringGetVolumeId () const
 
bool VolumeIdHasBeenSet () const
 
void SetVolumeId (const Aws::String &value)
 
void SetVolumeId (Aws::String &&value)
 
void SetVolumeId (const char *value)
 
CreateSnapshotRequestWithVolumeId (const Aws::String &value)
 
CreateSnapshotRequestWithVolumeId (Aws::String &&value)
 
CreateSnapshotRequestWithVolumeId (const char *value)
 
const Aws::Vector< TagSpecification > & GetTagSpecifications () const
 
bool TagSpecificationsHasBeenSet () const
 
void SetTagSpecifications (const Aws::Vector< TagSpecification > &value)
 
void SetTagSpecifications (Aws::Vector< TagSpecification > &&value)
 
CreateSnapshotRequestWithTagSpecifications (const Aws::Vector< TagSpecification > &value)
 
CreateSnapshotRequestWithTagSpecifications (Aws::Vector< TagSpecification > &&value)
 
CreateSnapshotRequestAddTagSpecifications (const TagSpecification &value)
 
CreateSnapshotRequestAddTagSpecifications (TagSpecification &&value)
 
bool GetDryRun () const
 
bool DryRunHasBeenSet () const
 
void SetDryRun (bool value)
 
CreateSnapshotRequestWithDryRun (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 23 of file CreateSnapshotRequest.h.

Constructor & Destructor Documentation

◆ CreateSnapshotRequest()

Aws::EC2::Model::CreateSnapshotRequest::CreateSnapshotRequest ( )

Member Function Documentation

◆ AddTagSpecifications() [1/2]

CreateSnapshotRequest& Aws::EC2::Model::CreateSnapshotRequest::AddTagSpecifications ( const TagSpecification value)
inline

The tags to apply to the snapshot during creation.

Definition at line 285 of file CreateSnapshotRequest.h.

◆ AddTagSpecifications() [2/2]

CreateSnapshotRequest& Aws::EC2::Model::CreateSnapshotRequest::AddTagSpecifications ( TagSpecification &&  value)
inline

The tags to apply to the snapshot during creation.

Definition at line 290 of file CreateSnapshotRequest.h.

◆ DescriptionHasBeenSet()

bool Aws::EC2::Model::CreateSnapshotRequest::DescriptionHasBeenSet ( ) const
inline

A description for the snapshot.

Definition at line 49 of file CreateSnapshotRequest.h.

◆ DryRunHasBeenSet()

bool Aws::EC2::Model::CreateSnapshotRequest::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 307 of file CreateSnapshotRequest.h.

◆ DumpBodyToUrl()

void Aws::EC2::Model::CreateSnapshotRequest::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.

◆ GetDescription()

const Aws::String& Aws::EC2::Model::CreateSnapshotRequest::GetDescription ( ) const
inline

A description for the snapshot.

Definition at line 44 of file CreateSnapshotRequest.h.

◆ GetDryRun()

bool Aws::EC2::Model::CreateSnapshotRequest::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 299 of file CreateSnapshotRequest.h.

◆ GetOutpostArn()

const Aws::String& Aws::EC2::Model::CreateSnapshotRequest::GetOutpostArn ( ) const
inline

The Amazon Resource Name (ARN) of the Outpost on which to create a local snapshot.

  • To create a snapshot of a volume in a Region, omit this parameter. The snapshot is created in the same Region as the volume.

  • To create a snapshot of a volume on an Outpost and store the snapshot in the Region, omit this parameter. The snapshot is created in the Region for the Outpost.

  • To create a snapshot of a volume on an Outpost and store the snapshot on an Outpost, specify the ARN of the destination Outpost. The snapshot must be created on the same Outpost as the volume.

For more information, see Create local snapshots from volumes on an Outpost in the Amazon Elastic Compute Cloud User Guide.

Definition at line 96 of file CreateSnapshotRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 32 of file CreateSnapshotRequest.h.

◆ GetTagSpecifications()

const Aws::Vector<TagSpecification>& Aws::EC2::Model::CreateSnapshotRequest::GetTagSpecifications ( ) const
inline

The tags to apply to the snapshot during creation.

Definition at line 255 of file CreateSnapshotRequest.h.

◆ GetVolumeId()

const Aws::String& Aws::EC2::Model::CreateSnapshotRequest::GetVolumeId ( ) const
inline

The ID of the Amazon EBS volume.

Definition at line 214 of file CreateSnapshotRequest.h.

◆ OutpostArnHasBeenSet()

bool Aws::EC2::Model::CreateSnapshotRequest::OutpostArnHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) of the Outpost on which to create a local snapshot.

  • To create a snapshot of a volume in a Region, omit this parameter. The snapshot is created in the same Region as the volume.

  • To create a snapshot of a volume on an Outpost and store the snapshot in the Region, omit this parameter. The snapshot is created in the Region for the Outpost.

  • To create a snapshot of a volume on an Outpost and store the snapshot on an Outpost, specify the ARN of the destination Outpost. The snapshot must be created on the same Outpost as the volume.

For more information, see Create local snapshots from volumes on an Outpost in the Amazon Elastic Compute Cloud User Guide.

Definition at line 112 of file CreateSnapshotRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDescription() [1/3]

void Aws::EC2::Model::CreateSnapshotRequest::SetDescription ( Aws::String &&  value)
inline

A description for the snapshot.

Definition at line 59 of file CreateSnapshotRequest.h.

◆ SetDescription() [2/3]

void Aws::EC2::Model::CreateSnapshotRequest::SetDescription ( const Aws::String value)
inline

A description for the snapshot.

Definition at line 54 of file CreateSnapshotRequest.h.

◆ SetDescription() [3/3]

void Aws::EC2::Model::CreateSnapshotRequest::SetDescription ( const char *  value)
inline

A description for the snapshot.

Definition at line 64 of file CreateSnapshotRequest.h.

◆ SetDryRun()

void Aws::EC2::Model::CreateSnapshotRequest::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 315 of file CreateSnapshotRequest.h.

◆ SetOutpostArn() [1/3]

void Aws::EC2::Model::CreateSnapshotRequest::SetOutpostArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the Outpost on which to create a local snapshot.

  • To create a snapshot of a volume in a Region, omit this parameter. The snapshot is created in the same Region as the volume.

  • To create a snapshot of a volume on an Outpost and store the snapshot in the Region, omit this parameter. The snapshot is created in the Region for the Outpost.

  • To create a snapshot of a volume on an Outpost and store the snapshot on an Outpost, specify the ARN of the destination Outpost. The snapshot must be created on the same Outpost as the volume.

For more information, see Create local snapshots from volumes on an Outpost in the Amazon Elastic Compute Cloud User Guide.

Definition at line 144 of file CreateSnapshotRequest.h.

◆ SetOutpostArn() [2/3]

void Aws::EC2::Model::CreateSnapshotRequest::SetOutpostArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the Outpost on which to create a local snapshot.

  • To create a snapshot of a volume in a Region, omit this parameter. The snapshot is created in the same Region as the volume.

  • To create a snapshot of a volume on an Outpost and store the snapshot in the Region, omit this parameter. The snapshot is created in the Region for the Outpost.

  • To create a snapshot of a volume on an Outpost and store the snapshot on an Outpost, specify the ARN of the destination Outpost. The snapshot must be created on the same Outpost as the volume.

For more information, see Create local snapshots from volumes on an Outpost in the Amazon Elastic Compute Cloud User Guide.

Definition at line 128 of file CreateSnapshotRequest.h.

◆ SetOutpostArn() [3/3]

void Aws::EC2::Model::CreateSnapshotRequest::SetOutpostArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the Outpost on which to create a local snapshot.

  • To create a snapshot of a volume in a Region, omit this parameter. The snapshot is created in the same Region as the volume.

  • To create a snapshot of a volume on an Outpost and store the snapshot in the Region, omit this parameter. The snapshot is created in the Region for the Outpost.

  • To create a snapshot of a volume on an Outpost and store the snapshot on an Outpost, specify the ARN of the destination Outpost. The snapshot must be created on the same Outpost as the volume.

For more information, see Create local snapshots from volumes on an Outpost in the Amazon Elastic Compute Cloud User Guide.

Definition at line 160 of file CreateSnapshotRequest.h.

◆ SetTagSpecifications() [1/2]

void Aws::EC2::Model::CreateSnapshotRequest::SetTagSpecifications ( Aws::Vector< TagSpecification > &&  value)
inline

The tags to apply to the snapshot during creation.

Definition at line 270 of file CreateSnapshotRequest.h.

◆ SetTagSpecifications() [2/2]

void Aws::EC2::Model::CreateSnapshotRequest::SetTagSpecifications ( const Aws::Vector< TagSpecification > &  value)
inline

The tags to apply to the snapshot during creation.

Definition at line 265 of file CreateSnapshotRequest.h.

◆ SetVolumeId() [1/3]

void Aws::EC2::Model::CreateSnapshotRequest::SetVolumeId ( Aws::String &&  value)
inline

The ID of the Amazon EBS volume.

Definition at line 229 of file CreateSnapshotRequest.h.

◆ SetVolumeId() [2/3]

void Aws::EC2::Model::CreateSnapshotRequest::SetVolumeId ( const Aws::String value)
inline

The ID of the Amazon EBS volume.

Definition at line 224 of file CreateSnapshotRequest.h.

◆ SetVolumeId() [3/3]

void Aws::EC2::Model::CreateSnapshotRequest::SetVolumeId ( const char *  value)
inline

The ID of the Amazon EBS volume.

Definition at line 234 of file CreateSnapshotRequest.h.

◆ TagSpecificationsHasBeenSet()

bool Aws::EC2::Model::CreateSnapshotRequest::TagSpecificationsHasBeenSet ( ) const
inline

The tags to apply to the snapshot during creation.

Definition at line 260 of file CreateSnapshotRequest.h.

◆ VolumeIdHasBeenSet()

bool Aws::EC2::Model::CreateSnapshotRequest::VolumeIdHasBeenSet ( ) const
inline

The ID of the Amazon EBS volume.

Definition at line 219 of file CreateSnapshotRequest.h.

◆ WithDescription() [1/3]

CreateSnapshotRequest& Aws::EC2::Model::CreateSnapshotRequest::WithDescription ( Aws::String &&  value)
inline

A description for the snapshot.

Definition at line 74 of file CreateSnapshotRequest.h.

◆ WithDescription() [2/3]

CreateSnapshotRequest& Aws::EC2::Model::CreateSnapshotRequest::WithDescription ( const Aws::String value)
inline

A description for the snapshot.

Definition at line 69 of file CreateSnapshotRequest.h.

◆ WithDescription() [3/3]

CreateSnapshotRequest& Aws::EC2::Model::CreateSnapshotRequest::WithDescription ( const char *  value)
inline

A description for the snapshot.

Definition at line 79 of file CreateSnapshotRequest.h.

◆ WithDryRun()

CreateSnapshotRequest& Aws::EC2::Model::CreateSnapshotRequest::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 323 of file CreateSnapshotRequest.h.

◆ WithOutpostArn() [1/3]

CreateSnapshotRequest& Aws::EC2::Model::CreateSnapshotRequest::WithOutpostArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the Outpost on which to create a local snapshot.

  • To create a snapshot of a volume in a Region, omit this parameter. The snapshot is created in the same Region as the volume.

  • To create a snapshot of a volume on an Outpost and store the snapshot in the Region, omit this parameter. The snapshot is created in the Region for the Outpost.

  • To create a snapshot of a volume on an Outpost and store the snapshot on an Outpost, specify the ARN of the destination Outpost. The snapshot must be created on the same Outpost as the volume.

For more information, see Create local snapshots from volumes on an Outpost in the Amazon Elastic Compute Cloud User Guide.

Definition at line 192 of file CreateSnapshotRequest.h.

◆ WithOutpostArn() [2/3]

CreateSnapshotRequest& Aws::EC2::Model::CreateSnapshotRequest::WithOutpostArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the Outpost on which to create a local snapshot.

  • To create a snapshot of a volume in a Region, omit this parameter. The snapshot is created in the same Region as the volume.

  • To create a snapshot of a volume on an Outpost and store the snapshot in the Region, omit this parameter. The snapshot is created in the Region for the Outpost.

  • To create a snapshot of a volume on an Outpost and store the snapshot on an Outpost, specify the ARN of the destination Outpost. The snapshot must be created on the same Outpost as the volume.

For more information, see Create local snapshots from volumes on an Outpost in the Amazon Elastic Compute Cloud User Guide.

Definition at line 176 of file CreateSnapshotRequest.h.

◆ WithOutpostArn() [3/3]

CreateSnapshotRequest& Aws::EC2::Model::CreateSnapshotRequest::WithOutpostArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the Outpost on which to create a local snapshot.

  • To create a snapshot of a volume in a Region, omit this parameter. The snapshot is created in the same Region as the volume.

  • To create a snapshot of a volume on an Outpost and store the snapshot in the Region, omit this parameter. The snapshot is created in the Region for the Outpost.

  • To create a snapshot of a volume on an Outpost and store the snapshot on an Outpost, specify the ARN of the destination Outpost. The snapshot must be created on the same Outpost as the volume.

For more information, see Create local snapshots from volumes on an Outpost in the Amazon Elastic Compute Cloud User Guide.

Definition at line 208 of file CreateSnapshotRequest.h.

◆ WithTagSpecifications() [1/2]

CreateSnapshotRequest& Aws::EC2::Model::CreateSnapshotRequest::WithTagSpecifications ( Aws::Vector< TagSpecification > &&  value)
inline

The tags to apply to the snapshot during creation.

Definition at line 280 of file CreateSnapshotRequest.h.

◆ WithTagSpecifications() [2/2]

CreateSnapshotRequest& Aws::EC2::Model::CreateSnapshotRequest::WithTagSpecifications ( const Aws::Vector< TagSpecification > &  value)
inline

The tags to apply to the snapshot during creation.

Definition at line 275 of file CreateSnapshotRequest.h.

◆ WithVolumeId() [1/3]

CreateSnapshotRequest& Aws::EC2::Model::CreateSnapshotRequest::WithVolumeId ( Aws::String &&  value)
inline

The ID of the Amazon EBS volume.

Definition at line 244 of file CreateSnapshotRequest.h.

◆ WithVolumeId() [2/3]

CreateSnapshotRequest& Aws::EC2::Model::CreateSnapshotRequest::WithVolumeId ( const Aws::String value)
inline

The ID of the Amazon EBS volume.

Definition at line 239 of file CreateSnapshotRequest.h.

◆ WithVolumeId() [3/3]

CreateSnapshotRequest& Aws::EC2::Model::CreateSnapshotRequest::WithVolumeId ( const char *  value)
inline

The ID of the Amazon EBS volume.

Definition at line 249 of file CreateSnapshotRequest.h.


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