Mgn

import { Mgn } from "https://aws-api.deno.dev/v0.4/services/mgn.ts?docs=full";

class Mgn {

constructor(apiFactory: client.ApiFactory);

async archiveApplication(params: ArchiveApplicationRequest, opts?: client.RequestOptions): Promise<Application>;

async archiveWave(params: ArchiveWaveRequest, opts?: client.RequestOptions): Promise<Wave>;

async associateApplications(params: AssociateApplicationsRequest, opts?: client.RequestOptions): Promise<void>;

async associateSourceServers(params: AssociateSourceServersRequest, opts?: client.RequestOptions): Promise<void>;

async changeServerLifeCycleState(params: ChangeServerLifeCycleStateRequest, opts?: client.RequestOptions): Promise<SourceServer>;

async createApplication(params: CreateApplicationRequest, opts?: client.RequestOptions): Promise<Application>;

async createLaunchConfigurationTemplate(params?: CreateLaunchConfigurationTemplateRequest, opts?: client.RequestOptions): Promise<LaunchConfigurationTemplate>;

async createReplicationConfigurationTemplate(params: CreateReplicationConfigurationTemplateRequest, opts?: client.RequestOptions): Promise<ReplicationConfigurationTemplate>;

async createWave(params: CreateWaveRequest, opts?: client.RequestOptions): Promise<Wave>;

async deleteApplication(params: DeleteApplicationRequest, opts?: client.RequestOptions): Promise<void>;

async deleteJob(params: DeleteJobRequest, opts?: client.RequestOptions): Promise<void>;

async deleteLaunchConfigurationTemplate(params: DeleteLaunchConfigurationTemplateRequest, opts?: client.RequestOptions): Promise<void>;

async deleteReplicationConfigurationTemplate(params: DeleteReplicationConfigurationTemplateRequest, opts?: client.RequestOptions): Promise<void>;

async deleteSourceServer(params: DeleteSourceServerRequest, opts?: client.RequestOptions): Promise<void>;

async deleteVcenterClient(params: DeleteVcenterClientRequest, opts?: client.RequestOptions): Promise<void>;

async deleteWave(params: DeleteWaveRequest, opts?: client.RequestOptions): Promise<void>;

async describeJobLogItems(params: DescribeJobLogItemsRequest, opts?: client.RequestOptions): Promise<DescribeJobLogItemsResponse>;

async describeJobs(params?: DescribeJobsRequest, opts?: client.RequestOptions): Promise<DescribeJobsResponse>;

async describeLaunchConfigurationTemplates(params?: DescribeLaunchConfigurationTemplatesRequest, opts?: client.RequestOptions): Promise<DescribeLaunchConfigurationTemplatesResponse>;

async describeReplicationConfigurationTemplates(params?: DescribeReplicationConfigurationTemplatesRequest, opts?: client.RequestOptions): Promise<DescribeReplicationConfigurationTemplatesResponse>;

async describeSourceServers(params?: DescribeSourceServersRequest, opts?: client.RequestOptions): Promise<DescribeSourceServersResponse>;

async describeVcenterClients(params?: DescribeVcenterClientsRequest, opts?: client.RequestOptions): Promise<DescribeVcenterClientsResponse>;

async disassociateApplications(params: DisassociateApplicationsRequest, opts?: client.RequestOptions): Promise<void>;

async disassociateSourceServers(params: DisassociateSourceServersRequest, opts?: client.RequestOptions): Promise<void>;

async disconnectFromService(params: DisconnectFromServiceRequest, opts?: client.RequestOptions): Promise<SourceServer>;

async finalizeCutover(params: FinalizeCutoverRequest, opts?: client.RequestOptions): Promise<SourceServer>;

async getLaunchConfiguration(params: GetLaunchConfigurationRequest, opts?: client.RequestOptions): Promise<LaunchConfiguration>;

async getReplicationConfiguration(params: GetReplicationConfigurationRequest, opts?: client.RequestOptions): Promise<ReplicationConfiguration>;

async initializeService(opts?: client.RequestOptions): Promise<void>;

async listApplications(params?: ListApplicationsRequest, opts?: client.RequestOptions): Promise<ListApplicationsResponse>;

async listSourceServerActions(params: ListSourceServerActionsRequest, opts?: client.RequestOptions): Promise<ListSourceServerActionsResponse>;

async listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>;

async listTemplateActions(params: ListTemplateActionsRequest, opts?: client.RequestOptions): Promise<ListTemplateActionsResponse>;

async listWaves(params?: ListWavesRequest, opts?: client.RequestOptions): Promise<ListWavesResponse>;

async markAsArchived(params: MarkAsArchivedRequest, opts?: client.RequestOptions): Promise<SourceServer>;

async putSourceServerAction(params: PutSourceServerActionRequest, opts?: client.RequestOptions): Promise<SourceServerActionDocument>;

async putTemplateAction(params: PutTemplateActionRequest, opts?: client.RequestOptions): Promise<TemplateActionDocument>;

async removeSourceServerAction(params: RemoveSourceServerActionRequest, opts?: client.RequestOptions): Promise<void>;

async removeTemplateAction(params: RemoveTemplateActionRequest, opts?: client.RequestOptions): Promise<void>;

async retryDataReplication(params: RetryDataReplicationRequest, opts?: client.RequestOptions): Promise<SourceServer>;

async startCutover(params: StartCutoverRequest, opts?: client.RequestOptions): Promise<StartCutoverResponse>;

async startReplication(params: StartReplicationRequest, opts?: client.RequestOptions): Promise<SourceServer>;

async startTest(params: StartTestRequest, opts?: client.RequestOptions): Promise<StartTestResponse>;

async tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async terminateTargetInstances(params: TerminateTargetInstancesRequest, opts?: client.RequestOptions): Promise<TerminateTargetInstancesResponse>;

async unarchiveApplication(params: UnarchiveApplicationRequest, opts?: client.RequestOptions): Promise<Application>;

async unarchiveWave(params: UnarchiveWaveRequest, opts?: client.RequestOptions): Promise<Wave>;

async untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async updateApplication(params: UpdateApplicationRequest, opts?: client.RequestOptions): Promise<Application>;

async updateLaunchConfiguration(params: UpdateLaunchConfigurationRequest, opts?: client.RequestOptions): Promise<LaunchConfiguration>;

async updateLaunchConfigurationTemplate(params: UpdateLaunchConfigurationTemplateRequest, opts?: client.RequestOptions): Promise<LaunchConfigurationTemplate>;

async updateReplicationConfiguration(params: UpdateReplicationConfigurationRequest, opts?: client.RequestOptions): Promise<ReplicationConfiguration>;

async updateReplicationConfigurationTemplate(params: UpdateReplicationConfigurationTemplateRequest, opts?: client.RequestOptions): Promise<ReplicationConfigurationTemplate>;

async updateSourceServerReplicationType(params: UpdateSourceServerReplicationTypeRequest, opts?: client.RequestOptions): Promise<SourceServer>;

async updateWave(params: UpdateWaveRequest, opts?: client.RequestOptions): Promise<Wave>;

static ApiMetadata: client.ApiMetadata;

}

§Constructors

new Mgn(apiFactory: client.ApiFactory)

[src]

§Methods

archiveApplication(params: ArchiveApplicationRequest, opts?: client.RequestOptions): Promise<Application>

[src]

Archive application.

archiveWave(params: ArchiveWaveRequest, opts?: client.RequestOptions): Promise<Wave>

[src]

Archive wave.

associateApplications(params: AssociateApplicationsRequest, opts?: client.RequestOptions): Promise<void>

[src]

Associate applications to wave.

associateSourceServers(params: AssociateSourceServersRequest, opts?: client.RequestOptions): Promise<void>

[src]

Associate source servers to application.

changeServerLifeCycleState(params: ChangeServerLifeCycleStateRequest, opts?: client.RequestOptions): Promise<SourceServer>

[src]

Allows the user to set the SourceServer.LifeCycle.state property for specific Source Server IDs to one of the following: READY_FOR_TEST or READY_FOR_CUTOVER. This command only works if the Source Server is already launchable (dataReplicationInfo.lagDuration is not null.)

createApplication(params: CreateApplicationRequest, opts?: client.RequestOptions): Promise<Application>

[src]

Create application.

createLaunchConfigurationTemplate(params?: CreateLaunchConfigurationTemplateRequest, opts?: client.RequestOptions): Promise<LaunchConfigurationTemplate>

[src]

Creates a new Launch Configuration Template.

createReplicationConfigurationTemplate(params: CreateReplicationConfigurationTemplateRequest, opts?: client.RequestOptions): Promise<ReplicationConfigurationTemplate>

[src]

Creates a new ReplicationConfigurationTemplate.

createWave(params: CreateWaveRequest, opts?: client.RequestOptions): Promise<Wave>

[src]

Create wave.

deleteApplication(params: DeleteApplicationRequest, opts?: client.RequestOptions): Promise<void>

[src]

Delete application.

deleteJob(params: DeleteJobRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes a single Job by ID.

deleteLaunchConfigurationTemplate(params: DeleteLaunchConfigurationTemplateRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes a single Launch Configuration Template by ID.

deleteReplicationConfigurationTemplate(params: DeleteReplicationConfigurationTemplateRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes a single Replication Configuration Template by ID

deleteSourceServer(params: DeleteSourceServerRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes a single source server by ID.

deleteVcenterClient(params: DeleteVcenterClientRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes a given vCenter client by ID.

deleteWave(params: DeleteWaveRequest, opts?: client.RequestOptions): Promise<void>

[src]

Delete wave.

describeJobLogItems(params: DescribeJobLogItemsRequest, opts?: client.RequestOptions): Promise<DescribeJobLogItemsResponse>

[src]

Retrieves detailed job log items with paging.

describeJobs(params?: DescribeJobsRequest, opts?: client.RequestOptions): Promise<DescribeJobsResponse>

[src]

Returns a list of Jobs. Use the JobsID and fromDate and toData filters to limit which jobs are returned. The response is sorted by creationDataTime - latest date first. Jobs are normally created by the StartTest, StartCutover, and TerminateTargetInstances 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.

describeLaunchConfigurationTemplates(params?: DescribeLaunchConfigurationTemplatesRequest, opts?: client.RequestOptions): Promise<DescribeLaunchConfigurationTemplatesResponse>

[src]

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

describeReplicationConfigurationTemplates(params?: DescribeReplicationConfigurationTemplatesRequest, opts?: client.RequestOptions): Promise<DescribeReplicationConfigurationTemplatesResponse>

[src]

Lists all ReplicationConfigurationTemplates, filtered by Source Server IDs.

describeSourceServers(params?: DescribeSourceServersRequest, opts?: client.RequestOptions): Promise<DescribeSourceServersResponse>

[src]

Retrieves all SourceServers or multiple SourceServers by ID.

describeVcenterClients(params?: DescribeVcenterClientsRequest, opts?: client.RequestOptions): Promise<DescribeVcenterClientsResponse>

[src]

Returns a list of the installed vCenter clients.

disassociateApplications(params: DisassociateApplicationsRequest, opts?: client.RequestOptions): Promise<void>

[src]

Disassociate applications from wave.

disassociateSourceServers(params: DisassociateSourceServersRequest, opts?: client.RequestOptions): Promise<void>

[src]

Disassociate source servers from application.

disconnectFromService(params: DisconnectFromServiceRequest, opts?: client.RequestOptions): Promise<SourceServer>

[src]

Disconnects specific Source Servers from Application Migration Service. Data replication is stopped immediately. All AWS resources created by Application Migration Service for enabling the replication of these source servers will be terminated / deleted within 90 minutes. Launched Test or Cutover instances will NOT be terminated. If the agent on the source server has not been prevented from communicating with the Application Migration Service 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.

finalizeCutover(params: FinalizeCutoverRequest, opts?: client.RequestOptions): Promise<SourceServer>

[src]

Finalizes the cutover immediately for specific Source Servers. All AWS resources created by Application Migration Service for enabling the replication of these source servers will be terminated / deleted within 90 minutes. Launched Test or Cutover instances will NOT be terminated. The AWS Replication Agent will receive a command to uninstall itself (within 10 minutes). The following properties of the SourceServer will be changed immediately: dataReplicationInfo.dataReplicationState will be changed to DISCONNECTED; The SourceServer.lifeCycle.state will be changed to CUTOVER; The totalStorageBytes property fo each of dataReplicationInfo.replicatedDisks will be set to zero; dataReplicationInfo.lagDuration and dataReplicationInfo.lagDuration will be nullified.

getLaunchConfiguration(params: GetLaunchConfigurationRequest, opts?: client.RequestOptions): Promise<LaunchConfiguration>

[src]

Lists all LaunchConfigurations available, filtered by Source Server IDs.

getReplicationConfiguration(params: GetReplicationConfigurationRequest, opts?: client.RequestOptions): Promise<ReplicationConfiguration>

[src]

Lists all ReplicationConfigurations, filtered by Source Server ID.

initializeService(opts?: client.RequestOptions): Promise<void>

[src]

Initialize Application Migration Service.

listApplications(params?: ListApplicationsRequest, opts?: client.RequestOptions): Promise<ListApplicationsResponse>

[src]

Retrieves all applications or multiple applications by ID.

listSourceServerActions(params: ListSourceServerActionsRequest, opts?: client.RequestOptions): Promise<ListSourceServerActionsResponse>

[src]

List source server post migration custom actions.

listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>

[src]

List all tags for your Application Migration Service resources.

listTemplateActions(params: ListTemplateActionsRequest, opts?: client.RequestOptions): Promise<ListTemplateActionsResponse>

[src]

List template post migration custom actions.

listWaves(params?: ListWavesRequest, opts?: client.RequestOptions): Promise<ListWavesResponse>

[src]

Retrieves all waves or multiple waves by ID.

markAsArchived(params: MarkAsArchivedRequest, opts?: client.RequestOptions): Promise<SourceServer>

[src]

Archives specific Source Servers by setting the SourceServer.isArchived property to true for specified SourceServers by ID. This command only works for SourceServers with a lifecycle. state which equals DISCONNECTED or CUTOVER.

putSourceServerAction(params: PutSourceServerActionRequest, opts?: client.RequestOptions): Promise<SourceServerActionDocument>

[src]

Put source server post migration custom action.

putTemplateAction(params: PutTemplateActionRequest, opts?: client.RequestOptions): Promise<TemplateActionDocument>

[src]

Put template post migration custom action.

removeSourceServerAction(params: RemoveSourceServerActionRequest, opts?: client.RequestOptions): Promise<void>

[src]

Remove source server post migration custom action.

removeTemplateAction(params: RemoveTemplateActionRequest, opts?: client.RequestOptions): Promise<void>

[src]

Remove template post migration custom action.

retryDataReplication(params: RetryDataReplicationRequest, opts?: client.RequestOptions): Promise<SourceServer>

[src]

Causes the data replication initiation sequence to begin immediately upon next Handshake for specified SourceServer IDs, regardless of when the previous initiation started. This command will not work if the SourceServer is not stalled or is in a DISCONNECTED or STOPPED state.

startCutover(params: StartCutoverRequest, opts?: client.RequestOptions): Promise<StartCutoverResponse>

[src]

Launches a Cutover Instance for specific Source Servers. This command starts a LAUNCH job whose initiatedBy property is StartCutover and changes the SourceServer.lifeCycle.state property to CUTTING_OVER.

startReplication(params: StartReplicationRequest, opts?: client.RequestOptions): Promise<SourceServer>

[src]

Starts replication for SNAPSHOT_SHIPPING agents.

startTest(params: StartTestRequest, opts?: client.RequestOptions): Promise<StartTestResponse>

[src]

Launches a Test Instance for specific Source Servers. This command starts a LAUNCH job whose initiatedBy property is StartTest and changes the SourceServer.lifeCycle.state property to TESTING.

tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

Adds or overwrites only the specified tags for the specified Application Migration Service 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.

terminateTargetInstances(params: TerminateTargetInstancesRequest, opts?: client.RequestOptions): Promise<TerminateTargetInstancesResponse>

[src]

Starts a job that terminates specific launched EC2 Test and Cutover instances. This command will not work for any Source Server with a lifecycle.state of TESTING, CUTTING_OVER, or CUTOVER.

unarchiveApplication(params: UnarchiveApplicationRequest, opts?: client.RequestOptions): Promise<Application>

[src]

Unarchive application.

unarchiveWave(params: UnarchiveWaveRequest, opts?: client.RequestOptions): Promise<Wave>

[src]

Unarchive wave.

untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes the specified set of tags from the specified set of Application Migration Service resources.

updateApplication(params: UpdateApplicationRequest, opts?: client.RequestOptions): Promise<Application>

[src]

Update application.

updateLaunchConfiguration(params: UpdateLaunchConfigurationRequest, opts?: client.RequestOptions): Promise<LaunchConfiguration>

[src]

Updates multiple LaunchConfigurations by Source Server ID.

updateLaunchConfigurationTemplate(params: UpdateLaunchConfigurationTemplateRequest, opts?: client.RequestOptions): Promise<LaunchConfigurationTemplate>

[src]

Updates an existing Launch Configuration Template by ID.

updateReplicationConfiguration(params: UpdateReplicationConfigurationRequest, opts?: client.RequestOptions): Promise<ReplicationConfiguration>

[src]

Allows you to update multiple ReplicationConfigurations by Source Server ID.

updateReplicationConfigurationTemplate(params: UpdateReplicationConfigurationTemplateRequest, opts?: client.RequestOptions): Promise<ReplicationConfigurationTemplate>

[src]

Updates multiple ReplicationConfigurationTemplates by ID.

updateSourceServerReplicationType(params: UpdateSourceServerReplicationTypeRequest, opts?: client.RequestOptions): Promise<SourceServer>

[src]

Allows you to change between the AGENT_BASED replication type and the SNAPSHOT_SHIPPING replication type.

updateWave(params: UpdateWaveRequest, opts?: client.RequestOptions): Promise<Wave>

[src]

Update wave.

§Static Properties

ApiMetadata: client.ApiMetadata

[src]