/*
* 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 DeleteService operation.
/// Deletes a specified service within a cluster. You can delete a service if you have
/// no running tasks in it and the desired task count is zero. If the service is actively
/// maintaining tasks, you can't delete it, and you must update the service to a desired
/// task count of zero. For more information, see UpdateService.
///
///
///
/// When you delete a service, if there are still running tasks that require cleanup,
/// the service status moves from ACTIVE
to DRAINING
, and the
/// service is no longer visible in the console or in the ListServices API operation.
/// After all tasks have transitioned to either STOPPING
or STOPPED
/// status, the service status moves from DRAINING
to INACTIVE
.
/// Services in the DRAINING
or INACTIVE
status can still be
/// viewed with the DescribeServices API operation. However, in the future, INACTIVE
/// services may be cleaned up and purged from Amazon ECS record keeping, and DescribeServices
/// calls on those services return a ServiceNotFoundException
error.
///
///
///
/// If you attempt to create a new service with the same name as an existing service in
/// either ACTIVE
or DRAINING
status, you receive an error.
///
///
///
public partial class DeleteServiceRequest : AmazonECSRequest
{
private string _cluster;
private bool? _force;
private string _service;
///
/// Gets and sets the property Cluster.
///
/// The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service
/// to delete. 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 Force.
///
/// If true
, allows you to delete a service even if it wasn't scaled down
/// to zero tasks. It's only necessary to use this if the service uses the REPLICA
/// scheduling strategy.
///
///
public bool Force
{
get { return this._force.GetValueOrDefault(); }
set { this._force = value; }
}
// Check to see if Force property is set
internal bool IsSetForce()
{
return this._force.HasValue;
}
///
/// Gets and sets the property Service.
///
/// The name of the service to delete.
///
///
[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;
}
}
}