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

#include <CreateSnapshotsRequest.h>

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

Public Member Functions

 CreateSnapshotsRequest ()
 
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)
 
CreateSnapshotsRequestWithDescription (const Aws::String &value)
 
CreateSnapshotsRequestWithDescription (Aws::String &&value)
 
CreateSnapshotsRequestWithDescription (const char *value)
 
const InstanceSpecificationGetInstanceSpecification () const
 
bool InstanceSpecificationHasBeenSet () const
 
void SetInstanceSpecification (const InstanceSpecification &value)
 
void SetInstanceSpecification (InstanceSpecification &&value)
 
CreateSnapshotsRequestWithInstanceSpecification (const InstanceSpecification &value)
 
CreateSnapshotsRequestWithInstanceSpecification (InstanceSpecification &&value)
 
const Aws::StringGetOutpostArn () const
 
bool OutpostArnHasBeenSet () const
 
void SetOutpostArn (const Aws::String &value)
 
void SetOutpostArn (Aws::String &&value)
 
void SetOutpostArn (const char *value)
 
CreateSnapshotsRequestWithOutpostArn (const Aws::String &value)
 
CreateSnapshotsRequestWithOutpostArn (Aws::String &&value)
 
CreateSnapshotsRequestWithOutpostArn (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)
 
CreateSnapshotsRequestWithTagSpecifications (const Aws::Vector< TagSpecification > &value)
 
CreateSnapshotsRequestWithTagSpecifications (Aws::Vector< TagSpecification > &&value)
 
CreateSnapshotsRequestAddTagSpecifications (const TagSpecification &value)
 
CreateSnapshotsRequestAddTagSpecifications (TagSpecification &&value)
 
bool GetDryRun () const
 
bool DryRunHasBeenSet () const
 
void SetDryRun (bool value)
 
CreateSnapshotsRequestWithDryRun (bool value)
 
const CopyTagsFromSourceGetCopyTagsFromSource () const
 
bool CopyTagsFromSourceHasBeenSet () const
 
void SetCopyTagsFromSource (const CopyTagsFromSource &value)
 
void SetCopyTagsFromSource (CopyTagsFromSource &&value)
 
CreateSnapshotsRequestWithCopyTagsFromSource (const CopyTagsFromSource &value)
 
CreateSnapshotsRequestWithCopyTagsFromSource (CopyTagsFromSource &&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 25 of file CreateSnapshotsRequest.h.

Constructor & Destructor Documentation

◆ CreateSnapshotsRequest()

Aws::EC2::Model::CreateSnapshotsRequest::CreateSnapshotsRequest ( )

Member Function Documentation

◆ AddTagSpecifications() [1/2]

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

Tags to apply to every snapshot specified by the instance.

Definition at line 283 of file CreateSnapshotsRequest.h.

◆ AddTagSpecifications() [2/2]

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

Tags to apply to every snapshot specified by the instance.

Definition at line 288 of file CreateSnapshotsRequest.h.

◆ CopyTagsFromSourceHasBeenSet()

bool Aws::EC2::Model::CreateSnapshotsRequest::CopyTagsFromSourceHasBeenSet ( ) const
inline

Copies the tags from the specified volume to corresponding snapshot.

Definition at line 332 of file CreateSnapshotsRequest.h.

◆ DescriptionHasBeenSet()

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

A description propagated to every snapshot specified by the instance.

Definition at line 51 of file CreateSnapshotsRequest.h.

◆ DryRunHasBeenSet()

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

◆ DumpBodyToUrl()

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

◆ GetCopyTagsFromSource()

const CopyTagsFromSource& Aws::EC2::Model::CreateSnapshotsRequest::GetCopyTagsFromSource ( ) const
inline

Copies the tags from the specified volume to corresponding snapshot.

Definition at line 327 of file CreateSnapshotsRequest.h.

◆ GetDescription()

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

A description propagated to every snapshot specified by the instance.

Definition at line 46 of file CreateSnapshotsRequest.h.

◆ GetDryRun()

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

◆ GetInstanceSpecification()

const InstanceSpecification& Aws::EC2::Model::CreateSnapshotsRequest::GetInstanceSpecification ( ) const
inline

The instance to specify which volumes should be included in the snapshots.

Definition at line 88 of file CreateSnapshotsRequest.h.

◆ GetOutpostArn()

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

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

  • To create snapshots from an instance in a Region, omit this parameter. The snapshots are created in the same Region as the instance.

  • To create snapshots from an instance on an Outpost and store the snapshots in the Region, omit this parameter. The snapshots are created in the Region for the Outpost.

  • To create snapshots from an instance on an Outpost and store the snapshots on an Outpost, specify the ARN of the destination Outpost. The snapshots must be created on the same Outpost as the instance.

For more information, see Creating multi-volume local snapshots from instances on an Outpost in the Amazon Elastic Compute Cloud User Guide.

Definition at line 135 of file CreateSnapshotsRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 34 of file CreateSnapshotsRequest.h.

◆ GetTagSpecifications()

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

Tags to apply to every snapshot specified by the instance.

Definition at line 253 of file CreateSnapshotsRequest.h.

◆ InstanceSpecificationHasBeenSet()

bool Aws::EC2::Model::CreateSnapshotsRequest::InstanceSpecificationHasBeenSet ( ) const
inline

The instance to specify which volumes should be included in the snapshots.

Definition at line 94 of file CreateSnapshotsRequest.h.

◆ OutpostArnHasBeenSet()

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

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

  • To create snapshots from an instance in a Region, omit this parameter. The snapshots are created in the same Region as the instance.

  • To create snapshots from an instance on an Outpost and store the snapshots in the Region, omit this parameter. The snapshots are created in the Region for the Outpost.

  • To create snapshots from an instance on an Outpost and store the snapshots on an Outpost, specify the ARN of the destination Outpost. The snapshots must be created on the same Outpost as the instance.

For more information, see Creating multi-volume local snapshots from instances on an Outpost in the Amazon Elastic Compute Cloud User Guide.

Definition at line 151 of file CreateSnapshotsRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetCopyTagsFromSource() [1/2]

void Aws::EC2::Model::CreateSnapshotsRequest::SetCopyTagsFromSource ( const CopyTagsFromSource value)
inline

Copies the tags from the specified volume to corresponding snapshot.

Definition at line 337 of file CreateSnapshotsRequest.h.

◆ SetCopyTagsFromSource() [2/2]

void Aws::EC2::Model::CreateSnapshotsRequest::SetCopyTagsFromSource ( CopyTagsFromSource &&  value)
inline

Copies the tags from the specified volume to corresponding snapshot.

Definition at line 342 of file CreateSnapshotsRequest.h.

◆ SetDescription() [1/3]

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

A description propagated to every snapshot specified by the instance.

Definition at line 61 of file CreateSnapshotsRequest.h.

◆ SetDescription() [2/3]

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

A description propagated to every snapshot specified by the instance.

Definition at line 56 of file CreateSnapshotsRequest.h.

◆ SetDescription() [3/3]

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

A description propagated to every snapshot specified by the instance.

Definition at line 66 of file CreateSnapshotsRequest.h.

◆ SetDryRun()

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

◆ SetInstanceSpecification() [1/2]

void Aws::EC2::Model::CreateSnapshotsRequest::SetInstanceSpecification ( const InstanceSpecification value)
inline

The instance to specify which volumes should be included in the snapshots.

Definition at line 100 of file CreateSnapshotsRequest.h.

◆ SetInstanceSpecification() [2/2]

void Aws::EC2::Model::CreateSnapshotsRequest::SetInstanceSpecification ( InstanceSpecification &&  value)
inline

The instance to specify which volumes should be included in the snapshots.

Definition at line 106 of file CreateSnapshotsRequest.h.

◆ SetOutpostArn() [1/3]

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

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

  • To create snapshots from an instance in a Region, omit this parameter. The snapshots are created in the same Region as the instance.

  • To create snapshots from an instance on an Outpost and store the snapshots in the Region, omit this parameter. The snapshots are created in the Region for the Outpost.

  • To create snapshots from an instance on an Outpost and store the snapshots on an Outpost, specify the ARN of the destination Outpost. The snapshots must be created on the same Outpost as the instance.

For more information, see Creating multi-volume local snapshots from instances on an Outpost in the Amazon Elastic Compute Cloud User Guide.

Definition at line 183 of file CreateSnapshotsRequest.h.

◆ SetOutpostArn() [2/3]

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

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

  • To create snapshots from an instance in a Region, omit this parameter. The snapshots are created in the same Region as the instance.

  • To create snapshots from an instance on an Outpost and store the snapshots in the Region, omit this parameter. The snapshots are created in the Region for the Outpost.

  • To create snapshots from an instance on an Outpost and store the snapshots on an Outpost, specify the ARN of the destination Outpost. The snapshots must be created on the same Outpost as the instance.

For more information, see Creating multi-volume local snapshots from instances on an Outpost in the Amazon Elastic Compute Cloud User Guide.

Definition at line 167 of file CreateSnapshotsRequest.h.

◆ SetOutpostArn() [3/3]

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

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

  • To create snapshots from an instance in a Region, omit this parameter. The snapshots are created in the same Region as the instance.

  • To create snapshots from an instance on an Outpost and store the snapshots in the Region, omit this parameter. The snapshots are created in the Region for the Outpost.

  • To create snapshots from an instance on an Outpost and store the snapshots on an Outpost, specify the ARN of the destination Outpost. The snapshots must be created on the same Outpost as the instance.

For more information, see Creating multi-volume local snapshots from instances on an Outpost in the Amazon Elastic Compute Cloud User Guide.

Definition at line 199 of file CreateSnapshotsRequest.h.

◆ SetTagSpecifications() [1/2]

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

Tags to apply to every snapshot specified by the instance.

Definition at line 268 of file CreateSnapshotsRequest.h.

◆ SetTagSpecifications() [2/2]

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

Tags to apply to every snapshot specified by the instance.

Definition at line 263 of file CreateSnapshotsRequest.h.

◆ TagSpecificationsHasBeenSet()

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

Tags to apply to every snapshot specified by the instance.

Definition at line 258 of file CreateSnapshotsRequest.h.

◆ WithCopyTagsFromSource() [1/2]

CreateSnapshotsRequest& Aws::EC2::Model::CreateSnapshotsRequest::WithCopyTagsFromSource ( const CopyTagsFromSource value)
inline

Copies the tags from the specified volume to corresponding snapshot.

Definition at line 347 of file CreateSnapshotsRequest.h.

◆ WithCopyTagsFromSource() [2/2]

CreateSnapshotsRequest& Aws::EC2::Model::CreateSnapshotsRequest::WithCopyTagsFromSource ( CopyTagsFromSource &&  value)
inline

Copies the tags from the specified volume to corresponding snapshot.

Definition at line 352 of file CreateSnapshotsRequest.h.

◆ WithDescription() [1/3]

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

A description propagated to every snapshot specified by the instance.

Definition at line 76 of file CreateSnapshotsRequest.h.

◆ WithDescription() [2/3]

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

A description propagated to every snapshot specified by the instance.

Definition at line 71 of file CreateSnapshotsRequest.h.

◆ WithDescription() [3/3]

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

A description propagated to every snapshot specified by the instance.

Definition at line 81 of file CreateSnapshotsRequest.h.

◆ WithDryRun()

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

◆ WithInstanceSpecification() [1/2]

CreateSnapshotsRequest& Aws::EC2::Model::CreateSnapshotsRequest::WithInstanceSpecification ( const InstanceSpecification value)
inline

The instance to specify which volumes should be included in the snapshots.

Definition at line 112 of file CreateSnapshotsRequest.h.

◆ WithInstanceSpecification() [2/2]

CreateSnapshotsRequest& Aws::EC2::Model::CreateSnapshotsRequest::WithInstanceSpecification ( InstanceSpecification &&  value)
inline

The instance to specify which volumes should be included in the snapshots.

Definition at line 118 of file CreateSnapshotsRequest.h.

◆ WithOutpostArn() [1/3]

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

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

  • To create snapshots from an instance in a Region, omit this parameter. The snapshots are created in the same Region as the instance.

  • To create snapshots from an instance on an Outpost and store the snapshots in the Region, omit this parameter. The snapshots are created in the Region for the Outpost.

  • To create snapshots from an instance on an Outpost and store the snapshots on an Outpost, specify the ARN of the destination Outpost. The snapshots must be created on the same Outpost as the instance.

For more information, see Creating multi-volume local snapshots from instances on an Outpost in the Amazon Elastic Compute Cloud User Guide.

Definition at line 231 of file CreateSnapshotsRequest.h.

◆ WithOutpostArn() [2/3]

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

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

  • To create snapshots from an instance in a Region, omit this parameter. The snapshots are created in the same Region as the instance.

  • To create snapshots from an instance on an Outpost and store the snapshots in the Region, omit this parameter. The snapshots are created in the Region for the Outpost.

  • To create snapshots from an instance on an Outpost and store the snapshots on an Outpost, specify the ARN of the destination Outpost. The snapshots must be created on the same Outpost as the instance.

For more information, see Creating multi-volume local snapshots from instances on an Outpost in the Amazon Elastic Compute Cloud User Guide.

Definition at line 215 of file CreateSnapshotsRequest.h.

◆ WithOutpostArn() [3/3]

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

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

  • To create snapshots from an instance in a Region, omit this parameter. The snapshots are created in the same Region as the instance.

  • To create snapshots from an instance on an Outpost and store the snapshots in the Region, omit this parameter. The snapshots are created in the Region for the Outpost.

  • To create snapshots from an instance on an Outpost and store the snapshots on an Outpost, specify the ARN of the destination Outpost. The snapshots must be created on the same Outpost as the instance.

For more information, see Creating multi-volume local snapshots from instances on an Outpost in the Amazon Elastic Compute Cloud User Guide.

Definition at line 247 of file CreateSnapshotsRequest.h.

◆ WithTagSpecifications() [1/2]

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

Tags to apply to every snapshot specified by the instance.

Definition at line 278 of file CreateSnapshotsRequest.h.

◆ WithTagSpecifications() [2/2]

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

Tags to apply to every snapshot specified by the instance.

Definition at line 273 of file CreateSnapshotsRequest.h.


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