software.amazon.awssdk.services.sms.model

Interface ReplicationJob.Builder

All Superinterfaces:

Buildable, CopyableBuilder<ReplicationJob.Builder,ReplicationJob>, SdkBuilder<ReplicationJob.Builder,ReplicationJob>, SdkPojo

Enclosing class:

ReplicationJob

public static interface ReplicationJob.Builder
extends SdkPojo, CopyableBuilder<ReplicationJob.Builder,ReplicationJob>

Method Summary

Modifier and Type	Method and Description
ReplicationJob.Builder	description(String description) The description of the replication job.
ReplicationJob.Builder	encrypted(Boolean encrypted) Indicates whether the replication job should produce encrypted AMIs.
ReplicationJob.Builder	frequency(Integer frequency) The time between consecutive replication runs, in hours.
ReplicationJob.Builder	kmsKeyId(String kmsKeyId) The ID of the KMS key for replication jobs that produce encrypted AMIs.
ReplicationJob.Builder	latestAmiId(String latestAmiId) The ID of the latest Amazon Machine Image (AMI).
ReplicationJob.Builder	licenseType(LicenseType licenseType) The license type to be used for the AMI created by a successful replication run.
ReplicationJob.Builder	licenseType(String licenseType) The license type to be used for the AMI created by a successful replication run.
ReplicationJob.Builder	nextReplicationRunStartTime(Instant nextReplicationRunStartTime) The start time of the next replication run.
ReplicationJob.Builder	numberOfRecentAmisToKeep(Integer numberOfRecentAmisToKeep) The number of recent AMIs to keep in the customer's account for a replication job.
ReplicationJob.Builder	replicationJobId(String replicationJobId) The ID of the replication job.
ReplicationJob.Builder	replicationRunList(Collection<ReplicationRun> replicationRunList) Information about the replication runs.
ReplicationJob.Builder	replicationRunList(Consumer<ReplicationRun.Builder>... replicationRunList) Information about the replication runs.
ReplicationJob.Builder	replicationRunList(ReplicationRun... replicationRunList) Information about the replication runs.
ReplicationJob.Builder	roleName(String roleName) The name of the IAM role to be used by AWS SMS.
ReplicationJob.Builder	runOnce(Boolean runOnce) Indicates whether to run the replication job one time.
ReplicationJob.Builder	seedReplicationTime(Instant seedReplicationTime) The seed replication time.
ReplicationJob.Builder	serverId(String serverId) The ID of the server.
ReplicationJob.Builder	serverType(ServerType serverType) The type of server.
ReplicationJob.Builder	serverType(String serverType) The type of server.
ReplicationJob.Builder	state(ReplicationJobState state) The state of the replication job.
ReplicationJob.Builder	state(String state) The state of the replication job.
ReplicationJob.Builder	statusMessage(String statusMessage) The description of the current status of the replication job.
default ReplicationJob.Builder	vmServer(Consumer<VmServer.Builder> vmServer) Information about the VM server.
ReplicationJob.Builder	vmServer(VmServer vmServer) Information about the VM server.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

replicationJobId

ReplicationJob.Builder replicationJobId(String replicationJobId)

The ID of the replication job.

Parameters:

replicationJobId - The ID of the replication job.

Returns:

Returns a reference to this object so that method calls can be chained together.

serverId

ReplicationJob.Builder serverId(String serverId)

The ID of the server.

Parameters:

serverId - The ID of the server.

Returns:

Returns a reference to this object so that method calls can be chained together.

serverType

ReplicationJob.Builder serverType(String serverType)

The type of server.

Parameters:

serverType - The type of server.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ServerType, ServerType

serverType

ReplicationJob.Builder serverType(ServerType serverType)

The type of server.

Parameters:

serverType - The type of server.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ServerType, ServerType

vmServer

ReplicationJob.Builder vmServer(VmServer vmServer)

Information about the VM server.

Parameters:

vmServer - Information about the VM server.

Returns:

Returns a reference to this object so that method calls can be chained together.

vmServer

default ReplicationJob.Builder vmServer(Consumer<VmServer.Builder> vmServer)

Information about the VM server.

This is a convenience that creates an instance of the VmServer.Builder avoiding the need to create one manually via VmServer.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to vmServer(VmServer).

Parameters:

vmServer - a consumer that will call methods on VmServer.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

vmServer(VmServer)

seedReplicationTime

ReplicationJob.Builder seedReplicationTime(Instant seedReplicationTime)

The seed replication time.

Parameters:

seedReplicationTime - The seed replication time.

Returns:

Returns a reference to this object so that method calls can be chained together.

frequency

ReplicationJob.Builder frequency(Integer frequency)

The time between consecutive replication runs, in hours.

Parameters:

frequency - The time between consecutive replication runs, in hours.

Returns:

Returns a reference to this object so that method calls can be chained together.

runOnce

ReplicationJob.Builder runOnce(Boolean runOnce)

Indicates whether to run the replication job one time.

Parameters:

runOnce - Indicates whether to run the replication job one time.

Returns:

Returns a reference to this object so that method calls can be chained together.

nextReplicationRunStartTime

ReplicationJob.Builder nextReplicationRunStartTime(Instant nextReplicationRunStartTime)

The start time of the next replication run.

Parameters:

nextReplicationRunStartTime - The start time of the next replication run.

Returns:

Returns a reference to this object so that method calls can be chained together.

licenseType

ReplicationJob.Builder licenseType(String licenseType)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

LicenseType, LicenseType

licenseType

ReplicationJob.Builder licenseType(LicenseType licenseType)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

LicenseType, LicenseType

roleName

ReplicationJob.Builder roleName(String roleName)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

latestAmiId

ReplicationJob.Builder latestAmiId(String latestAmiId)

The ID of the latest Amazon Machine Image (AMI).

Parameters:

latestAmiId - The ID of the latest Amazon Machine Image (AMI).

Returns:

Returns a reference to this object so that method calls can be chained together.

state

ReplicationJob.Builder state(String state)

The state of the replication job.

Parameters:

state - The state of the replication job.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ReplicationJobState, ReplicationJobState

state

ReplicationJob.Builder state(ReplicationJobState state)

The state of the replication job.

Parameters:

state - The state of the replication job.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ReplicationJobState, ReplicationJobState

statusMessage

ReplicationJob.Builder statusMessage(String statusMessage)

The description of the current status of the replication job.

Parameters:

statusMessage - The description of the current status of the replication job.

Returns:

Returns a reference to this object so that method calls can be chained together.

description

ReplicationJob.Builder description(String description)

The description of the replication job.

Parameters:

description - The description of the replication job.

Returns:

Returns a reference to this object so that method calls can be chained together.

numberOfRecentAmisToKeep

ReplicationJob.Builder numberOfRecentAmisToKeep(Integer numberOfRecentAmisToKeep)

The number of recent AMIs to keep in the customer's account for a replication job. By default, the value is set to zero, meaning that all AMIs are kept.

Parameters:

numberOfRecentAmisToKeep - The number of recent AMIs to keep in the customer's account for a replication job. By default, the value is set to zero, meaning that all AMIs are kept.

Returns:

Returns a reference to this object so that method calls can be chained together.

encrypted

ReplicationJob.Builder encrypted(Boolean encrypted)

Indicates whether the replication job should produce encrypted AMIs.

Parameters:

encrypted - Indicates whether the replication job should produce encrypted AMIs.

Returns:

Returns a reference to this object so that method calls can be chained together.

kmsKeyId

ReplicationJob.Builder kmsKeyId(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 enabled but a KMS key ID is not specified, the customer's default KMS key for Amazon EBS is used.

Parameters:

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 enabled but a KMS key ID is not specified, the customer's default KMS key for Amazon EBS is used.

Returns:

Returns a reference to this object so that method calls can be chained together.

replicationRunList

ReplicationJob.Builder replicationRunList(Collection<ReplicationRun> replicationRunList)

Information about the replication runs.

Parameters:

replicationRunList - Information about the replication runs.

Returns:

Returns a reference to this object so that method calls can be chained together.

replicationRunList

ReplicationJob.Builder replicationRunList(ReplicationRun... replicationRunList)

Information about the replication runs.

Parameters:

replicationRunList - Information about the replication runs.

Returns:

Returns a reference to this object so that method calls can be chained together.

replicationRunList

ReplicationJob.Builder replicationRunList(Consumer<ReplicationRun.Builder>... replicationRunList)

Information about the replication runs.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #replicationRunList(List).

Parameters:

replicationRunList - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#replicationRunList(List)