Class PutAccountSettingDefaultRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.ecs.model.EcsRequest
-
- software.amazon.awssdk.services.ecs.model.PutAccountSettingDefaultRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<PutAccountSettingDefaultRequest.Builder,PutAccountSettingDefaultRequest>
@Generated("software.amazon.awssdk:codegen") public final class PutAccountSettingDefaultRequest extends EcsRequest implements ToCopyableBuilder<PutAccountSettingDefaultRequest.Builder,PutAccountSettingDefaultRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfacePutAccountSettingDefaultRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static PutAccountSettingDefaultRequest.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()SettingNamename()The resource name for which to modify the account setting.StringnameAsString()The resource name for which to modify the account setting.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends PutAccountSettingDefaultRequest.Builder>serializableBuilderClass()PutAccountSettingDefaultRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.Stringvalue()The account setting value for the specified principal ARN.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
name
public final SettingName name()
The resource name for which to modify the account setting.
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. IfawsvpcTrunkingis 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- 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
containerInsightsaccount setting toenhanced.To use Container Insights, set the
containerInsightsaccount setting toenabled.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 theawsvpcnetwork 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 specifyfargateFIPSMode, 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. UsefargateTaskRetirementWaitPeriodto 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 asecsCreateCluster. 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 theecs:TagResourceaction. For more information, see Grant permission to tag resources on creation in the Amazon ECS Developer Guide. -
defaultLogDriverMode-Amazon ECS supports setting a default delivery mode of log messages from a container to thelogDriverthat you specify in the container'slogConfiguration. The delivery mode affects application stability when the flow of logs from the container to the log driver is interrupted. ThedefaultLogDriverModesetting supports two values:blockingandnon-blocking. If you don't specify a delivery mode in your container definition'slogConfiguration, the mode you specify using this account setting will be used as the default. For more information about log delivery modes, see LogConfiguration.On June 25, 2025, Amazon ECS is changing the default log driver mode from
blockingtonon-blockingto prioritize task availability over logging. To continue using theblockingmode after this change, do one of the following:-
Set the
modeoption in your container definition'slogConfigurationasblocking. -
Set the
defaultLogDriverModeaccount setting toblocking.
-
-
guardDutyActivate- TheguardDutyActivateparameter 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.
If the service returns an enum value that is not available in the current SDK version,
namewill returnSettingName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromnameAsString().- Returns:
- The resource name for which to modify the account setting.
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. IfawsvpcTrunkingis 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- 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
containerInsightsaccount setting toenhanced.To use Container Insights, set the
containerInsightsaccount setting toenabled.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 theawsvpcnetwork 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 specifyfargateFIPSMode, 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. UsefargateTaskRetirementWaitPeriodto 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 asecsCreateCluster. 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 theecs:TagResourceaction. For more information, see Grant permission to tag resources on creation in the Amazon ECS Developer Guide. -
defaultLogDriverMode-Amazon ECS supports setting a default delivery mode of log messages from a container to thelogDriverthat you specify in the container'slogConfiguration. The delivery mode affects application stability when the flow of logs from the container to the log driver is interrupted. ThedefaultLogDriverModesetting supports two values:blockingandnon-blocking. If you don't specify a delivery mode in your container definition'slogConfiguration, the mode you specify using this account setting will be used as the default. For more information about log delivery modes, see LogConfiguration.On June 25, 2025, Amazon ECS is changing the default log driver mode from
blockingtonon-blockingto prioritize task availability over logging. To continue using theblockingmode after this change, do one of the following:-
Set the
modeoption in your container definition'slogConfigurationasblocking. -
Set the
defaultLogDriverModeaccount setting toblocking.
-
-
guardDutyActivate- TheguardDutyActivateparameter 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 Also:
SettingName
-
-
nameAsString
public final String nameAsString()
The resource name for which to modify the account setting.
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. IfawsvpcTrunkingis 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- 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
containerInsightsaccount setting toenhanced.To use Container Insights, set the
containerInsightsaccount setting toenabled.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 theawsvpcnetwork 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 specifyfargateFIPSMode, 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. UsefargateTaskRetirementWaitPeriodto 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 asecsCreateCluster. 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 theecs:TagResourceaction. For more information, see Grant permission to tag resources on creation in the Amazon ECS Developer Guide. -
defaultLogDriverMode-Amazon ECS supports setting a default delivery mode of log messages from a container to thelogDriverthat you specify in the container'slogConfiguration. The delivery mode affects application stability when the flow of logs from the container to the log driver is interrupted. ThedefaultLogDriverModesetting supports two values:blockingandnon-blocking. If you don't specify a delivery mode in your container definition'slogConfiguration, the mode you specify using this account setting will be used as the default. For more information about log delivery modes, see LogConfiguration.On June 25, 2025, Amazon ECS is changing the default log driver mode from
blockingtonon-blockingto prioritize task availability over logging. To continue using theblockingmode after this change, do one of the following:-
Set the
modeoption in your container definition'slogConfigurationasblocking. -
Set the
defaultLogDriverModeaccount setting toblocking.
-
-
guardDutyActivate- TheguardDutyActivateparameter 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.
If the service returns an enum value that is not available in the current SDK version,
namewill returnSettingName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromnameAsString().- Returns:
- The resource name for which to modify the account setting.
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. IfawsvpcTrunkingis 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- 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
containerInsightsaccount setting toenhanced.To use Container Insights, set the
containerInsightsaccount setting toenabled.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 theawsvpcnetwork 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 specifyfargateFIPSMode, 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. UsefargateTaskRetirementWaitPeriodto 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 asecsCreateCluster. 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 theecs:TagResourceaction. For more information, see Grant permission to tag resources on creation in the Amazon ECS Developer Guide. -
defaultLogDriverMode-Amazon ECS supports setting a default delivery mode of log messages from a container to thelogDriverthat you specify in the container'slogConfiguration. The delivery mode affects application stability when the flow of logs from the container to the log driver is interrupted. ThedefaultLogDriverModesetting supports two values:blockingandnon-blocking. If you don't specify a delivery mode in your container definition'slogConfiguration, the mode you specify using this account setting will be used as the default. For more information about log delivery modes, see LogConfiguration.On June 25, 2025, Amazon ECS is changing the default log driver mode from
blockingtonon-blockingto prioritize task availability over logging. To continue using theblockingmode after this change, do one of the following:-
Set the
modeoption in your container definition'slogConfigurationasblocking. -
Set the
defaultLogDriverModeaccount setting toblocking.
-
-
guardDutyActivate- TheguardDutyActivateparameter 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 Also:
SettingName
-
-
value
public final String value()
The account setting value for the specified principal ARN. Accepted values are
enabled,disabled,on,enhanced, andoff.When you specify
fargateTaskRetirementWaitPeriodfor thename, 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:
- The account setting value for the specified principal ARN. Accepted values are
enabled,disabled,on,enhanced, andoff.When you specify
fargateTaskRetirementWaitPeriodfor thename, 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.
-
-
-
toBuilder
public PutAccountSettingDefaultRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<PutAccountSettingDefaultRequest.Builder,PutAccountSettingDefaultRequest>- Specified by:
toBuilderin classEcsRequest
-
builder
public static PutAccountSettingDefaultRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends PutAccountSettingDefaultRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
toString
public final String toString()
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-