software.amazon.awssdk.services.sms.model

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(value="software.amazon.awssdk:codegen")
public final class CreateReplicationJobRequest
extends SmsRequest
implements ToCopyableBuilder<CreateReplicationJobRequest.Builder,CreateReplicationJobRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateReplicationJobRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateReplicationJobRequest.Builder	builder()
String	description() The description of the replication job.
Boolean	encrypted() Indicates whether the replication job produces encrypted AMIs.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Integer	frequency() The time between consecutive replication runs, in hours.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	kmsKeyId() The ID of the KMS key for replication jobs that produce encrypted AMIs.
LicenseType	licenseType() The license type to be used for the AMI created by a successful replication run.
String	licenseTypeAsString() The license type to be used for the AMI created by a successful replication run.
Integer	numberOfRecentAmisToKeep() The maximum number of SMS-created AMIs to retain.
String	roleName() The name of the IAM role to be used by the AWS SMS.
Boolean	runOnce() Indicates whether to run the replication job one time.
List<SdkField<?>>	sdkFields()
Instant	seedReplicationTime() The seed replication time.
static Class<? extends CreateReplicationJobRequest.Builder>	serializableBuilderClass()
String	serverId() The ID of the server.
CreateReplicationJobRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

serverId

public String serverId()

The ID of the server.

Returns:

The ID of the server.

seedReplicationTime

public Instant seedReplicationTime()

The seed replication time.

Returns:

The seed replication time.

frequency

public Integer frequency()

The time between consecutive replication runs, in hours.

Returns:

The time between consecutive replication runs, in hours.

runOnce

public Boolean runOnce()

Indicates whether to run the replication job one time.

Returns:

Indicates whether to run the replication job one time.

licenseType

public 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:

LicenseType

licenseTypeAsString

public 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:

LicenseType

roleName

public String roleName()

The name of the IAM role to be used by the AWS SMS.

Returns:

The name of the IAM role to be used by the AWS SMS.

description

public String description()

The description of the replication job.

Returns:

The description of the replication job.

numberOfRecentAmisToKeep

public 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 Boolean encrypted()

Indicates whether the replication job produces encrypted AMIs.

Returns:

Indicates whether the replication job produces encrypted AMIs.

kmsKeyId

public 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()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateReplicationJobRequest.Builder,CreateReplicationJobRequest>

Specified by:

toBuilder in class SmsRequest

builder

public static CreateReplicationJobRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo