/* * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ /* * Do not modify this file. This file is generated from the ecs-2014-11-13.normal.json service model. */ using System; using System.Collections.Generic; using System.Xml.Serialization; using System.Text; using System.IO; using System.Net; using Amazon.Runtime; using Amazon.Runtime.Internal; namespace Amazon.ECS.Model { /// /// Container for the parameters to the UpdateService operation. /// Modifies the parameters of a service. /// /// /// /// For services using the rolling update (ECS) you can update the desired /// count, deployment configuration, network configuration, load balancers, service registries, /// enable ECS managed tags option, propagate tags option, task placement constraints /// and strategies, and task definition. When you update any of these parameters, Amazon /// ECS starts new tasks with the new configuration. /// /// /// /// For services using the blue/green (CODE_DEPLOY) deployment controller, /// only the desired count, deployment configuration, health check grace period, task /// placement constraints and strategies, enable ECS managed tags option, and propagate /// tags can be updated using this API. If the network configuration, platform version, /// task definition, or load balancer need to be updated, create a new CodeDeploy deployment. /// For more information, see CreateDeployment /// in the CodeDeploy API Reference. /// /// /// /// For services using an external deployment controller, you can update only the desired /// count, task placement constraints and strategies, health check grace period, enable /// ECS managed tags option, and propagate tags option, using this API. If the launch /// type, load balancer, network configuration, platform version, or task definition need /// to be updated, create a new task set For more information, see CreateTaskSet. /// /// /// /// You can add to or subtract from the number of instantiations of a task definition /// in a service by specifying the cluster that the service is running in and a new desiredCount /// parameter. /// /// /// /// If you have updated the Docker image of your application, you can create a new task /// definition with that image and deploy it to your service. The service scheduler uses /// the minimum healthy percent and maximum percent parameters (in the service's deployment /// configuration) to determine the deployment strategy. /// /// /// /// If your updated Docker image uses the same tag as what is in the existing task definition /// for your service (for example, my_image:latest), you don't need to create /// a new revision of your task definition. You can update the service using the forceNewDeployment /// option. The new tasks launched by the deployment pull the current image/tag combination /// from your repository when they start. /// /// /// /// You can also update the deployment configuration of a service. When a deployment is /// triggered by updating the task definition of a service, the service scheduler uses /// the deployment configuration parameters, minimumHealthyPercent and maximumPercent, /// to determine the deployment strategy. /// /// /// /// When UpdateService stops a task during a deployment, the equivalent of docker /// stop is issued to the containers running in the task. This results in a SIGTERM /// and a 30-second timeout. After this, SIGKILL is sent and the containers /// are forcibly stopped. If the container handles the SIGTERM gracefully /// and exits within 30 seconds from receiving it, no SIGKILL is sent. /// /// /// /// When the service scheduler launches new tasks, it determines task placement in your /// cluster with the following logic. /// /// /// /// When the service scheduler stops running tasks, it attempts to maintain balance across /// the Availability Zones in your cluster using the following logic: /// /// /// /// You must have a service-linked role when you update any of the following service properties. /// If you specified a custom role when you created the service, Amazon ECS automatically /// replaces the roleARN /// associated with the service with the ARN of your service-linked role. For more information, /// see Service-linked /// roles in the Amazon Elastic Container Service Developer Guide. /// /// /// public partial class UpdateServiceRequest : AmazonECSRequest { private List _capacityProviderStrategy = new List(); private string _cluster; private DeploymentConfiguration _deploymentConfiguration; private int? _desiredCount; private bool? _enableecsManagedTags; private bool? _enableExecuteCommand; private bool? _forceNewDeployment; private int? _healthCheckGracePeriodSeconds; private List _loadBalancers = new List(); private NetworkConfiguration _networkConfiguration; private List _placementConstraints = new List(); private List _placementStrategy = new List(); private string _platformVersion; private PropagateTags _propagateTags; private string _service; private ServiceConnectConfiguration _serviceConnectConfiguration; private List _serviceRegistries = new List(); private string _taskDefinition; /// /// Gets and sets the property CapacityProviderStrategy. /// /// The capacity provider strategy to update the service to use. /// /// /// /// if the service uses the default capacity provider strategy for the cluster, the service /// can be updated to use one or more capacity providers as opposed to the default capacity /// provider strategy. However, when a service is using a capacity provider strategy that's /// not the default capacity provider strategy, the service can't be updated to use the /// cluster's default capacity provider strategy. /// /// /// /// A capacity provider strategy consists of one or more capacity providers along with /// the base and weight to assign to them. A capacity provider /// must be associated with the cluster to be used in a capacity provider strategy. The /// PutClusterCapacityProviders API is used to associate a capacity provider with /// a cluster. Only capacity providers with an ACTIVE or UPDATING /// status can be used. /// /// /// /// If specifying a capacity provider that uses an Auto Scaling group, the capacity provider /// must already be created. New capacity providers can be created with the CreateCapacityProvider /// API operation. /// /// /// /// To use a Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT /// capacity providers. The Fargate capacity providers are available to all accounts and /// only need to be associated with a cluster to be used. /// /// /// /// The PutClusterCapacityProviders API operation is used to update the list of /// available capacity providers for a cluster after the cluster is created. /// /// public List CapacityProviderStrategy { get { return this._capacityProviderStrategy; } set { this._capacityProviderStrategy = value; } } // Check to see if CapacityProviderStrategy property is set internal bool IsSetCapacityProviderStrategy() { return this._capacityProviderStrategy != null && this._capacityProviderStrategy.Count > 0; } /// /// Gets and sets the property Cluster. /// /// The short name or full Amazon Resource Name (ARN) of the cluster that your service /// runs on. If you do not specify a cluster, the default cluster is assumed. /// /// public string Cluster { get { return this._cluster; } set { this._cluster = value; } } // Check to see if Cluster property is set internal bool IsSetCluster() { return this._cluster != null; } /// /// Gets and sets the property DeploymentConfiguration. /// /// Optional deployment parameters that control how many tasks run during the deployment /// and the ordering of stopping and starting tasks. /// /// public DeploymentConfiguration DeploymentConfiguration { get { return this._deploymentConfiguration; } set { this._deploymentConfiguration = value; } } // Check to see if DeploymentConfiguration property is set internal bool IsSetDeploymentConfiguration() { return this._deploymentConfiguration != null; } /// /// Gets and sets the property DesiredCount. /// /// The number of instantiations of the task to place and keep running in your service. /// /// public int DesiredCount { get { return this._desiredCount.GetValueOrDefault(); } set { this._desiredCount = value; } } // Check to see if DesiredCount property is set internal bool IsSetDesiredCount() { return this._desiredCount.HasValue; } /// /// Gets and sets the property EnableECSManagedTags. /// /// Determines whether to turn on Amazon ECS managed tags for the tasks in the service. /// For more information, see Tagging /// Your Amazon ECS Resources in the Amazon Elastic Container Service Developer /// Guide. /// /// /// /// Only tasks launched after the update will reflect the update. To update the tags on /// all tasks, set forceNewDeployment to true, so that Amazon /// ECS starts new tasks with the updated tags. /// /// public bool EnableECSManagedTags { get { return this._enableecsManagedTags.GetValueOrDefault(); } set { this._enableecsManagedTags = value; } } // Check to see if EnableECSManagedTags property is set internal bool IsSetEnableECSManagedTags() { return this._enableecsManagedTags.HasValue; } /// /// Gets and sets the property EnableExecuteCommand. /// /// If true, this enables execute command functionality on all task containers. /// /// /// /// If you do not want to override the value that was set when the service was created, /// you can set this to null when performing this action. /// /// public bool EnableExecuteCommand { get { return this._enableExecuteCommand.GetValueOrDefault(); } set { this._enableExecuteCommand = value; } } // Check to see if EnableExecuteCommand property is set internal bool IsSetEnableExecuteCommand() { return this._enableExecuteCommand.HasValue; } /// /// Gets and sets the property ForceNewDeployment. /// /// Determines whether to force a new deployment of the service. By default, deployments /// aren't forced. You can use this option to start a new deployment with no service definition /// changes. For example, you can update a service's tasks to use a newer Docker image /// with the same image/tag combination (my_image:latest) or to roll Fargate /// tasks onto a newer platform version. /// /// public bool ForceNewDeployment { get { return this._forceNewDeployment.GetValueOrDefault(); } set { this._forceNewDeployment = value; } } // Check to see if ForceNewDeployment property is set internal bool IsSetForceNewDeployment() { return this._forceNewDeployment.HasValue; } /// /// Gets and sets the property HealthCheckGracePeriodSeconds. /// /// The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy /// Elastic Load Balancing target health checks after a task has first started. This is /// only valid if your service is configured to use a load balancer. If your service's /// tasks take a while to start and respond to Elastic Load Balancing health checks, you /// can specify a health check grace period of up to 2,147,483,647 seconds. During that /// time, the Amazon ECS service scheduler ignores the Elastic Load Balancing health check /// status. This grace period can prevent the ECS service scheduler from marking tasks /// as unhealthy and stopping them before they have time to come up. /// /// public int HealthCheckGracePeriodSeconds { get { return this._healthCheckGracePeriodSeconds.GetValueOrDefault(); } set { this._healthCheckGracePeriodSeconds = value; } } // Check to see if HealthCheckGracePeriodSeconds property is set internal bool IsSetHealthCheckGracePeriodSeconds() { return this._healthCheckGracePeriodSeconds.HasValue; } /// /// Gets and sets the property LoadBalancers. /// /// A list of Elastic Load Balancing load balancer objects. It contains the load balancer /// name, the container name, and the container port to access from the load balancer. /// The container name is as it appears in a container definition. /// /// /// /// When you add, update, or remove a load balancer configuration, Amazon ECS starts new /// tasks with the updated Elastic Load Balancing configuration, and then stops the old /// tasks when the new tasks are running. /// /// /// /// For services that use rolling updates, you can add, update, or remove Elastic Load /// Balancing target groups. You can update from a single target group to multiple target /// groups and from multiple target groups to a single target group. /// /// /// /// For services that use blue/green deployments, you can update Elastic Load Balancing /// target groups by using CreateDeployment /// through CodeDeploy. Note that multiple target groups are not supported for /// blue/green deployments. For more information see Register /// multiple target groups with a service in the Amazon Elastic Container Service /// Developer Guide. /// /// /// /// For services that use the external deployment controller, you can add, update, or /// remove load balancers by using CreateTaskSet. /// Note that multiple target groups are not supported for external deployments. For more /// information see Register /// multiple target groups with a service in the Amazon Elastic Container Service /// Developer Guide. /// /// /// /// You can remove existing loadBalancers by passing an empty list. /// /// public List LoadBalancers { get { return this._loadBalancers; } set { this._loadBalancers = value; } } // Check to see if LoadBalancers property is set internal bool IsSetLoadBalancers() { return this._loadBalancers != null && this._loadBalancers.Count > 0; } /// /// Gets and sets the property NetworkConfiguration. /// /// An object representing the network configuration for the service. /// /// public NetworkConfiguration NetworkConfiguration { get { return this._networkConfiguration; } set { this._networkConfiguration = value; } } // Check to see if NetworkConfiguration property is set internal bool IsSetNetworkConfiguration() { return this._networkConfiguration != null; } /// /// Gets and sets the property PlacementConstraints. /// /// An array of task placement constraint objects to update the service to use. If no /// value is specified, the existing placement constraints for the service will remain /// unchanged. If this value is specified, it will override any existing placement constraints /// defined for the service. To remove all existing placement constraints, specify an /// empty array. /// /// /// /// You can specify a maximum of 10 constraints for each task. This limit includes constraints /// in the task definition and those specified at runtime. /// /// public List PlacementConstraints { get { return this._placementConstraints; } set { this._placementConstraints = value; } } // Check to see if PlacementConstraints property is set internal bool IsSetPlacementConstraints() { return this._placementConstraints != null && this._placementConstraints.Count > 0; } /// /// Gets and sets the property PlacementStrategy. /// /// The task placement strategy objects to update the service to use. If no value is specified, /// the existing placement strategy for the service will remain unchanged. If this value /// is specified, it will override the existing placement strategy defined for the service. /// To remove an existing placement strategy, specify an empty object. /// /// /// /// You can specify a maximum of five strategy rules for each service. /// /// public List PlacementStrategy { get { return this._placementStrategy; } set { this._placementStrategy = value; } } // Check to see if PlacementStrategy property is set internal bool IsSetPlacementStrategy() { return this._placementStrategy != null && this._placementStrategy.Count > 0; } /// /// Gets and sets the property PlatformVersion. /// /// The platform version that your tasks in the service run on. A platform version is /// only specified for tasks using the Fargate launch type. If a platform version is not /// specified, the LATEST platform version is used. For more information, /// see Fargate /// Platform Versions in the Amazon Elastic Container Service Developer Guide. /// /// public string PlatformVersion { get { return this._platformVersion; } set { this._platformVersion = value; } } // Check to see if PlatformVersion property is set internal bool IsSetPlatformVersion() { return this._platformVersion != null; } /// /// Gets and sets the property PropagateTags. /// /// Determines whether to propagate the tags from the task definition or the service to /// the task. If no value is specified, the tags aren't propagated. /// /// /// /// Only tasks launched after the update will reflect the update. To update the tags on /// all tasks, set forceNewDeployment to true, so that Amazon /// ECS starts new tasks with the updated tags. /// /// public PropagateTags PropagateTags { get { return this._propagateTags; } set { this._propagateTags = value; } } // Check to see if PropagateTags property is set internal bool IsSetPropagateTags() { return this._propagateTags != null; } /// /// Gets and sets the property Service. /// /// The name of the service to update. /// /// [AWSProperty(Required=true)] public string Service { get { return this._service; } set { this._service = value; } } // Check to see if Service property is set internal bool IsSetService() { return this._service != null; } /// /// Gets and sets the property ServiceConnectConfiguration. /// /// The configuration for this service to discover and connect to services, and be discovered /// by, and connected from, other services within a namespace. /// /// /// /// Tasks that run in a namespace can use short names to connect to services in the namespace. /// Tasks can connect to services across all of the clusters in the namespace. Tasks connect /// through a managed proxy container that collects logs and metrics for increased visibility. /// Only the tasks that Amazon ECS services create are supported with Service Connect. /// For more information, see Service /// Connect in the Amazon Elastic Container Service Developer Guide. /// /// public ServiceConnectConfiguration ServiceConnectConfiguration { get { return this._serviceConnectConfiguration; } set { this._serviceConnectConfiguration = value; } } // Check to see if ServiceConnectConfiguration property is set internal bool IsSetServiceConnectConfiguration() { return this._serviceConnectConfiguration != null; } /// /// Gets and sets the property ServiceRegistries. /// /// The details for the service discovery registries to assign to this service. For more /// information, see Service /// Discovery. /// /// /// /// When you add, update, or remove the service registries configuration, Amazon ECS starts /// new tasks with the updated service registries configuration, and then stops the old /// tasks when the new tasks are running. /// /// /// /// You can remove existing serviceRegistries by passing an empty list. /// /// public List ServiceRegistries { get { return this._serviceRegistries; } set { this._serviceRegistries = value; } } // Check to see if ServiceRegistries property is set internal bool IsSetServiceRegistries() { return this._serviceRegistries != null && this._serviceRegistries.Count > 0; } /// /// Gets and sets the property TaskDefinition. /// /// The family and revision (family:revision) or /// full ARN of the task definition to run in your service. If a revision /// is not specified, the latest ACTIVE revision is used. If you modify the /// task definition with UpdateService, Amazon ECS spawns a task with the /// new version of the task definition and then stops an old task after the new version /// is running. /// /// public string TaskDefinition { get { return this._taskDefinition; } set { this._taskDefinition = value; } } // Check to see if TaskDefinition property is set internal bool IsSetTaskDefinition() { return this._taskDefinition != null; } } }