Class ServiceSetting

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

The service setting data structure.

ServiceSetting is an account-level setting for an Amazon Web Services service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an Amazon Web Services service charges money to the account based on feature or service usage, then the Amazon Web Services service team might create a default setting of "false". This means the user can't use this feature unless they change the setting to "true" and intentionally opt in for a paid feature.

Services map a SettingId object to a setting value. Amazon Web Services services teams define the default value for a SettingId. You can't create a new SettingId, but you can overwrite the default value if you have the ssm:UpdateServiceSetting permission for the setting. Use the UpdateServiceSetting API operation to change the default setting. Or, use the ResetServiceSetting to change the value back to the original value defined by the Amazon Web Services service team.

See Also:

  • Method Details

    • settingId

      public final String settingId()

      The ID of the service setting.

      Returns:
      The ID of the service setting.

    • settingValue

      public final String settingValue()

      The value of the service setting.

      Returns:
      The value of the service setting.

    • lastModifiedDate

      public final Instant lastModifiedDate()

      The last time the service setting was modified.

      Returns:
      The last time the service setting was modified.

    • lastModifiedUser

      public final String lastModifiedUser()

      The ARN of the last modified user. This field is populated only if the setting value was overwritten.

      Returns:
      The ARN of the last modified user. This field is populated only if the setting value was overwritten.

    • arn

      public final String arn()

      The ARN of the service setting.

      Returns:
      The ARN of the service setting.

    • status

      public final String status()

      The status of the service setting. The value can be Default, Customized or PendingUpdate.

      • Default: The current setting uses a default value provisioned by the Amazon Web Services service team.

      • Customized: The current setting use a custom value specified by the customer.

      • PendingUpdate: The current setting uses a default or custom value, but a setting change request is pending approval.

      Returns:
      The status of the service setting. The value can be Default, Customized or PendingUpdate.

      • Default: The current setting uses a default value provisioned by the Amazon Web Services service team.

      • Customized: The current setting use a custom value specified by the customer.

      • PendingUpdate: The current setting uses a default or custom value, but a setting change request is pending approval.

    • toBuilder

      public ServiceSetting.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<ServiceSetting.Builder,ServiceSetting>
      Returns:
      a builder for type T

    • builder

      public static ServiceSetting.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ServiceSetting.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.