Class RestoreServerRequest

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

  • Method Details

    • backupId

      public final String backupId()

      The ID of the backup that you want to use to restore a server.

      Returns:
      The ID of the backup that you want to use to restore a server.

    • serverName

      public final String serverName()

      The name of the server that you want to restore.

      Returns:
      The name of the server that you want to restore.

    • instanceType

      public final String instanceType()

      The type of instance to restore. Valid values must be specified in the following format: ^([cm][34]|t2).* For example, m5.large. Valid values are m5.large, r5.xlarge, and r5.2xlarge. If you do not specify this parameter, RestoreServer uses the instance type from the specified backup.

      Returns:
      The type of instance to restore. Valid values must be specified in the following format: ^([cm][34]|t2).* For example, m5.large. Valid values are m5.large, r5.xlarge, and r5.2xlarge. If you do not specify this parameter, RestoreServer uses the instance type from the specified backup.

    • keyPair

      public final String keyPair()

      The name of the key pair to set on the new EC2 instance. This can be helpful if the administrator no longer has the SSH key.

      Returns:
      The name of the key pair to set on the new EC2 instance. This can be helpful if the administrator no longer has the SSH key.

    • toBuilder

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

    • builder

      public static RestoreServerRequest.Builder builder()

    • serializableBuilderClass

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