SMS class

AWS Server Migration Service (AWS SMS) makes it easier and faster for you to migrate your on-premises workloads to AWS. To learn more about AWS SMS, see the following resources:

Constructors

SMS({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

close() → void

Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.

createApp({String? clientToken, String? description, String? name, String? roleName, List<ServerGroup>? serverGroups, List<Tag>? tags}) → Future<CreateAppResponse>

Creates an application. An application consists of one or more server groups. Each server group contain one or more servers.

createReplicationJob({required DateTime seedReplicationTime, required String serverId, String? description, bool? encrypted, int? frequency, String? kmsKeyId, LicenseType? licenseType, int? numberOfRecentAmisToKeep, String? roleName, bool? runOnce}) → Future<CreateReplicationJobResponse>

Creates a replication job. The replication job schedules periodic replication runs to replicate your server to AWS. Each replication run creates an Amazon Machine Image (AMI).

deleteApp({String? appId, bool? forceStopAppReplication, bool? forceTerminateApp}) → Future<void>

Deletes the specified application. Optionally deletes the launched stack associated with the application and all AWS SMS replication jobs for servers in the application.

deleteAppLaunchConfiguration({String? appId}) → Future<void>

Deletes the launch configuration for the specified application.

deleteAppReplicationConfiguration({String? appId}) → Future<void>

Deletes the replication configuration for the specified application.

deleteAppValidationConfiguration({required String appId}) → Future<void>

Deletes the validation configuration for the specified application.

deleteReplicationJob({required String replicationJobId}) → Future<void>

Deletes the specified replication job.

deleteServerCatalog() → Future<void>

Deletes all servers from your server catalog.

disassociateConnector({required String connectorId}) → Future<void>

Disassociates the specified connector from AWS SMS.

generateChangeSet({String? appId, OutputFormat? changesetFormat}) → Future<GenerateChangeSetResponse>

Generates a target change set for a currently launched stack and writes it to an Amazon S3 object in the customer’s Amazon S3 bucket.

generateTemplate({String? appId, OutputFormat? templateFormat}) → Future<GenerateTemplateResponse>

Generates an AWS CloudFormation template based on the current launch configuration and writes it to an Amazon S3 object in the customer’s Amazon S3 bucket.

getApp({String? appId}) → Future<GetAppResponse>

Retrieve information about the specified application.

getAppLaunchConfiguration({String? appId}) → Future<GetAppLaunchConfigurationResponse>

Retrieves the application launch configuration associated with the specified application.

getAppReplicationConfiguration({String? appId}) → Future<GetAppReplicationConfigurationResponse>

Retrieves the application replication configuration associated with the specified application.

getAppValidationConfiguration({required String appId}) → Future<GetAppValidationConfigurationResponse>

Retrieves information about a configuration for validating an application.

getAppValidationOutput({required String appId}) → Future<GetAppValidationOutputResponse>

Retrieves output from validating an application.

getConnectors({int? maxResults, String? nextToken}) → Future<GetConnectorsResponse>

Describes the connectors registered with the AWS SMS.

getReplicationJobs({int? maxResults, String? nextToken, String? replicationJobId}) → Future<GetReplicationJobsResponse>

Describes the specified replication job or all of your replication jobs.

getReplicationRuns({required String replicationJobId, int? maxResults, String? nextToken}) → Future<GetReplicationRunsResponse>

Describes the replication runs for the specified replication job.

getServers({int? maxResults, String? nextToken, List<VmServerAddress>? vmServerAddressList}) → Future<GetServersResponse>

Describes the servers in your server catalog.

importAppCatalog({String? roleName}) → Future<void>

Allows application import from AWS Migration Hub.

importServerCatalog() → Future<void>

Gathers a complete list of on-premises servers. Connectors must be installed and monitoring all servers to import.

launchApp({String? appId}) → Future<void>

Launches the specified application as a stack in AWS CloudFormation.

listApps({List<String>? appIds, int? maxResults, String? nextToken}) → Future<ListAppsResponse>

Retrieves summaries for all applications.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

notifyAppValidationOutput({required String appId, NotificationContext? notificationContext}) → Future<void>

Provides information to AWS SMS about whether application validation is successful.

putAppLaunchConfiguration({String? appId, bool? autoLaunch, String? roleName, List<ServerGroupLaunchConfiguration>? serverGroupLaunchConfigurations}) → Future<void>

Creates or updates the launch configuration for the specified application.

putAppReplicationConfiguration({String? appId, List<ServerGroupReplicationConfiguration>? serverGroupReplicationConfigurations}) → Future<void>

Creates or updates the replication configuration for the specified application.

putAppValidationConfiguration({required String appId, List<AppValidationConfiguration>? appValidationConfigurations, List<ServerGroupValidationConfiguration>? serverGroupValidationConfigurations}) → Future<void>

Creates or updates a validation configuration for the specified application.

startAppReplication({String? appId}) → Future<void>

Starts replicating the specified application by creating replication jobs for each server in the application.

startOnDemandAppReplication({required String appId, String? description}) → Future<void>

Starts an on-demand replication run for the specified application.

startOnDemandReplicationRun({required String replicationJobId, String? description}) → Future<StartOnDemandReplicationRunResponse>

Starts an on-demand replication run for the specified replication job. This replication run starts immediately. This replication run is in addition to the ones already scheduled.

stopAppReplication({String? appId}) → Future<void>

Stops replicating the specified application by deleting the replication job for each server in the application.

terminateApp({String? appId}) → Future<void>

Terminates the stack for the specified application.

toString() → String

A string representation of this object.

inherited

updateApp({String? appId, String? description, String? name, String? roleName, List<ServerGroup>? serverGroups, List<Tag>? tags}) → Future<UpdateAppResponse>

Updates the specified application.

updateReplicationJob({required String replicationJobId, String? description, bool? encrypted, int? frequency, String? kmsKeyId, LicenseType? licenseType, DateTime? nextReplicationRunStartTime, int? numberOfRecentAmisToKeep, String? roleName}) → Future<void>

Updates the specified settings for the specified replication job.

Operators

operator ==(Object other) → bool

The equality operator.

inherited