drs/aws.sdk.kotlin.services.drs

Package-level declarations

Types

Link copied to clipboard
interface DrsClient : SdkClient

AWS Elastic Disaster Recovery Service.

Properties

Link copied to clipboard
const val SdkVersion: String
Link copied to clipboard
Link copied to clipboard
const val ServiceId: String

Functions

Link copied to clipboard
inline suspend fun DrsClient.associateSourceNetworkStack(crossinline block: AssociateSourceNetworkStackRequest.Builder.() -> Unit): AssociateSourceNetworkStackResponse

Associate a Source Network to an existing CloudFormation Stack and modify launch templates to use this network. Can be used for reverting to previously deployed CloudFormation stacks.

Link copied to clipboard
inline suspend fun DrsClient.createExtendedSourceServer(crossinline block: CreateExtendedSourceServerRequest.Builder.() -> Unit): CreateExtendedSourceServerResponse

Create an extended source server in the target Account based on the source server in staging account.

Link copied to clipboard
inline suspend fun DrsClient.createLaunchConfigurationTemplate(crossinline block: CreateLaunchConfigurationTemplateRequest.Builder.() -> Unit): CreateLaunchConfigurationTemplateResponse

Creates a new Launch Configuration Template.

Link copied to clipboard
Link copied to clipboard
inline suspend fun DrsClient.createSourceNetwork(crossinline block: CreateSourceNetworkRequest.Builder.() -> Unit): CreateSourceNetworkResponse

Create a new Source Network resource for a provided VPC ID.

Link copied to clipboard
inline suspend fun DrsClient.deleteJob(crossinline block: DeleteJobRequest.Builder.() -> Unit): DeleteJobResponse

Deletes a single Job by ID.

Link copied to clipboard
inline suspend fun DrsClient.deleteLaunchAction(crossinline block: DeleteLaunchActionRequest.Builder.() -> Unit): DeleteLaunchActionResponse

Deletes a resource launch action.

Link copied to clipboard
inline suspend fun DrsClient.deleteLaunchConfigurationTemplate(crossinline block: DeleteLaunchConfigurationTemplateRequest.Builder.() -> Unit): DeleteLaunchConfigurationTemplateResponse

Deletes a single Launch Configuration Template by ID.

Link copied to clipboard
inline suspend fun DrsClient.deleteRecoveryInstance(crossinline block: DeleteRecoveryInstanceRequest.Builder.() -> Unit): DeleteRecoveryInstanceResponse

Deletes a single Recovery Instance by ID. This deletes the Recovery Instance resource from Elastic Disaster Recovery. The Recovery Instance must be disconnected first in order to delete it.

Link copied to clipboard
inline suspend fun DrsClient.deleteReplicationConfigurationTemplate(crossinline block: DeleteReplicationConfigurationTemplateRequest.Builder.() -> Unit): DeleteReplicationConfigurationTemplateResponse

Deletes a single Replication Configuration Template by ID

Link copied to clipboard
inline suspend fun DrsClient.deleteSourceNetwork(crossinline block: DeleteSourceNetworkRequest.Builder.() -> Unit): DeleteSourceNetworkResponse

Delete Source Network resource.

Link copied to clipboard
inline suspend fun DrsClient.deleteSourceServer(crossinline block: DeleteSourceServerRequest.Builder.() -> Unit): DeleteSourceServerResponse

Deletes a single Source Server by ID. The Source Server must be disconnected first.

Link copied to clipboard
inline suspend fun DrsClient.describeJobLogItems(crossinline block: DescribeJobLogItemsRequest.Builder.() -> Unit): DescribeJobLogItemsResponse

Retrieves a detailed Job log with pagination.

Link copied to clipboard
inline suspend fun DrsClient.describeJobs(crossinline block: DescribeJobsRequest.Builder.() -> Unit): DescribeJobsResponse

Returns a list of Jobs. Use the JobsID and fromDate and toDate filters to limit which jobs are returned. The response is sorted by creationDataTime - latest date first. Jobs are created by the StartRecovery, TerminateRecoveryInstances and StartFailbackLaunch APIs. Jobs are also created by DiagnosticLaunch and TerminateDiagnosticInstances, which are APIs available only to Support and only used in response to relevant support tickets.

Link copied to clipboard
inline suspend fun DrsClient.describeLaunchConfigurationTemplates(crossinline block: DescribeLaunchConfigurationTemplatesRequest.Builder.() -> Unit): DescribeLaunchConfigurationTemplatesResponse

Lists all Launch Configuration Templates, filtered by Launch Configuration Template IDs

Link copied to clipboard
inline suspend fun DrsClient.describeRecoveryInstances(crossinline block: DescribeRecoveryInstancesRequest.Builder.() -> Unit): DescribeRecoveryInstancesResponse

Lists all Recovery Instances or multiple Recovery Instances by ID.

Link copied to clipboard
inline suspend fun DrsClient.describeRecoverySnapshots(crossinline block: DescribeRecoverySnapshotsRequest.Builder.() -> Unit): DescribeRecoverySnapshotsResponse

Lists all Recovery Snapshots for a single Source Server.

inline suspend fun DrsClient.describeReplicationConfigurationTemplates(crossinline block: DescribeReplicationConfigurationTemplatesRequest.Builder.() -> Unit): DescribeReplicationConfigurationTemplatesResponse

Lists all ReplicationConfigurationTemplates, filtered by Source Server IDs.

Link copied to clipboard
inline suspend fun DrsClient.describeSourceNetworks(crossinline block: DescribeSourceNetworksRequest.Builder.() -> Unit): DescribeSourceNetworksResponse

Lists all Source Networks or multiple Source Networks filtered by ID.

Link copied to clipboard
inline suspend fun DrsClient.describeSourceServers(crossinline block: DescribeSourceServersRequest.Builder.() -> Unit): DescribeSourceServersResponse

Lists all Source Servers or multiple Source Servers filtered by ID.

Link copied to clipboard
inline suspend fun DrsClient.disconnectRecoveryInstance(crossinline block: DisconnectRecoveryInstanceRequest.Builder.() -> Unit): DisconnectRecoveryInstanceResponse

Disconnect a Recovery Instance from Elastic Disaster Recovery. Data replication is stopped immediately. All AWS resources created by Elastic Disaster Recovery for enabling the replication of the Recovery Instance will be terminated / deleted within 90 minutes. If the agent on the Recovery Instance has not been prevented from communicating with the Elastic Disaster Recovery service, then it will receive a command to uninstall itself (within approximately 10 minutes). The following properties of the Recovery Instance will be changed immediately: dataReplicationInfo.dataReplicationState will be set to DISCONNECTED; The totalStorageBytes property for each of dataReplicationInfo.replicatedDisks will be set to zero; dataReplicationInfo.lagDuration and dataReplicationInfo.lagDuration will be nullified.

Link copied to clipboard
inline suspend fun DrsClient.disconnectSourceServer(crossinline block: DisconnectSourceServerRequest.Builder.() -> Unit): DisconnectSourceServerResponse

Disconnects a specific Source Server from Elastic Disaster Recovery. Data replication is stopped immediately. All AWS resources created by Elastic Disaster Recovery for enabling the replication of the Source Server will be terminated / deleted within 90 minutes. You cannot disconnect a Source Server if it has a Recovery Instance. If the agent on the Source Server has not been prevented from communicating with the Elastic Disaster Recovery service, then it will receive a command to uninstall itself (within approximately 10 minutes). The following properties of the SourceServer will be changed immediately: dataReplicationInfo.dataReplicationState will be set to DISCONNECTED; The totalStorageBytes property for each of dataReplicationInfo.replicatedDisks will be set to zero; dataReplicationInfo.lagDuration and dataReplicationInfo.lagDuration will be nullified.

Link copied to clipboard
inline suspend fun DrsClient.exportSourceNetworkCfnTemplate(crossinline block: ExportSourceNetworkCfnTemplateRequest.Builder.() -> Unit): ExportSourceNetworkCfnTemplateResponse

Export the Source Network CloudFormation template to an S3 bucket.

Link copied to clipboard
inline suspend fun DrsClient.getFailbackReplicationConfiguration(crossinline block: GetFailbackReplicationConfigurationRequest.Builder.() -> Unit): GetFailbackReplicationConfigurationResponse

Lists all Failback ReplicationConfigurations, filtered by Recovery Instance ID.

Link copied to clipboard
inline suspend fun DrsClient.getLaunchConfiguration(crossinline block: GetLaunchConfigurationRequest.Builder.() -> Unit): GetLaunchConfigurationResponse

Gets a LaunchConfiguration, filtered by Source Server IDs.

Link copied to clipboard
inline suspend fun DrsClient.getReplicationConfiguration(crossinline block: GetReplicationConfigurationRequest.Builder.() -> Unit): GetReplicationConfigurationResponse

Gets a ReplicationConfiguration, filtered by Source Server ID.

Link copied to clipboard
inline suspend fun DrsClient.initializeService(crossinline block: InitializeServiceRequest.Builder.() -> Unit): InitializeServiceResponse

Initialize Elastic Disaster Recovery.

Link copied to clipboard
inline suspend fun DrsClient.listExtensibleSourceServers(crossinline block: ListExtensibleSourceServersRequest.Builder.() -> Unit): ListExtensibleSourceServersResponse

Returns a list of source servers on a staging account that are extensible, which means that: a. The source server is not already extended into this Account. b. The source server on the Account we’re reading from is not an extension of another source server.

Link copied to clipboard
inline suspend fun DrsClient.listLaunchActions(crossinline block: ListLaunchActionsRequest.Builder.() -> Unit): ListLaunchActionsResponse

Lists resource launch actions.

Link copied to clipboard
inline suspend fun DrsClient.listStagingAccounts(crossinline block: ListStagingAccountsRequest.Builder.() -> Unit): ListStagingAccountsResponse

Returns an array of staging accounts for existing extended source servers.

Link copied to clipboard
inline suspend fun DrsClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

List all tags for your Elastic Disaster Recovery resources.

Link copied to clipboard
inline suspend fun DrsClient.putLaunchAction(crossinline block: PutLaunchActionRequest.Builder.() -> Unit): PutLaunchActionResponse

Puts a resource launch action.

Link copied to clipboard
inline suspend fun DrsClient.retryDataReplication(crossinline block: RetryDataReplicationRequest.Builder.() -> Unit): RetryDataReplicationResponse

WARNING: RetryDataReplication is deprecated. Causes the data replication initiation sequence to begin immediately upon next Handshake for the specified Source Server ID, regardless of when the previous initiation started. This command will work only if the Source Server is stalled or is in a DISCONNECTED or STOPPED state.

Link copied to clipboard
inline suspend fun DrsClient.reverseReplication(crossinline block: ReverseReplicationRequest.Builder.() -> Unit): ReverseReplicationResponse

Start replication to origin / target region - applies only to protected instances that originated in EC2. For recovery instances on target region - starts replication back to origin region. For failback instances on origin region - starts replication to target region to re-protect them.

Link copied to clipboard
inline suspend fun DrsClient.startFailbackLaunch(crossinline block: StartFailbackLaunchRequest.Builder.() -> Unit): StartFailbackLaunchResponse

Initiates a Job for launching the machine that is being failed back to from the specified Recovery Instance. This will run conversion on the failback client and will reboot your machine, thus completing the failback process.

Link copied to clipboard
inline suspend fun DrsClient.startRecovery(crossinline block: StartRecoveryRequest.Builder.() -> Unit): StartRecoveryResponse

Launches Recovery Instances for the specified Source Servers. For each Source Server you may choose a point in time snapshot to launch from, or use an on demand snapshot.

Link copied to clipboard
inline suspend fun DrsClient.startReplication(crossinline block: StartReplicationRequest.Builder.() -> Unit): StartReplicationResponse

Starts replication for a stopped Source Server. This action would make the Source Server protected again and restart billing for it.

Link copied to clipboard
inline suspend fun DrsClient.startSourceNetworkRecovery(crossinline block: StartSourceNetworkRecoveryRequest.Builder.() -> Unit): StartSourceNetworkRecoveryResponse

Deploy VPC for the specified Source Network and modify launch templates to use this network. The VPC will be deployed using a dedicated CloudFormation stack.

Link copied to clipboard
inline suspend fun DrsClient.startSourceNetworkReplication(crossinline block: StartSourceNetworkReplicationRequest.Builder.() -> Unit): StartSourceNetworkReplicationResponse

Starts replication for a Source Network. This action would make the Source Network protected.

Link copied to clipboard
inline suspend fun DrsClient.stopFailback(crossinline block: StopFailbackRequest.Builder.() -> Unit): StopFailbackResponse

Stops the failback process for a specified Recovery Instance. This changes the Failback State of the Recovery Instance back to FAILBACK_NOT_STARTED.

Link copied to clipboard
inline suspend fun DrsClient.stopReplication(crossinline block: StopReplicationRequest.Builder.() -> Unit): StopReplicationResponse

Stops replication for a Source Server. This action would make the Source Server unprotected, delete its existing snapshots and stop billing for it.

Link copied to clipboard
inline suspend fun DrsClient.stopSourceNetworkReplication(crossinline block: StopSourceNetworkReplicationRequest.Builder.() -> Unit): StopSourceNetworkReplicationResponse

Stops replication for a Source Network. This action would make the Source Network unprotected.

Link copied to clipboard
inline suspend fun DrsClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Adds or overwrites only the specified tags for the specified Elastic Disaster Recovery resource or resources. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value.

Link copied to clipboard
inline suspend fun DrsClient.terminateRecoveryInstances(crossinline block: TerminateRecoveryInstancesRequest.Builder.() -> Unit): TerminateRecoveryInstancesResponse

Initiates a Job for terminating the EC2 resources associated with the specified Recovery Instances, and then will delete the Recovery Instances from the Elastic Disaster Recovery service.

Link copied to clipboard
inline suspend fun DrsClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Deletes the specified set of tags from the specified set of Elastic Disaster Recovery resources.

Link copied to clipboard
inline suspend fun DrsClient.updateFailbackReplicationConfiguration(crossinline block: UpdateFailbackReplicationConfigurationRequest.Builder.() -> Unit): UpdateFailbackReplicationConfigurationResponse

Allows you to update the failback replication configuration of a Recovery Instance by ID.

Link copied to clipboard
inline suspend fun DrsClient.updateLaunchConfiguration(crossinline block: UpdateLaunchConfigurationRequest.Builder.() -> Unit): UpdateLaunchConfigurationResponse

Updates a LaunchConfiguration by Source Server ID.

Link copied to clipboard
inline suspend fun DrsClient.updateLaunchConfigurationTemplate(crossinline block: UpdateLaunchConfigurationTemplateRequest.Builder.() -> Unit): UpdateLaunchConfigurationTemplateResponse

Updates an existing Launch Configuration Template by ID.

Link copied to clipboard
inline suspend fun DrsClient.updateReplicationConfiguration(crossinline block: UpdateReplicationConfigurationRequest.Builder.() -> Unit): UpdateReplicationConfigurationResponse

Allows you to update a ReplicationConfiguration by Source Server ID.

Link copied to clipboard
inline suspend fun DrsClient.updateReplicationConfigurationTemplate(crossinline block: UpdateReplicationConfigurationTemplateRequest.Builder.() -> Unit): UpdateReplicationConfigurationTemplateResponse

Updates a ReplicationConfigurationTemplate by ID.

Link copied to clipboard
fun DrsClient.withConfig(block: DrsClient.Config.Builder.() -> Unit): DrsClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.