818 lines
42 KiB
C++
818 lines
42 KiB
C++
/**
|
|
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
|
|
* SPDX-License-Identifier: Apache-2.0.
|
|
*/
|
|
|
|
#pragma once
|
|
#include <aws/ecs/ECS_EXPORTS.h>
|
|
#include <aws/ecs/ECSRequest.h>
|
|
#include <aws/core/utils/memory/stl/AWSString.h>
|
|
#include <aws/core/utils/memory/stl/AWSVector.h>
|
|
#include <aws/ecs/model/NetworkConfiguration.h>
|
|
#include <aws/ecs/model/TaskOverride.h>
|
|
#include <aws/ecs/model/PropagateTags.h>
|
|
#include <aws/ecs/model/Tag.h>
|
|
#include <utility>
|
|
|
|
namespace Aws
|
|
{
|
|
namespace ECS
|
|
{
|
|
namespace Model
|
|
{
|
|
|
|
/**
|
|
*/
|
|
class AWS_ECS_API StartTaskRequest : public ECSRequest
|
|
{
|
|
public:
|
|
StartTaskRequest();
|
|
|
|
// 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 "StartTask"; }
|
|
|
|
Aws::String SerializePayload() const override;
|
|
|
|
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override;
|
|
|
|
|
|
/**
|
|
* <p>The short name or full Amazon Resource Name (ARN) of the cluster on which to
|
|
* start your task. If you do not specify a cluster, the default cluster is
|
|
* assumed.</p>
|
|
*/
|
|
inline const Aws::String& GetCluster() const{ return m_cluster; }
|
|
|
|
/**
|
|
* <p>The short name or full Amazon Resource Name (ARN) of the cluster on which to
|
|
* start your task. If you do not specify a cluster, the default cluster is
|
|
* assumed.</p>
|
|
*/
|
|
inline bool ClusterHasBeenSet() const { return m_clusterHasBeenSet; }
|
|
|
|
/**
|
|
* <p>The short name or full Amazon Resource Name (ARN) of the cluster on which to
|
|
* start your task. If you do not specify a cluster, the default cluster is
|
|
* assumed.</p>
|
|
*/
|
|
inline void SetCluster(const Aws::String& value) { m_clusterHasBeenSet = true; m_cluster = value; }
|
|
|
|
/**
|
|
* <p>The short name or full Amazon Resource Name (ARN) of the cluster on which to
|
|
* start your task. If you do not specify a cluster, the default cluster is
|
|
* assumed.</p>
|
|
*/
|
|
inline void SetCluster(Aws::String&& value) { m_clusterHasBeenSet = true; m_cluster = std::move(value); }
|
|
|
|
/**
|
|
* <p>The short name or full Amazon Resource Name (ARN) of the cluster on which to
|
|
* start your task. If you do not specify a cluster, the default cluster is
|
|
* assumed.</p>
|
|
*/
|
|
inline void SetCluster(const char* value) { m_clusterHasBeenSet = true; m_cluster.assign(value); }
|
|
|
|
/**
|
|
* <p>The short name or full Amazon Resource Name (ARN) of the cluster on which to
|
|
* start your task. If you do not specify a cluster, the default cluster is
|
|
* assumed.</p>
|
|
*/
|
|
inline StartTaskRequest& WithCluster(const Aws::String& value) { SetCluster(value); return *this;}
|
|
|
|
/**
|
|
* <p>The short name or full Amazon Resource Name (ARN) of the cluster on which to
|
|
* start your task. If you do not specify a cluster, the default cluster is
|
|
* assumed.</p>
|
|
*/
|
|
inline StartTaskRequest& WithCluster(Aws::String&& value) { SetCluster(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>The short name or full Amazon Resource Name (ARN) of the cluster on which to
|
|
* start your task. If you do not specify a cluster, the default cluster is
|
|
* assumed.</p>
|
|
*/
|
|
inline StartTaskRequest& WithCluster(const char* value) { SetCluster(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>The container instance IDs or full ARN entries for the container instances on
|
|
* which you would like to place your task. You can specify up to 10 container
|
|
* instances.</p>
|
|
*/
|
|
inline const Aws::Vector<Aws::String>& GetContainerInstances() const{ return m_containerInstances; }
|
|
|
|
/**
|
|
* <p>The container instance IDs or full ARN entries for the container instances on
|
|
* which you would like to place your task. You can specify up to 10 container
|
|
* instances.</p>
|
|
*/
|
|
inline bool ContainerInstancesHasBeenSet() const { return m_containerInstancesHasBeenSet; }
|
|
|
|
/**
|
|
* <p>The container instance IDs or full ARN entries for the container instances on
|
|
* which you would like to place your task. You can specify up to 10 container
|
|
* instances.</p>
|
|
*/
|
|
inline void SetContainerInstances(const Aws::Vector<Aws::String>& value) { m_containerInstancesHasBeenSet = true; m_containerInstances = value; }
|
|
|
|
/**
|
|
* <p>The container instance IDs or full ARN entries for the container instances on
|
|
* which you would like to place your task. You can specify up to 10 container
|
|
* instances.</p>
|
|
*/
|
|
inline void SetContainerInstances(Aws::Vector<Aws::String>&& value) { m_containerInstancesHasBeenSet = true; m_containerInstances = std::move(value); }
|
|
|
|
/**
|
|
* <p>The container instance IDs or full ARN entries for the container instances on
|
|
* which you would like to place your task. You can specify up to 10 container
|
|
* instances.</p>
|
|
*/
|
|
inline StartTaskRequest& WithContainerInstances(const Aws::Vector<Aws::String>& value) { SetContainerInstances(value); return *this;}
|
|
|
|
/**
|
|
* <p>The container instance IDs or full ARN entries for the container instances on
|
|
* which you would like to place your task. You can specify up to 10 container
|
|
* instances.</p>
|
|
*/
|
|
inline StartTaskRequest& WithContainerInstances(Aws::Vector<Aws::String>&& value) { SetContainerInstances(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>The container instance IDs or full ARN entries for the container instances on
|
|
* which you would like to place your task. You can specify up to 10 container
|
|
* instances.</p>
|
|
*/
|
|
inline StartTaskRequest& AddContainerInstances(const Aws::String& value) { m_containerInstancesHasBeenSet = true; m_containerInstances.push_back(value); return *this; }
|
|
|
|
/**
|
|
* <p>The container instance IDs or full ARN entries for the container instances on
|
|
* which you would like to place your task. You can specify up to 10 container
|
|
* instances.</p>
|
|
*/
|
|
inline StartTaskRequest& AddContainerInstances(Aws::String&& value) { m_containerInstancesHasBeenSet = true; m_containerInstances.push_back(std::move(value)); return *this; }
|
|
|
|
/**
|
|
* <p>The container instance IDs or full ARN entries for the container instances on
|
|
* which you would like to place your task. You can specify up to 10 container
|
|
* instances.</p>
|
|
*/
|
|
inline StartTaskRequest& AddContainerInstances(const char* value) { m_containerInstancesHasBeenSet = true; m_containerInstances.push_back(value); return *this; }
|
|
|
|
|
|
/**
|
|
* <p>Specifies whether to enable Amazon ECS managed tags for the task. For more
|
|
* information, see <a
|
|
* href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html">Tagging
|
|
* Your Amazon ECS Resources</a> in the <i>Amazon Elastic Container Service
|
|
* Developer Guide</i>.</p>
|
|
*/
|
|
inline bool GetEnableECSManagedTags() const{ return m_enableECSManagedTags; }
|
|
|
|
/**
|
|
* <p>Specifies whether to enable Amazon ECS managed tags for the task. For more
|
|
* information, see <a
|
|
* href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html">Tagging
|
|
* Your Amazon ECS Resources</a> in the <i>Amazon Elastic Container Service
|
|
* Developer Guide</i>.</p>
|
|
*/
|
|
inline bool EnableECSManagedTagsHasBeenSet() const { return m_enableECSManagedTagsHasBeenSet; }
|
|
|
|
/**
|
|
* <p>Specifies whether to enable Amazon ECS managed tags for the task. For more
|
|
* information, see <a
|
|
* href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html">Tagging
|
|
* Your Amazon ECS Resources</a> in the <i>Amazon Elastic Container Service
|
|
* Developer Guide</i>.</p>
|
|
*/
|
|
inline void SetEnableECSManagedTags(bool value) { m_enableECSManagedTagsHasBeenSet = true; m_enableECSManagedTags = value; }
|
|
|
|
/**
|
|
* <p>Specifies whether to enable Amazon ECS managed tags for the task. For more
|
|
* information, see <a
|
|
* href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html">Tagging
|
|
* Your Amazon ECS Resources</a> in the <i>Amazon Elastic Container Service
|
|
* Developer Guide</i>.</p>
|
|
*/
|
|
inline StartTaskRequest& WithEnableECSManagedTags(bool value) { SetEnableECSManagedTags(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>The name of the task group to associate with the task. The default value is
|
|
* the family name of the task definition (for example, family:my-family-name).</p>
|
|
*/
|
|
inline const Aws::String& GetGroup() const{ return m_group; }
|
|
|
|
/**
|
|
* <p>The name of the task group to associate with the task. The default value is
|
|
* the family name of the task definition (for example, family:my-family-name).</p>
|
|
*/
|
|
inline bool GroupHasBeenSet() const { return m_groupHasBeenSet; }
|
|
|
|
/**
|
|
* <p>The name of the task group to associate with the task. The default value is
|
|
* the family name of the task definition (for example, family:my-family-name).</p>
|
|
*/
|
|
inline void SetGroup(const Aws::String& value) { m_groupHasBeenSet = true; m_group = value; }
|
|
|
|
/**
|
|
* <p>The name of the task group to associate with the task. The default value is
|
|
* the family name of the task definition (for example, family:my-family-name).</p>
|
|
*/
|
|
inline void SetGroup(Aws::String&& value) { m_groupHasBeenSet = true; m_group = std::move(value); }
|
|
|
|
/**
|
|
* <p>The name of the task group to associate with the task. The default value is
|
|
* the family name of the task definition (for example, family:my-family-name).</p>
|
|
*/
|
|
inline void SetGroup(const char* value) { m_groupHasBeenSet = true; m_group.assign(value); }
|
|
|
|
/**
|
|
* <p>The name of the task group to associate with the task. The default value is
|
|
* the family name of the task definition (for example, family:my-family-name).</p>
|
|
*/
|
|
inline StartTaskRequest& WithGroup(const Aws::String& value) { SetGroup(value); return *this;}
|
|
|
|
/**
|
|
* <p>The name of the task group to associate with the task. The default value is
|
|
* the family name of the task definition (for example, family:my-family-name).</p>
|
|
*/
|
|
inline StartTaskRequest& WithGroup(Aws::String&& value) { SetGroup(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>The name of the task group to associate with the task. The default value is
|
|
* the family name of the task definition (for example, family:my-family-name).</p>
|
|
*/
|
|
inline StartTaskRequest& WithGroup(const char* value) { SetGroup(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>The VPC subnet and security group configuration for tasks that receive their
|
|
* own elastic network interface by using the <code>awsvpc</code> networking
|
|
* mode.</p>
|
|
*/
|
|
inline const NetworkConfiguration& GetNetworkConfiguration() const{ return m_networkConfiguration; }
|
|
|
|
/**
|
|
* <p>The VPC subnet and security group configuration for tasks that receive their
|
|
* own elastic network interface by using the <code>awsvpc</code> networking
|
|
* mode.</p>
|
|
*/
|
|
inline bool NetworkConfigurationHasBeenSet() const { return m_networkConfigurationHasBeenSet; }
|
|
|
|
/**
|
|
* <p>The VPC subnet and security group configuration for tasks that receive their
|
|
* own elastic network interface by using the <code>awsvpc</code> networking
|
|
* mode.</p>
|
|
*/
|
|
inline void SetNetworkConfiguration(const NetworkConfiguration& value) { m_networkConfigurationHasBeenSet = true; m_networkConfiguration = value; }
|
|
|
|
/**
|
|
* <p>The VPC subnet and security group configuration for tasks that receive their
|
|
* own elastic network interface by using the <code>awsvpc</code> networking
|
|
* mode.</p>
|
|
*/
|
|
inline void SetNetworkConfiguration(NetworkConfiguration&& value) { m_networkConfigurationHasBeenSet = true; m_networkConfiguration = std::move(value); }
|
|
|
|
/**
|
|
* <p>The VPC subnet and security group configuration for tasks that receive their
|
|
* own elastic network interface by using the <code>awsvpc</code> networking
|
|
* mode.</p>
|
|
*/
|
|
inline StartTaskRequest& WithNetworkConfiguration(const NetworkConfiguration& value) { SetNetworkConfiguration(value); return *this;}
|
|
|
|
/**
|
|
* <p>The VPC subnet and security group configuration for tasks that receive their
|
|
* own elastic network interface by using the <code>awsvpc</code> networking
|
|
* mode.</p>
|
|
*/
|
|
inline StartTaskRequest& WithNetworkConfiguration(NetworkConfiguration&& value) { SetNetworkConfiguration(std::move(value)); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>A list of container overrides in JSON format that specify the name of a
|
|
* container in the specified task definition and the overrides it should receive.
|
|
* You can override the default command for a container (that is specified in the
|
|
* task definition or Docker image) with a <code>command</code> override. You can
|
|
* also override existing environment variables (that are specified in the task
|
|
* definition or Docker image) on a container or add new environment variables to
|
|
* it with an <code>environment</code> override.</p> <p>A total of 8192
|
|
* characters are allowed for overrides. This limit includes the JSON formatting
|
|
* characters of the override structure.</p>
|
|
*/
|
|
inline const TaskOverride& GetOverrides() const{ return m_overrides; }
|
|
|
|
/**
|
|
* <p>A list of container overrides in JSON format that specify the name of a
|
|
* container in the specified task definition and the overrides it should receive.
|
|
* You can override the default command for a container (that is specified in the
|
|
* task definition or Docker image) with a <code>command</code> override. You can
|
|
* also override existing environment variables (that are specified in the task
|
|
* definition or Docker image) on a container or add new environment variables to
|
|
* it with an <code>environment</code> override.</p> <p>A total of 8192
|
|
* characters are allowed for overrides. This limit includes the JSON formatting
|
|
* characters of the override structure.</p>
|
|
*/
|
|
inline bool OverridesHasBeenSet() const { return m_overridesHasBeenSet; }
|
|
|
|
/**
|
|
* <p>A list of container overrides in JSON format that specify the name of a
|
|
* container in the specified task definition and the overrides it should receive.
|
|
* You can override the default command for a container (that is specified in the
|
|
* task definition or Docker image) with a <code>command</code> override. You can
|
|
* also override existing environment variables (that are specified in the task
|
|
* definition or Docker image) on a container or add new environment variables to
|
|
* it with an <code>environment</code> override.</p> <p>A total of 8192
|
|
* characters are allowed for overrides. This limit includes the JSON formatting
|
|
* characters of the override structure.</p>
|
|
*/
|
|
inline void SetOverrides(const TaskOverride& value) { m_overridesHasBeenSet = true; m_overrides = value; }
|
|
|
|
/**
|
|
* <p>A list of container overrides in JSON format that specify the name of a
|
|
* container in the specified task definition and the overrides it should receive.
|
|
* You can override the default command for a container (that is specified in the
|
|
* task definition or Docker image) with a <code>command</code> override. You can
|
|
* also override existing environment variables (that are specified in the task
|
|
* definition or Docker image) on a container or add new environment variables to
|
|
* it with an <code>environment</code> override.</p> <p>A total of 8192
|
|
* characters are allowed for overrides. This limit includes the JSON formatting
|
|
* characters of the override structure.</p>
|
|
*/
|
|
inline void SetOverrides(TaskOverride&& value) { m_overridesHasBeenSet = true; m_overrides = std::move(value); }
|
|
|
|
/**
|
|
* <p>A list of container overrides in JSON format that specify the name of a
|
|
* container in the specified task definition and the overrides it should receive.
|
|
* You can override the default command for a container (that is specified in the
|
|
* task definition or Docker image) with a <code>command</code> override. You can
|
|
* also override existing environment variables (that are specified in the task
|
|
* definition or Docker image) on a container or add new environment variables to
|
|
* it with an <code>environment</code> override.</p> <p>A total of 8192
|
|
* characters are allowed for overrides. This limit includes the JSON formatting
|
|
* characters of the override structure.</p>
|
|
*/
|
|
inline StartTaskRequest& WithOverrides(const TaskOverride& value) { SetOverrides(value); return *this;}
|
|
|
|
/**
|
|
* <p>A list of container overrides in JSON format that specify the name of a
|
|
* container in the specified task definition and the overrides it should receive.
|
|
* You can override the default command for a container (that is specified in the
|
|
* task definition or Docker image) with a <code>command</code> override. You can
|
|
* also override existing environment variables (that are specified in the task
|
|
* definition or Docker image) on a container or add new environment variables to
|
|
* it with an <code>environment</code> override.</p> <p>A total of 8192
|
|
* characters are allowed for overrides. This limit includes the JSON formatting
|
|
* characters of the override structure.</p>
|
|
*/
|
|
inline StartTaskRequest& WithOverrides(TaskOverride&& value) { SetOverrides(std::move(value)); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>Specifies whether to propagate the tags from the task definition or the
|
|
* service to the task. If no value is specified, the tags are not propagated.</p>
|
|
*/
|
|
inline const PropagateTags& GetPropagateTags() const{ return m_propagateTags; }
|
|
|
|
/**
|
|
* <p>Specifies whether to propagate the tags from the task definition or the
|
|
* service to the task. If no value is specified, the tags are not propagated.</p>
|
|
*/
|
|
inline bool PropagateTagsHasBeenSet() const { return m_propagateTagsHasBeenSet; }
|
|
|
|
/**
|
|
* <p>Specifies whether to propagate the tags from the task definition or the
|
|
* service to the task. If no value is specified, the tags are not propagated.</p>
|
|
*/
|
|
inline void SetPropagateTags(const PropagateTags& value) { m_propagateTagsHasBeenSet = true; m_propagateTags = value; }
|
|
|
|
/**
|
|
* <p>Specifies whether to propagate the tags from the task definition or the
|
|
* service to the task. If no value is specified, the tags are not propagated.</p>
|
|
*/
|
|
inline void SetPropagateTags(PropagateTags&& value) { m_propagateTagsHasBeenSet = true; m_propagateTags = std::move(value); }
|
|
|
|
/**
|
|
* <p>Specifies whether to propagate the tags from the task definition or the
|
|
* service to the task. If no value is specified, the tags are not propagated.</p>
|
|
*/
|
|
inline StartTaskRequest& WithPropagateTags(const PropagateTags& value) { SetPropagateTags(value); return *this;}
|
|
|
|
/**
|
|
* <p>Specifies whether to propagate the tags from the task definition or the
|
|
* service to the task. If no value is specified, the tags are not propagated.</p>
|
|
*/
|
|
inline StartTaskRequest& WithPropagateTags(PropagateTags&& value) { SetPropagateTags(std::move(value)); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>The reference ID to use for the task.</p>
|
|
*/
|
|
inline const Aws::String& GetReferenceId() const{ return m_referenceId; }
|
|
|
|
/**
|
|
* <p>The reference ID to use for the task.</p>
|
|
*/
|
|
inline bool ReferenceIdHasBeenSet() const { return m_referenceIdHasBeenSet; }
|
|
|
|
/**
|
|
* <p>The reference ID to use for the task.</p>
|
|
*/
|
|
inline void SetReferenceId(const Aws::String& value) { m_referenceIdHasBeenSet = true; m_referenceId = value; }
|
|
|
|
/**
|
|
* <p>The reference ID to use for the task.</p>
|
|
*/
|
|
inline void SetReferenceId(Aws::String&& value) { m_referenceIdHasBeenSet = true; m_referenceId = std::move(value); }
|
|
|
|
/**
|
|
* <p>The reference ID to use for the task.</p>
|
|
*/
|
|
inline void SetReferenceId(const char* value) { m_referenceIdHasBeenSet = true; m_referenceId.assign(value); }
|
|
|
|
/**
|
|
* <p>The reference ID to use for the task.</p>
|
|
*/
|
|
inline StartTaskRequest& WithReferenceId(const Aws::String& value) { SetReferenceId(value); return *this;}
|
|
|
|
/**
|
|
* <p>The reference ID to use for the task.</p>
|
|
*/
|
|
inline StartTaskRequest& WithReferenceId(Aws::String&& value) { SetReferenceId(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>The reference ID to use for the task.</p>
|
|
*/
|
|
inline StartTaskRequest& WithReferenceId(const char* value) { SetReferenceId(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>An optional tag specified when a task is started. For example, if you
|
|
* automatically trigger a task to run a batch process job, you could apply a
|
|
* unique identifier for that job to your task with the <code>startedBy</code>
|
|
* parameter. You can then identify which tasks belong to that job by filtering the
|
|
* results of a <a>ListTasks</a> call with the <code>startedBy</code> value. Up to
|
|
* 36 letters (uppercase and lowercase), numbers, hyphens, and underscores are
|
|
* allowed.</p> <p>If a task is started by an Amazon ECS service, then the
|
|
* <code>startedBy</code> parameter contains the deployment ID of the service that
|
|
* starts it.</p>
|
|
*/
|
|
inline const Aws::String& GetStartedBy() const{ return m_startedBy; }
|
|
|
|
/**
|
|
* <p>An optional tag specified when a task is started. For example, if you
|
|
* automatically trigger a task to run a batch process job, you could apply a
|
|
* unique identifier for that job to your task with the <code>startedBy</code>
|
|
* parameter. You can then identify which tasks belong to that job by filtering the
|
|
* results of a <a>ListTasks</a> call with the <code>startedBy</code> value. Up to
|
|
* 36 letters (uppercase and lowercase), numbers, hyphens, and underscores are
|
|
* allowed.</p> <p>If a task is started by an Amazon ECS service, then the
|
|
* <code>startedBy</code> parameter contains the deployment ID of the service that
|
|
* starts it.</p>
|
|
*/
|
|
inline bool StartedByHasBeenSet() const { return m_startedByHasBeenSet; }
|
|
|
|
/**
|
|
* <p>An optional tag specified when a task is started. For example, if you
|
|
* automatically trigger a task to run a batch process job, you could apply a
|
|
* unique identifier for that job to your task with the <code>startedBy</code>
|
|
* parameter. You can then identify which tasks belong to that job by filtering the
|
|
* results of a <a>ListTasks</a> call with the <code>startedBy</code> value. Up to
|
|
* 36 letters (uppercase and lowercase), numbers, hyphens, and underscores are
|
|
* allowed.</p> <p>If a task is started by an Amazon ECS service, then the
|
|
* <code>startedBy</code> parameter contains the deployment ID of the service that
|
|
* starts it.</p>
|
|
*/
|
|
inline void SetStartedBy(const Aws::String& value) { m_startedByHasBeenSet = true; m_startedBy = value; }
|
|
|
|
/**
|
|
* <p>An optional tag specified when a task is started. For example, if you
|
|
* automatically trigger a task to run a batch process job, you could apply a
|
|
* unique identifier for that job to your task with the <code>startedBy</code>
|
|
* parameter. You can then identify which tasks belong to that job by filtering the
|
|
* results of a <a>ListTasks</a> call with the <code>startedBy</code> value. Up to
|
|
* 36 letters (uppercase and lowercase), numbers, hyphens, and underscores are
|
|
* allowed.</p> <p>If a task is started by an Amazon ECS service, then the
|
|
* <code>startedBy</code> parameter contains the deployment ID of the service that
|
|
* starts it.</p>
|
|
*/
|
|
inline void SetStartedBy(Aws::String&& value) { m_startedByHasBeenSet = true; m_startedBy = std::move(value); }
|
|
|
|
/**
|
|
* <p>An optional tag specified when a task is started. For example, if you
|
|
* automatically trigger a task to run a batch process job, you could apply a
|
|
* unique identifier for that job to your task with the <code>startedBy</code>
|
|
* parameter. You can then identify which tasks belong to that job by filtering the
|
|
* results of a <a>ListTasks</a> call with the <code>startedBy</code> value. Up to
|
|
* 36 letters (uppercase and lowercase), numbers, hyphens, and underscores are
|
|
* allowed.</p> <p>If a task is started by an Amazon ECS service, then the
|
|
* <code>startedBy</code> parameter contains the deployment ID of the service that
|
|
* starts it.</p>
|
|
*/
|
|
inline void SetStartedBy(const char* value) { m_startedByHasBeenSet = true; m_startedBy.assign(value); }
|
|
|
|
/**
|
|
* <p>An optional tag specified when a task is started. For example, if you
|
|
* automatically trigger a task to run a batch process job, you could apply a
|
|
* unique identifier for that job to your task with the <code>startedBy</code>
|
|
* parameter. You can then identify which tasks belong to that job by filtering the
|
|
* results of a <a>ListTasks</a> call with the <code>startedBy</code> value. Up to
|
|
* 36 letters (uppercase and lowercase), numbers, hyphens, and underscores are
|
|
* allowed.</p> <p>If a task is started by an Amazon ECS service, then the
|
|
* <code>startedBy</code> parameter contains the deployment ID of the service that
|
|
* starts it.</p>
|
|
*/
|
|
inline StartTaskRequest& WithStartedBy(const Aws::String& value) { SetStartedBy(value); return *this;}
|
|
|
|
/**
|
|
* <p>An optional tag specified when a task is started. For example, if you
|
|
* automatically trigger a task to run a batch process job, you could apply a
|
|
* unique identifier for that job to your task with the <code>startedBy</code>
|
|
* parameter. You can then identify which tasks belong to that job by filtering the
|
|
* results of a <a>ListTasks</a> call with the <code>startedBy</code> value. Up to
|
|
* 36 letters (uppercase and lowercase), numbers, hyphens, and underscores are
|
|
* allowed.</p> <p>If a task is started by an Amazon ECS service, then the
|
|
* <code>startedBy</code> parameter contains the deployment ID of the service that
|
|
* starts it.</p>
|
|
*/
|
|
inline StartTaskRequest& WithStartedBy(Aws::String&& value) { SetStartedBy(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>An optional tag specified when a task is started. For example, if you
|
|
* automatically trigger a task to run a batch process job, you could apply a
|
|
* unique identifier for that job to your task with the <code>startedBy</code>
|
|
* parameter. You can then identify which tasks belong to that job by filtering the
|
|
* results of a <a>ListTasks</a> call with the <code>startedBy</code> value. Up to
|
|
* 36 letters (uppercase and lowercase), numbers, hyphens, and underscores are
|
|
* allowed.</p> <p>If a task is started by an Amazon ECS service, then the
|
|
* <code>startedBy</code> parameter contains the deployment ID of the service that
|
|
* starts it.</p>
|
|
*/
|
|
inline StartTaskRequest& WithStartedBy(const char* value) { SetStartedBy(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>The metadata that you apply to the task to help you categorize and organize
|
|
* them. Each tag consists of a key and an optional value, both of which you
|
|
* define.</p> <p>The following basic restrictions apply to tags:</p> <ul> <li>
|
|
* <p>Maximum number of tags per resource - 50</p> </li> <li> <p>For each resource,
|
|
* each tag key must be unique, and each tag key can have only one value.</p> </li>
|
|
* <li> <p>Maximum key length - 128 Unicode characters in UTF-8</p> </li> <li>
|
|
* <p>Maximum value length - 256 Unicode characters in UTF-8</p> </li> <li> <p>If
|
|
* your tagging schema is used across multiple services and resources, remember
|
|
* that other services may have restrictions on allowed characters. Generally
|
|
* allowed characters are: letters, numbers, and spaces representable in UTF-8, and
|
|
* the following characters: + - = . _ : / @.</p> </li> <li> <p>Tag keys and values
|
|
* are case-sensitive.</p> </li> <li> <p>Do not use <code>aws:</code>,
|
|
* <code>AWS:</code>, or any upper or lowercase combination of such as a prefix for
|
|
* either keys or values as it is reserved for AWS use. You cannot edit or delete
|
|
* tag keys or values with this prefix. Tags with this prefix do not count against
|
|
* your tags per resource limit.</p> </li> </ul>
|
|
*/
|
|
inline const Aws::Vector<Tag>& GetTags() const{ return m_tags; }
|
|
|
|
/**
|
|
* <p>The metadata that you apply to the task to help you categorize and organize
|
|
* them. Each tag consists of a key and an optional value, both of which you
|
|
* define.</p> <p>The following basic restrictions apply to tags:</p> <ul> <li>
|
|
* <p>Maximum number of tags per resource - 50</p> </li> <li> <p>For each resource,
|
|
* each tag key must be unique, and each tag key can have only one value.</p> </li>
|
|
* <li> <p>Maximum key length - 128 Unicode characters in UTF-8</p> </li> <li>
|
|
* <p>Maximum value length - 256 Unicode characters in UTF-8</p> </li> <li> <p>If
|
|
* your tagging schema is used across multiple services and resources, remember
|
|
* that other services may have restrictions on allowed characters. Generally
|
|
* allowed characters are: letters, numbers, and spaces representable in UTF-8, and
|
|
* the following characters: + - = . _ : / @.</p> </li> <li> <p>Tag keys and values
|
|
* are case-sensitive.</p> </li> <li> <p>Do not use <code>aws:</code>,
|
|
* <code>AWS:</code>, or any upper or lowercase combination of such as a prefix for
|
|
* either keys or values as it is reserved for AWS use. You cannot edit or delete
|
|
* tag keys or values with this prefix. Tags with this prefix do not count against
|
|
* your tags per resource limit.</p> </li> </ul>
|
|
*/
|
|
inline bool TagsHasBeenSet() const { return m_tagsHasBeenSet; }
|
|
|
|
/**
|
|
* <p>The metadata that you apply to the task to help you categorize and organize
|
|
* them. Each tag consists of a key and an optional value, both of which you
|
|
* define.</p> <p>The following basic restrictions apply to tags:</p> <ul> <li>
|
|
* <p>Maximum number of tags per resource - 50</p> </li> <li> <p>For each resource,
|
|
* each tag key must be unique, and each tag key can have only one value.</p> </li>
|
|
* <li> <p>Maximum key length - 128 Unicode characters in UTF-8</p> </li> <li>
|
|
* <p>Maximum value length - 256 Unicode characters in UTF-8</p> </li> <li> <p>If
|
|
* your tagging schema is used across multiple services and resources, remember
|
|
* that other services may have restrictions on allowed characters. Generally
|
|
* allowed characters are: letters, numbers, and spaces representable in UTF-8, and
|
|
* the following characters: + - = . _ : / @.</p> </li> <li> <p>Tag keys and values
|
|
* are case-sensitive.</p> </li> <li> <p>Do not use <code>aws:</code>,
|
|
* <code>AWS:</code>, or any upper or lowercase combination of such as a prefix for
|
|
* either keys or values as it is reserved for AWS use. You cannot edit or delete
|
|
* tag keys or values with this prefix. Tags with this prefix do not count against
|
|
* your tags per resource limit.</p> </li> </ul>
|
|
*/
|
|
inline void SetTags(const Aws::Vector<Tag>& value) { m_tagsHasBeenSet = true; m_tags = value; }
|
|
|
|
/**
|
|
* <p>The metadata that you apply to the task to help you categorize and organize
|
|
* them. Each tag consists of a key and an optional value, both of which you
|
|
* define.</p> <p>The following basic restrictions apply to tags:</p> <ul> <li>
|
|
* <p>Maximum number of tags per resource - 50</p> </li> <li> <p>For each resource,
|
|
* each tag key must be unique, and each tag key can have only one value.</p> </li>
|
|
* <li> <p>Maximum key length - 128 Unicode characters in UTF-8</p> </li> <li>
|
|
* <p>Maximum value length - 256 Unicode characters in UTF-8</p> </li> <li> <p>If
|
|
* your tagging schema is used across multiple services and resources, remember
|
|
* that other services may have restrictions on allowed characters. Generally
|
|
* allowed characters are: letters, numbers, and spaces representable in UTF-8, and
|
|
* the following characters: + - = . _ : / @.</p> </li> <li> <p>Tag keys and values
|
|
* are case-sensitive.</p> </li> <li> <p>Do not use <code>aws:</code>,
|
|
* <code>AWS:</code>, or any upper or lowercase combination of such as a prefix for
|
|
* either keys or values as it is reserved for AWS use. You cannot edit or delete
|
|
* tag keys or values with this prefix. Tags with this prefix do not count against
|
|
* your tags per resource limit.</p> </li> </ul>
|
|
*/
|
|
inline void SetTags(Aws::Vector<Tag>&& value) { m_tagsHasBeenSet = true; m_tags = std::move(value); }
|
|
|
|
/**
|
|
* <p>The metadata that you apply to the task to help you categorize and organize
|
|
* them. Each tag consists of a key and an optional value, both of which you
|
|
* define.</p> <p>The following basic restrictions apply to tags:</p> <ul> <li>
|
|
* <p>Maximum number of tags per resource - 50</p> </li> <li> <p>For each resource,
|
|
* each tag key must be unique, and each tag key can have only one value.</p> </li>
|
|
* <li> <p>Maximum key length - 128 Unicode characters in UTF-8</p> </li> <li>
|
|
* <p>Maximum value length - 256 Unicode characters in UTF-8</p> </li> <li> <p>If
|
|
* your tagging schema is used across multiple services and resources, remember
|
|
* that other services may have restrictions on allowed characters. Generally
|
|
* allowed characters are: letters, numbers, and spaces representable in UTF-8, and
|
|
* the following characters: + - = . _ : / @.</p> </li> <li> <p>Tag keys and values
|
|
* are case-sensitive.</p> </li> <li> <p>Do not use <code>aws:</code>,
|
|
* <code>AWS:</code>, or any upper or lowercase combination of such as a prefix for
|
|
* either keys or values as it is reserved for AWS use. You cannot edit or delete
|
|
* tag keys or values with this prefix. Tags with this prefix do not count against
|
|
* your tags per resource limit.</p> </li> </ul>
|
|
*/
|
|
inline StartTaskRequest& WithTags(const Aws::Vector<Tag>& value) { SetTags(value); return *this;}
|
|
|
|
/**
|
|
* <p>The metadata that you apply to the task to help you categorize and organize
|
|
* them. Each tag consists of a key and an optional value, both of which you
|
|
* define.</p> <p>The following basic restrictions apply to tags:</p> <ul> <li>
|
|
* <p>Maximum number of tags per resource - 50</p> </li> <li> <p>For each resource,
|
|
* each tag key must be unique, and each tag key can have only one value.</p> </li>
|
|
* <li> <p>Maximum key length - 128 Unicode characters in UTF-8</p> </li> <li>
|
|
* <p>Maximum value length - 256 Unicode characters in UTF-8</p> </li> <li> <p>If
|
|
* your tagging schema is used across multiple services and resources, remember
|
|
* that other services may have restrictions on allowed characters. Generally
|
|
* allowed characters are: letters, numbers, and spaces representable in UTF-8, and
|
|
* the following characters: + - = . _ : / @.</p> </li> <li> <p>Tag keys and values
|
|
* are case-sensitive.</p> </li> <li> <p>Do not use <code>aws:</code>,
|
|
* <code>AWS:</code>, or any upper or lowercase combination of such as a prefix for
|
|
* either keys or values as it is reserved for AWS use. You cannot edit or delete
|
|
* tag keys or values with this prefix. Tags with this prefix do not count against
|
|
* your tags per resource limit.</p> </li> </ul>
|
|
*/
|
|
inline StartTaskRequest& WithTags(Aws::Vector<Tag>&& value) { SetTags(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>The metadata that you apply to the task to help you categorize and organize
|
|
* them. Each tag consists of a key and an optional value, both of which you
|
|
* define.</p> <p>The following basic restrictions apply to tags:</p> <ul> <li>
|
|
* <p>Maximum number of tags per resource - 50</p> </li> <li> <p>For each resource,
|
|
* each tag key must be unique, and each tag key can have only one value.</p> </li>
|
|
* <li> <p>Maximum key length - 128 Unicode characters in UTF-8</p> </li> <li>
|
|
* <p>Maximum value length - 256 Unicode characters in UTF-8</p> </li> <li> <p>If
|
|
* your tagging schema is used across multiple services and resources, remember
|
|
* that other services may have restrictions on allowed characters. Generally
|
|
* allowed characters are: letters, numbers, and spaces representable in UTF-8, and
|
|
* the following characters: + - = . _ : / @.</p> </li> <li> <p>Tag keys and values
|
|
* are case-sensitive.</p> </li> <li> <p>Do not use <code>aws:</code>,
|
|
* <code>AWS:</code>, or any upper or lowercase combination of such as a prefix for
|
|
* either keys or values as it is reserved for AWS use. You cannot edit or delete
|
|
* tag keys or values with this prefix. Tags with this prefix do not count against
|
|
* your tags per resource limit.</p> </li> </ul>
|
|
*/
|
|
inline StartTaskRequest& AddTags(const Tag& value) { m_tagsHasBeenSet = true; m_tags.push_back(value); return *this; }
|
|
|
|
/**
|
|
* <p>The metadata that you apply to the task to help you categorize and organize
|
|
* them. Each tag consists of a key and an optional value, both of which you
|
|
* define.</p> <p>The following basic restrictions apply to tags:</p> <ul> <li>
|
|
* <p>Maximum number of tags per resource - 50</p> </li> <li> <p>For each resource,
|
|
* each tag key must be unique, and each tag key can have only one value.</p> </li>
|
|
* <li> <p>Maximum key length - 128 Unicode characters in UTF-8</p> </li> <li>
|
|
* <p>Maximum value length - 256 Unicode characters in UTF-8</p> </li> <li> <p>If
|
|
* your tagging schema is used across multiple services and resources, remember
|
|
* that other services may have restrictions on allowed characters. Generally
|
|
* allowed characters are: letters, numbers, and spaces representable in UTF-8, and
|
|
* the following characters: + - = . _ : / @.</p> </li> <li> <p>Tag keys and values
|
|
* are case-sensitive.</p> </li> <li> <p>Do not use <code>aws:</code>,
|
|
* <code>AWS:</code>, or any upper or lowercase combination of such as a prefix for
|
|
* either keys or values as it is reserved for AWS use. You cannot edit or delete
|
|
* tag keys or values with this prefix. Tags with this prefix do not count against
|
|
* your tags per resource limit.</p> </li> </ul>
|
|
*/
|
|
inline StartTaskRequest& AddTags(Tag&& value) { m_tagsHasBeenSet = true; m_tags.push_back(std::move(value)); return *this; }
|
|
|
|
|
|
/**
|
|
* <p>The <code>family</code> and <code>revision</code>
|
|
* (<code>family:revision</code>) or full ARN of the task definition to start. If a
|
|
* <code>revision</code> is not specified, the latest <code>ACTIVE</code> revision
|
|
* is used.</p>
|
|
*/
|
|
inline const Aws::String& GetTaskDefinition() const{ return m_taskDefinition; }
|
|
|
|
/**
|
|
* <p>The <code>family</code> and <code>revision</code>
|
|
* (<code>family:revision</code>) or full ARN of the task definition to start. If a
|
|
* <code>revision</code> is not specified, the latest <code>ACTIVE</code> revision
|
|
* is used.</p>
|
|
*/
|
|
inline bool TaskDefinitionHasBeenSet() const { return m_taskDefinitionHasBeenSet; }
|
|
|
|
/**
|
|
* <p>The <code>family</code> and <code>revision</code>
|
|
* (<code>family:revision</code>) or full ARN of the task definition to start. If a
|
|
* <code>revision</code> is not specified, the latest <code>ACTIVE</code> revision
|
|
* is used.</p>
|
|
*/
|
|
inline void SetTaskDefinition(const Aws::String& value) { m_taskDefinitionHasBeenSet = true; m_taskDefinition = value; }
|
|
|
|
/**
|
|
* <p>The <code>family</code> and <code>revision</code>
|
|
* (<code>family:revision</code>) or full ARN of the task definition to start. If a
|
|
* <code>revision</code> is not specified, the latest <code>ACTIVE</code> revision
|
|
* is used.</p>
|
|
*/
|
|
inline void SetTaskDefinition(Aws::String&& value) { m_taskDefinitionHasBeenSet = true; m_taskDefinition = std::move(value); }
|
|
|
|
/**
|
|
* <p>The <code>family</code> and <code>revision</code>
|
|
* (<code>family:revision</code>) or full ARN of the task definition to start. If a
|
|
* <code>revision</code> is not specified, the latest <code>ACTIVE</code> revision
|
|
* is used.</p>
|
|
*/
|
|
inline void SetTaskDefinition(const char* value) { m_taskDefinitionHasBeenSet = true; m_taskDefinition.assign(value); }
|
|
|
|
/**
|
|
* <p>The <code>family</code> and <code>revision</code>
|
|
* (<code>family:revision</code>) or full ARN of the task definition to start. If a
|
|
* <code>revision</code> is not specified, the latest <code>ACTIVE</code> revision
|
|
* is used.</p>
|
|
*/
|
|
inline StartTaskRequest& WithTaskDefinition(const Aws::String& value) { SetTaskDefinition(value); return *this;}
|
|
|
|
/**
|
|
* <p>The <code>family</code> and <code>revision</code>
|
|
* (<code>family:revision</code>) or full ARN of the task definition to start. If a
|
|
* <code>revision</code> is not specified, the latest <code>ACTIVE</code> revision
|
|
* is used.</p>
|
|
*/
|
|
inline StartTaskRequest& WithTaskDefinition(Aws::String&& value) { SetTaskDefinition(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>The <code>family</code> and <code>revision</code>
|
|
* (<code>family:revision</code>) or full ARN of the task definition to start. If a
|
|
* <code>revision</code> is not specified, the latest <code>ACTIVE</code> revision
|
|
* is used.</p>
|
|
*/
|
|
inline StartTaskRequest& WithTaskDefinition(const char* value) { SetTaskDefinition(value); return *this;}
|
|
|
|
private:
|
|
|
|
Aws::String m_cluster;
|
|
bool m_clusterHasBeenSet;
|
|
|
|
Aws::Vector<Aws::String> m_containerInstances;
|
|
bool m_containerInstancesHasBeenSet;
|
|
|
|
bool m_enableECSManagedTags;
|
|
bool m_enableECSManagedTagsHasBeenSet;
|
|
|
|
Aws::String m_group;
|
|
bool m_groupHasBeenSet;
|
|
|
|
NetworkConfiguration m_networkConfiguration;
|
|
bool m_networkConfigurationHasBeenSet;
|
|
|
|
TaskOverride m_overrides;
|
|
bool m_overridesHasBeenSet;
|
|
|
|
PropagateTags m_propagateTags;
|
|
bool m_propagateTagsHasBeenSet;
|
|
|
|
Aws::String m_referenceId;
|
|
bool m_referenceIdHasBeenSet;
|
|
|
|
Aws::String m_startedBy;
|
|
bool m_startedByHasBeenSet;
|
|
|
|
Aws::Vector<Tag> m_tags;
|
|
bool m_tagsHasBeenSet;
|
|
|
|
Aws::String m_taskDefinition;
|
|
bool m_taskDefinitionHasBeenSet;
|
|
};
|
|
|
|
} // namespace Model
|
|
} // namespace ECS
|
|
} // namespace Aws
|