Class CreateReplicationJobRequest

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

  • Method Details

    • serverId

      public final String serverId()

      The ID of the server.

      Returns:
      The ID of the server.

    • seedReplicationTime

      public final Instant seedReplicationTime()

      The seed replication time.

      Returns:
      The seed replication time.

    • frequency

      public final Integer frequency()

      The time between consecutive replication runs, in hours.

      Returns:
      The time between consecutive replication runs, in hours.

    • runOnce

      public final Boolean runOnce()

      Indicates whether to run the replication job one time.

      Returns:
      Indicates whether to run the replication job one time.

    • licenseType

      public final LicenseType licenseType()

      The license type to be used for the AMI created by a successful replication run.

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

      Returns:
      The license type to be used for the AMI created by a successful replication run.
      See Also:

    • licenseTypeAsString

      public final String licenseTypeAsString()

      The license type to be used for the AMI created by a successful replication run.

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

      Returns:
      The license type to be used for the AMI created by a successful replication run.
      See Also:

    • roleName

      public final String roleName()

      The name of the IAM role to be used by the Server Migration Service.

      Returns:
      The name of the IAM role to be used by the Server Migration Service.

    • description

      public final String description()

      The description of the replication job.

      Returns:
      The description of the replication job.

    • numberOfRecentAmisToKeep

      public final Integer numberOfRecentAmisToKeep()

      The maximum number of SMS-created AMIs to retain. The oldest is deleted after the maximum number is reached and a new AMI is created.

      Returns:
      The maximum number of SMS-created AMIs to retain. The oldest is deleted after the maximum number is reached and a new AMI is created.

    • encrypted

      public final Boolean encrypted()

      Indicates whether the replication job produces encrypted AMIs.

      Returns:
      Indicates whether the replication job produces encrypted AMIs.

    • kmsKeyId

      public final String kmsKeyId()

      The ID of the KMS key for replication jobs that produce encrypted AMIs. This value can be any of the following:

      • KMS key ID

      • KMS key alias

      • ARN referring to the KMS key ID

      • ARN referring to the KMS key alias

      If encrypted is true but a KMS key ID is not specified, the customer's default KMS key for Amazon EBS is used.

      Returns:
      The ID of the KMS key for replication jobs that produce encrypted AMIs. This value can be any of the following:

      • KMS key ID

      • KMS key alias

      • ARN referring to the KMS key ID

      • ARN referring to the KMS key alias

      If encrypted is true but a KMS key ID is not specified, the customer's default KMS key for Amazon EBS is used.

    • toBuilder

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

    • builder

      public static CreateReplicationJobRequest.Builder builder()

    • serializableBuilderClass

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