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() When true, the replication job produces encrypted AMIs.
boolean	equals(Object obj)
Integer	frequency() The time between consecutive replication runs, in hours.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
String	kmsKeyId() KMS key ID 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()
List<SdkField<?>>	sdkFields()
Instant	seedReplicationTime() The seed replication time.
static Class<? extends CreateReplicationJobRequest.Builder>	serializableBuilderClass()
String	serverId() The identifier of the server.
CreateReplicationJobRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

serverId

public String serverId()

The identifier of the server.

Returns:

The identifier 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()

Returns:

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 will be deleted once the maximum number is reached and a new AMI is created.

Returns:

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

encrypted

public Boolean encrypted()

When true, the replication job produces encrypted AMIs. See also KmsKeyId below.

Returns:

When true, the replication job produces encrypted AMIs. See also KmsKeyId below.

kmsKeyId

public String kmsKeyId()

KMS key ID for replication jobs that produce encrypted AMIs. Can be any of the following:

• KMS key ID

• KMS key alias

• ARN referring to KMS key ID

• ARN referring to KMS key alias

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

Returns:

KMS key ID for replication jobs that produce encrypted AMIs. Can be any of the following:

• KMS key ID

• KMS key alias

• ARN referring to KMS key ID

• ARN referring to KMS key alias

If encrypted is true but a KMS key id is not specified, the customer's default KMS key for 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 int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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