software.amazon.awssdk.services.ecs.model.PutAccountSettingDefaultRequest Maven / Gradle / Ivy
/*
* Copyright 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 software.amazon.awssdk.services.ecs.model;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class PutAccountSettingDefaultRequest extends EcsRequest implements
ToCopyableBuilder {
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("name")
.getter(getter(PutAccountSettingDefaultRequest::nameAsString)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("name").build()).build();
private static final SdkField VALUE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("value")
.getter(getter(PutAccountSettingDefaultRequest::value)).setter(setter(Builder::value))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("value").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(NAME_FIELD, VALUE_FIELD));
private final String name;
private final String value;
private PutAccountSettingDefaultRequest(BuilderImpl builder) {
super(builder);
this.name = builder.name;
this.value = builder.value;
}
/**
*
* The resource name for which to modify the account setting. If you specify serviceLongArnFormat, the
* ARN for your Amazon ECS services is affected. If you specify taskLongArnFormat, the ARN and resource
* ID for your Amazon ECS tasks is affected. If you specify containerInstanceLongArnFormat, the ARN and
* resource ID for your Amazon ECS container instances is affected. If you specify awsvpcTrunking, the
* ENI limit for your Amazon ECS container instances is affected. If you specify containerInsights, the
* default setting for Amazon Web Services CloudWatch Container Insights for your clusters is affected. If you
* specify tagResourceAuthorization, 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 specify
* fargateTaskRetirementWaitPeriod, the default wait time to retire a Fargate task due to required
* maintenance is affected.
*
*
* When you specify fargateFIPSMode for the name and enabled for the
* value, Fargate uses FIPS-140 compliant cryptographic algorithms on your tasks. For more information
* about FIPS-140 compliance with Fargate, see Amazon Web Services
* Fargate Federal Information Processing Standard (FIPS) 140-2 compliance in the Amazon Elastic Container
* Service Developer Guide.
*
*
* 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 set the wait time to retire a Fargate task to the default. For
* information about the Fargate tasks maintenance, see Amazon Web Services
* Fargate task maintenance in the Amazon ECS Developer Guide.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #name} will return
* {@link SettingName#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #nameAsString}.
*
*
* @return The resource name for which to modify the account setting. If you specify
* serviceLongArnFormat, the ARN for your Amazon ECS services is affected. If you specify
* taskLongArnFormat, the ARN and resource ID for your Amazon ECS tasks is affected. If you
* specify containerInstanceLongArnFormat, the ARN and resource ID for your Amazon ECS
* container instances is affected. If you specify awsvpcTrunking, the ENI limit for your
* Amazon ECS container instances is affected. If you specify containerInsights, the default
* setting for Amazon Web Services CloudWatch Container Insights for your clusters is affected. If you
* specify tagResourceAuthorization, 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 specify
* fargateTaskRetirementWaitPeriod, the default wait time to retire a Fargate task due to
* required maintenance is affected.
*
* When you specify fargateFIPSMode for the name and enabled for the
* value, Fargate uses FIPS-140 compliant cryptographic algorithms on your tasks. For more
* information about FIPS-140 compliance with Fargate, see Amazon Web
* Services Fargate Federal Information Processing Standard (FIPS) 140-2 compliance in the Amazon
* Elastic Container Service Developer Guide.
*
*
* 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 set the wait time to retire a Fargate task to the
* default. For information about the Fargate tasks maintenance, see Amazon Web
* Services Fargate task maintenance in the Amazon ECS Developer Guide.
* @see SettingName
*/
public final SettingName name() {
return SettingName.fromValue(name);
}
/**
*
* The resource name for which to modify the account setting. If you specify serviceLongArnFormat, the
* ARN for your Amazon ECS services is affected. If you specify taskLongArnFormat, the ARN and resource
* ID for your Amazon ECS tasks is affected. If you specify containerInstanceLongArnFormat, the ARN and
* resource ID for your Amazon ECS container instances is affected. If you specify awsvpcTrunking, the
* ENI limit for your Amazon ECS container instances is affected. If you specify containerInsights, the
* default setting for Amazon Web Services CloudWatch Container Insights for your clusters is affected. If you
* specify tagResourceAuthorization, 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 specify
* fargateTaskRetirementWaitPeriod, the default wait time to retire a Fargate task due to required
* maintenance is affected.
*
*
* When you specify fargateFIPSMode for the name and enabled for the
* value, Fargate uses FIPS-140 compliant cryptographic algorithms on your tasks. For more information
* about FIPS-140 compliance with Fargate, see Amazon Web Services
* Fargate Federal Information Processing Standard (FIPS) 140-2 compliance in the Amazon Elastic Container
* Service Developer Guide.
*
*
* 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 set the wait time to retire a Fargate task to the default. For
* information about the Fargate tasks maintenance, see Amazon Web Services
* Fargate task maintenance in the Amazon ECS Developer Guide.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #name} will return
* {@link SettingName#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #nameAsString}.
*
*
* @return The resource name for which to modify the account setting. If you specify
* serviceLongArnFormat, the ARN for your Amazon ECS services is affected. If you specify
* taskLongArnFormat, the ARN and resource ID for your Amazon ECS tasks is affected. If you
* specify containerInstanceLongArnFormat, the ARN and resource ID for your Amazon ECS
* container instances is affected. If you specify awsvpcTrunking, the ENI limit for your
* Amazon ECS container instances is affected. If you specify containerInsights, the default
* setting for Amazon Web Services CloudWatch Container Insights for your clusters is affected. If you
* specify tagResourceAuthorization, 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 specify
* fargateTaskRetirementWaitPeriod, the default wait time to retire a Fargate task due to
* required maintenance is affected.
*
* When you specify fargateFIPSMode for the name and enabled for the
* value, Fargate uses FIPS-140 compliant cryptographic algorithms on your tasks. For more
* information about FIPS-140 compliance with Fargate, see Amazon Web
* Services Fargate Federal Information Processing Standard (FIPS) 140-2 compliance in the Amazon
* Elastic Container Service Developer Guide.
*
*
* 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 set the wait time to retire a Fargate task to the
* default. For information about the Fargate tasks maintenance, see Amazon Web
* Services Fargate task maintenance in the Amazon ECS Developer Guide.
* @see SettingName
*/
public final String nameAsString() {
return 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.
*
*
*
*
* @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 final String value() {
return value;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(nameAsString());
hashCode = 31 * hashCode + Objects.hashCode(value());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof PutAccountSettingDefaultRequest)) {
return false;
}
PutAccountSettingDefaultRequest other = (PutAccountSettingDefaultRequest) obj;
return Objects.equals(nameAsString(), other.nameAsString()) && Objects.equals(value(), other.value());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("PutAccountSettingDefaultRequest").add("Name", nameAsString()).add("Value", value()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "name":
return Optional.ofNullable(clazz.cast(nameAsString()));
case "value":
return Optional.ofNullable(clazz.cast(value()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((PutAccountSettingDefaultRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends EcsRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The resource name for which to modify the account setting. If you specify serviceLongArnFormat,
* the ARN for your Amazon ECS services is affected. If you specify taskLongArnFormat, the ARN and
* resource ID for your Amazon ECS tasks is affected. If you specify containerInstanceLongArnFormat
* , the ARN and resource ID for your Amazon ECS container instances is affected. If you specify
* awsvpcTrunking, the ENI limit for your Amazon ECS container instances is affected. If you
* specify containerInsights, the default setting for Amazon Web Services CloudWatch Container
* Insights for your clusters is affected. If you specify tagResourceAuthorization, 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 specify
* fargateTaskRetirementWaitPeriod, the default wait time to retire a Fargate task due to required
* maintenance is affected.
*
*
* When you specify fargateFIPSMode for the name and enabled for the
* value, Fargate uses FIPS-140 compliant cryptographic algorithms on your tasks. For more
* information about FIPS-140 compliance with Fargate, see Amazon Web
* Services Fargate Federal Information Processing Standard (FIPS) 140-2 compliance in the Amazon Elastic
* Container Service Developer Guide.
*
*
* 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 set the wait time to retire a Fargate task to the default.
* For information about the Fargate tasks maintenance, see Amazon Web Services
* Fargate task maintenance in the Amazon ECS Developer Guide.
*
*
* @param name
* The resource name for which to modify the account setting. If you specify
* serviceLongArnFormat, the ARN for your Amazon ECS services is affected. If you specify
* taskLongArnFormat, the ARN and resource ID for your Amazon ECS tasks is affected. If you
* specify containerInstanceLongArnFormat, the ARN and resource ID for your Amazon ECS
* container instances is affected. If you specify awsvpcTrunking, the ENI limit for your
* Amazon ECS container instances is affected. If you specify containerInsights, the default
* setting for Amazon Web Services CloudWatch Container Insights for your clusters is affected. If you
* specify tagResourceAuthorization, 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 specify
* fargateTaskRetirementWaitPeriod, the default wait time to retire a Fargate task due to
* required maintenance is affected.
*
* When you specify fargateFIPSMode for the name and enabled for
* the value, Fargate uses FIPS-140 compliant cryptographic algorithms on your tasks. For
* more information about FIPS-140 compliance with Fargate, see Amazon
* Web Services Fargate Federal Information Processing Standard (FIPS) 140-2 compliance in the
* Amazon Elastic Container Service Developer Guide.
*
*
* 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 set the wait time to retire a Fargate task to the
* default. For information about the Fargate tasks maintenance, see Amazon Web
* Services Fargate task maintenance in the Amazon ECS Developer Guide.
* @see SettingName
* @return Returns a reference to this object so that method calls can be chained together.
* @see SettingName
*/
Builder name(String name);
/**
*
* The resource name for which to modify the account setting. If you specify serviceLongArnFormat,
* the ARN for your Amazon ECS services is affected. If you specify taskLongArnFormat, the ARN and
* resource ID for your Amazon ECS tasks is affected. If you specify containerInstanceLongArnFormat
* , the ARN and resource ID for your Amazon ECS container instances is affected. If you specify
* awsvpcTrunking, the ENI limit for your Amazon ECS container instances is affected. If you
* specify containerInsights, the default setting for Amazon Web Services CloudWatch Container
* Insights for your clusters is affected. If you specify tagResourceAuthorization, 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 specify
* fargateTaskRetirementWaitPeriod, the default wait time to retire a Fargate task due to required
* maintenance is affected.
*
*
* When you specify fargateFIPSMode for the name and enabled for the
* value, Fargate uses FIPS-140 compliant cryptographic algorithms on your tasks. For more
* information about FIPS-140 compliance with Fargate, see Amazon Web
* Services Fargate Federal Information Processing Standard (FIPS) 140-2 compliance in the Amazon Elastic
* Container Service Developer Guide.
*
*
* 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 set the wait time to retire a Fargate task to the default.
* For information about the Fargate tasks maintenance, see Amazon Web Services
* Fargate task maintenance in the Amazon ECS Developer Guide.
*
*
* @param name
* The resource name for which to modify the account setting. If you specify
* serviceLongArnFormat, the ARN for your Amazon ECS services is affected. If you specify
* taskLongArnFormat, the ARN and resource ID for your Amazon ECS tasks is affected. If you
* specify containerInstanceLongArnFormat, the ARN and resource ID for your Amazon ECS
* container instances is affected. If you specify awsvpcTrunking, the ENI limit for your
* Amazon ECS container instances is affected. If you specify containerInsights, the default
* setting for Amazon Web Services CloudWatch Container Insights for your clusters is affected. If you
* specify tagResourceAuthorization, 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 specify
* fargateTaskRetirementWaitPeriod, the default wait time to retire a Fargate task due to
* required maintenance is affected.
*
* When you specify fargateFIPSMode for the name and enabled for
* the value, Fargate uses FIPS-140 compliant cryptographic algorithms on your tasks. For
* more information about FIPS-140 compliance with Fargate, see Amazon
* Web Services Fargate Federal Information Processing Standard (FIPS) 140-2 compliance in the
* Amazon Elastic Container Service Developer Guide.
*
*
* 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 set the wait time to retire a Fargate task to the
* default. For information about the Fargate tasks maintenance, see Amazon Web
* Services Fargate task maintenance in the Amazon ECS Developer Guide.
* @see SettingName
* @return Returns a reference to this object so that method calls can be chained together.
* @see SettingName
*/
Builder name(SettingName 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.
*
*
*
*
* @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.
*/
Builder value(String value);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends EcsRequest.BuilderImpl implements Builder {
private String name;
private String value;
private BuilderImpl() {
}
private BuilderImpl(PutAccountSettingDefaultRequest model) {
super(model);
name(model.name);
value(model.value);
}
public final String getName() {
return name;
}
public final void setName(String name) {
this.name = name;
}
@Override
public final Builder name(String name) {
this.name = name;
return this;
}
@Override
public final Builder name(SettingName name) {
this.name(name == null ? null : name.toString());
return this;
}
public final String getValue() {
return value;
}
public final void setValue(String value) {
this.value = value;
}
@Override
public final Builder value(String value) {
this.value = value;
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public PutAccountSettingDefaultRequest build() {
return new PutAccountSettingDefaultRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}