The task execution role grants the Amazon ECS container and Fargate agents permission to make AWS API calls on your behalf. The task execution IAM role is required depending on the requirements of your task. You can have multiple task execution roles for different purposes and services associated with your account.
NoteThese permissions are made available to the agent running on your instance by Amazon ECS periodically sending it the role's temporary credentials, but they aren't directly accessible by the containers in the task. For the IAM permissions that your application code inside the container needs to run, see Amazon ECS task IAM role.
The following are common use cases for a task execution IAM role:
Your task is hosted on AWS Fargate or on an external instance and:
pulls a container image from an Amazon ECR private repository.
pulls a container image from an Amazon ECR private repository in a different account from the account that runs the task.
sends container logs to CloudWatch Logs using the awslogs
log driver. For more information, see Send Amazon ECS logs to CloudWatch .
Your tasks are hosted on either AWS Fargate or Amazon EC2 instances and:
The task execution role is supported by Amazon ECS container agent version 1.16.0 and later.
Amazon ECS provides the managed policy named AmazonECSTaskExecutionRolePolicy
which contains the permissions the common use cases described above require. For more information, see AmazonECSTaskExecutionRolePolicy in the AWS Managed Policy Reference Guide. It might be necessary to add inline policies to your task execution role for special use cases
The Amazon ECS console creates a task execution role. You can manually attach the managed IAM policy for tasks to allow Amazon ECS to add permissions for future features and enhancements as they are introduced. You can use IAM console search to search for ecsTaskExecutionRole
and see if your account already has the task execution role. For more information, see IAM console search in the IAM user guide.
If you pull images as an authenticated user, you're less likely to be impacted by the changes that occurred to Docker Hub usage and limits. For more information see, Private registry authentication for container instances.
By using Amazon ECR and Amazon ECR Public, you can avoid the limits imposed by Docker. If you pull images from Amazon ECR, this also helps shorten network pull times and reduces data transfer changes when traffic leaves your VPC.
When you use Fargate, you must authenticate to a private image registry using repositoryCredentials
. It's not possible to set the Amazon ECS container agent environment variables ECS_ENGINE_AUTH_TYPE
or ECS_ENGINE_AUTH_DATA
or modify the ecs.config
file for tasks hosted on Fargate. For more information, see Private registry authentication for tasks.
If your account doesn't already have a task execution role, use the following steps to create the role.
Sign in to the AWS Management Console and open the IAM console at https://console.aws.amazon.com/iam/.
In the navigation pane of the IAM console, choose Roles, and then choose Create role.
For Trusted entity type, choose AWS service.
For Service or use case, choose Elastic Container Service, and then choose the Elastic Container Service Task use case.
Choose Next.
In the Add permissions section, search for AmazonECSTaskExecutionRolePolicy, then select the policy.
Choose Next.
For Role name, enter ecsTaskExecutionRole.
Review the role, and then choose Create role.
Replace all user input
with your own information.
Create a file named ecs-tasks-trust-policy.json
that contains the trust policy to use for the IAM role. The file should contain the following:
{
"Version": "2012-10-17",
"Statement": [
{
"Sid": "",
"Effect": "Allow",
"Principal": {
"Service": "ecs-tasks.amazonaws.com"
},
"Action": "sts:AssumeRole"
}
]
}
Create an IAM role named ecsTaskExecutionRole
using the trust policy created in the previous step.
aws iam create-role \
--role-name ecsTaskExecutionRole
\
--assume-role-policy-document file://ecs-tasks-trust-policy.json
Attach the AWS managed AmazonECSTaskExecutionRolePolicy
policy to the ecsTaskExecutionRole
role.
aws iam attach-role-policy \
--role-name ecsTaskExecutionRole
\
--policy-arn arn:aws:iam::aws:policy/service-role/AmazonECSTaskExecutionRolePolicy
After you create the role, add additional permissions to the role for the following features.
Private registry authentication permissionsPrivate registry authentication allows your Amazon ECS tasks to pull container images from private registries outside of AWS (such as Docker Hub, Quay.io, or your own private registry) that require authentication credentials. This feature uses Secrets Manager to securely store your registry credentials, which are then referenced in your task definition using the repositoryCredentials
parameter.
For more information about configuring private registry authentication, see Using non-AWS container images in Amazon ECS.
To provide access to the secrets that contain your private registry credentials, add the following permissions as an inline policy to the task execution role. For more information, see Adding and Removing IAM Policies.
secretsmanager:GetSecretValue
âRequired to retrieve the private registry credentials from Secrets Manager.
kms:Decrypt
âRequired only if your secret uses a custom KMS key and not the default key. The Amazon Resource Name (ARN) for your custom key must be added as a resource.
The following is an example inline policy that adds the permissions.
{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"kms:Decrypt",
"secretsmanager:GetSecretValue"
],
"Resource": [
"arn:aws:secretsmanager:<region>:<aws_account_id>:secret:secret_name",
"arn:aws:kms:<region>:<aws_account_id>:key/key_id"
]
}
]
}
Secrets Manager or Systems Manager permissions
The permission to allow the container agent to pull the necessary AWS Systems Manager or Secrets Manager resources. For more information, see Pass sensitive data to an Amazon ECS container.
Using Secrets Manager
To provide access to the Secrets Manager secrets that you create, manually add the following permission to the task execution role. For information about how to manage permissions, see Adding and Removing IAM identity permissions in the IAM User Guide.
secretsmanager:GetSecretValue
â Required if you are referencing a Secrets Manager secret. Adds the permission to retrieve the secret from Secrets Manager.
The following example policy adds the required permissions.
{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"secretsmanager:GetSecretValue"
],
"Resource": [
"arn:aws:secretsmanager:region
:aws_account_id
:secret:secret_name
"
]
}
]
}
Using Systems Manager
ImportantFor tasks that use the EC2 launch type, you must use the ECS agent configuration variable ECS_ENABLE_AWSLOGS_EXECUTIONROLE_OVERRIDE=true
to use this feature. You can add it to the ./etc/ecs/ecs.config
file during container instance creation or you can add it to an existing instance and then restart the ECS agent. For more information, see Amazon ECS container agent configuration.
To provide access to the Systems Manager Parameter Store parameters that you create, manually add the following permissions as a policy to the task execution role. For information about how to manage permissions, see Adding and Removing IAM identity permissions in the IAM User Guide.
ssm:GetParameters
â Required if you are referencing a Systems Manager Parameter Store parameter in a task definition. Adds the permission to retrieve Systems Manager parameters.
secretsmanager:GetSecretValue
â Required if you are referencing a Secrets Manager secret either directly or if your Systems Manager Parameter Store parameter is referencing a Secrets Manager secret in a task definition. Adds the permission to retrieve the secret from Secrets Manager.
kms:Decrypt
â Required only if your secret uses a customer managed key and not the default key. The ARN for your custom key should be added as a resource. Adds the permission to decrypt the customer managed key .
The following example policy adds the required permissions:
{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"ssm:GetParameters",
"secretsmanager:GetSecretValue",
"kms:Decrypt"
],
"Resource": [
"arn:aws:ssm:region
:aws_account_id
:parameter/parameter_name
",
"arn:aws:secretsmanager:region
:aws_account_id
:secret:secret_name
",
"arn:aws:kms:region
:aws_account_id
:key/key_id
"
]
}
]
}
Fargate tasks pulling Amazon ECR images over interface endpoints permissions
When launching tasks that use the Fargate launch type that pull images from Amazon ECR when Amazon ECR is configured to use an interface VPC endpoint, you can restrict the tasks access to a specific VPC or VPC endpoint. Do this by creating a task execution role for the tasks to use that use IAM condition keys.
Use the following IAM global condition keys to restrict access to a specific VPC or VPC endpoint. For more information, see AWS Global Condition Context Keys.
aws:SourceVpc
âRestricts access to a specific VPC. You can restrict the VPC to the VPC that hosts the task and endpoint.
aws:SourceVpce
âRestricts access to a specific VPC endpoint.
The following task execution role policy provides an example for adding condition keys:
{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"ecr:GetAuthorizationToken",
"logs:CreateLogStream",
"logs:PutLogEvents"
],
"Resource": "*"
},
{
"Effect": "Allow",
"Action": [
"ecr:BatchCheckLayerAvailability",
"ecr:GetDownloadUrlForLayer",
"ecr:BatchGetImage"
],
"Resource": "*",
"Condition": {
"StringEquals": {
"arn:aws:ec2:arn:aws::111122223333
:vpc-endpoint/vpce-0123456789abcdef0
",
"arn:aws:ec2:arn:aws::111122223333
:vpc/vpc-0123456789abcdef0
"
}
}
}
]
}
The following permissions are required when you need to pull container images from Amazon ECR private repositories. The task execution role should have these permissions to allow the Amazon ECS container and Fargate agents to pull container images on your behalf. For basic ECS implementations, these permissions should be added to the task execution role rather than the task IAM role.
The Amazon ECS task execution role managed policy (AmazonECSTaskExecutionRolePolicy
) includes the necessary permissions for pulling images from Amazon ECR. If you're using the managed policy, you don't need to add these permissions separately.
If you're creating a custom policy, include the following permissions to allow pulling images from Amazon ECR:
{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"ecr:BatchGetImage",
"ecr:GetDownloadUrlForLayer",
"ecr:GetAuthorizationToken"
],
"Resource": "*"
}
]
}
Note that these permissions are different from the permissions that might be required in the task IAM role if your application code needs to interact with Amazon ECR APIs directly. For information about task IAM role permissions for Amazon ECR, see Amazon ECR permissions.
Amazon S3 file storage permissionsWhen you specify a configuration file that's hosted in Amazon S3, the task execution role must include the s3:GetObject
permission for the configuration file and the s3:GetBucketLocation
permission on the Amazon S3 bucket that the file is in. For more information, see Policy actions for Amazon S3 in the Amazon Simple Storage Service User Guide.
The following example policy adds the required permissions for retrieving a file from Amazon S3. Specify the name of your Amazon S3 bucket and configuration file name.
{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"s3:GetObject
"
],
"Resource": [
"arn:aws:s3:::amzn-s3-demo-bucket
/folder_name
/config_file_name
"
]
},
{
"Effect": "Allow",
"Action": [
"s3:GetBucketLocation"
],
"Resource": [
"arn:aws:s3:::amzn-s3-demo-bucket
"
]
}
]
}
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4