Class: Aws::ECS::Types::PutAccountSettingRequest

Inherits:

Struct

• Object
• Struct
• Aws::ECS::Types::PutAccountSettingRequest

Includes:

Structure

Defined in:

lib/aws-sdk-ecs/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #name ⇒ String

  The Amazon ECS account setting name to modify.

• #principal_arn ⇒ String

  The ARN of the principal, which can be a user, role, or the root user.

• #value ⇒ String

  The account setting value for the specified principal ARN.

Instance Attribute Details

#name ⇒ String

The Amazon ECS account setting name to modify.

The following are the valid values for the account setting name.

• ‘serviceLongArnFormat` - When modified, 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.

• ‘taskLongArnFormat` - When modified, 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.

• ‘fargateFIPSMode` - When turned on, you can run Fargate workloads in a manner that is compliant with Federal Information Processing Standard (FIPS-140). For more information, see [Fargate Federal Information Processing Standard (FIPS-140)].

• ‘containerInstanceLongArnFormat` - When modified, 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.

• ‘awsvpcTrunking` - When modified, 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][2

  in the *Amazon Elastic

  Container Service Developer Guide*.

• ‘containerInsights` - Container Insights with enhanced observability provides all the Container Insights metrics, plus additional task and container metrics. This version supports enhanced observability for Amazon ECS clusters using the Amazon EC2 and Fargate launch types. After you configure Container Insights with enhanced observability on Amazon ECS, Container Insights auto-collects detailed infrastructure telemetry from the cluster level down to the container level in your environment and displays these critical performance data in curated dashboards removing the heavy lifting in observability set-up.

  To use Container Insights with enhanced observability, set the ‘containerInsights` account setting to `enhanced`.

  To use Container Insights, set the ‘containerInsights` account setting to `enabled`.

  For more information, see [Monitor Amazon ECS containers using Container Insights with enhanced observability] in the *Amazon Elastic Container Service Developer Guide*.

• ‘dualStackIPv6` - When turned on, when using a VPC in dual stack mode, your tasks using the `awsvpc` network mode can have an IPv6 address assigned. For more information on using IPv6 with tasks launched on Amazon EC2 instances, see [Using a VPC in dual-stack mode]. For more information on using IPv6 with tasks launched on Fargate, see [Using a VPC in dual-stack mode].

• ‘fargateTaskRetirementWaitPeriod` - When Amazon Web Services 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 [Amazon Web Services Fargate task maintenance] in the *Amazon ECS Developer Guide*.

• ‘tagResourceAuthorization` - 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, Amazon Web Services 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*.

• ‘guardDutyActivate` - The `guardDutyActivate` parameter is read-only in Amazon ECS and indicates whether Amazon ECS Runtime Monitoring is enabled or disabled by your security administrator in your Amazon ECS account. Amazon GuardDuty controls this account setting on your behalf. For more information, see [Protecting Amazon ECS workloads with Amazon ECS Runtime Monitoring].

[1]: docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-fips-compliance.html [2]: docs.aws.amazon.com/AmazonECS/latest/developerguide/container-instance-eni.html [3]: docs.aws.amazon.com/AmazonECS/latest/developerguide/cloudwatch-container-insights.html [4]: docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking-awsvpc.html#task-networking-vpc-dual-stack [5]: docs.aws.amazon.com/AmazonECS/latest/developerguide/fargate-task-networking.html#fargate-task-networking-vpc-dual-stack [6]: docs.aws.amazon.com/AmazonECS/latest/developerguide/task-maintenance.html [7]: docs.aws.amazon.com/AmazonECS/latest/developerguide/supported-iam-actions-tagging.html [8]: docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-guard-duty-integration.html

Returns:

• (String)

# File 'lib/aws-sdk-ecs/types.rb', line 8140

class PutAccountSettingRequest < Struct.new(
  :name,
  :value,
  :principal_arn)
  SENSITIVE = []
  include Aws::Structure
end

#principal_arn ⇒ String

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 markdown=“1”> 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.

</note>

Returns:

• (String)

# File 'lib/aws-sdk-ecs/types.rb', line 8140

class PutAccountSettingRequest < Struct.new(
  :name,
  :value,
  :principal_arn)
  SENSITIVE = []
  include Aws::Structure
end

#value ⇒ String

The account setting value for the specified principal ARN. Accepted values are ‘enabled`, `disabled`, `enhanced`, `on`, and `off`.

When you specify ‘fargateTaskRetirementWaitPeriod` for the `name`, the following are the valid values:

• ‘0` - Amazon Web Services sends the notification, and immediately retires the affected tasks.

• ‘7` - Amazon Web Services sends the notification, and waits 7 calendar days to retire the tasks.

• ‘14` - Amazon Web Services sends the notification, and waits 14 calendar days to retire the tasks.

Returns:

• (String)

# File 'lib/aws-sdk-ecs/types.rb', line 8140

class PutAccountSettingRequest < Struct.new(
  :name,
  :value,
  :principal_arn)
  SENSITIVE = []
  include Aws::Structure
end