PutAccountSetting
Modifies an account setting. Account settings are set on a per-Region basis.
If you change the root user account setting, the default settings are reset for users and roles that do not have specified individual account settings. For more information, see Account Settings in the Amazon Elastic Container Service Developer Guide.
When you specify serviceLongArnFormat
, taskLongArnFormat
, or
containerInstanceLongArnFormat
, the Amazon Resource Name (ARN) and
resource ID format of the resource type for a specified user, role, or the root user for an
account is affected. The opt-in and opt-out account setting must be set for each Amazon ECS
resource separately. The ARN and resource ID format of a resource is defined by the
opt-in status of the user or role that created the resource. You must turn on this
setting to use Amazon ECS features such as resource tagging.
When you specify awsvpcTrunking
, the elastic network interface (ENI) limit for
any new container instances that support the feature is changed. If
awsvpcTrunking
is turned on, any new container instances that support
the feature are launched have the increased ENI limits available to them. For more
information, see Elastic Network
Interface Trunking in the Amazon Elastic Container Service Developer Guide.
When you specify containerInsights
, the default setting indicating whether
AWS CloudWatch Container Insights is turned on for your clusters is changed. If
containerInsights
is turned on, any new clusters that are created will
have Container Insights turned on unless you disable it during cluster creation. For
more information, see CloudWatch
Container Insights in the Amazon Elastic Container Service Developer Guide.
Amazon ECS is introducing tagging authorization for resource creation. Users must have
permissions for actions that create the resource, such as ecsCreateCluster
.
If tags are specified when you create a resource, AWS performs additional
authorization to verify if users or roles have permissions to create tags. Therefore,
you must grant explicit permissions to use the ecs:TagResource
action. For
more information, see Grant
permission to tag resources on creation in the Amazon ECS Developer
Guide.
When AWS determines that a security or infrastructure update is needed for an Amazon ECS
task hosted on Fargate, the tasks need to be stopped and new tasks launched to replace
them. Use fargateTaskRetirementWaitPeriod
to configure the wait time to
retire a Fargate task. For information about the Fargate tasks maintenance, see AWS Fargate task maintenance in the Amazon ECS Developer
Guide.
Request Syntax
{
"name": "string
",
"principalArn": "string
",
"value": "string
"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- name
-
The Amazon ECS resource name for which to modify the account setting. If you specify
serviceLongArnFormat
, the ARN for your Amazon ECS services is affected. If you specifytaskLongArnFormat
, the ARN and resource ID for your Amazon ECS tasks is affected. If you specifycontainerInstanceLongArnFormat
, the ARN and resource ID for your Amazon ECS container instances is affected. If you specifyawsvpcTrunking
, the elastic network interface (ENI) limit for your Amazon ECS container instances is affected. If you specifycontainerInsights
, the default setting for AWS CloudWatch Container Insights for your clusters is affected. If you specifyfargateFIPSMode
, AWS Fargate FIPS 140 compliance is affected. If you specifytagResourceAuthorization
, the opt-in option for tagging resources on creation is affected. For information about the opt-in timeline, see Tagging authorization timeline in the Amazon ECS Developer Guide. If you specifyfargateTaskRetirementWaitPeriod
, the wait time to retire a Fargate task is affected.Type: String
Valid Values:
serviceLongArnFormat | taskLongArnFormat | containerInstanceLongArnFormat | awsvpcTrunking | containerInsights | fargateFIPSMode | tagResourceAuthorization | fargateTaskRetirementWaitPeriod
Required: Yes
- principalArn
-
The ARN of the principal, which can be a user, role, or the root user. If you specify the root user, it modifies the account setting for all users, roles, and the root user of the account unless a user or role explicitly overrides these settings. If this field is omitted, the setting is changed only for the authenticated user.
Note
You must use the root user when you set the Fargate wait time (
fargateTaskRetirementWaitPeriod
).Federated users assume the account setting of the root user and can't have explicit account settings set for them.
Type: String
Required: No
- value
-
The account setting value for the specified principal ARN. Accepted values are
enabled
,disabled
,on
, andoff
.When you specify
fargateTaskRetirementWaitPeriod
for thename
, the following are the valid values:-
0
- AWS sends the notification, and immediately retires the affected tasks. -
7
- AWS sends the notification, and waits 7 calendar days to retire the tasks. -
14
- AWS sends the notification, and waits 14 calendar days to retire the tasks.
Type: String
Required: Yes
-
Response Syntax
{
"setting": {
"name": "string",
"principalArn": "string",
"value": "string"
}
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
Errors
For information about the errors that are common to all actions, see Common Errors.
- ClientException
-
These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource,. Or, it might be specifying an identifier that isn't valid.
HTTP Status Code: 400
- InvalidParameterException
-
The specified parameter isn't valid. Review the available parameters for the API request.
HTTP Status Code: 400
- ServerException
-
These errors are usually caused by a server issue.
HTTP Status Code: 500
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: