Class Setting

java.lang.Object
software.amazon.awssdk.services.ecs.model.Setting
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Setting.Builder,Setting>
@Generated("software.amazon.awssdk:codegen") public final class Setting extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Setting.Builder,Setting>

The current account setting for a resource.

See Also:

  • Method Details

    • name

      public final SettingName name()

      The Amazon ECS resource name.

      If the service returns an enum value that is not available in the current SDK version, name will return SettingName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from nameAsString().

      Returns:
      The Amazon ECS resource name.
      See Also:

    • nameAsString

      public final String nameAsString()

      The Amazon ECS resource name.

      If the service returns an enum value that is not available in the current SDK version, name will return SettingName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from nameAsString().

      Returns:
      The Amazon ECS resource name.
      See Also:

    • value

      public final String value()

      Determines whether the account setting is on or off for the specified resource.

      Returns:
      Determines whether the account setting is on or off for the specified resource.

    • principalArn

      public final String principalArn()

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

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

    • type

      public final SettingType type()

      Indicates whether Amazon Web Services manages the account setting, or if the user manages it.

      aws_managed account settings are read-only, as Amazon Web Services manages such on the customer's behalf. Currently, the guardDutyActivate account setting is the only one Amazon Web Services manages.

      If the service returns an enum value that is not available in the current SDK version, type will return SettingType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      Indicates whether Amazon Web Services manages the account setting, or if the user manages it.

      aws_managed account settings are read-only, as Amazon Web Services manages such on the customer's behalf. Currently, the guardDutyActivate account setting is the only one Amazon Web Services manages.

      See Also:

    • typeAsString

      public final String typeAsString()

      Indicates whether Amazon Web Services manages the account setting, or if the user manages it.

      aws_managed account settings are read-only, as Amazon Web Services manages such on the customer's behalf. Currently, the guardDutyActivate account setting is the only one Amazon Web Services manages.

      If the service returns an enum value that is not available in the current SDK version, type will return SettingType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      Indicates whether Amazon Web Services manages the account setting, or if the user manages it.

      aws_managed account settings are read-only, as Amazon Web Services manages such on the customer's behalf. Currently, the guardDutyActivate account setting is the only one Amazon Web Services manages.

      See Also:

    • toBuilder

      public Setting.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<Setting.Builder,Setting>
      Returns:
      a builder for type T

    • builder

      public static Setting.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Setting.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.