[ aws . ecs ]

put-account-setting-default

Description

Modifies an account setting for all IAM users on an account for whom no individual account setting has been specified. Account settings are set on a per-Region basis.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  put-account-setting-default
--name <value>
--value <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--name (string)

The resource name for which to modify the account setting. If serviceLongArnFormat is specified, the ARN for your Amazon ECS services is affected. If taskLongArnFormat is specified, the ARN and resource ID for your Amazon ECS tasks is affected. If containerInstanceLongArnFormat is specified, the ARN and resource ID for your Amazon ECS container instances is affected. If awsvpcTrunking is specified, the ENI limit for your Amazon ECS container instances is affected. If containerInsights is specified, the default setting for CloudWatch Container Insights for your clusters is affected.

Possible values:

• serviceLongArnFormat

• taskLongArnFormat

• containerInstanceLongArnFormat

• awsvpcTrunking

• containerInsights

--value (string)

The account setting value for the specified principal ARN. Accepted values are enabled and disabled .

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples

To modify the default account settings

The following put-account-setting-default example modifies the default account setting for all IAM users or roles on your account. These changes apply to the entire AWS account unless an IAM user or role explicitly overrides these settings for themselves.

aws ecs put-account-setting-default --name serviceLongArnFormat --value enabled

Output:

{
    "setting": {
        "name": "serviceLongArnFormat",
        "value": "enabled",
        "principalArn": "arn:aws:iam::123456789012:root"
    }
}

For more information, see Amazon Resource Names (ARNs) and IDs in the Amazon ECS Developer Guide.

Output

setting -> (structure)

The current setting for a resource.

name -> (string)

The Amazon ECS resource name.

value -> (string)

Determines whether the account setting is enabled or disabled for the specified resource.

principalArn -> (string)

The ARN of the principal. It can be an IAM user, IAM role, or the root user. If this field is omitted, the authenticated user is assumed.