Class UpdateServiceSettingRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.ssm.model.SsmRequest
software.amazon.awssdk.services.ssm.model.UpdateServiceSettingRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateServiceSettingRequest.Builder,UpdateServiceSettingRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateServiceSettingRequest extends SsmRequest implements ToCopyableBuilder<UpdateServiceSettingRequest.Builder,UpdateServiceSettingRequest>

The request body of the UpdateServiceSetting API operation.

  • Method Details

    • settingId

      public final String settingId()

      The Amazon Resource Name (ARN) of the service setting to update. For example, arn:aws:ssm:us-east-1:111122223333:servicesetting/ssm/parameter-store/high-throughput-enabled. The setting ID can be one of the following.

      • /ssm/managed-instance/default-ec2-instance-management-role

      • /ssm/automation/customer-script-log-destination

      • /ssm/automation/customer-script-log-group-name

      • /ssm/documents/console/public-sharing-permission

      • /ssm/managed-instance/activation-tier

      • /ssm/opsinsights/opscenter

      • /ssm/parameter-store/default-parameter-tier

      • /ssm/parameter-store/high-throughput-enabled

      Permissions to update the /ssm/managed-instance/default-ec2-instance-management-role setting should only be provided to administrators. Implement least privilege access when allowing individuals to configure or modify the Default Host Management Configuration.

      Returns:
      The Amazon Resource Name (ARN) of the service setting to update. For example, arn:aws:ssm:us-east-1:111122223333:servicesetting/ssm/parameter-store/high-throughput-enabled . The setting ID can be one of the following.

      • /ssm/managed-instance/default-ec2-instance-management-role

      • /ssm/automation/customer-script-log-destination

      • /ssm/automation/customer-script-log-group-name

      • /ssm/documents/console/public-sharing-permission

      • /ssm/managed-instance/activation-tier

      • /ssm/opsinsights/opscenter

      • /ssm/parameter-store/default-parameter-tier

      • /ssm/parameter-store/high-throughput-enabled

      Permissions to update the /ssm/managed-instance/default-ec2-instance-management-role setting should only be provided to administrators. Implement least privilege access when allowing individuals to configure or modify the Default Host Management Configuration.

    • settingValue

      public final String settingValue()

      The new value to specify for the service setting. The following list specifies the available values for each setting.

      • For /ssm/managed-instance/default-ec2-instance-management-role, enter the name of an IAM role.

      • For /ssm/automation/customer-script-log-destination, enter CloudWatch.

      • For /ssm/automation/customer-script-log-group-name, enter the name of an Amazon CloudWatch Logs log group.

      • For /ssm/documents/console/public-sharing-permission, enter Enable or Disable.

      • For /ssm/managed-instance/activation-tier, enter standard or advanced.

      • For /ssm/opsinsights/opscenter, enter Enabled or Disabled.

      • For /ssm/parameter-store/default-parameter-tier, enter Standard, Advanced, or Intelligent-Tiering

      • For /ssm/parameter-store/high-throughput-enabled, enter true or false.

      Returns:
      The new value to specify for the service setting. The following list specifies the available values for each setting.

      • For /ssm/managed-instance/default-ec2-instance-management-role, enter the name of an IAM role.

      • For /ssm/automation/customer-script-log-destination, enter CloudWatch.

      • For /ssm/automation/customer-script-log-group-name, enter the name of an Amazon CloudWatch Logs log group.

      • For /ssm/documents/console/public-sharing-permission, enter Enable or Disable.

      • For /ssm/managed-instance/activation-tier, enter standard or advanced.

      • For /ssm/opsinsights/opscenter, enter Enabled or Disabled.

      • For /ssm/parameter-store/default-parameter-tier, enter Standard, Advanced, or Intelligent-Tiering

      • For /ssm/parameter-store/high-throughput-enabled, enter true or false.

    • toBuilder

      public UpdateServiceSettingRequest.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<UpdateServiceSettingRequest.Builder,UpdateServiceSettingRequest>
      Specified by:
      toBuilder in class SsmRequest
      Returns:
      a builder for type T

    • builder

      public static UpdateServiceSettingRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • 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.