This repository has been archived on 2025-09-14. You can view files and clone it, but cannot push or open issues or pull requests.
Files
pxz-hos-client-cpp-module/support/aws-sdk-cpp-master/aws-cpp-sdk-ec2/include/aws/ec2/model/RunScheduledInstancesRequest.h

262 lines
10 KiB
C++

/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include <aws/ec2/EC2_EXPORTS.h>
#include <aws/ec2/EC2Request.h>
#include <aws/core/utils/memory/stl/AWSString.h>
#include <aws/ec2/model/ScheduledInstancesLaunchSpecification.h>
#include <utility>
#include <aws/core/utils/UUID.h>
namespace Aws
{
namespace EC2
{
namespace Model
{
/**
* <p>Contains the parameters for RunScheduledInstances.</p><p><h3>See Also:</h3>
* <a
* href="http://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/RunScheduledInstancesRequest">AWS
* API Reference</a></p>
*/
class AWS_EC2_API RunScheduledInstancesRequest : public EC2Request
{
public:
RunScheduledInstancesRequest();
// Service request name is the Operation name which will send this request out,
// each operation should has unique request name, so that we can get operation's name from this request.
// Note: this is not true for response, multiple operations may have the same response name,
// so we can not get operation's name from response.
inline virtual const char* GetServiceRequestName() const override { return "RunScheduledInstances"; }
Aws::String SerializePayload() const override;
protected:
void DumpBodyToUrl(Aws::Http::URI& uri ) const override;
public:
/**
* <p>Unique, case-sensitive identifier that ensures the idempotency of the
* request. For more information, see <a
* href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring
* Idempotency</a>.</p>
*/
inline const Aws::String& GetClientToken() const{ return m_clientToken; }
/**
* <p>Unique, case-sensitive identifier that ensures the idempotency of the
* request. For more information, see <a
* href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring
* Idempotency</a>.</p>
*/
inline bool ClientTokenHasBeenSet() const { return m_clientTokenHasBeenSet; }
/**
* <p>Unique, case-sensitive identifier that ensures the idempotency of the
* request. For more information, see <a
* href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring
* Idempotency</a>.</p>
*/
inline void SetClientToken(const Aws::String& value) { m_clientTokenHasBeenSet = true; m_clientToken = value; }
/**
* <p>Unique, case-sensitive identifier that ensures the idempotency of the
* request. For more information, see <a
* href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring
* Idempotency</a>.</p>
*/
inline void SetClientToken(Aws::String&& value) { m_clientTokenHasBeenSet = true; m_clientToken = std::move(value); }
/**
* <p>Unique, case-sensitive identifier that ensures the idempotency of the
* request. For more information, see <a
* href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring
* Idempotency</a>.</p>
*/
inline void SetClientToken(const char* value) { m_clientTokenHasBeenSet = true; m_clientToken.assign(value); }
/**
* <p>Unique, case-sensitive identifier that ensures the idempotency of the
* request. For more information, see <a
* href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring
* Idempotency</a>.</p>
*/
inline RunScheduledInstancesRequest& WithClientToken(const Aws::String& value) { SetClientToken(value); return *this;}
/**
* <p>Unique, case-sensitive identifier that ensures the idempotency of the
* request. For more information, see <a
* href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring
* Idempotency</a>.</p>
*/
inline RunScheduledInstancesRequest& WithClientToken(Aws::String&& value) { SetClientToken(std::move(value)); return *this;}
/**
* <p>Unique, case-sensitive identifier that ensures the idempotency of the
* request. For more information, see <a
* href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring
* Idempotency</a>.</p>
*/
inline RunScheduledInstancesRequest& WithClientToken(const char* value) { SetClientToken(value); return *this;}
/**
* <p>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 <code>DryRunOperation</code>.
* Otherwise, it is <code>UnauthorizedOperation</code>.</p>
*/
inline bool GetDryRun() const{ return m_dryRun; }
/**
* <p>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 <code>DryRunOperation</code>.
* Otherwise, it is <code>UnauthorizedOperation</code>.</p>
*/
inline bool DryRunHasBeenSet() const { return m_dryRunHasBeenSet; }
/**
* <p>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 <code>DryRunOperation</code>.
* Otherwise, it is <code>UnauthorizedOperation</code>.</p>
*/
inline void SetDryRun(bool value) { m_dryRunHasBeenSet = true; m_dryRun = value; }
/**
* <p>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 <code>DryRunOperation</code>.
* Otherwise, it is <code>UnauthorizedOperation</code>.</p>
*/
inline RunScheduledInstancesRequest& WithDryRun(bool value) { SetDryRun(value); return *this;}
/**
* <p>The number of instances.</p> <p>Default: 1</p>
*/
inline int GetInstanceCount() const{ return m_instanceCount; }
/**
* <p>The number of instances.</p> <p>Default: 1</p>
*/
inline bool InstanceCountHasBeenSet() const { return m_instanceCountHasBeenSet; }
/**
* <p>The number of instances.</p> <p>Default: 1</p>
*/
inline void SetInstanceCount(int value) { m_instanceCountHasBeenSet = true; m_instanceCount = value; }
/**
* <p>The number of instances.</p> <p>Default: 1</p>
*/
inline RunScheduledInstancesRequest& WithInstanceCount(int value) { SetInstanceCount(value); return *this;}
/**
* <p>The launch specification. You must match the instance type, Availability
* Zone, network, and platform of the schedule that you purchased.</p>
*/
inline const ScheduledInstancesLaunchSpecification& GetLaunchSpecification() const{ return m_launchSpecification; }
/**
* <p>The launch specification. You must match the instance type, Availability
* Zone, network, and platform of the schedule that you purchased.</p>
*/
inline bool LaunchSpecificationHasBeenSet() const { return m_launchSpecificationHasBeenSet; }
/**
* <p>The launch specification. You must match the instance type, Availability
* Zone, network, and platform of the schedule that you purchased.</p>
*/
inline void SetLaunchSpecification(const ScheduledInstancesLaunchSpecification& value) { m_launchSpecificationHasBeenSet = true; m_launchSpecification = value; }
/**
* <p>The launch specification. You must match the instance type, Availability
* Zone, network, and platform of the schedule that you purchased.</p>
*/
inline void SetLaunchSpecification(ScheduledInstancesLaunchSpecification&& value) { m_launchSpecificationHasBeenSet = true; m_launchSpecification = std::move(value); }
/**
* <p>The launch specification. You must match the instance type, Availability
* Zone, network, and platform of the schedule that you purchased.</p>
*/
inline RunScheduledInstancesRequest& WithLaunchSpecification(const ScheduledInstancesLaunchSpecification& value) { SetLaunchSpecification(value); return *this;}
/**
* <p>The launch specification. You must match the instance type, Availability
* Zone, network, and platform of the schedule that you purchased.</p>
*/
inline RunScheduledInstancesRequest& WithLaunchSpecification(ScheduledInstancesLaunchSpecification&& value) { SetLaunchSpecification(std::move(value)); return *this;}
/**
* <p>The Scheduled Instance ID.</p>
*/
inline const Aws::String& GetScheduledInstanceId() const{ return m_scheduledInstanceId; }
/**
* <p>The Scheduled Instance ID.</p>
*/
inline bool ScheduledInstanceIdHasBeenSet() const { return m_scheduledInstanceIdHasBeenSet; }
/**
* <p>The Scheduled Instance ID.</p>
*/
inline void SetScheduledInstanceId(const Aws::String& value) { m_scheduledInstanceIdHasBeenSet = true; m_scheduledInstanceId = value; }
/**
* <p>The Scheduled Instance ID.</p>
*/
inline void SetScheduledInstanceId(Aws::String&& value) { m_scheduledInstanceIdHasBeenSet = true; m_scheduledInstanceId = std::move(value); }
/**
* <p>The Scheduled Instance ID.</p>
*/
inline void SetScheduledInstanceId(const char* value) { m_scheduledInstanceIdHasBeenSet = true; m_scheduledInstanceId.assign(value); }
/**
* <p>The Scheduled Instance ID.</p>
*/
inline RunScheduledInstancesRequest& WithScheduledInstanceId(const Aws::String& value) { SetScheduledInstanceId(value); return *this;}
/**
* <p>The Scheduled Instance ID.</p>
*/
inline RunScheduledInstancesRequest& WithScheduledInstanceId(Aws::String&& value) { SetScheduledInstanceId(std::move(value)); return *this;}
/**
* <p>The Scheduled Instance ID.</p>
*/
inline RunScheduledInstancesRequest& WithScheduledInstanceId(const char* value) { SetScheduledInstanceId(value); return *this;}
private:
Aws::String m_clientToken;
bool m_clientTokenHasBeenSet;
bool m_dryRun;
bool m_dryRunHasBeenSet;
int m_instanceCount;
bool m_instanceCountHasBeenSet;
ScheduledInstancesLaunchSpecification m_launchSpecification;
bool m_launchSpecificationHasBeenSet;
Aws::String m_scheduledInstanceId;
bool m_scheduledInstanceIdHasBeenSet;
};
} // namespace Model
} // namespace EC2
} // namespace Aws