Class ModifyDbParameterGroupRequest

All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ModifyDbParameterGroupRequest.Builder,ModifyDbParameterGroupRequest>

@Generated("software.amazon.awssdk:codegen") public final class ModifyDbParameterGroupRequest extends RdsRequest implements ToCopyableBuilder<ModifyDbParameterGroupRequest.Builder,ModifyDbParameterGroupRequest>

  • Method Details

    • dbParameterGroupName

      public final String dbParameterGroupName()

      The name of the DB parameter group.

      Constraints:

      • If supplied, must match the name of an existing DBParameterGroup.

      Returns:
      The name of the DB parameter group.

      Constraints:

      • If supplied, must match the name of an existing DBParameterGroup.

    • hasParameters

      public final boolean hasParameters()
      For responses, this returns true if the service returned a value for the Parameters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
    • parameters

      public final List<Parameter> parameters()

      An array of parameter names, values, and the application methods for the parameter update. At least one parameter name, value, and application method must be supplied; later arguments are optional. A maximum of 20 parameters can be modified in a single request.

      Valid Values (for the application method): immediate | pending-reboot

      You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters.

      When the application method is immediate, changes to dynamic parameters are applied immediately to the DB instances associated with the parameter group.

      When the application method is pending-reboot, changes to dynamic and static parameters are applied after a reboot without failover to the DB instances associated with the parameter group.

      You can't use pending-reboot with dynamic parameters on RDS for SQL Server DB instances. Use immediate.

      For more information on modifying DB parameters, see Working with DB parameter groups in the Amazon RDS User Guide.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasParameters() method.

      Returns:
      An array of parameter names, values, and the application methods for the parameter update. At least one parameter name, value, and application method must be supplied; later arguments are optional. A maximum of 20 parameters can be modified in a single request.

      Valid Values (for the application method): immediate | pending-reboot

      You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters.

      When the application method is immediate, changes to dynamic parameters are applied immediately to the DB instances associated with the parameter group.

      When the application method is pending-reboot, changes to dynamic and static parameters are applied after a reboot without failover to the DB instances associated with the parameter group.

      You can't use pending-reboot with dynamic parameters on RDS for SQL Server DB instances. Use immediate.

      For more information on modifying DB parameters, see Working with DB parameter groups in the Amazon RDS User Guide.

    • 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<ModifyDbParameterGroupRequest.Builder,ModifyDbParameterGroupRequest>
      Specified by:
      toBuilder in class RdsRequest
      Returns:
      a builder for type T
    • builder

      public static ModifyDbParameterGroupRequest.Builder builder()
    • serializableBuilderClass

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