com.amazonaws.services.ecs.model.PutAccountSettingRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ecs Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.ecs.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class PutAccountSettingRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* 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.
*
*
* -
*
* 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 in the Amazon Elastic Container Service Developer Guide.
*
*
* -
*
* containerInsights - When modified, the default setting indicating whether Amazon Web Services
* 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.
*
*
* -
*
* 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.
*
*
* -
*
* fargateFIPSMode - If you specify fargateFIPSMode, Fargate FIPS 140 compliance is
* affected.
*
*
* -
*
* 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.
*
*
*
*/
private String name;
/**
*
* The account setting value for the specified principal ARN. Accepted values are enabled,
* disabled, 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.
*
*
*
*/
private String value;
/**
*
* 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.
*
*
*
* 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.
*
*
*/
private String principalArn;
/**
*
* 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.
*
*
* -
*
* 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 in the Amazon Elastic Container Service Developer Guide.
*
*
* -
*
* containerInsights - When modified, the default setting indicating whether Amazon Web Services
* 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.
*
*
* -
*
* 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.
*
*
* -
*
* fargateFIPSMode - If you specify fargateFIPSMode, Fargate FIPS 140 compliance is
* affected.
*
*
* -
*
* 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.
*
*
*
*
* @param name
* 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.
*
*
* -
*
* 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 in the Amazon Elastic Container Service Developer Guide.
*
*
* -
*
* containerInsights - When modified, the default setting indicating whether Amazon Web Services
* 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.
*
*
* -
*
* 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.
*
*
* -
*
* fargateFIPSMode - If you specify fargateFIPSMode, Fargate FIPS 140 compliance is
* affected.
*
*
* -
*
* 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.
*
*
* @see SettingName
*/
public void setName(String name) {
this.name = name;
}
/**
*
* 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.
*
*
* -
*
* 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 in the Amazon Elastic Container Service Developer Guide.
*
*
* -
*
* containerInsights - When modified, the default setting indicating whether Amazon Web Services
* 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.
*
*
* -
*
* 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.
*
*
* -
*
* fargateFIPSMode - If you specify fargateFIPSMode, Fargate FIPS 140 compliance is
* affected.
*
*
* -
*
* 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.
*
*
*
*
* @return 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.
*
*
* -
*
* 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 in the Amazon Elastic Container Service Developer Guide.
*
*
* -
*
* containerInsights - When modified, the default setting indicating whether Amazon Web
* Services 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.
*
*
* -
*
* 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.
*
*
* -
*
* fargateFIPSMode - If you specify fargateFIPSMode, Fargate FIPS 140 compliance
* is affected.
*
*
* -
*
* 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.
*
*
* @see SettingName
*/
public String getName() {
return this.name;
}
/**
*
* 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.
*
*
* -
*
* 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 in the Amazon Elastic Container Service Developer Guide.
*
*
* -
*
* containerInsights - When modified, the default setting indicating whether Amazon Web Services
* 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.
*
*
* -
*
* 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.
*
*
* -
*
* fargateFIPSMode - If you specify fargateFIPSMode, Fargate FIPS 140 compliance is
* affected.
*
*
* -
*
* 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.
*
*
*
*
* @param name
* 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.
*
*
* -
*
* 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 in the Amazon Elastic Container Service Developer Guide.
*
*
* -
*
* containerInsights - When modified, the default setting indicating whether Amazon Web Services
* 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.
*
*
* -
*
* 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.
*
*
* -
*
* fargateFIPSMode - If you specify fargateFIPSMode, Fargate FIPS 140 compliance is
* affected.
*
*
* -
*
* 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see SettingName
*/
public PutAccountSettingRequest withName(String name) {
setName(name);
return this;
}
/**
*
* 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.
*
*
* -
*
* 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 in the Amazon Elastic Container Service Developer Guide.
*
*
* -
*
* containerInsights - When modified, the default setting indicating whether Amazon Web Services
* 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.
*
*
* -
*
* 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.
*
*
* -
*
* fargateFIPSMode - If you specify fargateFIPSMode, Fargate FIPS 140 compliance is
* affected.
*
*
* -
*
* 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.
*
*
*
*
* @param name
* 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.
*
*
* -
*
* 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 in the Amazon Elastic Container Service Developer Guide.
*
*
* -
*
* containerInsights - When modified, the default setting indicating whether Amazon Web Services
* 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.
*
*
* -
*
* 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.
*
*
* -
*
* fargateFIPSMode - If you specify fargateFIPSMode, Fargate FIPS 140 compliance is
* affected.
*
*
* -
*
* 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see SettingName
*/
public PutAccountSettingRequest withName(SettingName name) {
this.name = name.toString();
return this;
}
/**
*
* The account setting value for the specified principal ARN. Accepted values are enabled,
* disabled, 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.
*
*
*
*
* @param value
* The account setting value for the specified principal ARN. Accepted values are enabled,
* disabled, 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.
*
*
*/
public void setValue(String value) {
this.value = value;
}
/**
*
* The account setting value for the specified principal ARN. Accepted values are enabled,
* disabled, 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.
*
*
*
*
* @return The account setting value for the specified principal ARN. Accepted values are enabled,
* disabled, 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.
*
*
*/
public String getValue() {
return this.value;
}
/**
*
* The account setting value for the specified principal ARN. Accepted values are enabled,
* disabled, 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.
*
*
*
*
* @param value
* The account setting value for the specified principal ARN. Accepted values are enabled,
* disabled, 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PutAccountSettingRequest withValue(String value) {
setValue(value);
return this;
}
/**
*
* 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.
*
*
*
* 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.
*
*
*
* @param 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.
*
* 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.
*
*/
public void setPrincipalArn(String principalArn) {
this.principalArn = 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.
*
*
*
* 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.
*
*
*
* @return 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.
*
* 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.
*
*/
public String getPrincipalArn() {
return this.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.
*
*
*
* 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.
*
*
*
* @param 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.
*
* 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.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PutAccountSettingRequest withPrincipalArn(String principalArn) {
setPrincipalArn(principalArn);
return this;
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getValue() != null)
sb.append("Value: ").append(getValue()).append(",");
if (getPrincipalArn() != null)
sb.append("PrincipalArn: ").append(getPrincipalArn());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof PutAccountSettingRequest == false)
return false;
PutAccountSettingRequest other = (PutAccountSettingRequest) obj;
if (other.getName() == null ^ this.getName() == null)
return false;
if (other.getName() != null && other.getName().equals(this.getName()) == false)
return false;
if (other.getValue() == null ^ this.getValue() == null)
return false;
if (other.getValue() != null && other.getValue().equals(this.getValue()) == false)
return false;
if (other.getPrincipalArn() == null ^ this.getPrincipalArn() == null)
return false;
if (other.getPrincipalArn() != null && other.getPrincipalArn().equals(this.getPrincipalArn()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getValue() == null) ? 0 : getValue().hashCode());
hashCode = prime * hashCode + ((getPrincipalArn() == null) ? 0 : getPrincipalArn().hashCode());
return hashCode;
}
@Override
public PutAccountSettingRequest clone() {
return (PutAccountSettingRequest) super.clone();
}
}