Doc AWS SDK Examples GitHub リポジトリには、他にも SDK の例があります。 [AWS](https://github.com/awsdocs/aws-doc-sdk-examples)
翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
# を使用した Amazon ECS の例 AWS CLI
次のコード例は、Amazon ECS AWS Command Line Interface で を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。
*アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。
各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。
**Topics**
+ [アクション](#actions)
## アクション
### `capacity-provider-update`
次のコード例は、`capacity-provider-update` を使用する方法を示しています。
**AWS CLI**
**ECS クラスターのキャパシティプロバイダーを更新する**
次の `update-capacity-provider` の例では、ECS クラスターのキャパシティプロバイダーのパラメータを変更する方法を示します。
```
aws ecs update-capacity-provider \
--name Infra-ECS-Cluster-ECS-project-update-cluster-d6bb6d5b-EC2CapacityProvider-3fIpdkLywwFt \
--auto-scaling-group-provider "managedScaling={status=DISABLED,targetCapacity=50,minimumScalingStepSize=2,maximumScalingStepSize=30,instanceWarmupPeriod=200},managedTerminationProtection=DISABLED,managedDraining=DISABLED"
```
出力:
```
{
"capacityProvider": {
"capacityProviderArn": "arn:aws:ecs:us-west-2:123456789012:capacity-provider/Infra-ECS-Cluster-ECS-project-update-cluster-d6bb6d5b-EC2CapacityProvider-3fIpdkLywwFt",
"name": "Infra-ECS-Cluster-ECS-project-update-cluster-d6bb6d5b-EC2CapacityProvider-3fIpdkLywwFt",
"status": "ACTIVE",
"autoScalingGroupProvider": {
"autoScalingGroupArn": "arn:aws:autoscaling:us-west-2:123456789012:autoScalingGroup:424941d1-b43f-4a17-adbb-08b6a6e397e1:autoScalingGroupName/Infra-ECS-Cluster-ECS-project-update-cluster-d6bb6d5b-ECSAutoScalingGroup-f44jrQHS2nRB",
"managedScaling": {
"status": "ENABLED",
"targetCapacity": 100,
"minimumScalingStepSize": 1,
"maximumScalingStepSize": 10000,
"instanceWarmupPeriod": 300
},
"managedTerminationProtection": "DISABLED",
"managedDraining": "ENABLED"
},
"updateStatus": "UPDATE_IN_PROGRESS",
"tags": []
}
}
```
キャパシティプロバイダーの詳細については、*Amazon ECS デベロッパーガイド*の「[EC2 起動タイプ用の Amazon ECS キャパシティプロバイダー](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/asg-capacity-providers.html)」を参照してください。
+ API の詳細については、*AWS CLI コマンドリファレンス*の「[CapacityProviderUpdate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/capacity-provider-update.html)」を参照してください。
### `create-capacity-provider`
次のコード例は、`create-capacity-provider` を使用する方法を示しています。
**AWS CLI**
**キャパシティープロバイダーを作成するには**
次の create-capacity-provider の例では、MyASG という名前の Auto Scaling グループを使用し、マネージドスケーリングおよびマネージド終了保護を有効にしたキャパシティープロバイダーを作成します。この構成は、Amazon ECS クラスターの自動スケーリングに使用されます。
```
aws ecs create-capacity-provider \
--name "MyCapacityProvider" \
--auto-scaling-group-provider "autoScalingGroupArn=arn:aws:autoscaling:us-east-1:123456789012:autoScalingGroup:57ffcb94-11f0-4d6d-bf60-3bac5EXAMPLE:autoScalingGroupName/MyASG,managedScaling={status=ENABLED,targetCapacity=100},managedTerminationProtection=ENABLED"
```
出力:
```
{
"capacityProvider": {
"capacityProviderArn": "arn:aws:ecs:us-east-1:123456789012:capacity-provider/MyCapacityProvider",
"name": "MyCapacityProvider",
"status": "ACTIVE",
"autoScalingGroupProvider": {
"autoScalingGroupArn": "arn:aws:autoscaling:us-east-1:132456789012:autoScalingGroup:57ffcb94-11f0-4d6d-bf60-3bac5EXAMPLE:autoScalingGroupName/MyASG",
"managedScaling": {
"status": "ENABLED",
"targetCapacity": 100,
"minimumScalingStepSize": 1,
"maximumScalingStepSize": 10000,
"instanceWarmupPeriod": 300
},
"managedTerminationProtection": "ENABLED"
},
"tags": []
}
```
詳細については、「*Amazon ECS デベロッパーガイド*」の「[Amazon ECS クラスター自動スケーリング](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-auto-scaling.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateCapacityProvider](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/create-capacity-provider.html)」を参照してください。
### `create-cluster`
次のコード例は、`create-cluster` を使用する方法を示しています。
**AWS CLI**
**例 1: 新しいクラスターを作成するには**
次の `create-cluster`の例では、`MyCluster` という名前のクラスターを作成し、オブザーバビリティが強化された CloudWatch Container Insights を有効にします。
```
aws ecs create-cluster \
--cluster-name MyCluster \
--settings name=containerInsights,value=enhanced
```
出力:
```
{
"cluster": {
"clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster",
"clusterName": "MyCluster",
"status": "ACTIVE",
"registeredContainerInstancesCount": 0,
"pendingTasksCount": 0,
"runningTasksCount": 0,
"activeServicesCount": 0,
"statistics": [],
"settings": [
{
"name": "containerInsights",
"value": "enhanced"
}
],
"tags": []
}
}
```
詳細については、「Amazon ECS ディベロッパーガイド」の「[従来のコンソールを使用したクラスターの作成](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/create_cluster.html)」を参照してください。**
**例 2: キャパシティプロバイダーを使用して新しいクラスターを作成するには**
次の `create-cluster` の例は、クラスターを作成し、2 つの既存のキャパシティプロバイダーをそのクラスターに関連付けます。キャパシティープロバイダーを作成するには、`create-capacity-provider` コマンドを使用します。デフォルトのキャパシティープロバイダー戦略を指定することは任意ですが、指定することをお勧めします。この例では、`MyCluster` という名前のクラスターを作成し、`MyCapacityProvider1` と `MyCapacityProvider2` をキャパシティプロバイダーに関連付けます。デフォルトのキャパシティープロバイダー戦略は、タスクを両方のキャパシティープロバイダーに均等に分散するように指定されています。
```
aws ecs create-cluster \
--cluster-name MyCluster \
--capacity-providers MyCapacityProvider1 MyCapacityProvider2 \
--default-capacity-provider-strategy capacityProvider=MyCapacityProvider1,weight=1 capacityProvider=MyCapacityProvider2,weight=1
```
出力:
```
{
"cluster": {
"clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster",
"clusterName": "MyCluster",
"status": "PROVISIONING",
"registeredContainerInstancesCount": 0,
"pendingTasksCount": 0,
"runningTasksCount": 0,
"activeServicesCount": 0,
"statistics": [],
"settings": [
{
"name": "containerInsights",
"value": "enabled"
}
],
"capacityProviders": [
"MyCapacityProvider1",
"MyCapacityProvider2"
],
"defaultCapacityProviderStrategy": [
{
"capacityProvider": "MyCapacityProvider1",
"weight": 1,
"base": 0
},
{
"capacityProvider": "MyCapacityProvider2",
"weight": 1,
"base": 0
}
],
"attachments": [
{
"id": "0fb0c8f4-6edd-4de1-9b09-17e470ee1918",
"type": "asp",
"status": "PRECREATED",
"details": [
{
"name": "capacityProviderName",
"value": "MyCapacityProvider1"
},
{
"name": "scalingPlanName",
"value": "ECSManagedAutoScalingPlan-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
}
]
},
{
"id": "ae592060-2382-4663-9476-b015c685593c",
"type": "asp",
"status": "PRECREATED",
"details": [
{
"name": "capacityProviderName",
"value": "MyCapacityProvider2"
},
{
"name": "scalingPlanName",
"value": "ECSManagedAutoScalingPlan-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222"
}
]
}
],
"attachmentsStatus": "UPDATE_IN_PROGRESS"
}
}
```
詳細については、「Amazon ECS ディベロッパーガイド」の「[Amazon ECS キャパシティープロバイダー](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-capacity-providers.html)」を参照してください。**
**例 3: 複数のタグを含む新しいクラスターを作成するには**
次の `create-cluster` の例は、複数のタグを含むクラスターを作成します。短縮構文を使用したタグの追加の詳細については、「 *AWS CLI ユーザーガイド*[」の AWS 「 コマンドラインインターフェイスでの短縮構文](https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-shorthand.html)の使用」を参照してください。
```
aws ecs create-cluster \
--cluster-name MyCluster \
--tags key=key1,value=value1 key=key2,value=value2
```
出力:
```
{
"cluster": {
"clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster",
"clusterName": "MyCluster",
"status": "ACTIVE",
"registeredContainerInstancesCount": 0,
"pendingTasksCount": 0,
"runningTasksCount": 0,
"activeServicesCount": 0,
"statistics": [],
"tags": [
{
"key": "key1",
"value": "value1"
},
{
"key": "key2",
"value": "value2"
}
]
}
}
```
詳細については、「Amazon ECS ディベロッパーガイド」の「[従来のコンソールを使用したクラスターの作成](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/create_cluster.html)」を参照してください。**
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/create-cluster.html)」を参照してください。
### `create-service`
次のコード例は、`create-service` を使用する方法を示しています。
**AWS CLI**
**例 1: Fargate タスクを使用してサービスを作成するには**
次の `create-service` の例は、Fargate タスクを使用してサービスを作成する方法を示しています。
```
aws ecs create-service \
--cluster MyCluster \
--service-name MyService \
--task-definition sample-fargate:1 \
--desired-count 2 \
--launch-type FARGATE \
--platform-version LATEST \
--network-configuration 'awsvpcConfiguration={subnets=[subnet-12344321],securityGroups=[sg-12344321],assignPublicIp=ENABLED}' \
--tags key=key1,value=value1 key=key2,value=value2 key=key3,value=value3
```
出力:
```
{
"service": {
"serviceArn": "arn:aws:ecs:us-west-2:123456789012:service/MyCluster/MyService",
"serviceName": "MyService",
"clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster",
"loadBalancers": [],
"serviceRegistries": [],
"status": "ACTIVE",
"desiredCount": 2,
"runningCount": 0,
"pendingCount": 0,
"launchType": "FARGATE",
"platformVersion": "LATEST",
"taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/sample-fargate:1",
"deploymentConfiguration": {
"maximumPercent": 200,
"minimumHealthyPercent": 100
},
"deployments": [
{
"id": "ecs-svc/1234567890123456789",
"status": "PRIMARY",
"taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/sample-fargate:1",
"desiredCount": 2,
"pendingCount": 0,
"runningCount": 0,
"createdAt": 1557119253.821,
"updatedAt": 1557119253.821,
"launchType": "FARGATE",
"platformVersion": "1.3.0",
"networkConfiguration": {
"awsvpcConfiguration": {
"subnets": [
"subnet-12344321"
],
"securityGroups": [
"sg-12344321"
],
"assignPublicIp": "ENABLED"
}
}
}
],
"roleArn": "arn:aws:iam::123456789012:role/aws-service-role/ecs.amazonaws.com/AWSServiceRoleForECS",
"events": [],
"createdAt": 1557119253.821,
"placementConstraints": [],
"placementStrategy": [],
"networkConfiguration": {
"awsvpcConfiguration": {
"subnets": [
"subnet-12344321"
],
"securityGroups": [
"sg-12344321"
],
"assignPublicIp": "ENABLED"
}
},
"schedulingStrategy": "REPLICA",
"tags": [
{
"key": "key1",
"value": "value1"
},
{
"key": "key2",
"value": "value2"
},
{
"key": "key3",
"value": "value3"
}
],
"enableECSManagedTags": false,
"propagateTags": "NONE"
}
}
```
詳細については、「Amazon ECS ディベロッパーガイド」の「[クラシックコンソール内の Amazon ECS サービスの作成](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/create-service-console-v2.html)」を参照してください。**
**例 2: EC2 起動タイプを使用してサービスを作成するには**
次の `create-service` の例は、EC2 起動タイプを使用して、`ecs-simple-service` と呼ばれるサービスを作成する方法を示しています。このサービスは `sleep360` タスク定義を使用し、タスクのインスタンスを 1 つ保持します。
```
aws ecs create-service \
--cluster MyCluster \
--service-name ecs-simple-service \
--task-definition sleep360:2 \
--desired-count 1
```
出力:
```
{
"service": {
"serviceArn": "arn:aws:ecs:us-west-2:123456789012:service/MyCluster/ecs-simple-service",
"serviceName": "ecs-simple-service",
"clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster",
"loadBalancers": [],
"serviceRegistries": [],
"status": "ACTIVE",
"desiredCount": 1,
"runningCount": 0,
"pendingCount": 0,
"launchType": "EC2",
"taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/sleep360:2",
"deploymentConfiguration": {
"maximumPercent": 200,
"minimumHealthyPercent": 100
},
"deployments": [
{
"id": "ecs-svc/1234567890123456789",
"status": "PRIMARY",
"taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/sleep360:2",
"desiredCount": 1,
"pendingCount": 0,
"runningCount": 0,
"createdAt": 1557206498.798,
"updatedAt": 1557206498.798,
"launchType": "EC2"
}
],
"events": [],
"createdAt": 1557206498.798,
"placementConstraints": [],
"placementStrategy": [],
"schedulingStrategy": "REPLICA",
"enableECSManagedTags": false,
"propagateTags": "NONE"
}
}
```
詳細については、「Amazon ECS ディベロッパーガイド」の「[クラシックコンソール内の Amazon ECS サービスの作成](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/create-service-console-v2.html)」を参照してください。**
**例 3: 外部のデプロイコントローラーを使用するサービスを作成するには**
次の `create-service` の例は、外部のデプロイコントローラーを使用するサービスを作成します。
```
aws ecs create-service \
--cluster MyCluster \
--service-name MyService \
--deployment-controller type=EXTERNAL \
--desired-count 1
```
出力:
```
{
"service": {
"serviceArn": "arn:aws:ecs:us-west-2:123456789012:service/MyCluster/MyService",
"serviceName": "MyService",
"clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster",
"loadBalancers": [],
"serviceRegistries": [],
"status": "ACTIVE",
"desiredCount": 1,
"runningCount": 0,
"pendingCount": 0,
"launchType": "EC2",
"deploymentConfiguration": {
"maximumPercent": 200,
"minimumHealthyPercent": 100
},
"taskSets": [],
"deployments": [],
"roleArn": "arn:aws:iam::123456789012:role/aws-service-role/ecs.amazonaws.com/AWSServiceRoleForECS",
"events": [],
"createdAt": 1557128207.101,
"placementConstraints": [],
"placementStrategy": [],
"schedulingStrategy": "REPLICA",
"deploymentController": {
"type": "EXTERNAL"
},
"enableECSManagedTags": false,
"propagateTags": "NONE"
}
}
```
詳細については、「Amazon ECS ディベロッパーガイド」の「[クラシックコンソール内の Amazon ECS サービスの作成](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/create-service-console-v2.html)」を参照してください。**
**例 4: ロードバランサーの背後に新しいサービスを作成するには**
次の `create-service` の例は、ロードバランサーの背後にサービスを作成する方法を示しています。コンテナインスタンスと同じリージョンに、ロードバランサーを設定する必要があります。この例では、`--cli-input-json` オプションと、以下の内容を含む JSON 入力ファイル (`ecs-simple-service-elb.json`) を使用します。
```
aws ecs create-service \
--cluster MyCluster \
--service-name ecs-simple-service-elb \
--cli-input-json file://ecs-simple-service-elb.json
```
`ecs-simple-service-elb.json` の内容:
```
{
"serviceName": "ecs-simple-service-elb",
"taskDefinition": "ecs-demo",
"loadBalancers": [
{
"loadBalancerName": "EC2Contai-EcsElast-123456789012",
"containerName": "simple-demo",
"containerPort": 80
}
],
"desiredCount": 10,
"role": "ecsServiceRole"
}
```
出力:
```
{
"service": {
"status": "ACTIVE",
"taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/ecs-demo:1",
"pendingCount": 0,
"loadBalancers": [
{
"containerName": "ecs-demo",
"containerPort": 80,
"loadBalancerName": "EC2Contai-EcsElast-123456789012"
}
],
"roleArn": "arn:aws:iam::123456789012:role/ecsServiceRole",
"desiredCount": 10,
"serviceName": "ecs-simple-service-elb",
"clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster",
"serviceArn": "arn:aws:ecs:us-west-2:123456789012:service/ecs-simple-service-elb",
"deployments": [
{
"status": "PRIMARY",
"pendingCount": 0,
"createdAt": 1428100239.123,
"desiredCount": 10,
"taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/ecs-demo:1",
"updatedAt": 1428100239.123,
"id": "ecs-svc/1234567890123456789",
"runningCount": 0
}
],
"events": [],
"runningCount": 0
}
}
```
詳細については、「*Amazon ECS デベロッパーガイド*」の「[ロードバランサーを使用して Amazon ECS サービストラフィックを分散する](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html)」を参照してください。
**例 5: サービスの作成時に Amazon EBS ボリュームを設定するには**
次の `create-service` の例では、サービスで管理するタスクごとに Amazon EBS ボリュームを設定する方法を示します。`AmazonECSInfrastructureRolePolicyForVolumes` マネージドポリシーがアタッチされた Amazon ECS インフラストラクチャロールを設定する必要があります。`create-service` リクエストと同じボリューム名でタスク定義を指定する必要があります。この例では、`--cli-input-json` オプションと、以下の内容を含む JSON 入力ファイル (`ecs-simple-service-ebs.json`) を使用します。
```
aws ecs create-service \
--cli-input-json file://ecs-simple-service-ebs.json
```
`ecs-simple-service-ebs.json` の内容:
```
{
"cluster": "mycluster",
"taskDefinition": "mytaskdef",
"serviceName": "ecs-simple-service-ebs",
"desiredCount": 2,
"launchType": "FARGATE",
"networkConfiguration":{
"awsvpcConfiguration":{
"assignPublicIp": "ENABLED",
"securityGroups": ["sg-12344321"],
"subnets":["subnet-12344321"]
}
},
"volumeConfigurations": [
{
"name": "myEbsVolume",
"managedEBSVolume": {
"roleArn":"arn:aws:iam::123456789012:role/ecsInfrastructureRole",
"volumeType": "gp3",
"sizeInGiB": 100,
"iops": 3000,
"throughput": 125,
"filesystemType": "ext4"
}
}
]
}
```
出力:
```
{
"service": {
"serviceArn": "arn:aws:ecs:us-west-2:123456789012:service/mycluster/ecs-simple-service-ebs",
"serviceName": "ecs-simple-service-ebs",
"clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/mycluster",
"loadBalancers": [],
"serviceRegistries": [],
"status": "ACTIVE",
"desiredCount": 2,
"runningCount": 0,
"pendingCount": 0,
"launchType": "EC2",
"taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/mytaskdef:3",
"deploymentConfiguration": {
"deploymentCircuitBreaker": {
"enable": false,
"rollback": false
},
"maximumPercent": 200,
"minimumHealthyPercent": 100
},
"deployments": [
{
"id": "ecs-svc/7851020056849183687",
"status": "PRIMARY",
"taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/mytaskdef:3",
"desiredCount": 0,
"pendingCount": 0,
"runningCount": 0,
"failedTasks": 0,
"createdAt": "2025-01-21T11:32:38.034000-06:00",
"updatedAt": "2025-01-21T11:32:38.034000-06:00",
"launchType": "EC2",
"networkConfiguration": {
"awsvpcConfiguration": {
"subnets": [
"subnet-12344321"
],
"securityGroups": [
"sg-12344321"
],
"assignPublicIp": "DISABLED"
}
},
"rolloutState": "IN_PROGRESS",
"rolloutStateReason": "ECS deployment ecs-svc/7851020056849183687 in progress.",
"volumeConfigurations": [
{
"name": "myEBSVolume",
"managedEBSVolume": {
"volumeType": "gp3",
"sizeInGiB": 100,
"iops": 3000,
"throughput": 125,
"roleArn": "arn:aws:iam::123456789012:role/ecsInfrastructureRole",
"filesystemType": "ext4"
}
}
]
}
],
"roleArn": "arn:aws:iam::123456789012:role/aws-service-role/ecs.amazonaws.com/AWSServiceRoleForECS",
"events": [],
"createdAt": "2025-01-21T11:32:38.034000-06:00",
"placementConstraints": [],
"placementStrategy": [],
"networkConfiguration": {
"awsvpcConfiguration": {
"subnets": [
"subnet-12344321"
],
"securityGroups": [
"sg-12344321"
],
"assignPublicIp": "DISABLED"
}
},
"healthCheckGracePeriodSeconds": 0,
"schedulingStrategy": "REPLICA",
"deploymentController": {
"type": "ECS"
},
"createdBy": "arn:aws:iam::123456789012:user/AIDACKCEVSQ6C2EXAMPLE",
"enableECSManagedTags": false,
"propagateTags": "NONE",
"enableExecuteCommand": false,
"availabilityZoneRebalancing": "DISABLED"
}
}
```
詳細については、「*Amazon ECS デベロッパーガイド*」の「[Amazon ECS での Amazon EBS ボリュームの使用](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html)」を参照してください。
+ API の詳細については、AWS CLI コマンドリファレンスの「[CreateService](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/create-service.html)」を参照してください。**
### `create-task-set`
次のコード例は、`create-task-set` を使用する方法を示しています。
**AWS CLI**
**タスクセットを作成するには**
次の `create-task-set` の例は、外部のデプロイコントローラーを使用するサービスのタスクセットを作成します。
```
aws ecs create-task-set \
--cluster MyCluster \
--service MyService \
--task-definition MyTaskDefinition:2 \
--network-configuration "awsvpcConfiguration={subnets=[subnet-12344321],securityGroups=[sg-12344321]}"
```
出力:
```
{
"taskSet": {
"id": "ecs-svc/1234567890123456789",
"taskSetArn": "arn:aws:ecs:us-west-2:123456789012:task-set/MyCluster/MyService/ecs-svc/1234567890123456789",
"status": "ACTIVE",
"taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/MyTaskDefinition:2",
"computedDesiredCount": 0,
"pendingCount": 0,
"runningCount": 0,
"createdAt": 1557128360.711,
"updatedAt": 1557128360.711,
"launchType": "EC2",
"networkConfiguration": {
"awsvpcConfiguration": {
"subnets": [
"subnet-12344321"
],
"securityGroups": [
"sg-12344321"
],
"assignPublicIp": "DISABLED"
}
},
"loadBalancers": [],
"serviceRegistries": [],
"scale": {
"value": 0.0,
"unit": "PERCENT"
},
"stabilityStatus": "STABILIZING",
"stabilityStatusAt": 1557128360.711
}
}
```
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateTaskSet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/create-task-set.html)」を参照してください。
### `delete-account-setting`
次のコード例は、`delete-account-setting` を使用する方法を示しています。
**AWS CLI**
**特定の IAM ユーザーまたは IAM ロールのアカウント設定を削除するには**
次の例では、`delete-account-setting` により、特定の IAM ユーザーまたは IAM ロールのアカウント設定が削除されます。
```
aws ecs delete-account-setting \
--name serviceLongArnFormat \
--principal-arn arn:aws:iam::123456789012:user/MyUser
```
出力:
```
{
"setting": {
"name": "serviceLongArnFormat",
"value": "enabled",
"principalArn": "arn:aws:iam::123456789012:user/MyUser"
}
}
```
詳細については、「*Amazon ECS デベロッパーガイド*」の「[Amazon リソースネーム (ARN) と ID](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-resource-ids.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteAccountSetting](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/delete-account-setting.html)」を参照してください。
### `delete-attributes`
次のコード例は、`delete-attributes` を使用する方法を示しています。
**AWS CLI**
**Amazon ECS リソースから 1 つ以上のカスタム属性を削除するには**
次の `delete-attributes` では、コンテナインスタンスから `stack` という名前の属性を削除します。
```
aws ecs delete-attributes \
--attributes name=stack,targetId=arn:aws:ecs:us-west-2:130757420319:container-instance/1c3be8ed-df30-47b4-8f1e-6e68ebd01f34
```
出力:
```
{
"attributes": [
{
"name": "stack",
"targetId": "arn:aws:ecs:us-west-2:130757420319:container-instance/1c3be8ed-df30-47b4-8f1e-6e68ebd01f34",
"value": "production"
}
]
}
```
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/delete-attributes.html)」を参照してください。
### `delete-capacity-provider`
次のコード例は、`delete-capacity-provider` を使用する方法を示しています。
**AWS CLI**
**例 1: Amazon リソースネーム (ARN) を使用してキャパシティプロバイダーを削除するには**
次の `delete-capacity-provider` の例では、キャパシティープロバイダーの Amazon リソースネーム (ARN) を指定して、キャパシティープロバイダーを削除します。ARN とキャパシティープロバイダーの削除のステータスは、`describe-capacity-providers` コマンドを使用して取得できます。
```
aws ecs delete-capacity-provider \
--capacity-provider arn:aws:ecs:us-west-2:123456789012:capacity-provider/ExampleCapacityProvider
```
出力:
```
{
"capacityProvider": {
"capacityProviderArn": "arn:aws:ecs:us-west-2:123456789012:capacity-provider/ExampleCapacityProvider",
"name": "ExampleCapacityProvider",
"status": "ACTIVE",
"autoScalingGroupProvider": {
"autoScalingGroupArn": "arn:aws:autoscaling:us-west-2:123456789012:autoScalingGroup:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111:autoScalingGroupName/MyAutoScalingGroup",
"managedScaling": {
"status": "ENABLED",
"targetCapacity": 100,
"minimumScalingStepSize": 1,
"maximumScalingStepSize": 10000
},
"managedTerminationProtection": "DISABLED"
},
"updateStatus": "DELETE_IN_PROGRESS",
"tags": []
}
}
```
詳細については、「Amazon ECS ディベロッパーガイド」の「[Amazon ECS キャパシティープロバイダー](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-capacity-providers.html)」を参照してください。**
**例 2: 名前を使用してキャパシティープロバイダーを削除するには**
次の `delete-capacity-provider` の例では、キャパシティープロバイダーの短縮名を指定して、キャパシティープロバイダーを削除します。短縮名とキャパシティープロバイダーの削除のステータスは、`describe-capacity-providers` コマンドを使用して取得できます。
```
aws ecs delete-capacity-provider \
--capacity-provider ExampleCapacityProvider
```
出力:
```
{
"capacityProvider": {
"capacityProviderArn": "arn:aws:ecs:us-west-2:123456789012:capacity-provider/ExampleCapacityProvider",
"name": "ExampleCapacityProvider",
"status": "ACTIVE",
"autoScalingGroupProvider": {
"autoScalingGroupArn": "arn:aws:autoscaling:us-west-2:123456789012:autoScalingGroup:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111:autoScalingGroupName/MyAutoScalingGroup",
"managedScaling": {
"status": "ENABLED",
"targetCapacity": 100,
"minimumScalingStepSize": 1,
"maximumScalingStepSize": 10000
},
"managedTerminationProtection": "DISABLED"
},
"updateStatus": "DELETE_IN_PROGRESS",
"tags": []
}
}
```
詳細については、「Amazon ECS ディベロッパーガイド」の「[Amazon ECS キャパシティープロバイダー](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-capacity-providers.html)」を参照してください。**
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteCapacityProvider](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/delete-capacity-provider.html)」を参照してください。
### `delete-cluster`
次のコード例は、`delete-cluster` を使用する方法を示しています。
**AWS CLI**
**空のクラスターを削除するには**
次の `delete-cluster` の例は、指定された空のクラスターを削除します。
```
aws ecs delete-cluster --cluster MyCluster
```
出力:
```
{
"cluster": {
"clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster",
"status": "INACTIVE",
"clusterName": "MyCluster",
"registeredContainerInstancesCount": 0,
"pendingTasksCount": 0,
"runningTasksCount": 0,
"activeServicesCount": 0
"statistics": [],
"tags": []
}
}
```
詳細については、「Amazon ECS ディベロッパーガイド」の「[クラシックコンソールを使用してクラスターを削除するには](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/delete_cluster.html)」を参照してください。**
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/delete-cluster.html)」を参照してください。
### `delete-service`
次のコード例は、`delete-service` を使用する方法を示しています。
**AWS CLI**
**サービスを削除する方法**
次の `ecs delete-service` の例は、指定されたサービスをクラスターから削除します。`--force` パラメータを含めると、タスクがゼロになっていない場合でも、サービスを削除することができます。
```
aws ecs delete-service --cluster MyCluster --service MyService1 --force
```
詳細については、「Amazon ECS ディベロッパーガイド」の「[クラシックコンソールを使用してサービスを削除するには](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/delete-service.html)」を参照してください。**
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteService](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/delete-service.html)」を参照してください。
### `delete-task-definitions`
次のコード例は、`delete-task-definitions` を使用する方法を示しています。
**AWS CLI**
**タスク定義を削除するには**
次の `delete-task-definitions` の例では、INACTIVE タスク定義を削除します。
```
aws ecs delete-task-definitions \
--task-definition curltest:1
```
出力:
```
{
"taskDefinitions": [
{
"taskDefinitionArn": "arn:aws:ecs:us-east-1:123456789012:task-definition/curltest:1",
"containerDefinitions": [
{
"name": "ctest",
"image": "mreferre/eksutils",
"cpu": 0,
"portMappings": [],
"essential": true,
"entryPoint": [
"sh",
"-c"
],
"command": [
"curl ${ECS_CONTAINER_METADATA_URI_V4}/task"
],
"environment": [],
"mountPoints": [],
"volumesFrom": [],
"logConfiguration": {
"logDriver": "awslogs",
"options": {
"awslogs-create-group": "true",
"awslogs-group": "/ecs/curltest",
"awslogs-region": "us-east-1",
"awslogs-stream-prefix": "ecs"
}
}
}
],
"family": "curltest",
"taskRoleArn": "arn:aws:iam::123456789012:role/ecsTaskExecutionRole",
"executionRoleArn": "arn:aws:iam::123456789012:role/ecsTaskExecutionRole",
"networkMode": "awsvpc",
"revision": 1,
"volumes": [],
"status": "DELETE_IN_PROGRESS",
"compatibilities": [
"EC2",
"FARGATE"
],
"requiresCompatibilities": [
"FARGATE"
],
"cpu": "256",
"memory": "512",
"registeredAt": "2021-09-10T12:56:24.704000+00:00",
"deregisteredAt": "2023-03-14T15:20:59.419000+00:00",
"registeredBy": "arn:aws:sts::123456789012:assumed-role/Admin/jdoe"
}
],
"failures": []
}
```
詳細については、「Amazon ECS ディベロッパーガイド」の「[Amazon ECS のタスク定義](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definitions.html)」を参照してください。**
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteTaskDefinitions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/delete-task-definitions.html)」を参照してください。
### `delete-task-set`
次のコード例は、`delete-task-set` を使用する方法を示しています。
**AWS CLI**
**タスクセットを削除するには**
次の `delete-task-set` の例で、タスクセットを削除する方法について説明します。`--force` パラメータを含めると、タスクセットがゼロになっていない場合でも、タスクセットを削除することができます。
```
aws ecs delete-task-set \
--cluster MyCluster \
--service MyService \
--task-set arn:aws:ecs:us-west-2:123456789012:task-set/MyCluster/MyService/ecs-svc/1234567890123456789 \
--force
```
出力:
```
{
"taskSet": {
"id": "ecs-svc/1234567890123456789",
"taskSetArn": "arn:aws:ecs:us-west-2:123456789012:task-set/MyCluster/MyService/ecs-svc/1234567890123456789",
"status": "DRAINING",
"taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/sample-fargate:2",
"computedDesiredCount": 0,
"pendingCount": 0,
"runningCount": 0,
"createdAt": 1557130260.276,
"updatedAt": 1557130290.707,
"launchType": "EC2",
"networkConfiguration": {
"awsvpcConfiguration": {
"subnets": [
"subnet-12345678"
],
"securityGroups": [
"sg-12345678"
],
"assignPublicIp": "DISABLED"
}
},
"loadBalancers": [],
"serviceRegistries": [],
"scale": {
"value": 0.0,
"unit": "PERCENT"
},
"stabilityStatus": "STABILIZING",
"stabilityStatusAt": 1557130290.707
}
}
```
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteTaskSet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/delete-task-set.html)」を参照してください。
### `deregister-container-instance`
次のコード例は、`deregister-container-instance` を使用する方法を示しています。
**AWS CLI**
**クラスターからコンテナインスタンスの登録を解除するには**
次の `deregister-container-instance` の例では、指定されたクラスターからコンテナインスタンスを登録解除します。コンテナインスタンスでまだ実行中のタスクがある場合は、登録解除する前にそれらのタスクを停止するか、`--force` オプションを使用する必要があります。
```
aws ecs deregister-container-instance \
--cluster arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster \
--container-instance arn:aws:ecs:us-west-2:123456789012:container-instance/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE \
--force
```
出力:
```
{
"containerInstance": {
"remainingResources": [
{
"integerValue": 1024,
"doubleValue": 0.0,
"type": "INTEGER",
"longValue": 0,
"name": "CPU"
},
{
"integerValue": 985,
"doubleValue": 0.0,
"type": "INTEGER",
"longValue": 0,
"name": "MEMORY"
},
{
"type": "STRINGSET",
"integerValue": 0,
"name": "PORTS",
"stringSetValue": [
"22",
"2376",
"2375",
"51678",
"51679"
],
"longValue": 0,
"doubleValue": 0.0
},
{
"type": "STRINGSET",
"integerValue": 0,
"name": "PORTS_UDP",
"stringSetValue": [],
"longValue": 0,
"doubleValue": 0.0
}
],
"agentConnected": true,
"attributes": [
{
"name": "ecs.capability.secrets.asm.environment-variables"
},
{
"name": "com.amazonaws.ecs.capability.logging-driver.syslog"
},
{
"value": "ami-01a82c3fce2c3ba58",
"name": "ecs.ami-id"
},
{
"name": "ecs.capability.secrets.asm.bootstrap.log-driver"
},
{
"name": "com.amazonaws.ecs.capability.logging-driver.none"
},
{
"name": "ecs.capability.ecr-endpoint"
},
{
"name": "com.amazonaws.ecs.capability.logging-driver.json-file"
},
{
"value": "vpc-1234567890123467",
"name": "ecs.vpc-id"
},
{
"name": "ecs.capability.execution-role-awslogs"
},
{
"name": "com.amazonaws.ecs.capability.docker-remote-api.1.17"
},
{
"name": "com.amazonaws.ecs.capability.docker-remote-api.1.18"
},
{
"name": "com.amazonaws.ecs.capability.docker-remote-api.1.19"
},
{
"name": "ecs.capability.docker-plugin.local"
},
{
"name": "ecs.capability.task-eni"
},
{
"name": "ecs.capability.task-cpu-mem-limit"
},
{
"name": "ecs.capability.secrets.ssm.bootstrap.log-driver"
},
{
"name": "com.amazonaws.ecs.capability.docker-remote-api.1.30"
},
{
"name": "com.amazonaws.ecs.capability.docker-remote-api.1.31"
},
{
"name": "com.amazonaws.ecs.capability.docker-remote-api.1.32"
},
{
"name": "ecs.capability.execution-role-ecr-pull"
},
{
"name": "ecs.capability.container-health-check"
},
{
"value": "subnet-1234567890123467",
"name": "ecs.subnet-id"
},
{
"value": "us-west-2a",
"name": "ecs.availability-zone"
},
{
"value": "t2.micro",
"name": "ecs.instance-type"
},
{
"name": "com.amazonaws.ecs.capability.task-iam-role-network-host"
},
{
"name": "ecs.capability.aws-appmesh"
},
{
"name": "com.amazonaws.ecs.capability.logging-driver.awslogs"
},
{
"name": "com.amazonaws.ecs.capability.docker-remote-api.1.24"
},
{
"name": "com.amazonaws.ecs.capability.docker-remote-api.1.25"
},
{
"name": "com.amazonaws.ecs.capability.docker-remote-api.1.26"
},
{
"name": "com.amazonaws.ecs.capability.docker-remote-api.1.27"
},
{
"name": "com.amazonaws.ecs.capability.privileged-container"
},
{
"name": "ecs.capability.container-ordering"
},
{
"name": "com.amazonaws.ecs.capability.docker-remote-api.1.28"
},
{
"name": "com.amazonaws.ecs.capability.docker-remote-api.1.29"
},
{
"value": "x86_64",
"name": "ecs.cpu-architecture"
},
{
"value": "93f43776-2018.10.0",
"name": "ecs.capability.cni-plugin-version"
},
{
"name": "ecs.capability.secrets.ssm.environment-variables"
},
{
"name": "ecs.capability.pid-ipc-namespace-sharing"
},
{
"name": "com.amazonaws.ecs.capability.ecr-auth"
},
{
"value": "linux",
"name": "ecs.os-type"
},
{
"name": "com.amazonaws.ecs.capability.docker-remote-api.1.20"
},
{
"name": "com.amazonaws.ecs.capability.docker-remote-api.1.21"
},
{
"name": "com.amazonaws.ecs.capability.docker-remote-api.1.22"
},
{
"name": "ecs.capability.task-eia"
},
{
"name": "ecs.capability.private-registry-authentication.secretsmanager"
},
{
"name": "com.amazonaws.ecs.capability.task-iam-role"
},
{
"name": "com.amazonaws.ecs.capability.docker-remote-api.1.23"
}
],
"pendingTasksCount": 0,
"tags": [],
"containerInstanceArn": "arn:aws:ecs:us-west-2:123456789012:container-instance/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
"registeredResources": [
{
"integerValue": 1024,
"doubleValue": 0.0,
"type": "INTEGER",
"longValue": 0,
"name": "CPU"
},
{
"integerValue": 985,
"doubleValue": 0.0,
"type": "INTEGER",
"longValue": 0,
"name": "MEMORY"
},
{
"type": "STRINGSET",
"integerValue": 0,
"name": "PORTS",
"stringSetValue": [
"22",
"2376",
"2375",
"51678",
"51679"
],
"longValue": 0,
"doubleValue": 0.0
},
{
"type": "STRINGSET",
"integerValue": 0,
"name": "PORTS_UDP",
"stringSetValue": [],
"longValue": 0,
"doubleValue": 0.0
}
],
"status": "INACTIVE",
"registeredAt": 1557768075.681,
"version": 4,
"versionInfo": {
"agentVersion": "1.27.0",
"agentHash": "aabe65ee",
"dockerVersion": "DockerVersion: 18.06.1-ce"
},
"attachments": [],
"runningTasksCount": 0,
"ec2InstanceId": "i-12345678901234678"
}
}
```
詳細については、「*ECS デベロッパーガイド*」の[「コンテナインスタンスの登録解除](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deregister_container_instance.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeregisterContainerInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/deregister-container-instance.html)」を参照してください。
### `deregister-task-definition`
次のコード例は、`deregister-task-definition` を使用する方法を示しています。
**AWS CLI**
**タスク定義の登録を解除するには**
次の `deregister-task-definition` の例では、デフォルトのリージョンで `curler` タスク定義の最初のリビジョンを登録解除します。
```
aws ecs deregister-task-definition --task-definition curler:1
```
結果の出力では、タスク定義ステータスに `INACTIVE` が表示されることに注意してください。
```
{
"taskDefinition": {
"status": "INACTIVE",
"family": "curler",
"volumes": [],
"taskDefinitionArn": "arn:aws:ecs:us-west-2:123456789012:task-definition/curler:1",
"containerDefinitions": [
{
"environment": [],
"name": "curler",
"mountPoints": [],
"image": "curl:latest",
"cpu": 100,
"portMappings": [],
"entryPoint": [],
"memory": 256,
"command": [
"curl -v http://example.com/"
],
"essential": true,
"volumesFrom": []
}
],
"revision": 1
}
}
```
詳細については、「Amazon ECS ディベロッパーガイド」の「[Amazon ECS のタスク定義](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definitions.html)」を参照してください。**
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeregisterTaskDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/deregister-task-definition.html)」を参照してください。
### `describe-capacity-providers`
次のコード例は、`describe-capacity-providers` を使用する方法を示しています。
**AWS CLI**
**例 1: すべてのキャパシティプロバイダーを記述するには**
次の `describe-capacity-providers` の例では、すべてのキャパシティプロバイダーの詳細を取得します。
```
aws ecs describe-capacity-providers
```
出力:
```
{
"capacityProviders": [
{
"capacityProviderArn": "arn:aws:ecs:us-west-2:123456789012:capacity-provider/MyCapacityProvider",
"name": "MyCapacityProvider",
"status": "ACTIVE",
"autoScalingGroupProvider": {
"autoScalingGroupArn": "arn:aws:autoscaling:us-west-2:123456789012:autoScalingGroup:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111:autoScalingGroupName/MyAutoScalingGroup",
"managedScaling": {
"status": "ENABLED",
"targetCapacity": 100,
"minimumScalingStepSize": 1,
"maximumScalingStepSize": 1000
},
"managedTerminationProtection": "ENABLED"
},
"tags": []
},
{
"capacityProviderArn": "arn:aws:ecs:us-west-2:123456789012:capacity-provider/FARGATE",
"name": "FARGATE",
"status": "ACTIVE",
"tags": []
},
{
"capacityProviderArn": "arn:aws:ecs:us-west-2:123456789012:capacity-provider/FARGATE_SPOT",
"name": "FARGATE_SPOT",
"status": "ACTIVE",
"tags": []
}
]
}
```
詳細については、「Amazon ECS ディベロッパーガイド」の「[Amazon ECS キャパシティープロバイダー](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-capacity-providers.html)」を参照してください。**
**例 2: 特定のキャパシティプロバイダーを記述するには**
次の `describe-capacity-providers` の例では、特定のキャパシティープロバイダーの詳細を取得します。`--include TAGS` パラメータを使用すると、キャパシティープロバイダーに関連付けられたタグが出力に追加されます。
```
aws ecs describe-capacity-providers \
--capacity-providers MyCapacityProvider \
--include TAGS
```
出力:
```
{
"capacityProviders": [
{
"capacityProviderArn": "arn:aws:ecs:us-west-2:123456789012:capacity-provider/MyCapacityProvider",
"name": "MyCapacityProvider",
"status": "ACTIVE",
"autoScalingGroupProvider": {
"autoScalingGroupArn": "arn:aws:autoscaling:us-west-2:123456789012:autoScalingGroup:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111:autoScalingGroupName/MyAutoScalingGroup",
"managedScaling": {
"status": "ENABLED",
"targetCapacity": 100,
"minimumScalingStepSize": 1,
"maximumScalingStepSize": 1000
},
"managedTerminationProtection": "ENABLED"
},
"tags": [
{
"key": "environment",
"value": "production"
}
]
}
]
}
```
詳細については、「Amazon ECS ディベロッパーガイド」の「[Amazon ECS キャパシティープロバイダー](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-capacity-providers.html)」を参照してください。**
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeCapacityProviders](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/describe-capacity-providers.html)」を参照してください。
### `describe-clusters`
次のコード例は、`describe-clusters` を使用する方法を示しています。
**AWS CLI**
**例 1: クラスターを記述するには**
次の `describe-clusters` の例は、指定されたクラスターの詳細情報を取得します。
```
aws ecs describe-clusters \
--cluster default
```
出力:
```
{
"clusters": [
{
"status": "ACTIVE",
"clusterName": "default",
"registeredContainerInstancesCount": 0,
"pendingTasksCount": 0,
"runningTasksCount": 0,
"activeServicesCount": 1,
"clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/default"
}
],
"failures": []
}
```
詳細については、「Amazon ECS ディベロッパーガイド」の「[Amazon ECS Clusters](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ECS_clusters.html)」を参照してください。**
**例 2: 添付ファイルオプションを使用してクラスターを記述するには**
次の `describe-clusters` の例は、添付ファイルオプションを指定します。指定されたクラスターの詳細情報と、クラスターにアタッチされているリソースのリストを添付ファイルの形式で取得します。キャパシティプロバイダーをクラスターで使用する場合、AutoScaling プランまたはスケーリングポリシーのリソースは asp または as\$1policy ATTACHMENTS として表示されます。
```
aws ecs describe-clusters \
--include ATTACHMENTS \
--clusters sampleCluster
```
出力:
```
{
"clusters": [
{
"clusterArn": "arn:aws:ecs:af-south-1:123456789222:cluster/sampleCluster",
"clusterName": "sampleCluster",
"status": "ACTIVE",
"registeredContainerInstancesCount": 0,
"runningTasksCount": 0,
"pendingTasksCount": 0,
"activeServicesCount": 0,
"statistics": [],
"tags": [],
"settings": [],
"capacityProviders": [
"sampleCapacityProvider"
],
"defaultCapacityProviderStrategy": [],
"attachments": [
{
"id": "a1b2c3d4-5678-901b-cdef-EXAMPLE22222",
"type": "as_policy",
"status": "CREATED",
"details": [
{
"name": "capacityProviderName",
"value": "sampleCapacityProvider"
},
{
"name": "scalingPolicyName",
"value": "ECSManagedAutoScalingPolicy-3048e262-fe39-4eaf-826d-6f975d303188"
}
]
}
],
"attachmentsStatus": "UPDATE_COMPLETE"
}
],
"failures": []
}
```
詳細については、「Amazon ECS ディベロッパーガイド」の「[Amazon ECS Clusters](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ECS_clusters.html)」を参照してください。**
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeClusters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/describe-clusters.html)」を参照してください。
### `describe-container-instances`
次のコード例は、`describe-container-instances` を使用する方法を示しています。
**AWS CLI**
**コンテナインスタンスを記述するには**
次の `describe-container-instances` の例では、コンテナインスタンス UUID を識別子として使用して、`update` クラスター内のコンテナインスタンスの詳細を取得します。
```
aws ecs describe-container-instances \
--cluster update \
--container-instances a1b2c3d4-5678-90ab-cdef-11111EXAMPLE
```
出力:
```
{
"failures": [],
"containerInstances": [
{
"status": "ACTIVE",
"registeredResources": [
{
"integerValue": 2048,
"longValue": 0,
"type": "INTEGER",
"name": "CPU",
"doubleValue": 0.0
},
{
"integerValue": 3955,
"longValue": 0,
"type": "INTEGER",
"name": "MEMORY",
"doubleValue": 0.0
},
{
"name": "PORTS",
"longValue": 0,
"doubleValue": 0.0,
"stringSetValue": [
"22",
"2376",
"2375",
"51678"
],
"type": "STRINGSET",
"integerValue": 0
}
],
"ec2InstanceId": "i-A1B2C3D4",
"agentConnected": true,
"containerInstanceArn": "arn:aws:ecs:us-west-2:123456789012:container-instance/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
"pendingTasksCount": 0,
"remainingResources": [
{
"integerValue": 2048,
"longValue": 0,
"type": "INTEGER",
"name": "CPU",
"doubleValue": 0.0
},
{
"integerValue": 3955,
"longValue": 0,
"type": "INTEGER",
"name": "MEMORY",
"doubleValue": 0.0
},
{
"name": "PORTS",
"longValue": 0,
"doubleValue": 0.0,
"stringSetValue": [
"22",
"2376",
"2375",
"51678"
],
"type": "STRINGSET",
"integerValue": 0
}
],
"runningTasksCount": 0,
"versionInfo": {
"agentVersion": "1.0.0",
"agentHash": "4023248",
"dockerVersion": "DockerVersion: 1.5.0"
}
}
]
}
```
詳細については、「*Amazon ECS デベロッパーガイド*」の「[Amazon ECS コンテナインスタンス](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ECS_instances.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeContainerInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/describe-container-instances.html)」を参照してください。
### `describe-service-deployments`
次のコード例は、`describe-service-deployments` を使用する方法を示しています。
**AWS CLI**
**サービスデプロイの詳細を取得するには**
次の `describe-service-deployments` の例では、ARN が `arn:aws:ecs:us-east-1:123456789012:service-deployment/example-cluster/example-service/ejGvqq2ilnbKT9qj0vLJe` のサービスデプロイの詳細を取得します。
```
aws ecs describe-service-deployments \
--service-deployment-arn arn:aws:ecs:us-east-1:123456789012:service-deployment/example-cluster/example-service/ejGvqq2ilnbKT9qj0vLJe
```
出力:
```
{
"serviceDeployments": [
{
"serviceDeploymentArn": "arn:aws:ecs:us-east-1:123456789012:service-deployment/example-cluster/example-service/ejGvqq2ilnbKT9qj0vLJe",
"serviceArn": "arn:aws:ecs:us-east-1:123456789012:service/example-cluster/example-service",
"clusterArn": "arn:aws:ecs:us-east-1:123456789012:cluster/example-cluster",
"createdAt": "2024-10-31T08:03:30.917000-04:00",
"startedAt": "2024-10-31T08:03:32.510000-04:00",
"finishedAt": "2024-10-31T08:05:04.527000-04:00",
"updatedAt": "2024-10-31T08:05:04.527000-04:00",
"sourceServiceRevisions": [],
"targetServiceRevision": {
"arn": "arn:aws:ecs:us-east-1:123456789012:service-revision/example-cluster/example-service/1485800978477494678",
"requestedTaskCount": 1,
"runningTaskCount": 1,
"pendingTaskCount": 0
},
"status": "SUCCESSFUL",
"deploymentConfiguration": {
"deploymentCircuitBreaker": {
"enable": true,
"rollback": true
},
"maximumPercent": 200,
"minimumHealthyPercent": 100,
"alarms": {
"alarmNames": [],
"rollback": false,
"enable": false
}
},
"deploymentCircuitBreaker": {
"status": "MONITORING_COMPLETE",
"failureCount": 0,
"threshold": 3
},
"alarms": {
"status": "DISABLED"
}
}
],
"failures": []
}
```
詳細については、*Amazon ECS デベロッパーガイド*の「[Amazon ECS サービスデプロイを使用してサービス履歴を表示する](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-deployment.html)」を参照してください。
+ API の詳細については、*AWS CLI コマンドリファレンス*の「[DescribeServiceDeployments](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/describe-service-deployments.html)」を参照してください。
### `describe-service-revisions`
次のコード例は、`describe-service-revisions` を使用する方法を示しています。
**AWS CLI**
**サービスリビジョンの詳細を取得するには**
次の `describe-service-revisions` の例では、ARN が `arn:aws:ecs:us-east-1:123456789012:service-revision/example-cluster/example-service/1485800978477494678` のサービスリビジョンの詳細を取得します。
```
aws ecs describe-service-revisions \
--service-revision-arns arn:aws:ecs:us-east-1:123456789012:service-revision/example-cluster/example-service/1485800978477494678
```
出力:
```
{
"serviceRevisions": [
{
"serviceRevisionArn": "arn:aws:ecs:us-east-1:123456789012:service-revision/example-cluster/example-service/1485800978477494678",
"serviceArn": "arn:aws:ecs:us-east-1:123456789012:service/example-cluster/example-service",
"clusterArn": "arn:aws:ecs:us-east-1:123456789012:cluster/example-cluster",
"taskDefinition": "arn:aws:ecs:us-east-1:123456789012:task-definition/webserver:5",
"capacityProviderStrategy": [
{
"capacityProvider": "FARGATE",
"weight": 1,
"base": 0
}
],
"platformVersion": "1.4.0",
"platformFamily": "Linux",
"networkConfiguration": {
"awsvpcConfiguration": {
"subnets": [
"subnet-0d0eab1bb38d5ca64",
"subnet-0db5010045995c2d5"
],
"securityGroups": [
"sg-02556bf85a191f59a"
],
"assignPublicIp": "ENABLED"
}
},
"containerImages": [
{
"containerName": "aws-otel-collector",
"imageDigest": "sha256:7a1b3560655071bcacd66902c20ebe9a69470d5691fe3bd36baace7c2f3c4640",
"image": "public.ecr.aws/aws-observability/aws-otel-collector:v0.32.0"
},
{
"containerName": "web",
"imageDigest": "sha256:28402db69fec7c17e179ea87882667f1e054391138f77ffaf0c3eb388efc3ffb",
"image": "nginx"
}
],
"guardDutyEnabled": false,
"serviceConnectConfiguration": {
"enabled": false
},
"createdAt": "2024-10-31T08:03:29.302000-04:00"
}
],
"failures": []
}
```
詳細については、*Amazon ECS デベロッパーガイド*の「[Amazon ECS サービスリビジョン](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-revision.html)」を参照してください。
+ API の詳細については、*AWS CLI コマンドリファレンス*の「[DescribeServiceRevisions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/describe-service-revisions.html)」を参照してください。
### `describe-services`
次のコード例は、`describe-services` を使用する方法を示しています。
**AWS CLI**
**サービスを記述するには**
次の `describe-services` の例では、デフォルトのクラスター内の `my-http-service` サービスの詳細を取得します。
```
aws ecs describe-services --services my-http-service
```
出力:
```
{
"services": [
{
"status": "ACTIVE",
"taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/amazon-ecs-sample:1",
"pendingCount": 0,
"loadBalancers": [],
"desiredCount": 10,
"createdAt": 1466801808.595,
"serviceName": "my-http-service",
"clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/default",
"serviceArn": "arn:aws:ecs:us-west-2:123456789012:service/my-http-service",
"deployments": [
{
"status": "PRIMARY",
"pendingCount": 0,
"createdAt": 1466801808.595,
"desiredCount": 10,
"taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/amazon-ecs-sample:1",
"updatedAt": 1428326312.703,
"id": "ecs-svc/1234567890123456789",
"runningCount": 10
}
],
"events": [
{
"message": "(service my-http-service) has reached a steady state.",
"id": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
"createdAt": 1466801812.435
}
],
"runningCount": 10
}
],
"failures": []
}
```
詳細については、「Amazon ECS ディベロッパーガイド」の「[Amazon ECS サービス](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html)」を参照してください。**
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeServices](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/describe-services.html)」を参照してください。
### `describe-task-definition`
次のコード例は、`describe-task-definition` を使用する方法を示しています。
**AWS CLI**
**タスク定義を記述するには**
次の `describe-task-definition` の例は、タスク定義の詳細情報を取得します。
```
aws ecs describe-task-definition \
--task-definition hello_world:8
```
出力:
```
{
"taskDefinition": {
"taskDefinitionArn": "arn:aws:ecs:us-east-1:012345678910:task-definition/hello_world:8",
"containerDefinitions": [
{
"cpu": 10,
"environment": [],
"essential": true,
"image": "wordpress",
"links": [
"mysql"
] ,
"memory": 500,
"mountPoints": [],
"name": "wordpress",
"portMappings": [
{
"containerPort": 80,
"hostPort": 80
}
],
"volumesFrom": []
},
{
"cpu": 10,
"environment": [
{
"name": "MYSQL_ROOT_PASSWORD",
"value": "password"
}
],
"essential": true,
"image": "mysql",
"memory": 500,
"mountPoints": [],
"name": "mysql",
"portMappings": [],
"volumesFrom": []
}
],
"family": "hello_world",
"revision": 8,
"volumes": [],
"status": "ACTIVE",
"placementConstraints": [],
"compatibilities": [
"EXTERNAL",
"EC2"
],
"registeredAt": "2024-06-21T11:15:12.669000-05:00",
"registeredBy": "arn:aws:sts::012345678910:assumed-role/demo-role/jane-doe"
},
"tags": []
}
```
詳細については、「Amazon ECS ディベロッパーガイド」の「[Amazon ECS のタスク定義](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definitions.html)」を参照してください。**
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeTaskDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/describe-task-definition.html)」を参照してください。
### `describe-task-sets`
次のコード例は、`describe-task-sets` を使用する方法を示しています。
**AWS CLI**
**タスクセットを記述するには**
次の `describe-task-sets` の例では、外部デプロイを使用するサービス内のタスクセットについて説明します。
```
aws ecs describe-task-sets \
--cluster MyCluster \
--service MyService \
--task-sets arn:aws:ecs:us-west-2:123456789012:task-set/MyCluster/MyService/ecs-svc/1234567890123456789
```
出力:
```
{
"taskSets": [
{
"id": "ecs-svc/1234567890123456789",
"taskSetArn": "arn:aws:ecs:us-west-2:123456789012:task-set/MyCluster/MyService/ecs-svc/1234567890123456789",
"status": "ACTIVE",
"taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/sample-fargate:2",
"computedDesiredCount": 0,
"pendingCount": 0,
"runningCount": 0,
"createdAt": 1557207715.195,
"updatedAt": 1557207740.014,
"launchType": "EC2",
"networkConfiguration": {
"awsvpcConfiguration": {
"subnets": [
"subnet-12344321"
],
"securityGroups": [
"sg-1234431"
],
"assignPublicIp": "DISABLED"
}
},
"loadBalancers": [],
"serviceRegistries": [],
"scale": {
"value": 0.0,
"unit": "PERCENT"
},
"stabilityStatus": "STEADY_STATE",
"stabilityStatusAt": 1557207740.014
}
],
"failures": []
}
```
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeTaskSets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/describe-task-sets.html)」を参照してください。
### `describe-tasks`
次の例は、`describe-tasks` を使用する方法を説明しています。
**AWS CLI**
**例 1: 単一のタスクを記述するには**
次の `describe-tasks` の例は、クラスター内の単一のタスクの詳細情報を取得します。タスクの ID または完全な ARN を使用して、タスクを指定できます。この例では、タスクの完全な ARN を使用します。
```
aws ecs describe-tasks \
--cluster MyCluster \
--tasks arn:aws:ecs:us-east-1:123456789012:task/MyCluster/4d590253bb114126b7afa7b58EXAMPLE
```
出力:
```
{
"tasks": [
{
"attachments": [],
"attributes": [
{
"name": "ecs.cpu-architecture",
"value": "x86_64"
}
],
"availabilityZone": "us-east-1b",
"clusterArn": "arn:aws:ecs:us-east-1:123456789012:cluster/MyCluster",
"connectivity": "CONNECTED",
"connectivityAt": "2021-08-11T12:21:26.681000-04:00",
"containerInstanceArn": "arn:aws:ecs:us-east-1:123456789012:container-instance/test/025c7e2c5e054a6790a29fc1fEXAMPLE",
"containers": [
{
"containerArn": "arn:aws:ecs:us-east-1:123456789012:container/MyCluster/4d590253bb114126b7afa7b58eea9221/a992d1cc-ea46-474a-b6e8-24688EXAMPLE",
"taskArn": "arn:aws:ecs:us-east-1:123456789012:task/MyCluster/4d590253bb114126b7afa7b58EXAMPLE",
"name": "simple-app",
"image": "httpd:2.4",
"runtimeId": "91251eed27db90006ad67b1a08187290869f216557717dd5c39b37c94EXAMPLE",
"lastStatus": "RUNNING",
"networkBindings": [
{
"bindIP": "0.0.0.0",
"containerPort": 80,
"hostPort": 80,
"protocol": "tcp"
}
],
"networkInterfaces": [],
"healthStatus": "UNKNOWN",
"cpu": "10",
"memory": "300"
}
],
"cpu": "10",
"createdAt": "2021-08-11T12:21:26.681000-04:00",
"desiredStatus": "RUNNING",
"enableExecuteCommand": false,
"group": "service:testupdate",
"healthStatus": "UNKNOWN",
"lastStatus": "RUNNING",
"launchType": "EC2",
"memory": "300",
"overrides": {
"containerOverrides": [
{
"name": "simple-app"
}
],
"inferenceAcceleratorOverrides": []
},
"pullStartedAt": "2021-08-11T12:21:28.234000-04:00",
"pullStoppedAt": "2021-08-11T12:21:33.793000-04:00",
"startedAt": "2021-08-11T12:21:34.945000-04:00",
"startedBy": "ecs-svc/968695068243EXAMPLE",
"tags": [],
"taskArn": "arn:aws:ecs:us-east-1:123456789012:task/MyCluster/4d590253bb114126b7afa7b58eea9221",
"taskDefinitionArn": "arn:aws:ecs:us-east-1:123456789012:task-definition/console-sample-app-static2:1",
"version": 2
}
],
"failures": []
}
```
詳細については、「Amazon ECS ディベロッパーガイド」の「[Amazon ECS のタスク定義](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definitions.html)」を参照してください。**
**例 2: 複数のタスクを記述するには**
次の `describe-tasks` の例は、クラスター内の複数のタスクの詳細情報を取得します。タスクの ID または完全な ARN を使用して、タスクを指定できます。この例では、タスクの完全な ID を使用します。
```
aws ecs describe-tasks \
--cluster MyCluster \
--tasks "74de0355a10a4f979ac495c14EXAMPLE" "d789e94343414c25b9f6bd59eEXAMPLE"
```
出力:
```
{
"tasks": [
{
"attachments": [
{
"id": "d9e7735a-16aa-4128-bc7a-b2d51EXAMPLE",
"type": "ElasticNetworkInterface",
"status": "ATTACHED",
"details": [
{
"name": "subnetId",
"value": "subnet-0d0eab1bb3EXAMPLE"
},
{
"name": "networkInterfaceId",
"value": "eni-0fa40520aeEXAMPLE"
},
{
"name": "macAddress",
"value": "0e:89:76:28:07:b3"
},
{
"name": "privateDnsName",
"value": "ip-10-0-1-184.ec2.internal"
},
{
"name": "privateIPv4Address",
"value": "10.0.1.184"
}
]
}
],
"attributes": [
{
"name": "ecs.cpu-architecture",
"value": "x86_64"
}
],
"availabilityZone": "us-east-1b",
"clusterArn": "arn:aws:ecs:us-east-1:123456789012:cluster/MyCluster",
"connectivity": "CONNECTED",
"connectivityAt": "2021-12-20T12:13:37.875000-05:00",
"containers": [
{
"containerArn": "arn:aws:ecs:us-east-1:123456789012:container/MyCluster/74de0355a10a4f979ac495c14EXAMPLE/aad3ba00-83b3-4dac-84d4-11f8cEXAMPLE",
"taskArn": "arn:aws:ecs:us-east-1:123456789012:task/MyCluster/74de0355a10a4f979ac495c14EXAMPLE",
"name": "web",
"image": "nginx",
"runtimeId": "74de0355a10a4f979ac495c14EXAMPLE-265927825",
"lastStatus": "RUNNING",
"networkBindings": [],
"networkInterfaces": [
{
"attachmentId": "d9e7735a-16aa-4128-bc7a-b2d51EXAMPLE",
"privateIpv4Address": "10.0.1.184"
}
],
"healthStatus": "UNKNOWN",
"cpu": "99",
"memory": "100"
}
],
"cpu": "256",
"createdAt": "2021-12-20T12:13:20.226000-05:00",
"desiredStatus": "RUNNING",
"enableExecuteCommand": false,
"group": "service:tdsevicetag",
"healthStatus": "UNKNOWN",
"lastStatus": "RUNNING",
"launchType": "FARGATE",
"memory": "512",
"overrides": {
"containerOverrides": [
{
"name": "web"
}
],
"inferenceAcceleratorOverrides": []
},
"platformVersion": "1.4.0",
"platformFamily": "Linux",
"pullStartedAt": "2021-12-20T12:13:42.665000-05:00",
"pullStoppedAt": "2021-12-20T12:13:46.543000-05:00",
"startedAt": "2021-12-20T12:13:48.086000-05:00",
"startedBy": "ecs-svc/988401040018EXAMPLE",
"tags": [],
"taskArn": "arn:aws:ecs:us-east-1:123456789012:task/MyCluster/74de0355a10a4f979ac495c14EXAMPLE",
"taskDefinitionArn": "arn:aws:ecs:us-east-1:123456789012:task-definition/webserver:2",
"version": 3,
"ephemeralStorage": {
"sizeInGiB": 20
}
},
{
"attachments": [
{
"id": "214eb5a9-45cd-4bf8-87bc-57fefEXAMPLE",
"type": "ElasticNetworkInterface",
"status": "ATTACHED",
"details": [
{
"name": "subnetId",
"value": "subnet-0d0eab1bb3EXAMPLE"
},
{
"name": "networkInterfaceId",
"value": "eni-064c7766daEXAMPLE"
},
{
"name": "macAddress",
"value": "0e:76:83:01:17:a9"
},
{
"name": "privateDnsName",
"value": "ip-10-0-1-41.ec2.internal"
},
{
"name": "privateIPv4Address",
"value": "10.0.1.41"
}
]
}
],
"attributes": [
{
"name": "ecs.cpu-architecture",
"value": "x86_64"
}
],
"availabilityZone": "us-east-1b",
"clusterArn": "arn:aws:ecs:us-east-1:123456789012:cluster/MyCluster",
"connectivity": "CONNECTED",
"connectivityAt": "2021-12-20T12:13:35.243000-05:00",
"containers": [
{
"containerArn": "arn:aws:ecs:us-east-1:123456789012:container/MyCluster/d789e94343414c25b9f6bd59eEXAMPLE/9afef792-609b-43a5-bb6a-3efdbEXAMPLE",
"taskArn": "arn:aws:ecs:us-east-1:123456789012:task/MyCluster/d789e94343414c25b9f6bd59eEXAMPLE",
"name": "web",
"image": "nginx",
"runtimeId": "d789e94343414c25b9f6bd59eEXAMPLE-265927825",
"lastStatus": "RUNNING",
"networkBindings": [],
"networkInterfaces": [
{
"attachmentId": "214eb5a9-45cd-4bf8-87bc-57fefEXAMPLE",
"privateIpv4Address": "10.0.1.41"
}
],
"healthStatus": "UNKNOWN",
"cpu": "99",
"memory": "100"
}
],
"cpu": "256",
"createdAt": "2021-12-20T12:13:20.226000-05:00",
"desiredStatus": "RUNNING",
"enableExecuteCommand": false,
"group": "service:tdsevicetag",
"healthStatus": "UNKNOWN",
"lastStatus": "RUNNING",
"launchType": "FARGATE",
"memory": "512",
"overrides": {
"containerOverrides": [
{
"name": "web"
}
],
"inferenceAcceleratorOverrides": []
},
"platformVersion": "1.4.0",
"platformFamily": "Linux",
"pullStartedAt": "2021-12-20T12:13:44.611000-05:00",
"pullStoppedAt": "2021-12-20T12:13:48.251000-05:00",
"startedAt": "2021-12-20T12:13:49.326000-05:00",
"startedBy": "ecs-svc/988401040018EXAMPLE",
"tags": [],
"taskArn": "arn:aws:ecs:us-east-1:123456789012:task/MyCluster/d789e94343414c25b9f6bd59eEXAMPLE",
"taskDefinitionArn": "arn:aws:ecs:us-east-1:123456789012:task-definition/webserver:2",
"version": 3,
"ephemeralStorage": {
"sizeInGiB": 20
}
}
],
"failures": []
}
```
詳細については、「Amazon ECS ディベロッパーガイド」の「[Amazon ECS のタスク定義](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definitions.html)」を参照してください。**
+ API の詳細については、AWS CLI コマンドリファレンスの「[DescribeTasks](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/describe-tasks.html)」を参照してください。**
### `execute-command`
次のコード例は、`execute-command` を使用する方法を示しています。
**AWS CLI**
**インタラクティブ /bin/sh コマンドを実行するには**
次の `execute-command` の例では、ID が `arn:aws:ecs:us-east-1:123456789012:task/MyCluster/d789e94343414c25b9f6bd59eEXAMPLE` のタスクで、MyContainer という名前のコンテナに対してインタラクティブな /bin/sh コマンドを実行します。
```
aws ecs execute-command \
--cluster MyCluster \
--task arn:aws:ecs:us-east-1:123456789012:task/MyCluster/d789e94343414c25b9f6bd59eEXAMPLE \
--container MyContainer \
--interactive \
--command "/bin/sh"
```
このコマンドでは何も出力されません。
詳細については、「*Amazon ECS デベロッパーガイド*」の「[Amazon ECS Exec を使用してデバッグする](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-exec.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ExecuteCommand](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/execute-command.html)」を参照してください。
### `get-task-protection`
次のコード例は、`get-task-protection` を使用する方法を示しています。
**AWS CLI**
**ECS サービスでタスクの保護ステータスを取得する**
次の `get-task-protection` は、Amazon ECS サービスに属する ECS タスクの保護ステータスを返します。
```
aws ecs get-task-protection \
--cluster ECS-project-update-cluster \
--tasks c43ed3b1331041f289316f958adb6a24
```
出力:
```
{
"protectedTasks": [
{
"taskArn": "arn:aws:ecs:us-west-2:123456789012:task/c43ed3b1331041f289316f958adb6a24",
"protectionEnabled": false
}
],
"failures": []
}
```
タスク保護の詳細については、*Amazon ECS デベロッパーガイド*の「[Amazon ECS タスクがスケールインイベントによって終了するのを防ぐ](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-scale-in-protection.html)」を参照してください。
+ API の詳細については、*AWS CLI コマンドリファレンス*の「[GetTaskProtection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/get-task-protection.html)」を参照してください。
### `list-account-settings`
次のコード例は、`list-account-settings` を使用する方法を示しています。
**AWS CLI**
**例 1: アカウントのアカウント設定を表示するには**
次の `list-account-settings` の例は、アカウントの有効なアカウント設定を示しています。
```
aws ecs list-account-settings --effective-settings
```
出力:
```
{
"settings": [
{
"name": "containerInstanceLongArnFormat",
"value": "enabled",
"principalArn": "arn:aws:iam::123456789012:root"
},
{
"name": "serviceLongArnFormat",
"value": "enabled",
"principalArn": "arn:aws:iam::123456789012:root"
},
{
"name": "taskLongArnFormat",
"value": "enabled",
"principalArn": "arn:aws:iam::123456789012:root"
}
]
}
```
**例 2: 特定の IAM ユーザーまたは IAM ロールのアカウント設定を表示するには**
次の `list-account-settings` の例では、指定された IAM ユーザーまたは IAM ロールのアカウント設定を表示します。
```
aws ecs list-account-settings --principal-arn arn:aws:iam::123456789012:user/MyUser
```
出力:
```
{
"settings": [
{
"name": "serviceLongArnFormat",
"value": "enabled",
"principalArn": "arn:aws:iam::123456789012:user/MyUser"
}
]
}
```
詳細については、「*Amazon ECS デベロッパーガイド*」の「[Amazon リソースネーム (ARN) と ID](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-resource-ids.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListAccountSettings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/list-account-settings.html)」を参照してください。
### `list-attributes`
次のコード例は、`list-attributes` を使用する方法を示しています。
**AWS CLI**
**特定の属性を含むコンテナインスタンスを一覧表示するには**
次の例では、デフォルトクラスターに `stack=production` 属性を持つコンテナインスタンスの属性を一覧表示します。
```
aws ecs list-attributes \
--target-type container-instance \
--attribute-name stack \
--attribute-value production \
--cluster default
```
出力:
```
{
"attributes": [
{
"name": "stack",
"targetId": "arn:aws:ecs:us-west-2:130757420319:container-instance/1c3be8ed-df30-47b4-8f1e-6e68ebd01f34",
"value": "production"
}
]
}
```
詳細については、「*Amazon ECS デベロッパーガイド*」の「[Amazon ECS コンテナエージェントの設定](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/list-attributes.html)」を参照してください。
### `list-clusters`
次のコード例は、`list-clusters` を使用する方法を示しています。
**AWS CLI**
**使用可能なクラスターを一覧表示するには**
次の `list-clusters` の例は、使用可能なすべてのクラスターを一覧表示します。
```
aws ecs list-clusters
```
出力:
```
{
"clusterArns": [
"arn:aws:ecs:us-west-2:123456789012:cluster/MyECSCluster1",
"arn:aws:ecs:us-west-2:123456789012:cluster/AnotherECSCluster"
]
}
```
詳細については、「Amazon ECS ディベロッパーガイド」の「[Amazon ECS Clusters](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ECS_clusters.html)」を参照してください。**
+ API の詳細については、AWS CLI コマンドリファレンスの「[ListClusters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/list-clusters.html)」を参照してください。**
### `list-container-instances`
次のコード例は、`list-container-instances` を使用する方法を示しています。
**AWS CLI**
**クラスター内のコンテナインスタンスを一覧表示するには**
次の `list-container-instances` の例は、クラスターで使用可能なすべてのコンテナインスタンスを一覧表示します。
```
aws ecs list-container-instances --cluster MyCluster
```
出力:
```
{
"containerInstanceArns": [
"arn:aws:ecs:us-west-2:123456789012:container-instance/MyCluster/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
"arn:aws:ecs:us-west-2:123456789012:container-instance/MyCluster/a1b2c3d4-5678-90ab-cdef-22222EXAMPLE"
]
}
```
詳細については、「*Amazon ECS デベロッパーガイド*」の「[Amazon ECS コンテナインスタンス](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ECS_instances.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListContainerInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/list-container-instances.html)」を参照してください。
### `list-service-deployments`
次のコード例は、`list-service-deployments` を使用する方法を示しています。
**AWS CLI**
**サービスデプロイを一覧表示するには**
次の `list-service-deployments` の例では、`example-service` という名前のサービスのサービスデプロイを取得します。
```
aws ecs list-service-deployments \
--service arn:aws:ecs:us-east-1:123456789012:service/example-cluster/example-service
```
出力:
```
{
"serviceDeployments": [
{
"serviceDeploymentArn": "arn:aws:ecs:us-east-1:123456789012:service-deployment/example-cluster/example-service/ejGvqq2ilnbKT9qj0vLJe",
"serviceArn": "arn:aws:ecs:us-east-1:123456789012:service/example-cluster/example-service",
"clusterArn": "arn:aws:ecs:us-east-1:123456789012:cluster/example-cluster",
"startedAt": "2024-10-31T08:03:32.510000-04:00",
"createdAt": "2024-10-31T08:03:30.917000-04:00",
"finishedAt": "2024-10-31T08:05:04.527000-04:00",
"targetServiceRevisionArn": "arn:aws:ecs:us-east-1:123456789012:service-revision/example-cluster/example-service/1485800978477494678",
"status": "SUCCESSFUL"
}
]
}
```
詳細については、*Amazon ECS デベロッパーガイド*の「[Amazon ECS サービスデプロイを使用してサービス履歴を表示する](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-deployment.html)」を参照してください。
+ API の詳細については、*AWS CLI コマンドリファレンス*の「[ListServiceDeployments](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/list-service-deployments.html)」を参照してください。
### `list-services-by-namespace`
次のコード例は、`list-services-by-namespace` を使用する方法を示しています。
**AWS CLI**
**名前空間内のサービスを一覧表示するには**
次の `list-services-by-namespace` の例では、デフォルトのリージョンで指定された名前空間に対して設定されたすべてのサービスを一覧表示します。
```
aws ecs list-services-by-namespace \
--namespace service-connect
```
出力:
```
{
"serviceArns": [
"arn:aws:ecs:us-west-2:123456789012:service/MyCluster/MyService",
"arn:aws:ecs:us-west-2:123456789012:service/tutorial/service-connect-nginx-service"
]
}
```
詳細については、「*Amazon ECS デベロッパーガイド*」の「[Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListServicesByNamespace](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/list-services-by-namespace.html)」を参照してください。
### `list-services`
次のコード例は、`list-services` を使用する方法を示しています。
**AWS CLI**
**クラスター内のサービスを一覧表示するには**
次の `list-services` の例は、クラスターで実行中のサービスを一覧表示する方法を示しています。
```
aws ecs list-services --cluster MyCluster
```
出力:
```
{
"serviceArns": [
"arn:aws:ecs:us-west-2:123456789012:service/MyCluster/MyService"
]
}
```
詳細については、「Amazon ECS ディベロッパーガイド」の「[Amazon ECS サービス](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html)」を参照してください。**
+ API の詳細については、AWS CLI コマンドリファレンスの「[ListServices](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/list-services.html)」を参照してください。**
### `list-tags-for-resource`
次のコード例は、`list-tags-for-resource` を使用する方法を示しています。
**AWS CLI**
**リソースのタグを一覧表示するには**
次の `list-tags-for-resource` の例では、特定のクラスターのタグを一覧表示します。
```
aws ecs list-tags-for-resource \
--resource-arn arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster
```
出力:
```
{
"tags": [
{
"key": "key1",
"value": "value1"
},
{
"key": "key2",
"value": "value2"
},
{
"key": "key3",
"value": "value3"
}
]
}
```
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/list-tags-for-resource.html)」を参照してください。
### `list-task-definition-families`
次のコード例は、`list-task-definition-families` を使用する方法を示しています。
**AWS CLI**
**例 1: 登録されたタスク定義ファミリーを一覧表示するには**
次の `list-task-definition-families` の例では、登録されたすべてのタスク定義ファミリーを一覧表示します。
```
aws ecs list-task-definition-families
```
出力:
```
{
"families": [
"node-js-app",
"web-timer",
"hpcc",
"hpcc-c4-8xlarge"
]
}
```
**例 2: 登録されたタスク定義ファミリーをフィルタリングするには**
次の `list-task-definition-families` の例では、「hpcc」で始まるタスク定義のリビジョンを一覧表示します。
```
aws ecs list-task-definition-families --family-prefix hpcc
```
出力:
```
{
"families": [
"hpcc",
"hpcc-c4-8xlarge"
]
}
```
詳細については、「*Amazon ECS デベロッパーガイド*」の「[タスク定義のパラメータ](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#family)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListTaskDefinitionFamilies](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/list-task-definition-families.html)」を参照してください。
### `list-task-definitions`
次のコード例は、`list-task-definitions` を使用する方法を示しています。
**AWS CLI**
**例 1: 登録されたタスク定義を一覧表示するには**
次の `list-task-definitions` の例では、登録されたすべてのタスク定義を一覧表示します。
```
aws ecs list-task-definitions
```
出力:
```
{
"taskDefinitionArns": [
"arn:aws:ecs:us-west-2:123456789012:task-definition/sleep300:2",
"arn:aws:ecs:us-west-2:123456789012:task-definition/sleep360:1",
"arn:aws:ecs:us-west-2:123456789012:task-definition/wordpress:3",
"arn:aws:ecs:us-west-2:123456789012:task-definition/wordpress:4",
"arn:aws:ecs:us-west-2:123456789012:task-definition/wordpress:5",
"arn:aws:ecs:us-west-2:123456789012:task-definition/wordpress:6"
]
}
```
**例 2: ファミリーに登録されたタスク定義を一覧表示するには**
次の list-task-definitions の例では、指定されたファミリーのタスク定義リビジョンを一覧表示します。
```
aws ecs list-task-definitions --family-prefix wordpress
```
出力:
```
{
"taskDefinitionArns": [
"arn:aws:ecs:us-west-2:123456789012:task-definition/wordpress:3",
"arn:aws:ecs:us-west-2:123456789012:task-definition/wordpress:4",
"arn:aws:ecs:us-west-2:123456789012:task-definition/wordpress:5",
"arn:aws:ecs:us-west-2:123456789012:task-definition/wordpress:6"
]
}
```
詳細については、「Amazon ECS ディベロッパーガイド」の「[Amazon ECS のタスク定義](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definitions.html)」を参照してください。**
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListTaskDefinitions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/list-task-definitions.html)」を参照してください。
### `list-tasks`
次のコード例は、`list-tasks` を使用する方法を示しています。
**AWS CLI**
**例 1: クラスター内のタスクを一覧表示するには**
次の `list-tasks` の例は、クラスター内のすべてのタスクを一覧表示します。
```
aws ecs list-tasks --cluster default
```
出力:
```
{
"taskArns": [
"arn:aws:ecs:us-west-2:123456789012:task/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
"arn:aws:ecs:us-west-2:123456789012:task/a1b2c3d4-5678-90ab-cdef-22222EXAMPLE"
]
}
```
**例 2: 特定のコンテナインスタンスのタスクを一覧表示するには**
次の `list-tasks` の例は、コンテナインスタンスの UUID をフィルタとして使用して、コンテナインスタンスのタスクを一覧表示します。
```
aws ecs list-tasks --cluster default --container-instance a1b2c3d4-5678-90ab-cdef-33333EXAMPLE
```
出力:
```
{
"taskArns": [
"arn:aws:ecs:us-west-2:123456789012:task/a1b2c3d4-5678-90ab-cdef-44444EXAMPLE"
]
}
```
詳細については、「Amazon ECS ディベロッパーガイド」の「[Amazon ECS のタスク定義](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definitions.html)」を参照してください。**
+ API の詳細については、AWS CLI コマンドリファレンスの「[ListTasks](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/list-tasks.html)」を参照してください。**
### `put-account-setting-default`
次のコード例は、`put-account-setting-default` を使用する方法を示しています。
**AWS CLI**
**デフォルトのアカウント設定を変更するには**
次の `put-account-setting-default` の例では、アカウントのすべての IAM ユーザーまたはロールのデフォルトアカウント設定を変更します。これらの変更は、IAM ユーザーまたはロールがこれらの設定を明示的に上書きしない限り、 AWS アカウント全体に適用されます。
```
aws ecs put-account-setting-default --name serviceLongArnFormat --value enabled
```
出力:
```
{
"setting": {
"name": "serviceLongArnFormat",
"value": "enabled",
"principalArn": "arn:aws:iam::123456789012:root"
}
}
```
詳細については、「*Amazon ECS デベロッパーガイド*」の「[Amazon リソースネーム (ARN) と ID](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-resource-ids.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PutAccountSettingDefault](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/put-account-setting-default.html)」を参照してください。
### `put-account-setting`
次のコード例は、`put-account-setting` を使用する方法を示しています。
**AWS CLI**
**IAM ユーザーアカウントのアカウント設定を変更するには**
次の `put-account-setting` の例では、IAM ユーザーアカウントの `containerInsights` アカウント設定を `enhanced` に設定します。これにより、オブザーバビリティが強化された Container Insights が有効になります。
```
aws ecs put-account-setting \
--name containerInsights \
--value enhanced
```
出力:
```
{
"setting": {
"name": "containerInsights",
"value": "enhanced",
"principalArn": "arn:aws:iam::123456789012:user/johndoe",
"type": "user"
}
}
```
詳細については、「*Amazon ECS デベロッパーガイド*」の「[アカウント設定の変更](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-modifying-longer-id-settings.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PutAccountSetting](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/put-account-setting.html)」を参照してください。
### `put-account-settings`
次のコード例は、`put-account-settings` を使用する方法を示しています。
**AWS CLI**
**IAM ユーザーまたは IAM ロールのアカウント設定を変更するには**
次の `put-account-setting` の例では、指定された IAM ユーザーまたは IAM ロールのアカウント設定を変更します。
```
aws ecs put-account-setting \
--name serviceLongArnFormat \
--value enabled \
--principal-arn arn:aws:iam::123456789012:user/MyUser
```
出力:
```
{
"setting": {
"name": "serviceLongArnFormat",
"value": "enabled",
"principalArn": "arn:aws:iam::123456789012:user/MyUser"
}
}
```
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PutAccountSettings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/put-account-settings.html)」を参照してください。
### `put-attributes`
次のコード例は、`put-attributes` を使用する方法を示しています。
**AWS CLI**
**属性を作成して Amazon ECS リソースに関連付けるには**
次の `put-attributes` では、名前 stack と値 production を含む属性をコンテナインスタンスに適用します。
```
aws ecs put-attributes \
--attributes name=stack,value=production,targetId=arn:aws:ecs:us-west-2:130757420319:container-instance/1c3be8ed-df30-47b4-8f1e-6e68ebd01f34
```
出力:
```
{
"attributes": [
{
"name": "stack",
"targetId": "arn:aws:ecs:us-west-2:130757420319:container-instance/1c3be8ed-df30-47b4-8f1e-6e68ebd01f34",
"value": "production"
}
]
}
```
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PutAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/put-attributes.html)」を参照してください。
### `put-cluster-capacity-providers`
次のコード例は、`put-cluster-capacity-providers` を使用する方法を示しています。
**AWS CLI**
**例 1: 既存のキャパシティプロバイダーをクラスターに追加するには**
次の `put-cluster-capacity-providers` の例では、既存のキャパシティープロバイダーをクラスターに追加します。キャパシティープロバイダーを作成するには、`create-capacity-provider` コマンドを使用します。`describe-clusters` コマンドは、現在のキャパシティープロバイダーとクラスターに関連付けられたデフォルトのキャパシティープロバイダー戦略を記述するために使用されます。新しいキャパシティープロバイダーをクラスターに追加するときは、クラスターに関連付ける新しいキャパシティープロバイダーに加えて、既存のすべてのキャパシティープロバイダーを指定する必要があります。また、クラスターに関連付けるデフォルトのキャパシティープロバイダー戦略も指定する必要があります。この例では、`MyCluster` クラスターは関連付けられた `MyCapacityProvider1` キャパシティープロバイダーがあり、`MyCapacityProvider2` キャパシティープロバイダーを追加して、それをデフォルトのキャパシティープロバイダー戦略に含めることで、タスクが両方のキャパシティープロバイダーに均等に分散されるようにしようとしています。
```
aws ecs put-cluster-capacity-providers \
--cluster MyCluster \
--capacity-providers MyCapacityProvider1 MyCapacityProvider2 \
--default-capacity-provider-strategy capacityProvider=MyCapacityProvider1,weight=1 capacityProvider=MyCapacityProvider2,weight=1
```
出力:
```
{
"cluster": {
"clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster",
"clusterName": "MyCluster",
"status": "ACTIVE",
"registeredContainerInstancesCount": 0,
"runningTasksCount": 0,
"pendingTasksCount": 0,
"activeServicesCount": 0,
"statistics": [],
"tags": [],
"settings": [
{
"name": "containerInsights",
"value": "enabled"
}
],
"capacityProviders": [
"MyCapacityProvider1",
"MyCapacityProvider2"
],
"defaultCapacityProviderStrategy": [
{
"capacityProvider": "MyCapacityProvider1",
"weight": 1,
"base": 0
},
{
"capacityProvider": "MyCapacityProvider2",
"weight": 1,
"base": 0
}
],
"attachments": [
{
"id": "0fb0c8f4-6edd-4de1-9b09-17e470ee1918",
"type": "as_policy",
"status": "ACTIVE",
"details": [
{
"name": "capacityProviderName",
"value": "MyCapacityProvider1"
},
{
"name": "scalingPolicyName",
"value": "ECSManagedAutoScalingPolicy-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
}
]
},
{
"id": "ae592060-2382-4663-9476-b015c685593c",
"type": "as_policy",
"status": "ACTIVE",
"details": [
{
"name": "capacityProviderName",
"value": "MyCapacityProvider2"
},
{
"name": "scalingPolicyName",
"value": "ECSManagedAutoScalingPolicy-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222"
}
]
}
],
"attachmentsStatus": "UPDATE_IN_PROGRESS"
}
}
```
詳細については、「Amazon ECS ディベロッパーガイド」の「[Amazon ECS キャパシティープロバイダー](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-capacity-providers.html)」を参照してください。**
**例 2: クラスターからキャパシティプロバイダーを削除するには**
次の `put-cluster-capacity-providers` の例では、クラスターからキャパシティプロバイダーを削除します。`describe-clusters` コマンドは、クラスターに関連付けられている現在のキャパシティプロバイダーを記述するために使用されます。クラスターからキャパシティープロバイダーを削除するときは、クラスターに関連付けられたままにするキャパシティープロバイダーと、クラスターに関連付けるデフォルトのキャパシティープロバイダー戦略を指定する必要があります。この例では、クラスターに `MyCapacityProvider1` と `MyCapacityProvider2` キャパシティープロバイダーが関連付けられており、`MyCapacityProvider2` キャパシティープロバイダーを削除しようと思っています。そのため、更新されたデフォルトのキャパシティープロバイダー戦略とともにコマンドで `MyCapacityProvider1` のみを指定します。
```
aws ecs put-cluster-capacity-providers \
--cluster MyCluster \
--capacity-providers MyCapacityProvider1 \
--default-capacity-provider-strategy capacityProvider=MyCapacityProvider1,weight=1,base=0
```
出力:
```
{
"cluster": {
"clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster",
"clusterName": "MyCluster",
"status": "ACTIVE",
"registeredContainerInstancesCount": 0,
"runningTasksCount": 0,
"pendingTasksCount": 0,
"activeServicesCount": 0,
"statistics": [],
"tags": [],
"settings": [
{
"name": "containerInsights",
"value": "enabled"
}
],
"capacityProviders": [
"MyCapacityProvider1"
],
"defaultCapacityProviderStrategy": [
"capacityProvider": "MyCapacityProvider1",
"weight": 1,
"base": 0
],
"attachments": [
{
"id": "0fb0c8f4-6edd-4de1-9b09-17e470ee1918",
"type": "as_policy",
"status": "ACTIVE",
"details": [
{
"name": "capacityProviderName",
"value": "MyCapacityProvider1"
},
{
"name": "scalingPolicyName",
"value": "ECSManagedAutoScalingPolicy-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
}
]
},
{
"id": "ae592060-2382-4663-9476-b015c685593c",
"type": "as_policy",
"status": "DELETING",
"details": [
{
"name": "capacityProviderName",
"value": "MyCapacityProvider2"
},
{
"name": "scalingPolicyName",
"value": "ECSManagedAutoScalingPolicy-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222"
}
]
}
],
"attachmentsStatus": "UPDATE_IN_PROGRESS"
}
}
```
詳細については、「Amazon ECS ディベロッパーガイド」の「[Amazon ECS キャパシティープロバイダー](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-capacity-providers.html)」を参照してください。**
**例 3: クラスターからすべてのキャパシティプロバイダーを削除するには**
次の `put-cluster-capacity-providers` の例では、クラスターからすべての既存のキャパシティプロバイダーを削除します。
```
aws ecs put-cluster-capacity-providers \
--cluster MyCluster \
--capacity-providers [] \
--default-capacity-provider-strategy []
```
出力:
```
{
"cluster": {
"clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster",
"clusterName": "MyCluster",
"status": "ACTIVE",
"registeredContainerInstancesCount": 0,
"runningTasksCount": 0,
"pendingTasksCount": 0,
"activeServicesCount": 0,
"statistics": [],
"tags": [],
"settings": [
{
"name": "containerInsights",
"value": "enabled"
}
],
"capacityProviders": [],
"defaultCapacityProviderStrategy": [],
"attachments": [
{
"id": "0fb0c8f4-6edd-4de1-9b09-17e470ee1918",
"type": "as_policy",
"status": "DELETING",
"details": [
{
"name": "capacityProviderName",
"value": "MyCapacityProvider1"
},
{
"name": "scalingPolicyName",
"value": "ECSManagedAutoScalingPolicy-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
}
]
},
{
"id": "ae592060-2382-4663-9476-b015c685593c",
"type": "as_policy",
"status": "DELETING",
"details": [
{
"name": "capacityProviderName",
"value": "MyCapacityProvider2"
},
{
"name": "scalingPolicyName",
"value": "ECSManagedAutoScalingPolicy-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222"
}
]
}
],
"attachmentsStatus": "UPDATE_IN_PROGRESS"
}
}
```
詳細については、「Amazon ECS ディベロッパーガイド」の「[Amazon ECS キャパシティープロバイダー](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-capacity-providers.html)」を参照してください。**
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PutClusterCapacityProviders](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/put-cluster-capacity-providers.html)」を参照してください。
### `register-task-definition`
次のコード例は、`register-task-definition` を使用する方法を示しています。
**AWS CLI**
**例 1: タスク定義を JSON ファイルに登録するには**
次の `register-task-definition` の例では、タスク定義を指定されたファミリーに登録します。コンテナ定義は、指定されたファイルの場所に JSON 形式で保存されます。
```
aws ecs register-task-definition \
--cli-input-json file:///sleep360.json
```
`sleep360.json` の内容:
```
{
"containerDefinitions": [
{
"name": "sleep",
"image": "busybox",
"cpu": 10,
"command": [
"sleep",
"360"
],
"memory": 10,
"essential": true
}
],
"family": "sleep360"
}
```
出力:
```
{
"taskDefinition": {
"status": "ACTIVE",
"family": "sleep360",
"placementConstraints": [],
"compatibilities": [
"EXTERNAL",
"EC2"
],
"volumes": [],
"taskDefinitionArn": "arn:aws:ecs:us-east-1:123456789012:task-definition/sleep360:1",
"containerDefinitions": [
{
"environment": [],
"name": "sleep",
"mountPoints": [],
"image": "busybox",
"cpu": 10,
"portMappings": [],
"command": [
"sleep",
"360"
],
"memory": 10,
"essential": true,
"volumesFrom": []
}
],
"revision": 1
}
}
```
詳細については、「*Amazon ECS デベロッパーガイド*」の「[タスク定義の例](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/example_task_definitions.html)」を参照してください。
**例 2: タスク定義を JSON 文字列パラメータに登録するには**
次の `register-task-definition` の例では、エスケープされた二重引用符を持つ JSON 文字列パラメータとして提供されるコンテナ定義を使用してタスク定義を登録します。
```
aws ecs register-task-definition \
--family sleep360 \
--container-definitions "[{\"name\":\"sleep\",\"image\":\"busybox\",\"cpu\":10,\"command\":[\"sleep\",\"360\"],\"memory\":10,\"essential\":true}]"
```
出力は前の例と同じです。
詳細については、「*Amazon ECS デベロッパーガイド*」の「[タスク定義の作成](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/create-task-definition.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RegisterTaskDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/register-task-definition.html)」を参照してください。
### `run-task`
次のコード例は、`run-task` を使用する方法を示しています。
**AWS CLI**
**例 1: デフォルトのクラスターでタスクを実行するには**
次の `run-task` の例では、デフォルトのクラスターでタスクを実行し、クライアントトークンを使用します。
```
aws ecs run-task \
--cluster default \
--task-definition sleep360:1 \
--client-token 550e8400-e29b-41d4-a716-446655440000
```
出力:
```
{
"tasks": [
{
"attachments": [],
"attributes": [
{
"name": "ecs.cpu-architecture",
"value": "x86_64"
}
],
"availabilityZone": "us-east-1b",
"capacityProviderName": "example-capacity-provider",
"clusterArn": "arn:aws:ecs:us-east-1:123456789012:cluster/default",
"containerInstanceArn": "arn:aws:ecs:us-east-1:123456789012:container-instance/default/bc4d2ec611d04bb7bb97e83ceEXAMPLE",
"containers": [
{
"containerArn": "arn:aws:ecs:us-east-1:123456789012:container/default/d6f51cc5bbc94a47969c92035e9f66f8/75853d2d-711e-458a-8362-0f0aEXAMPLE",
"taskArn": "arn:aws:ecs:us-east-1:123456789012:task/default/d6f51cc5bbc94a47969c9203EXAMPLE",
"name": "sleep",
"image": "busybox",
"lastStatus": "PENDING",
"networkInterfaces": [],
"cpu": "10",
"memory": "10"
}
],
"cpu": "10",
"createdAt": "2023-11-21T16:59:34.403000-05:00",
"desiredStatus": "RUNNING",
"enableExecuteCommand": false,
"group": "family:sleep360",
"lastStatus": "PENDING",
"launchType": "EC2",
"memory": "10",
"overrides": {
"containerOverrides": [
{
"name": "sleep"
}
],
"inferenceAcceleratorOverrides": []
},
"tags": [],
"taskArn": "arn:aws:ecs:us-east-1:123456789012:task/default/d6f51cc5bbc94a47969c9203EXAMPLE",
"taskDefinitionArn": "arn:aws:ecs:us-east-1:123456789012:task-definition/sleep360:1",
"version": 1
}
],
"failures": []
}
```
詳細については、「*Amazon ECS デベロッパーガイド*」の「[スタンドアロンタスクとしてのアプリケーションの実行](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/standalone-task-create.html)」を参照してください。
**例 2: スタンドアロンタスクの Amazon EBS ボリュームを設定するには**
次の `run-task` の例では、デフォルトのクラスターで Fargate タスク用に暗号化された Amazon EBS ボリュームを設定します。`AmazonECSInfrastructureRolePolicyForVolumes` マネージドポリシーがアタッチされた Amazon ECS インフラストラクチャロールを設定する必要があります。`run-task` リクエストと同じボリューム名でタスク定義を指定する必要があります。この例では、`--cli-input-json` オプションと JSON 入力ファイル (`ebs.json`) を使用します。
```
aws ecs run-task \
--cli-input-json file://ebs.json
```
`ebs.json` の内容:
```
{
"cluster": "default",
"taskDefinition": "mytaskdef",
"launchType": "FARGATE",
"networkConfiguration":{
"awsvpcConfiguration":{
"assignPublicIp": "ENABLED",
"securityGroups": ["sg-12344321"],
"subnets":["subnet-12344321"]
}
},
"volumeConfigurations": [
{
"name": "myEBSVolume",
"managedEBSVolume": {
"volumeType": "gp3",
"sizeInGiB": 100,
"roleArn":"arn:aws:iam::1111222333:role/ecsInfrastructureRole",
"encrypted": true,
"kmsKeyId": "arn:aws:kms:region:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
}
}
]
}
```
出力:
```
{
"tasks": [
{
"attachments": [
{
"id": "ce868693-15ca-4083-91ac-f782f64000c9",
"type": "ElasticNetworkInterface",
"status": "PRECREATED",
"details": [
{
"name": "subnetId",
"value": "subnet-070982705451dad82"
}
]
},
{
"id": "a17ed863-786c-4372-b5b3-b23e53f37877",
"type": "AmazonElasticBlockStorage",
"status": "CREATED",
"details": [
{
"name": "roleArn",
"value": "arn:aws:iam::123456789012:role/ecsInfrastructureRole"
},
{
"name": "volumeName",
"value": "myEBSVolume"
},
{
"name": "deleteOnTermination",
"value": "true"
}
]
}
],
"attributes": [
{
"name": "ecs.cpu-architecture",
"value": "x86_64"
}
],
"availabilityZone": "us-west-2b",
"clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/default",
"containers": [
{
"containerArn": "arn:aws:ecs:us-west-2:123456789012:container/default/7f1fbd3629434cc4b82d72d2f09b67c9/e21962a2-f328-4699-98a3-5161ac2c186a",
"taskArn": "arn:aws:ecs:us-west-2:123456789012:task/default/7f1fbd3629434cc4b82d72d2f09b67c9",
"name": "container-using-ebs",
"image": "amazonlinux:2",
"lastStatus": "PENDING",
"networkInterfaces": [],
"cpu": "0"
}
],
"cpu": "1024",
"createdAt": "2025-01-23T10:29:46.650000-06:00",
"desiredStatus": "RUNNING",
"enableExecuteCommand": false,
"group": "family:mytaskdef",
"lastStatus": "PROVISIONING",
"launchType": "FARGATE",
"memory": "3072",
"overrides": {
"containerOverrides": [
{
"name": "container-using-ebs"
}
],
"inferenceAcceleratorOverrides": []
},
"platformVersion": "1.4.0",
"platformFamily": "Linux",
"tags": [],
"taskArn": "arn:aws:ecs:us-west-2:123456789012:task/default/7f1fbd3629434cc4b82d72d2f09b67c9",
"taskDefinitionArn": "arn:aws:ecs:us-west-2:123456789012:task-definition/mytaskdef:4",
"version": 1,
"ephemeralStorage": {
"sizeInGiB": 20
},
"fargateEphemeralStorage": {
"sizeInGiB": 20
}
}
],
"failures": []
}
```
詳細については、「*Amazon ECS デベロッパーガイド*」の「[Amazon ECS での Amazon EBS ボリュームの使用](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RunTask](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/run-task.html)」を参照してください。
### `start-task`
次のコード例は、`start-task` を使用する方法を示しています。
**AWS CLI**
**例 1: 新しいタスクを開始するには**
次の `start-task` の例では、デフォルトクラスター内の指定されたコンテナインスタンスで、最新リビジョンの `sleep360` タスク定義を使用してタスクを開始します。
```
aws ecs start-task \
--task-definition sleep360 \
--container-instances 765936fadbdd46b5991a4bd70c2a43d4
```
出力:
```
{
"tasks": [
{
"taskArn": "arn:aws:ecs:us-west-2:123456789012:task/default/666fdccc2e2d4b6894dd422f4eeee8f8",
"clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/default",
"taskDefinitionArn": "arn:aws:ecs:us-west-2:123456789012:task-definition/sleep360:3",
"containerInstanceArn": "arn:aws:ecs:us-west-2:123456789012:container-instance/default/765936fadbdd46b5991a4bd70c2a43d4",
"overrides": {
"containerOverrides": [
{
"name": "sleep"
}
]
},
"lastStatus": "PENDING",
"desiredStatus": "RUNNING",
"cpu": "128",
"memory": "128",
"containers": [
{
"containerArn": "arn:aws:ecs:us-west-2:123456789012:container/75f11ed4-8a3d-4f26-a33b-ad1db9e02d41",
"taskArn": "arn:aws:ecs:us-west-2:123456789012:task/default/666fdccc2e2d4b6894dd422f4eeee8f8",
"name": "sleep",
"lastStatus": "PENDING",
"networkInterfaces": [],
"cpu": "10",
"memory": "10"
}
],
"version": 1,
"createdAt": 1563421494.186,
"group": "family:sleep360",
"launchType": "EC2",
"attachments": [],
"tags": []
}
],
"failures": []
}
```
詳細については、「*Amazon ECS デベロッパーガイド*」の「[Amazon ECS でコンテナをスケジュールする](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/scheduling_tasks.html)」を参照してください。
**例 2: タスク開始時に Amazon EBS ボリュームを設定するには**
次の `start-task` の例では、指定されたコンテナインスタンスのタスク用に暗号化された Amazon EBS ボリュームを設定します。`AmazonECSInfrastructureRolePolicyForVolumes` マネージドポリシーがアタッチされた Amazon ECS インフラストラクチャロールを設定する必要があります。`start-task` リクエストと同じボリューム名でタスク定義を指定する必要があります。この例では、`--cli-input-json` オプションと、以下の内容を含む JSON 入力ファイル (`ebs.json`) を使用します。
```
aws ecs start-task \
--cli-input-json file://ebs.json \
--container-instances 765936fadbdd46b5991a4bd70c2a43d4
```
`ebs.json` の内容:
```
{
"cluster": "default",
"taskDefinition": "mytaskdef",
"networkConfiguration":{
"awsvpcConfiguration":{
"assignPublicIp": "ENABLED",
"securityGroups": ["sg-12344321"],
"subnets":["subnet-12344321"]
}
},
"volumeConfigurations": [
{
"name": "myEBSVolume",
"managedEBSVolume": {
"volumeType": "gp3",
"sizeInGiB": 100,
"roleArn":"arn:aws:iam::123456789012:role/ecsInfrastructureRole",
"encrypted": true,
"kmsKeyId": "arn:aws:kms:region:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab"
}
}
]
}
```
出力:
```
{
"tasks": [
{
"attachments": [
{
"id": "aea29489-9dcd-49f1-8164-4d91566e1113",
"type": "ElasticNetworkInterface",
"status": "PRECREATED",
"details": [
{
"name": "subnetId",
"value": "subnet-12344321"
}
]
},
{
"id": "f29e1222-9a1e-410f-b499-a12a7cd6d42e",
"type": "AmazonElasticBlockStorage",
"status": "CREATED",
"details": [
{
"name": "roleArn",
"value": "arn:aws:iam::123456789012:role/ecsInfrastructureRole"
},
{
"name": "volumeName",
"value": "myEBSVolume"
},
{
"name": "deleteOnTermination",
"value": "true"
}
]
}
],
"attributes": [
{
"name": "ecs.cpu-architecture",
"value": "arm64"
}
],
"availabilityZone": "us-west-2c",
"clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/default",
"containerInstanceArn": "arn:aws:ecs:us-west-2:123456789012:container-instance/default/765936fadbdd46b5991a4bd70c2a43d4",
"containers": [
{
"containerArn": "arn:aws:ecs:us-west-2:123456789012:container/default/bb122ace3ed84add92c00a351a03c69e/a4a9ed10-51c7-4567-9653-50e71b94f867",
"taskArn": "arn:aws:ecs:us-west-2:123456789012:task/default/bb122ace3ed84add92c00a351a03c69e",
"name": "container-using-ebs",
"image": "amazonlinux:2",
"lastStatus": "PENDING",
"networkInterfaces": [],
"cpu": "0"
}
],
"cpu": "1024",
"createdAt": "2025-01-23T14:51:05.191000-06:00",
"desiredStatus": "RUNNING",
"enableExecuteCommand": false,
"group": "family:mytaskdef",
"lastStatus": "PROVISIONING",
"launchType": "EC2",
"memory": "3072",
"overrides": {
"containerOverrides": [
{
"name": "container-using-ebs"
}
],
"inferenceAcceleratorOverrides": []
},
"tags": [],
"taskArn": "arn:aws:ecs:us-west-2:123456789012:task/default/bb122ace3ed84add92c00a351a03c69e",
"taskDefinitionArn": "arn:aws:ecs:us-west-2:123456789012:task-definition/mytaskdef:4",
"version": 1
}
],
"failures": []
}
```
詳細については、「*Amazon ECS デベロッパーガイド*」の「[Amazon ECS での Amazon EBS ボリュームの使用](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartTask](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/start-task.html)」を参照してください。
### `stop-task`
次のコード例は、`stop-task` を使用する方法を示しています。
**AWS CLI**
**タスクを停止するには**
次の `stop-task` は、指定されたタスクがデフォルトのクラスターで実行されないようにします。
```
aws ecs stop-task \
--task 666fdccc2e2d4b6894dd422f4eeee8f8
```
出力:
```
{
"task": {
"taskArn": "arn:aws:ecs:us-west-2:130757420319:task/default/666fdccc2e2d4b6894dd422f4eeee8f8",
"clusterArn": "arn:aws:ecs:us-west-2:130757420319:cluster/default",
"taskDefinitionArn": "arn:aws:ecs:us-west-2:130757420319:task-definition/sleep360:3",
"containerInstanceArn": "arn:aws:ecs:us-west-2:130757420319:container-instance/default/765936fadbdd46b5991a4bd70c2a43d4",
"overrides": {
"containerOverrides": []
},
"lastStatus": "STOPPED",
"desiredStatus": "STOPPED",
"cpu": "128",
"memory": "128",
"containers": [],
"version": 2,
"stoppedReason": "Taskfailedtostart",
"stopCode": "TaskFailedToStart",
"connectivity": "CONNECTED",
"connectivityAt": 1563421494.186,
"pullStartedAt": 1563421494.252,
"pullStoppedAt": 1563421496.252,
"executionStoppedAt": 1563421497,
"createdAt": 1563421494.186,
"stoppingAt": 1563421497.252,
"stoppedAt": 1563421497.252,
"group": "family:sleep360",
"launchType": "EC2",
"attachments": [],
"tags": []
}
}
```
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StopTask](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/stop-task.html)」を参照してください。
### `tag-resource`
次のコード例は、`tag-resource` を使用する方法を示しています。
**AWS CLI**
**リソースにタグを付けるには**
次の `tag-resource` の例では、指定されたリソースに単一のタグを追加します。
```
aws ecs tag-resource \
--resource-arn arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster
--tags key=key1,value=value1
```
このコマンドでは何も出力されません。
**リソースに複数のタグを追加するには**
次の `tag-resource` の例では、指定されたリソースに複数のタグを追加します。
```
aws ecs tag-resource \
--resource-arn arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster \
--tags key=key1,value=value1 key=key2,value=value2 key=key3,value=value3
```
このコマンドでは何も出力されません。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/tag-resource.html)」を参照してください。
### `untag-resource`
次の例では、`untag-resource` を使用する方法を説明しています。
**AWS CLI**
**リソースからタグを削除するには**
次の `untag-resource` の例では、指定されたリソース共有から一覧表示されたタグを削除します。
```
aws ecs untag-resource \
--resource-arn arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster \
--tag-keys key1,key2
```
このコマンドでは何も出力されません。
+ API の詳細については、「AWS CLI コマンドリファレンス」の「[UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/untag-resource.html)」を参照してください。
### `update-cluster-settings`
次のコード例は、`update-cluster-settings` を使用する方法を示しています。
**AWS CLI**
**クラスターの設定を変更するには**
次の `update-cluster-settings`の例では、`MyCluster` クラスターに対して、オブザーバビリティが強化された CloudWatch Container Insights を有効にします。
```
aws ecs update-cluster-settings \
--cluster MyCluster \
--settings name=containerInsights,value=enhanced
```
出力:
```
{
"cluster": {
"clusterArn": "arn:aws:ecs:us-esat-1:123456789012:cluster/MyCluster",
"clusterName": "default",
"status": "ACTIVE",
"registeredContainerInstancesCount": 0,
"runningTasksCount": 0,
"pendingTasksCount": 0,
"activeServicesCount": 0,
"statistics": [],
"tags": [],
"settings": [
{
"name": "containerInsights",
"value": "enhanced"
}
]
}
}
```
詳細については、「*Amazon ECS デベロッパーガイド*」の「[アカウント設定の変更](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-modifying-longer-id-settings.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateClusterSettings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/update-cluster-settings.html)」を参照してください。
### `update-cluster`
次のコード例は、`update-cluster` を使用する方法を示しています。
**AWS CLI**
**例 1: containerInsights を有効にして ECS クラスターを更新する**
次の `update-cluster` では、作成済みのクラスターで containerInsights の値を `enabled` に更新します。デフォルトでは、これは無効になっています。
```
aws ecs update-cluster \
--cluster ECS-project-update-cluster \
--settings name=containerInsights,value=enabled
```
出力:
```
"cluster": {
"clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/ECS-project-update-cluster",
"clusterName": "ECS-project-update-cluster",
"status": "ACTIVE",
"registeredContainerInstancesCount": 0,
"runningTasksCount": 0,
"pendingTasksCount": 0,
"activeServicesCount": 0,
"statistics": [],
"tags": [],
"settings": [
{
"name": "containerInsights",
"value": "enabled"
}
],
"capacityProviders": [
"Infra-ECS-Cluster-ECS-project-update-cluster-d6bb6d5b-EC2CapacityProvider-3fIpdkLywwFt"
],
"defaultCapacityProviderStrategy": [
{
"capacityProvider": "Infra-ECS-Cluster-ECS-project-update-cluster-d6bb6d5b-EC2CapacityProvider-3fIpdkLywwFt",
"weight": 1,
"base": 0
}
],
"attachments": [
{
"id": "069d002b-7634-42e4-b1d4-544f4c8f6380",
"type": "as_policy",
"status": "CREATED",
"details": [
{
"name": "capacityProviderName",
"value": "Infra-ECS-Cluster-ECS-project-update-cluster-d6bb6d5b-EC2CapacityProvider-3fIpdkLywwFt"
},
{
"name": "scalingPolicyName",
"value": "ECSManagedAutoScalingPolicy-152363a6-8c65-484c-b721-42c3e070ae93"
}
]
},
{
"id": "08b5b6ca-45e9-4209-a65d-e962a27c490a",
"type": "managed_draining",
"status": "CREATED",
"details": [
{
"name": "capacityProviderName",
"value": "Infra-ECS-Cluster-ECS-project-update-cluster-d6bb6d5b-EC2CapacityProvider-3fIpdkLywwFt"
},
{
"name": "autoScalingLifecycleHookName",
"value": "ecs-managed-draining-termination-hook"
}
]
},
{
"id": "45d0b36f-8cff-46b6-9380-1288744802ab",
"type": "sc",
"status": "ATTACHED",
"details": []
}
],
"attachmentsStatus": "UPDATE_COMPLETE",
"serviceConnectDefaults": {
"namespace": "arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-igwrsylmy3kwvcdx"
}
}
```
**例 2: デフォルトの Service Connect 名前空間を設定して ECS クラスターを更新する**
次の `update-cluster` は、デフォルトの Service Connect 名前空間を設定して ECS クラスターを更新します。
```
aws ecs update-cluster \
--cluster ECS-project-update-cluster \
--service-connect-defaults namespace=test
```
出力:
```
{
"cluster": {
"clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/ECS-project-update-cluster",
"clusterName": "ECS-project-update-cluster",
"status": "ACTIVE",
"registeredContainerInstancesCount": 0,
"runningTasksCount": 0,
"pendingTasksCount": 0,
"activeServicesCount": 0,
"statistics": [],
"tags": [],
"settings": [
{
"name": "containerInsights",
"value": "enabled"
}
],
"capacityProviders": [
"Infra-ECS-Cluster-ECS-project-update-cluster-d6bb6d5b-EC2CapacityProvider-3fIpdkLywwFt"
],
"defaultCapacityProviderStrategy": [
{
"capacityProvider": "Infra-ECS-Cluster-ECS-project-update-cluster-d6bb6d5b-EC2CapacityProvider-3fIpdkLywwFt",
"weight": 1,
"base": 0
}
],
"attachments": [
{
"id": "069d002b-7634-42e4-b1d4-544f4c8f6380",
"type": "as_policy",
"status": "CREATED",
"details": [
{
"name": "capacityProviderName",
"value": "Infra-ECS-Cluster-ECS-project-update-cluster-d6bb6d5b-EC2CapacityProvider-3fIpdkLywwFt"
},
{
"name": "scalingPolicyName",
"value": "ECSManagedAutoScalingPolicy-152363a6-8c65-484c-b721-42c3e070ae93"
}
]
},
{
"id": "08b5b6ca-45e9-4209-a65d-e962a27c490a",
"type": "managed_draining",
"status": "CREATED",
"details": [
{
"name": "capacityProviderName",
"value": "Infra-ECS-Cluster-ECS-project-update-cluster-d6bb6d5b-EC2CapacityProvider-3fIpdkLywwFt"
},
{
"name": "autoScalingLifecycleHookName",
"value": "ecs-managed-draining-termination-hook"
}
]
},
{
"id": "45d0b36f-8cff-46b6-9380-1288744802ab",
"type": "sc",
"status": "DELETED",
"details": []
},
{
"id": "3e6890c3-609c-4832-91de-d6ca891b3ef1",
"type": "sc",
"status": "ATTACHED",
"details": []
},
{
"id": "961b8ec1-c2f1-4070-8495-e669b7668e90",
"type": "sc",
"status": "DELETED",
"details": []
}
],
"attachmentsStatus": "UPDATE_COMPLETE",
"serviceConnectDefaults": {
"namespace": "arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-dtjmxqpfi46ht7dr"
}
}
}
```
Service Connect の詳細については、*Amazon ECS デベロッパーガイド*の「[Service Connect を使用して Amazon ECS サービスを短縮名で接続する](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/update-cluster.html)」を参照してください。
### `update-container-agent`
次のコード例は、`update-container-agent` を使用する方法を示しています。
**AWS CLI**
**Amazon ECS コンテナインスタンスのコンテナエージェントを更新するには**
次の `update-container-agent` の例では、デフォルトのクラスターで指定されたコンテナインスタンスのコンテナエージェントを更新します。
```
aws ecs update-container-agent --cluster default --container-instance a1b2c3d4-5678-90ab-cdef-11111EXAMPLE
```
出力:
```
{
"containerInstance": {
"status": "ACTIVE",
...
"agentUpdateStatus": "PENDING",
"versionInfo": {
"agentVersion": "1.0.0",
"agentHash": "4023248",
"dockerVersion": "DockerVersion: 1.5.0"
}
}
}
```
詳細については、「*Amazon ECS デベロッパーガイド*」の「[Amazon ECS コンテナエージェントの更新](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html)」を参照してください。
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateContainerAgent](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/update-container-agent.html)」を参照してください。
### `update-container-instances-state`
次のコード例は、`update-container-instances-state` を使用する方法を示しています。
**AWS CLI**
**コンテナインスタンスの状態を更新するには**
次の `update-container-instances-state` は、指定されたコンテナインスタンスを `DRAINING` の状態を更新し、登録されているクラスターから削除します。
```
aws ecs update-container-instances-state \
--container-instances 765936fadbdd46b5991a4bd70c2a43d4 \
--status DRAINING
```
出力:
```
{
"containerInstances": [
{
"containerInstanceArn": "arn:aws:ecs:us-west-2:130757420319:container-instance/default/765936fadbdd46b5991a4bd70c2a43d4",
"ec2InstanceId": "i-013d87ffbb4d513bf",
"version": 4390,
"versionInfo": {
"agentVersion": "1.29.0",
"agentHash": "a190a73f",
"dockerVersion": "DockerVersion:18.06.1-ce"
},
"remainingResources": [
{
"name": "CPU",
"type": "INTEGER",
"doubleValue": 0,
"longValue": 0,
"integerValue": 1536
},
{
"name": "MEMORY",
"type": "INTEGER",
"doubleValue": 0,
"longValue": 0,
"integerValue": 2681
},
{
"name": "PORTS",
"type": "STRINGSET",
"doubleValue": 0,
"longValue": 0,
"integerValue": 0,
"stringSetValue": [
"22",
"2376",
"2375",
"51678",
"51679"
]
},
{
"name": "PORTS_UDP",
"type": "STRINGSET",
"doubleValue": 0,
"longValue": 0,
"integerValue": 0,
"stringSetValue": []
}
],
"registeredResources": [
{
"name": "CPU",
"type": "INTEGER",
"doubleValue": 0,
"longValue": 0,
"integerValue": 2048
},
{
"name": "MEMORY",
"type": "INTEGER",
"doubleValue": 0,
"longValue": 0,
"integerValue": 3705
},
{
"name": "PORTS",
"type": "STRINGSET",
"doubleValue": 0,
"longValue": 0,
"integerValue": 0,
"stringSetValue": [
"22",
"2376",
"2375",
"51678",
"51679"
]
},
{
"name": "PORTS_UDP",
"type": "STRINGSET",
"doubleValue": 0,
"longValue": 0,
"integerValue": 0,
"stringSetValue": []
}
],
"status": "DRAINING",
"agentConnected": true,
"runningTasksCount": 2,
"pendingTasksCount": 0,
"attributes": [
{
"name": "ecs.capability.secrets.asm.environment-variables"
},
{
"name": "ecs.capability.branch-cni-plugin-version",
"value": "e0703516-"
},
{
"name": "ecs.ami-id",
"value": "ami-00e0090ac21971297"
},
{
"name": "ecs.capability.secrets.asm.bootstrap.log-driver"
},
{
"name": "com.amazonaws.ecs.capability.logging-driver.none"
},
{
"name": "ecs.capability.ecr-endpoint"
},
{
"name": "ecs.capability.docker-plugin.local"
},
{
"name": "ecs.capability.task-cpu-mem-limit"
},
{
"name": "ecs.capability.secrets.ssm.bootstrap.log-driver"
},
{
"name": "com.amazonaws.ecs.capability.docker-remote-api.1.30"
},
{
"name": "com.amazonaws.ecs.capability.docker-remote-api.1.31"
},
{
"name": "com.amazonaws.ecs.capability.docker-remote-api.1.32"
},
{
"name": "ecs.availability-zone",
"value": "us-west-2c"
},
{
"name": "ecs.capability.aws-appmesh"
},
{
"name": "com.amazonaws.ecs.capability.logging-driver.awslogs"
},
{
"name": "com.amazonaws.ecs.capability.docker-remote-api.1.24"
},
{
"name": "ecs.capability.task-eni-trunking"
},
{
"name": "com.amazonaws.ecs.capability.docker-remote-api.1.25"
},
{
"name": "com.amazonaws.ecs.capability.docker-remote-api.1.26"
},
{
"name": "com.amazonaws.ecs.capability.docker-remote-api.1.27"
},
{
"name": "com.amazonaws.ecs.capability.docker-remote-api.1.28"
},
{
"name": "com.amazonaws.ecs.capability.privileged-container"
},
{
"name": "com.amazonaws.ecs.capability.docker-remote-api.1.29"
},
{
"name": "ecs.cpu-architecture",
"value": "x86_64"
},
{
"name": "com.amazonaws.ecs.capability.ecr-auth"
},
{
"name": "com.amazonaws.ecs.capability.docker-remote-api.1.20"
},
{
"name": "ecs.os-type",
"value": "linux"
},
{
"name": "com.amazonaws.ecs.capability.docker-remote-api.1.21"
},
{
"name": "com.amazonaws.ecs.capability.docker-remote-api.1.22"
},
{
"name": "ecs.capability.task-eia"
},
{
"name": "com.amazonaws.ecs.capability.docker-remote-api.1.23"
},
{
"name": "ecs.capability.private-registry-authentication.secretsmanager"
},
{
"name": "com.amazonaws.ecs.capability.logging-driver.syslog"
},
{
"name": "com.amazonaws.ecs.capability.logging-driver.json-file"
},
{
"name": "ecs.capability.execution-role-awslogs"
},
{
"name": "ecs.vpc-id",
"value": "vpc-1234"
},
{
"name": "com.amazonaws.ecs.capability.docker-remote-api.1.17"
},
{
"name": "com.amazonaws.ecs.capability.docker-remote-api.1.18"
},
{
"name": "com.amazonaws.ecs.capability.docker-remote-api.1.19"
},
{
"name": "ecs.capability.task-eni"
},
{
"name": "ecs.capability.execution-role-ecr-pull"
},
{
"name": "ecs.capability.container-health-check"
},
{
"name": "ecs.subnet-id",
"value": "subnet-1234"
},
{
"name": "ecs.instance-type",
"value": "c5.large"
},
{
"name": "com.amazonaws.ecs.capability.task-iam-role-network-host"
},
{
"name": "ecs.capability.container-ordering"
},
{
"name": "ecs.capability.cni-plugin-version",
"value": "91ccefc8-2019.06.0"
},
{
"name": "ecs.capability.pid-ipc-namespace-sharing"
},
{
"name": "ecs.capability.secrets.ssm.environment-variables"
},
{
"name": "com.amazonaws.ecs.capability.task-iam-role"
}
],
"registeredAt": 1560788724.507,
"attachments": [],
"tags": []
}
],
"failures": []
}
```
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateContainerInstancesState](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/update-container-instances-state.html)」を参照してください。
### `update-service-primary-task-set`
次のコード例は、`update-service-primary-task-set` を使用する方法を示しています。
**AWS CLI**
**サービスのプライマリタスクセットを更新するには**
次の `update-service-primary-task-set` の例では、指定されたサービスのプライマリタスクセットを更新します。
```
aws ecs update-service-primary-task-set \
--cluster MyCluster \
--service MyService \
--primary-task-set arn:aws:ecs:us-west-2:123456789012:task-set/MyCluster/MyService/ecs-svc/1234567890123456789
```
出力:
```
{
"taskSet": {
"id": "ecs-svc/1234567890123456789",
"taskSetArn": "arn:aws:ecs:us-west-2:123456789012:task-set/MyCluster/MyService/ecs-svc/1234567890123456789",
"status": "PRIMARY",
"taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/sample-fargate:2",
"computedDesiredCount": 1,
"pendingCount": 0,
"runningCount": 0,
"createdAt": 1557128360.711,
"updatedAt": 1557129412.653,
"launchType": "EC2",
"networkConfiguration": {
"awsvpcConfiguration": {
"subnets": [
"subnet-12344321"
],
"securityGroups": [
"sg-12344312"
],
"assignPublicIp": "DISABLED"
}
},
"loadBalancers": [],
"serviceRegistries": [],
"scale": {
"value": 50.0,
"unit": "PERCENT"
},
"stabilityStatus": "STABILIZING",
"stabilityStatusAt": 1557129279.914
}
}
```
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateServicePrimaryTaskSet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/update-service-primary-task-set.html)」を参照してください。
### `update-service`
次のコード例は、`update-service` を使用する方法を示しています。
**AWS CLI**
**例 1: サービスで使用されるタスク定義を変更するには**
次の `update-service` の例は、`amazon-ecs-sample` タスク定義を使用するように `my-http-service` サービスを更新します。
```
aws ecs update-service \
--cluster test \
--service my-http-service \
--task-definition amazon-ecs-sample
```
出力:
```
{
"service": {
"serviceArn": "arn:aws:ecs:us-west-2:123456789012:service/test/my-http-service",
"serviceName": "my-http-service",
"clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/test",
"loadBalancers": [],
"serviceRegistries": [],
"status": "ACTIVE",
"desiredCount": 2,
"runningCount": 2,
"pendingCount": 0,
"launchType": "FARGATE",
"platformVersion": "1.4.0",
"platformFamily": "Linux",
"taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/amazon-ecs-sample:2",
"deploymentConfiguration": {
"deploymentCircuitBreaker": {
"enable": true,
"rollback": true
},
"maximumPercent": 200,
"minimumHealthyPercent": 100,
"alarms": {
"alarmNames": [],
"rollback": false,
"enable": false
}
},
"deployments": [
{
"id": "ecs-svc/7419115625193919142",
"status": "PRIMARY",
"taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/amazon-ecs-sample:2",
"desiredCount": 0,
"pendingCount": 0,
"runningCount": 0,
"failedTasks": 0,
"createdAt": "2025-02-21T13:26:02.734000-06:00",
"updatedAt": "2025-02-21T13:26:02.734000-06:00",
"launchType": "FARGATE",
"platformVersion": "1.4.0",
"platformFamily": "Linux",
"networkConfiguration": {
"awsvpcConfiguration": {
"subnets": [
"subnet-12344321"
],
"securityGroups": [
"sg-12344321"
],
"assignPublicIp": "ENABLED"
}
},
"rolloutState": "IN_PROGRESS",
"rolloutStateReason": "ECS deployment ecs-svc/7419115625193919142 in progress."
},
{
"id": "ecs-svc/1709597507655421668",
"status": "ACTIVE",
"taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/old-amazon-ecs-sample:4",
"desiredCount": 2,
"pendingCount": 0,
"runningCount": 2,
"failedTasks": 0,
"createdAt": "2025-01-24T11:13:07.621000-06:00",
"updatedAt": "2025-02-02T16:11:30.838000-06:00",
"launchType": "FARGATE",
"platformVersion": "1.4.0",
"platformFamily": "Linux",
"networkConfiguration": {
"awsvpcConfiguration": {
"subnets": [
"subnet-12344321"
],
"securityGroups": [
"sg-12344321"
],
"assignPublicIp": "ENABLED"
}
},
"rolloutState": "COMPLETED",
"rolloutStateReason": "ECS deployment ecs-svc/1709597507655421668 completed."
}
],
"roleArn": "arn:aws:iam::123456789012:role/aws-service-role/ecs.amazonaws.com/AWSServiceRoleForECS",
"events": [
{
"id": "e40b4d1c-80d9-4834-aaf3-6a268e530e17",
"createdAt": "2025-02-21T10:31:26.037000-06:00",
"message": "(my-http-service) has reached a steady state."
},
{
"id": "6ac069ad-fc8b-4e49-a35d-b5574a964c8e",
"createdAt": "2025-02-21T04:31:22.703000-06:00",
"message": "(my-http-service) has reached a steady state."
},
{
"id": "265f7d37-dfd1-4880-a846-ec486f341919",
"createdAt": "2025-02-20T22:31:22.514000-06:00",
"message": "(my-http-service) has reached a steady state."
}
],
"createdAt": "2024-10-30T17:12:43.218000-05:00",
"placementConstraints": [],
"placementStrategy": [],
"networkConfiguration": {
"awsvpcConfiguration": {
"subnets": [
"subnet-12344321",
],
"securityGroups": [
"sg-12344321"
],
"assignPublicIp": "ENABLED"
}
},
"healthCheckGracePeriodSeconds": 0,
"schedulingStrategy": "REPLICA",
"deploymentController": {
"type": "ECS"
},
"createdBy": "arn:aws:iam::123456789012:role/AIDACKCEVSQ6C2EXAMPLE",
"enableECSManagedTags": true,
"propagateTags": "NONE",
"enableExecuteCommand": false,
"availabilityZoneRebalancing": "DISABLED"
}
}
```
詳細については、「*Amazon ECS デベロッパーガイド*」の「[コンソールを使用した Amazon ECS サービスの更新](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/update-service-console-v2.html)」を参照してください。
**例 2: サービス内のタスク数を変更するには**
次の `update-service` の例では、`my-http-service` サービスの必要なタスク数を 2 に更新します。
```
aws ecs update-service \
--cluster MyCluster \
--service my-http-service \
--desired-count 2
```
出力:
```
{
"service": {
"serviceArn": "arn:aws:ecs:us-east-1:123456789012:service/MyCluster/my-http-service",
"serviceName": "my-http-service",
"clusterArn": "arn:aws:ecs:us-east-1:123456789012:cluster/MyCluster",
"loadBalancers": [],
"serviceRegistries": [],
"status": "ACTIVE",
"desiredCount": 2,
"runningCount": 1,
"pendingCount": 0,
"capacityProviderStrategy": [
{
"capacityProvider": "FARGATE",
"weight": 1,
"base": 0
}
],
"platformVersion": "LATEST",
"platformFamily": "Linux",
"taskDefinition": "arn:aws:ecs:us-east-1:123456789012:task-definition/MyTaskDefinition",
"deploymentConfiguration": {
"deploymentCircuitBreaker": {
"enable": true,
"rollback": true
},
"maximumPercent": 200,
"minimumHealthyPercent": 100,
"alarms": {
"alarmNames": [],
"rollback": false,
"enable": false
}
},
"deployments": [
{
"id": "ecs-svc/1976744184940610707",
"status": "PRIMARY",
"taskkDefinition": "arn:aws:ecs:us-east-1:123456789012:task-definition/MyTaskDefinition",
"desiredCount": 1,
"pendingCount": 0,
"runningCount": 1,
"failedTasks": 0,
"createdAt": "2024-12-03T16:24:25.225000-05:00",
"updatedAt": "2024-12-03T16:25:15.837000-05:00",
"capacityProviderStrategy": [
{
"capacityProvider": "FARGATE",
"weight": 1,
"base": 0
}
],
"platformVersion": "1.4.0",
"platformFamily": "Linux",
"networkConfiguration": {
"awsvpcConfiguration": {
"subnets": [
"subnet-0d0eab1bb38d5ca64",
"subnet-0db5010045995c2d5"
],
"securityGroups": [
"sg-02556bf85a191f59a"
],
"assignPublicIp": "ENABLED"
}
},
"rolloutState": "COMPLETED",
"rolloutStateReason": "ECS deployment ecs-svc/1976744184940610707 completed."
}
],
"roleArn": "arn:aws:iam::123456789012:role/aws-service-role/ecs.amazonaws.com/AWSServiceRoleForECS",
"events": [
{
"id": "f27350b9-4b2a-4e2e-b72e-a4b68380de45",
"createdAt": "2024-12-30T13:24:07.345000-05:00",
"message": "(service my-http-service) has reached a steady state."
},
{
"id": "e764ec63-f53f-45e3-9af2-d99f922d2957",
"createdAt": "2024-12-30T12:32:21.600000-05:00",
"message": "(service my-http-service) has reached a steady state."
},
{
"id": "28444756-c2fa-47f8-bd60-93a8e05f3991",
"createdAt": "2024-12-08T19:26:10.367000-05:00",
"message": "(service my-http-service) has reached a steady state."
}
],
"createdAt": "2024-12-03T16:24:25.225000-05:00",
"placementConstraints": [],
"placementStrategy": [],
"networkConfiguration": {
"awsvpcConfiguration": {
"subnets": [
"subnet-0d0eab1bb38d5ca64",
"subnet-0db5010045995c2d5"
],
"securityGroups": [
"sg-02556bf85a191f59a"
],
"assignPublicIp": "ENABLED"
}
},
"healthCheckGracePeriodSeconds": 0,
"schedulingStrategy": "REPLICA",
"deploymentController": {
"type": "ECS"
},
"createdBy": "arn:aws:iam::123456789012:role/Admin",
"enableECSManagedTags": true,
"propagateTags": "NONE",
"enableExecuteCommand": false,
"availabilityZoneRebalancing": "ENABLED"
}
}
```
詳細については、「*Amazon ECS デベロッパーガイド*」の「[コンソールを使用した Amazon ECS サービスの更新](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/update-service-console-v2.html)」を参照してください。
**例 3: サービスの更新時にアタッチメント用に Amazon EBS ボリュームを設定するには**
次の `update-service` の例では、Amazon EBS ボリュームを使用するように `my-http-service` サービスを更新します。`AmazonECSInfrastructureRolePolicyForVolumes` マネージドポリシーがアタッチされた Amazon ECS インフラストラクチャロールを設定する必要があります。また、`update-service` リクエストと同じボリューム名で、`configuredAtLaunch` を `true` に設定してタスク定義を指定する必要があります。この例では、`--cli-input-json` オプションと JSON 入力ファイル (`ebs.json`) を使用します。
```
aws ecs update-service \
--cli-input-json file://ebs.json
```
`ebs.json` の内容:
```
{
"cluster": "mycluster",
"taskDefinition": "mytaskdef",
"service": "my-http-service",
"desiredCount": 2,
"volumeConfigurations": [
{
"name": "myEbsVolume",
"managedEBSVolume": {
"roleArn":"arn:aws:iam::123456789012:role/ecsInfrastructureRole",
"volumeType": "gp3",
"sizeInGiB": 100,
"iops": 3000,
"throughput": 125,
"filesystemType": "ext4"
}
}
]
}
```
出力:
```
{
"service": {
"serviceArn": "arn:aws:ecs:us-west-2:123456789012:service/mycluster/my-http-service",
"serviceName": "my-http-service",
"clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/mycluster",
"loadBalancers": [],
"serviceRegistries": [],
"status": "ACTIVE",
"desiredCount": 2,
"runningCount": 2,
"pendingCount": 0,
"launchType": "FARGATE",
"platformVersion": "LATEST",
"platformFamily": "Linux",
"taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/mytaskdef:1",
"deploymentConfiguration": {
"deploymentCircuitBreaker": {
"enable": true,
"rollback": true
},
"maximumPercent": 200,
"minimumHealthyPercent": 100,
"alarms": {
"alarmNames": [],
"rollback": false,
"enable": false
}
},
"deployments": [
{
"id": "ecs-svc/2420458347226626275",
"status": "PRIMARY",
"taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/mytaskdef:1",
"desiredCount": 0,
"pendingCount": 0,
"runningCount": 0,
"failedTasks": 0,
"createdAt": "2025-02-21T15:07:20.519000-06:00",
"updatedAt": "2025-02-21T15:07:20.519000-06:00",
"launchType": "FARGATE",
"platformVersion": "1.4.0",
"platformFamily": "Linux",
"networkConfiguration": {
"awsvpcConfiguration": {
"subnets": [
"subnet-12344321",
],
"securityGroups": [
"sg-12344321"
],
"assignPublicIp": "ENABLED"
}
},
"rolloutState": "IN_PROGRESS",
"rolloutStateReason": "ECS deployment ecs-svc/2420458347226626275 in progress.",
"volumeConfigurations": [
{
"name": "ebs-volume",
"managedEBSVolume": {
"volumeType": "gp3",
"sizeInGiB": 100,
"iops": 3000,
"throughput": 125,
"roleArn": "arn:aws:iam::123456789012:role/ecsInfrastructureRole",
"filesystemType": "ext4"
}
}
]
},
{
"id": "ecs-svc/5191625155316533644",
"status": "ACTIVE",
"taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/mytaskdef:2",
"desiredCount": 2,
"pendingCount": 0,
"runningCount": 2,
"failedTasks": 0,
"createdAt": "2025-02-21T14:54:48.862000-06:00",
"updatedAt": "2025-02-21T14:57:22.502000-06:00",
"launchType": "FARGATE",
"platformVersion": "1.4.0",
"platformFamily": "Linux",
"networkConfiguration": {
"awsvpcConfiguration": {
"subnets": [
"subnet-12344321"
],
"securityGroups": [
"sg-12344321"
],
"assignPublicIp": "ENABLED"
}
},
"rolloutState": "COMPLETED",
"rolloutStateReason": "ECS deployment ecs-svc/5191625155316533644 completed."
}
],
"roleArn": "arn:aws:iam::123456789012:role/aws-service-role/ecs.amazonaws.com/AWSServiceRoleForECS",
"events": [
{
"id": "b5823113-c2c5-458e-9649-8c2ed38f23a5",
"createdAt": "2025-02-21T14:57:22.508000-06:00",
"message": "(service my-http-service) has reached a steady state."
},
{
"id": "b05a48e8-da35-4074-80aa-37ceb3167357",
"createdAt": "2025-02-21T14:57:22.507000-06:00",
"message": "(service my-http-service) (deployment ecs-svc/5191625155316533644) deployment completed."
},
{
"id": "a10cd55d-4ba6-4cea-a655-5a5d32ada8a0",
"createdAt": "2025-02-21T14:55:32.833000-06:00",
"message": "(service my-http-service) has started 1 tasks: (task fb9c8df512684aec92f3c57dc3f22361)."
},
],
"createdAt": "2025-02-21T14:54:48.862000-06:00",
"placementConstraints": [],
"placementStrategy": [],
"networkConfiguration": {
"awsvpcConfiguration": {
"subnets": [
"subnet-12344321"
],
"securityGroups": [
"sg-12344321"
],
"assignPublicIp": "ENABLED"
}
},
"healthCheckGracePeriodSeconds": 0,
"schedulingStrategy": "REPLICA",
"deploymentController": {
"type": "ECS"
},
"createdBy": "arn:aws:iam::123456789012:role/AIDACKCEVSQ6C2EXAMPLE",
"enableECSManagedTags": true,
"propagateTags": "NONE",
"enableExecuteCommand": false,
"availabilityZoneRebalancing": "ENABLED"
}
}
```
詳細については、「*Amazon ECS デベロッパーガイド*」の「[Amazon ECS での Amazon EBS ボリュームの使用](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html)」を参照してください。
**例 4: Amazon EBS ボリュームを今後使用しないようにサービスを更新するには**
次の `update-service` の例では、Amazon EBS ボリュームを今後使用しないように `my-http-service` サービスを更新します。`configuredAtLaunch` を `false` に設定したタスク定義リビジョンを指定する必要があります。
```
aws ecs update-service \
--cluster mycluster \
--task-definition mytaskdef \
--service my-http-service \
--desired-count 2 \
--volume-configurations "[]"
```
出力:
```
{
"service": {
"serviceArn": "arn:aws:ecs:us-west-2:123456789012:service/mycluster/my-http-service",
"serviceName": "my-http-service",
"clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/mycluster",
"loadBalancers": [],
"serviceRegistries": [],
"status": "ACTIVE",
"desiredCount": 2,
"runningCount": 2,
"pendingCount": 0,
"launchType": "FARGATE",
"platformVersion": "LATEST",
"platformFamily": "Linux",
"taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/mytaskdef:3",
"deploymentConfiguration": {
"deploymentCircuitBreaker": {
"enable": true,
"rollback": true
},
"maximumPercent": 200,
"minimumHealthyPercent": 100,
"alarms": {
"alarmNames": [],
"rollback": false,
"enable": false
}
},
"deployments": [
{
"id": "ecs-svc/7522791612543716777",
"status": "PRIMARY",
"taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/mytaskdef:3",
"desiredCount": 0,
"pendingCount": 0,
"runningCount": 0,
"failedTasks": 0,
"createdAt": "2025-02-21T15:25:38.598000-06:00",
"updatedAt": "2025-02-21T15:25:38.598000-06:00",
"launchType": "FARGATE",
"platformVersion": "1.4.0",
"platformFamily": "Linux",
"networkConfiguration": {
"awsvpcConfiguration": {
"subnets": [
"subnet-12344321"
],
"securityGroups": [
"sg-12344321"
],
"assignPublicIp": "ENABLED"
}
},
"rolloutState": "IN_PROGRESS",
"rolloutStateReason": "ECS deployment ecs-svc/7522791612543716777 in progress."
},
{
"id": "ecs-svc/2420458347226626275",
"status": "ACTIVE",
"taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/myoldtaskdef:1",
"desiredCount": 2,
"pendingCount": 0,
"runningCount": 2,
"failedTasks": 0,
"createdAt": "2025-02-21T15:07:20.519000-06:00",
"updatedAt": "2025-02-21T15:10:59.955000-06:00",
"launchType": "FARGATE",
"platformVersion": "1.4.0",
"platformFamily": "Linux",
"networkConfiguration": {
"awsvpcConfiguration": {
"subnets": [
"subnet-12344321"
],
"securityGroups": [
"sg-12344321"
],
"assignPublicIp": "ENABLED"
}
},
"rolloutState": "COMPLETED",
"rolloutStateReason": "ECS deployment ecs-svc/2420458347226626275 completed.",
"volumeConfigurations": [
{
"name": "ebs-volume",
"managedEBSVolume": {
"volumeType": "gp3",
"sizeInGiB": 100,
"iops": 3000,
"throughput": 125,
"roleArn": "arn:aws:iam::123456789012:role/ecsInfrastructureRole",
"filesystemType": "ext4"
}
}
]
}
],
"roleArn": "arn:aws:iam::123456789012:role/aws-service-role/ecs.amazonaws.com/AWSServiceRoleForECS",
"events": [
{
"id": "4f2c3ca1-7800-4048-ba57-bba210ada2ad",
"createdAt": "2025-02-21T15:10:59.959000-06:00",
"message": "(service my-http-service) has reached a steady state."
},
{
"id": "4b36a593-2d40-4ed6-8be8-b9b699eb6198",
"createdAt": "2025-02-21T15:10:59.958000-06:00",
"message": "(service my-http-service) (deployment ecs-svc/2420458347226626275) deployment completed."
},
{
"id": "88380089-14e2-4ef0-8dbb-a33991683371",
"createdAt": "2025-02-21T15:09:39.055000-06:00",
"message": "(service my-http-service) has stopped 1 running tasks: (task fb9c8df512684aec92f3c57dc3f22361)."
},
{
"id": "97d84243-d52f-4255-89bb-9311391c61f6",
"createdAt": "2025-02-21T15:08:57.653000-06:00",
"message": "(service my-http-service) has stopped 1 running tasks: (task 33eff090ad2c40539daa837e6503a9bc)."
},
{
"id": "672ece6c-e2d0-4021-b5da-eefb14001687",
"createdAt": "2025-02-21T15:08:15.631000-06:00",
"message": "(service my-http-service) has started 1 tasks: (task 996c02a66ff24f3190a4a8e0c841740f)."
},
{
"id": "a3cf9bea-9be6-4175-ac28-4c68360986eb",
"createdAt": "2025-02-21T15:07:36.931000-06:00",
"message": "(service my-http-service) has started 1 tasks: (task d5d23c39f89e46cf9a647b9cc6572feb)."
},
{
"id": "b5823113-c2c5-458e-9649-8c2ed38f23a5",
"createdAt": "2025-02-21T14:57:22.508000-06:00",
"message": "(service my-http-service) has reached a steady state."
},
{
"id": "b05a48e8-da35-4074-80aa-37ceb3167357",
"createdAt": "2025-02-21T14:57:22.507000-06:00",
"message": "(service my-http-service) (deployment ecs-svc/5191625155316533644) deployment completed."
},
{
"id": "a10cd55d-4ba6-4cea-a655-5a5d32ada8a0",
"createdAt": "2025-02-21T14:55:32.833000-06:00",
"message": "(service my-http-service) has started 1 tasks: (task fb9c8df512684aec92f3c57dc3f22361)."
},
{
"id": "42da91fa-e26d-42ef-88c3-bb5965c56b2f",
"createdAt": "2025-02-21T14:55:02.703000-06:00",
"message": "(service my-http-service) has started 1 tasks: (task 33eff090ad2c40539daa837e6503a9bc)."
}
],
"createdAt": "2025-02-21T14:54:48.862000-06:00",
"placementConstraints": [],
"placementStrategy": [],
"networkConfiguration": {
"awsvpcConfiguration": {
"subnets": [
"subnet-12344321"
],
"securityGroups": [
"sg-12344321"
],
"assignPublicIp": "ENABLED"
}
},
"healthCheckGracePeriodSeconds": 0,
"schedulingStrategy": "REPLICA",
"deploymentController": {
"type": "ECS"
},
"createdBy": "arn:aws:iam::123456789012:role/AIDACKCEVSQ6C2EXAMPLE",
"enableECSManagedTags": true,
"propagateTags": "NONE",
"enableExecuteCommand": false,
"availabilityZoneRebalancing": "ENABLED"
}
}
```
詳細については、「*Amazon ECS デベロッパーガイド*」の「[Amazon ECS での Amazon EBS ボリュームの使用](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html)」を参照してください。
**例 5: サービスのアベイラビリティーゾーンのリバランスを有効にするには**
次の `update-service` の例では、サービス `my-http-service` のアベイラビリティーゾーンのリバランスを有効にします。
```
aws ecs update-service \
--cluster MyCluster \
--service my-http-service \
--availability-zone-rebalancing ENABLED
```
出力:
```
{
"service": {
"serviceArn": "arn:aws:ecs:us-east-1:123456789012:service/MyCluster/my-http-service",
"serviceName": "my-http-service",
"clusterArn": "arn:aws:ecs:us-east-1:123456789012:cluster/MyCluster",
"loadBalancers": [],
"serviceRegistries": [],
"status": "ACTIVE",
"desiredCount": 2,
"runningCount": 1,
"pendingCount": 0,
"capacityProviderStrategy": [
{
"capacityProvider": "FARGATE",
"weight": 1,
"base": 0
}
],
"platformVersion": "LATEST",
"platformFamily": "Linux",
"taskDefinition": "arn:aws:ecs:us-east-1:123456789012:task-definition/MyTaskDefinition",
"deploymentConfiguration": {
"deploymentCircuitBreaker": {
"enable": true,
"rollback": true
},
"maximumPercent": 200,
"minimumHealthyPercent": 100,
"alarms": {
"alarmNames": [],
"rollback": false,
"enable": false
}
},
"deployments": [
{
"id": "ecs-svc/1976744184940610707",
"status": "PRIMARY",
"taskkDefinition": "arn:aws:ecs:us-east-1:123456789012:task-definition/MyTaskDefinition",
"desiredCount": 1,
"pendingCount": 0,
"runningCount": 1,
"failedTasks": 0,
"createdAt": "2024-12-03T16:24:25.225000-05:00",
"updatedAt": "2024-12-03T16:25:15.837000-05:00",
"capacityProviderStrategy": [
{
"capacityProvider": "FARGATE",
"weight": 1,
"base": 0
}
],
"platformVersion": "1.4.0",
"platformFamily": "Linux",
"networkConfiguration": {
"awsvpcConfiguration": {
"subnets": [
"subnet-0d0eab1bb38d5ca64",
"subnet-0db5010045995c2d5"
],
"securityGroups": [
"sg-02556bf85a191f59a"
],
"assignPublicIp": "ENABLED"
}
},
"rolloutState": "COMPLETED",
"rolloutStateReason": "ECS deployment ecs-svc/1976744184940610707 completed."
}
],
"roleArn": "arn:aws:iam::123456789012:role/aws-service-role/ecs.amazonaws.com/AWSServiceRoleForECS",
"events": [],
"createdAt": "2024-12-03T16:24:25.225000-05:00",
"placementConstraints": [],
"placementStrategy": [],
"networkConfiguration": {
"awsvpcConfiguration": {
"subnets": [
"subnet-0d0eab1bb38d5ca64",
"subnet-0db5010045995c2d5"
],
"securityGroups": [
"sg-02556bf85a191f59a"
],
"assignPublicIp": "ENABLED"
}
},
"healthCheckGracePeriodSeconds": 0,
"schedulingStrategy": "REPLICA",
"deploymentController": {
"type": "ECS"
},
"createdBy": "arn:aws:iam::123456789012:role/Admin",
"enableECSManagedTags": true,
"propagateTags": "NONE",
"enableExecuteCommand": false,
"availabilityZoneRebalancing": "ENABLED"
}
}
```
詳細については、「*Amazon ECS デベロッパーガイド*」の「[コンソールを使用した Amazon ECS サービスの更新](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/update-service-console-v2.html)」を参照してください。
+ API の詳細については、AWS CLI コマンドリファレンスの「[UpdateService](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/update-service.html)」を参照してください。**
### `update-task-protection`
次のコード例は、`update-task-protection` を使用する方法を示しています。
**AWS CLI**
**例 1: ECS タスクのタスク保護を有効にする**
次の `update-task-protection` は、デプロイまたは AutoScaling サービスによるスケールイン中の終了から ECS タスクを保護します。タスク保護のカスタム有効期限は 1 分から 2,880 分 (48 時間) の範囲で指定できます。有効期間を指定しない場合、タスク保護のデフォルトの有効期間は 2 時間になります。
```
aws ecs update-task-protection \
--cluster ECS-project-update-cluster \
--tasks c43ed3b1331041f289316f958adb6a24 \
--protection-enabled \
--expires-in-minutes 300
```
出力:
```
{
"protectedTasks": [
{
"taskArn": "arn:aws:ecs:us-west-2:123456789012:task/c43ed3b1331041f289316f958adb6a24",
"protectionEnabled": true,
"expirationDate": "2024-09-14T19:53:36.687000-05:00"
}
],
"failures": []
}
```
**例 2: ECS タスクのタスク保護を無効にする**
次の `update-task-protection` は、デプロイまたは Auto Scaling サービスによるスケールインから保護されているタスクの保護を無効にします。
```
aws ecs update-task-protection \
--cluster ECS-project-update-cluster \
--tasks c43ed3b1331041f289316f958adb6a24 \
--no-protection-enabled
```
出力:
```
{
"protectedTasks": [
{
"taskArn": "arn:aws:ecs:us-west-2:123456789012:task/c43ed3b1331041f289316f958adb6a24",
"protectionEnabled": false
}
],
"failures": []
}
```
タスク保護の詳細については、*Amazon ECS デベロッパーガイド*の「[Amazon ECS タスクがスケールインイベントによって終了するのを防ぐ](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-scale-in-protection.html)」を参照してください。
+ API の詳細については、*AWS CLI コマンドリファレンス*の「[UpdateTaskProtection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/update-task-protection.html)」を参照してください。
### `update-task-set`
次のコード例は、`update-task-set` を使用する方法を示しています。
**AWS CLI**
**テストセットを更新するには**
次の `update-task-set` の例では、タスクセットを更新してスケールを調整します。
```
aws ecs update-task-set \
--cluster MyCluster \
--service MyService \
--task-set arn:aws:ecs:us-west-2:123456789012:task-set/MyCluster/MyService/ecs-svc/1234567890123456789 \
--scale value=50,unit=PERCENT
```
出力:
```
{
"taskSet": {
"id": "ecs-svc/1234567890123456789",
"taskSetArn": "arn:aws:ecs:us-west-2:123456789012:task-set/MyCluster/MyService/ecs-svc/1234567890123456789",
"status": "ACTIVE",
"taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/sample-fargate:2",
"computedDesiredCount": 0,
"pendingCount": 0,
"runningCount": 0,
"createdAt": 1557128360.711,
"updatedAt": 1557129279.914,
"launchType": "EC2",
"networkConfiguration": {
"awsvpcConfiguration": {
"subnets": [
"subnet-12344321"
],
"securityGroups": [
"sg-12344321"
],
"assignPublicIp": "DISABLED"
}
},
"loadBalancers": [],
"serviceRegistries": [],
"scale": {
"value": 50.0,
"unit": "PERCENT"
},
"stabilityStatus": "STABILIZING",
"stabilityStatusAt": 1557129279.914
}
}
```
+ API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateTaskSet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/update-task-set.html)」を参照してください。