Struct aws_sdk_drs::Client
source · pub struct Client { /* private fields */ }
Expand description
Client for Elastic Disaster Recovery Service
Client for invoking operations on Elastic Disaster Recovery Service. Each operation on Elastic Disaster Recovery Service is a method on this
this struct. .send()
MUST be invoked on the generated operations to dispatch the request to the service.
Constructing a Client
A Config
is required to construct a client. For most use cases, the aws-config
crate should be used to automatically resolve this config using
aws_config::load_from_env()
, since this will resolve an SdkConfig
which can be shared
across multiple different AWS SDK clients. This config resolution process can be customized
by calling aws_config::from_env()
instead, which returns a ConfigLoader
that uses
the builder pattern to customize the default config.
In the simplest case, creating a client looks as follows:
let config = aws_config::load_from_env().await;
let client = aws_sdk_drs::Client::new(&config);
Occasionally, SDKs may have additional service-specific that can be set on the Config
that
is absent from SdkConfig
, or slightly different settings for a specific client may be desired.
The Config
struct implements From<&SdkConfig>
, so setting these specific settings can be
done as follows:
let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_drs::config::Builder::from(&sdk_config)
.some_service_specific_setting("value")
.build();
See the aws-config
docs and Config
for more information on customizing configuration.
Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.
Using the Client
A client has a function for every operation that can be performed by the service.
For example, the CreateExtendedSourceServer
operation has
a Client::create_extended_source_server
, function which returns a builder for that operation.
The fluent builder ultimately has a send()
function that returns an async future that
returns a result, as illustrated below:
let result = client.create_extended_source_server()
.source_server_arn("example")
.send()
.await;
The underlying HTTP requests that get made by this can be modified with the customize_operation
function on the fluent builder. See the customize
module for more
information.
Implementations§
source§impl Client
impl Client
sourcepub fn associate_source_network_stack(
&self
) -> AssociateSourceNetworkStackFluentBuilder
pub fn associate_source_network_stack( &self ) -> AssociateSourceNetworkStackFluentBuilder
Constructs a fluent builder for the AssociateSourceNetworkStack
operation.
- The fluent builder is configurable:
source_network_id(impl Into<String>)
/set_source_network_id(Option<String>)
:
required: trueThe Source Network ID to associate with CloudFormation template.
cfn_stack_name(impl Into<String>)
/set_cfn_stack_name(Option<String>)
:
required: trueCloudFormation template to associate with a Source Network.
- On success, responds with
AssociateSourceNetworkStackOutput
with field(s):job(Option<Job>)
:The Source Network association Job.
- On failure, responds with
SdkError<AssociateSourceNetworkStackError>
source§impl Client
impl Client
sourcepub fn create_extended_source_server(
&self
) -> CreateExtendedSourceServerFluentBuilder
pub fn create_extended_source_server( &self ) -> CreateExtendedSourceServerFluentBuilder
Constructs a fluent builder for the CreateExtendedSourceServer
operation.
- The fluent builder is configurable:
source_server_arn(impl Into<String>)
/set_source_server_arn(Option<String>)
:
required: trueThis defines the ARN of the source server in staging Account based on which you want to create an extended source server.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseA list of tags associated with the extended source server.
- On success, responds with
CreateExtendedSourceServerOutput
with field(s):source_server(Option<SourceServer>)
:Created extended source server.
- On failure, responds with
SdkError<CreateExtendedSourceServerError>
source§impl Client
impl Client
sourcepub fn create_launch_configuration_template(
&self
) -> CreateLaunchConfigurationTemplateFluentBuilder
pub fn create_launch_configuration_template( &self ) -> CreateLaunchConfigurationTemplateFluentBuilder
Constructs a fluent builder for the CreateLaunchConfigurationTemplate
operation.
- The fluent builder is configurable:
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseRequest to associate tags during creation of a Launch Configuration Template.
launch_disposition(LaunchDisposition)
/set_launch_disposition(Option<LaunchDisposition>)
:
required: falseLaunch disposition.
target_instance_type_right_sizing_method(TargetInstanceTypeRightSizingMethod)
/set_target_instance_type_right_sizing_method(Option<TargetInstanceTypeRightSizingMethod>)
:
required: falseTarget instance type right-sizing method.
copy_private_ip(bool)
/set_copy_private_ip(Option<bool>)
:
required: falseCopy private IP.
copy_tags(bool)
/set_copy_tags(Option<bool>)
:
required: falseCopy tags.
licensing(Licensing)
/set_licensing(Option<Licensing>)
:
required: falseLicensing.
export_bucket_arn(impl Into<String>)
/set_export_bucket_arn(Option<String>)
:
required: falseS3 bucket ARN to export Source Network templates.
post_launch_enabled(bool)
/set_post_launch_enabled(Option<bool>)
:
required: falseWhether we want to activate post-launch actions.
launch_into_source_instance(bool)
/set_launch_into_source_instance(Option<bool>)
:
required: falseDRS will set the ‘launch into instance ID’ of any source server when performing a drill, recovery or failback to the previous region or availability zone, using the instance ID of the source instance.
- On success, responds with
CreateLaunchConfigurationTemplateOutput
with field(s):launch_configuration_template(Option<LaunchConfigurationTemplate>)
:Created Launch Configuration Template.
- On failure, responds with
SdkError<CreateLaunchConfigurationTemplateError>
source§impl Client
impl Client
sourcepub fn create_replication_configuration_template(
&self
) -> CreateReplicationConfigurationTemplateFluentBuilder
pub fn create_replication_configuration_template( &self ) -> CreateReplicationConfigurationTemplateFluentBuilder
Constructs a fluent builder for the CreateReplicationConfigurationTemplate
operation.
- The fluent builder is configurable:
staging_area_subnet_id(impl Into<String>)
/set_staging_area_subnet_id(Option<String>)
:
required: trueThe subnet to be used by the replication staging area.
associate_default_security_group(bool)
/set_associate_default_security_group(Option<bool>)
:
required: trueWhether to associate the default Elastic Disaster Recovery Security group with the Replication Configuration Template.
replication_servers_security_groups_ids(impl Into<String>)
/set_replication_servers_security_groups_ids(Option<Vec::<String>>)
:
required: trueThe security group IDs that will be used by the replication server.
replication_server_instance_type(impl Into<String>)
/set_replication_server_instance_type(Option<String>)
:
required: trueThe instance type to be used for the replication server.
use_dedicated_replication_server(bool)
/set_use_dedicated_replication_server(Option<bool>)
:
required: trueWhether to use a dedicated Replication Server in the replication staging area.
default_large_staging_disk_type(ReplicationConfigurationDefaultLargeStagingDiskType)
/set_default_large_staging_disk_type(Option<ReplicationConfigurationDefaultLargeStagingDiskType>)
:
required: trueThe Staging Disk EBS volume type to be used during replication.
ebs_encryption(ReplicationConfigurationEbsEncryption)
/set_ebs_encryption(Option<ReplicationConfigurationEbsEncryption>)
:
required: trueThe type of EBS encryption to be used during replication.
ebs_encryption_key_arn(impl Into<String>)
/set_ebs_encryption_key_arn(Option<String>)
:
required: falseThe ARN of the EBS encryption key to be used during replication.
bandwidth_throttling(i64)
/set_bandwidth_throttling(Option<i64>)
:
required: trueConfigure bandwidth throttling for the outbound data transfer rate of the Source Server in Mbps.
data_plane_routing(ReplicationConfigurationDataPlaneRouting)
/set_data_plane_routing(Option<ReplicationConfigurationDataPlaneRouting>)
:
required: trueThe data plane routing mechanism that will be used for replication.
create_public_ip(bool)
/set_create_public_ip(Option<bool>)
:
required: trueWhether to create a Public IP for the Recovery Instance by default.
staging_area_tags(impl Into<String>, impl Into<String>)
/set_staging_area_tags(Option<HashMap::<String, String>>)
:
required: trueA set of tags to be associated with all resources created in the replication staging area: EC2 replication server, EBS volumes, EBS snapshots, etc.
pit_policy(PitPolicyRule)
/set_pit_policy(Option<Vec::<PitPolicyRule>>)
:
required: trueThe Point in time (PIT) policy to manage snapshots taken during replication.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseA set of tags to be associated with the Replication Configuration Template resource.
auto_replicate_new_disks(bool)
/set_auto_replicate_new_disks(Option<bool>)
:
required: falseWhether to allow the AWS replication agent to automatically replicate newly added disks.
- On success, responds with
CreateReplicationConfigurationTemplateOutput
with field(s):replication_configuration_template_id(String)
:The Replication Configuration Template ID.
arn(Option<String>)
:The Replication Configuration Template ARN.
staging_area_subnet_id(Option<String>)
:The subnet to be used by the replication staging area.
associate_default_security_group(Option<bool>)
:Whether to associate the default Elastic Disaster Recovery Security group with the Replication Configuration Template.
replication_servers_security_groups_ids(Option<Vec::<String>>)
:The security group IDs that will be used by the replication server.
replication_server_instance_type(Option<String>)
:The instance type to be used for the replication server.
use_dedicated_replication_server(Option<bool>)
:Whether to use a dedicated Replication Server in the replication staging area.
default_large_staging_disk_type(Option<ReplicationConfigurationDefaultLargeStagingDiskType>)
:The Staging Disk EBS volume type to be used during replication.
ebs_encryption(Option<ReplicationConfigurationEbsEncryption>)
:The type of EBS encryption to be used during replication.
ebs_encryption_key_arn(Option<String>)
:The ARN of the EBS encryption key to be used during replication.
bandwidth_throttling(i64)
:Configure bandwidth throttling for the outbound data transfer rate of the Source Server in Mbps.
data_plane_routing(Option<ReplicationConfigurationDataPlaneRouting>)
:The data plane routing mechanism that will be used for replication.
create_public_ip(Option<bool>)
:Whether to create a Public IP for the Recovery Instance by default.
staging_area_tags(Option<HashMap::<String, String>>)
:A set of tags to be associated with all resources created in the replication staging area: EC2 replication server, EBS volumes, EBS snapshots, etc.
tags(Option<HashMap::<String, String>>)
:A set of tags to be associated with the Replication Configuration Template resource.
pit_policy(Option<Vec::<PitPolicyRule>>)
:The Point in time (PIT) policy to manage snapshots taken during replication.
auto_replicate_new_disks(Option<bool>)
:Whether to allow the AWS replication agent to automatically replicate newly added disks.
- On failure, responds with
SdkError<CreateReplicationConfigurationTemplateError>
source§impl Client
impl Client
sourcepub fn create_source_network(&self) -> CreateSourceNetworkFluentBuilder
pub fn create_source_network(&self) -> CreateSourceNetworkFluentBuilder
Constructs a fluent builder for the CreateSourceNetwork
operation.
- The fluent builder is configurable:
vpc_id(impl Into<String>)
/set_vpc_id(Option<String>)
:
required: trueWhich VPC ID to protect.
origin_account_id(impl Into<String>)
/set_origin_account_id(Option<String>)
:
required: trueAccount containing the VPC to protect.
origin_region(impl Into<String>)
/set_origin_region(Option<String>)
:
required: trueRegion containing the VPC to protect.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseA set of tags to be associated with the Source Network resource.
- On success, responds with
CreateSourceNetworkOutput
with field(s):source_network_id(Option<String>)
:ID of the created Source Network.
- On failure, responds with
SdkError<CreateSourceNetworkError>
source§impl Client
impl Client
sourcepub fn delete_job(&self) -> DeleteJobFluentBuilder
pub fn delete_job(&self) -> DeleteJobFluentBuilder
Constructs a fluent builder for the DeleteJob
operation.
- The fluent builder is configurable:
job_id(impl Into<String>)
/set_job_id(Option<String>)
:
required: trueThe ID of the Job to be deleted.
- On success, responds with
DeleteJobOutput
- On failure, responds with
SdkError<DeleteJobError>
source§impl Client
impl Client
sourcepub fn delete_launch_action(&self) -> DeleteLaunchActionFluentBuilder
pub fn delete_launch_action(&self) -> DeleteLaunchActionFluentBuilder
Constructs a fluent builder for the DeleteLaunchAction
operation.
- The fluent builder is configurable:
resource_id(impl Into<String>)
/set_resource_id(Option<String>)
:
required: trueLaunch configuration template Id or Source Server Id
action_id(impl Into<String>)
/set_action_id(Option<String>)
:
required: trueLaunch action Id.
- On success, responds with
DeleteLaunchActionOutput
- On failure, responds with
SdkError<DeleteLaunchActionError>
source§impl Client
impl Client
sourcepub fn delete_launch_configuration_template(
&self
) -> DeleteLaunchConfigurationTemplateFluentBuilder
pub fn delete_launch_configuration_template( &self ) -> DeleteLaunchConfigurationTemplateFluentBuilder
Constructs a fluent builder for the DeleteLaunchConfigurationTemplate
operation.
- The fluent builder is configurable:
launch_configuration_template_id(impl Into<String>)
/set_launch_configuration_template_id(Option<String>)
:
required: trueThe ID of the Launch Configuration Template to be deleted.
- On success, responds with
DeleteLaunchConfigurationTemplateOutput
- On failure, responds with
SdkError<DeleteLaunchConfigurationTemplateError>
source§impl Client
impl Client
sourcepub fn delete_recovery_instance(&self) -> DeleteRecoveryInstanceFluentBuilder
pub fn delete_recovery_instance(&self) -> DeleteRecoveryInstanceFluentBuilder
Constructs a fluent builder for the DeleteRecoveryInstance
operation.
- The fluent builder is configurable:
recovery_instance_id(impl Into<String>)
/set_recovery_instance_id(Option<String>)
:
required: trueThe ID of the Recovery Instance to be deleted.
- On success, responds with
DeleteRecoveryInstanceOutput
- On failure, responds with
SdkError<DeleteRecoveryInstanceError>
source§impl Client
impl Client
sourcepub fn delete_replication_configuration_template(
&self
) -> DeleteReplicationConfigurationTemplateFluentBuilder
pub fn delete_replication_configuration_template( &self ) -> DeleteReplicationConfigurationTemplateFluentBuilder
Constructs a fluent builder for the DeleteReplicationConfigurationTemplate
operation.
- The fluent builder is configurable:
replication_configuration_template_id(impl Into<String>)
/set_replication_configuration_template_id(Option<String>)
:
required: trueThe ID of the Replication Configuration Template to be deleted.
- On success, responds with
DeleteReplicationConfigurationTemplateOutput
- On failure, responds with
SdkError<DeleteReplicationConfigurationTemplateError>
source§impl Client
impl Client
sourcepub fn delete_source_network(&self) -> DeleteSourceNetworkFluentBuilder
pub fn delete_source_network(&self) -> DeleteSourceNetworkFluentBuilder
Constructs a fluent builder for the DeleteSourceNetwork
operation.
- The fluent builder is configurable:
source_network_id(impl Into<String>)
/set_source_network_id(Option<String>)
:
required: trueID of the Source Network to delete.
- On success, responds with
DeleteSourceNetworkOutput
- On failure, responds with
SdkError<DeleteSourceNetworkError>
source§impl Client
impl Client
sourcepub fn delete_source_server(&self) -> DeleteSourceServerFluentBuilder
pub fn delete_source_server(&self) -> DeleteSourceServerFluentBuilder
Constructs a fluent builder for the DeleteSourceServer
operation.
- The fluent builder is configurable:
source_server_id(impl Into<String>)
/set_source_server_id(Option<String>)
:
required: trueThe ID of the Source Server to be deleted.
- On success, responds with
DeleteSourceServerOutput
- On failure, responds with
SdkError<DeleteSourceServerError>
source§impl Client
impl Client
sourcepub fn describe_job_log_items(&self) -> DescribeJobLogItemsFluentBuilder
pub fn describe_job_log_items(&self) -> DescribeJobLogItemsFluentBuilder
Constructs a fluent builder for the DescribeJobLogItems
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
job_id(impl Into<String>)
/set_job_id(Option<String>)
:
required: trueThe ID of the Job for which Job log items will be retrieved.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseMaximum number of Job log items to retrieve.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe token of the next Job log items to retrieve.
- On success, responds with
DescribeJobLogItemsOutput
with field(s):items(Option<Vec::<JobLog>>)
:An array of Job log items.
next_token(Option<String>)
:The token of the next Job log items to retrieve.
- On failure, responds with
SdkError<DescribeJobLogItemsError>
source§impl Client
impl Client
sourcepub fn describe_jobs(&self) -> DescribeJobsFluentBuilder
pub fn describe_jobs(&self) -> DescribeJobsFluentBuilder
Constructs a fluent builder for the DescribeJobs
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
filters(DescribeJobsRequestFilters)
/set_filters(Option<DescribeJobsRequestFilters>)
:
required: falseA set of filters by which to return Jobs.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseMaximum number of Jobs to retrieve.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe token of the next Job to retrieve.
- On success, responds with
DescribeJobsOutput
with field(s):items(Option<Vec::<Job>>)
:An array of Jobs.
next_token(Option<String>)
:The token of the next Job to retrieve.
- On failure, responds with
SdkError<DescribeJobsError>
source§impl Client
impl Client
sourcepub fn describe_launch_configuration_templates(
&self
) -> DescribeLaunchConfigurationTemplatesFluentBuilder
pub fn describe_launch_configuration_templates( &self ) -> DescribeLaunchConfigurationTemplatesFluentBuilder
Constructs a fluent builder for the DescribeLaunchConfigurationTemplates
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
launch_configuration_template_ids(impl Into<String>)
/set_launch_configuration_template_ids(Option<Vec::<String>>)
:
required: falseRequest to filter Launch Configuration Templates list by Launch Configuration Template ID.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseMaximum results to be returned in DescribeLaunchConfigurationTemplates.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe token of the next Launch Configuration Template to retrieve.
- On success, responds with
DescribeLaunchConfigurationTemplatesOutput
with field(s):items(Option<Vec::<LaunchConfigurationTemplate>>)
:List of items returned by DescribeLaunchConfigurationTemplates.
next_token(Option<String>)
:The token of the next Launch Configuration Template to retrieve.
- On failure, responds with
SdkError<DescribeLaunchConfigurationTemplatesError>
source§impl Client
impl Client
sourcepub fn describe_recovery_instances(
&self
) -> DescribeRecoveryInstancesFluentBuilder
pub fn describe_recovery_instances( &self ) -> DescribeRecoveryInstancesFluentBuilder
Constructs a fluent builder for the DescribeRecoveryInstances
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
filters(DescribeRecoveryInstancesRequestFilters)
/set_filters(Option<DescribeRecoveryInstancesRequestFilters>)
:
required: falseA set of filters by which to return Recovery Instances.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseMaximum number of Recovery Instances to retrieve.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe token of the next Recovery Instance to retrieve.
- On success, responds with
DescribeRecoveryInstancesOutput
with field(s):next_token(Option<String>)
:The token of the next Recovery Instance to retrieve.
items(Option<Vec::<RecoveryInstance>>)
:An array of Recovery Instances.
- On failure, responds with
SdkError<DescribeRecoveryInstancesError>
source§impl Client
impl Client
sourcepub fn describe_recovery_snapshots(
&self
) -> DescribeRecoverySnapshotsFluentBuilder
pub fn describe_recovery_snapshots( &self ) -> DescribeRecoverySnapshotsFluentBuilder
Constructs a fluent builder for the DescribeRecoverySnapshots
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
source_server_id(impl Into<String>)
/set_source_server_id(Option<String>)
:
required: trueFilter Recovery Snapshots by Source Server ID.
filters(DescribeRecoverySnapshotsRequestFilters)
/set_filters(Option<DescribeRecoverySnapshotsRequestFilters>)
:
required: falseA set of filters by which to return Recovery Snapshots.
order(RecoverySnapshotsOrder)
/set_order(Option<RecoverySnapshotsOrder>)
:
required: falseThe sorted ordering by which to return Recovery Snapshots.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseMaximum number of Recovery Snapshots to retrieve.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe token of the next Recovery Snapshot to retrieve.
- On success, responds with
DescribeRecoverySnapshotsOutput
with field(s):items(Option<Vec::<RecoverySnapshot>>)
:An array of Recovery Snapshots.
next_token(Option<String>)
:The token of the next Recovery Snapshot to retrieve.
- On failure, responds with
SdkError<DescribeRecoverySnapshotsError>
source§impl Client
impl Client
sourcepub fn describe_replication_configuration_templates(
&self
) -> DescribeReplicationConfigurationTemplatesFluentBuilder
pub fn describe_replication_configuration_templates( &self ) -> DescribeReplicationConfigurationTemplatesFluentBuilder
Constructs a fluent builder for the DescribeReplicationConfigurationTemplates
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
replication_configuration_template_ids(impl Into<String>)
/set_replication_configuration_template_ids(Option<Vec::<String>>)
:
required: falseThe IDs of the Replication Configuration Templates to retrieve. An empty list means all Replication Configuration Templates.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseMaximum number of Replication Configuration Templates to retrieve.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe token of the next Replication Configuration Template to retrieve.
- On success, responds with
DescribeReplicationConfigurationTemplatesOutput
with field(s):items(Option<Vec::<ReplicationConfigurationTemplate>>)
:An array of Replication Configuration Templates.
next_token(Option<String>)
:The token of the next Replication Configuration Template to retrieve.
- On failure, responds with
SdkError<DescribeReplicationConfigurationTemplatesError>
source§impl Client
impl Client
sourcepub fn describe_source_networks(&self) -> DescribeSourceNetworksFluentBuilder
pub fn describe_source_networks(&self) -> DescribeSourceNetworksFluentBuilder
Constructs a fluent builder for the DescribeSourceNetworks
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
filters(DescribeSourceNetworksRequestFilters)
/set_filters(Option<DescribeSourceNetworksRequestFilters>)
:
required: falseA set of filters by which to return Source Networks.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseMaximum number of Source Networks to retrieve.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe token of the next Source Networks to retrieve.
- On success, responds with
DescribeSourceNetworksOutput
with field(s):items(Option<Vec::<SourceNetwork>>)
:An array of Source Networks.
next_token(Option<String>)
:The token of the next Source Networks to retrieve.
- On failure, responds with
SdkError<DescribeSourceNetworksError>
source§impl Client
impl Client
sourcepub fn describe_source_servers(&self) -> DescribeSourceServersFluentBuilder
pub fn describe_source_servers(&self) -> DescribeSourceServersFluentBuilder
Constructs a fluent builder for the DescribeSourceServers
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
filters(DescribeSourceServersRequestFilters)
/set_filters(Option<DescribeSourceServersRequestFilters>)
:
required: falseA set of filters by which to return Source Servers.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseMaximum number of Source Servers to retrieve.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe token of the next Source Server to retrieve.
- On success, responds with
DescribeSourceServersOutput
with field(s):items(Option<Vec::<SourceServer>>)
:An array of Source Servers.
next_token(Option<String>)
:The token of the next Source Server to retrieve.
- On failure, responds with
SdkError<DescribeSourceServersError>
source§impl Client
impl Client
sourcepub fn disconnect_recovery_instance(
&self
) -> DisconnectRecoveryInstanceFluentBuilder
pub fn disconnect_recovery_instance( &self ) -> DisconnectRecoveryInstanceFluentBuilder
Constructs a fluent builder for the DisconnectRecoveryInstance
operation.
- The fluent builder is configurable:
recovery_instance_id(impl Into<String>)
/set_recovery_instance_id(Option<String>)
:
required: trueThe ID of the Recovery Instance to disconnect.
- On success, responds with
DisconnectRecoveryInstanceOutput
- On failure, responds with
SdkError<DisconnectRecoveryInstanceError>
source§impl Client
impl Client
sourcepub fn disconnect_source_server(&self) -> DisconnectSourceServerFluentBuilder
pub fn disconnect_source_server(&self) -> DisconnectSourceServerFluentBuilder
Constructs a fluent builder for the DisconnectSourceServer
operation.
- The fluent builder is configurable:
source_server_id(impl Into<String>)
/set_source_server_id(Option<String>)
:
required: trueThe ID of the Source Server to disconnect.
- On success, responds with
DisconnectSourceServerOutput
with field(s):source_server_id(Option<String>)
:The ID of the Source Server.
arn(Option<String>)
:The ARN of the Source Server.
tags(Option<HashMap::<String, String>>)
:The tags associated with the Source Server.
recovery_instance_id(Option<String>)
:The ID of the Recovery Instance associated with this Source Server.
last_launch_result(Option<LastLaunchResult>)
:The status of the last recovery launch of this Source Server.
data_replication_info(Option<DataReplicationInfo>)
:The Data Replication Info of the Source Server.
life_cycle(Option<LifeCycle>)
:The lifecycle information of this Source Server.
source_properties(Option<SourceProperties>)
:The source properties of the Source Server.
staging_area(Option<StagingArea>)
:The staging area of the source server.
source_cloud_properties(Option<SourceCloudProperties>)
:Source cloud properties of the Source Server.
replication_direction(Option<ReplicationDirection>)
:Replication direction of the Source Server.
reversed_direction_source_server_arn(Option<String>)
:For EC2-originated Source Servers which have been failed over and then failed back, this value will mean the ARN of the Source Server on the opposite replication direction.
source_network_id(Option<String>)
:ID of the Source Network which is protecting this Source Server’s network.
agent_version(Option<String>)
:The version of the DRS agent installed on the source server
- On failure, responds with
SdkError<DisconnectSourceServerError>
source§impl Client
impl Client
sourcepub fn export_source_network_cfn_template(
&self
) -> ExportSourceNetworkCfnTemplateFluentBuilder
pub fn export_source_network_cfn_template( &self ) -> ExportSourceNetworkCfnTemplateFluentBuilder
Constructs a fluent builder for the ExportSourceNetworkCfnTemplate
operation.
- The fluent builder is configurable:
source_network_id(impl Into<String>)
/set_source_network_id(Option<String>)
:
required: trueThe Source Network ID to export its CloudFormation template to an S3 bucket.
- On success, responds with
ExportSourceNetworkCfnTemplateOutput
with field(s):s3_destination_url(Option<String>)
:S3 bucket URL where the Source Network CloudFormation template was exported to.
- On failure, responds with
SdkError<ExportSourceNetworkCfnTemplateError>
source§impl Client
impl Client
sourcepub fn get_failback_replication_configuration(
&self
) -> GetFailbackReplicationConfigurationFluentBuilder
pub fn get_failback_replication_configuration( &self ) -> GetFailbackReplicationConfigurationFluentBuilder
Constructs a fluent builder for the GetFailbackReplicationConfiguration
operation.
- The fluent builder is configurable:
recovery_instance_id(impl Into<String>)
/set_recovery_instance_id(Option<String>)
:
required: trueThe ID of the Recovery Instance whose failback replication configuration should be returned.
- On success, responds with
GetFailbackReplicationConfigurationOutput
with field(s):recovery_instance_id(String)
:The ID of the Recovery Instance.
name(Option<String>)
:The name of the Failback Replication Configuration.
bandwidth_throttling(i64)
:Configure bandwidth throttling for the outbound data transfer rate of the Recovery Instance in Mbps.
use_private_ip(Option<bool>)
:Whether to use Private IP for the failback replication of the Recovery Instance.
- On failure, responds with
SdkError<GetFailbackReplicationConfigurationError>
source§impl Client
impl Client
sourcepub fn get_launch_configuration(&self) -> GetLaunchConfigurationFluentBuilder
pub fn get_launch_configuration(&self) -> GetLaunchConfigurationFluentBuilder
Constructs a fluent builder for the GetLaunchConfiguration
operation.
- The fluent builder is configurable:
source_server_id(impl Into<String>)
/set_source_server_id(Option<String>)
:
required: trueThe ID of the Source Server that we want to retrieve a Launch Configuration for.
- On success, responds with
GetLaunchConfigurationOutput
with field(s):source_server_id(Option<String>)
:The ID of the Source Server for this launch configuration.
name(Option<String>)
:The name of the launch configuration.
ec2_launch_template_id(Option<String>)
:The EC2 launch template ID of this launch configuration.
launch_disposition(Option<LaunchDisposition>)
:The state of the Recovery Instance in EC2 after the recovery operation.
target_instance_type_right_sizing_method(Option<TargetInstanceTypeRightSizingMethod>)
:Whether Elastic Disaster Recovery should try to automatically choose the instance type that best matches the OS, CPU, and RAM of your Source Server.
copy_private_ip(Option<bool>)
:Whether we should copy the Private IP of the Source Server to the Recovery Instance.
copy_tags(Option<bool>)
:Whether we want to copy the tags of the Source Server to the EC2 machine of the Recovery Instance.
licensing(Option<Licensing>)
:The licensing configuration to be used for this launch configuration.
post_launch_enabled(Option<bool>)
:Whether we want to activate post-launch actions for the Source Server.
launch_into_instance_properties(Option<LaunchIntoInstanceProperties>)
:Launch into existing instance properties.
- On failure, responds with
SdkError<GetLaunchConfigurationError>
source§impl Client
impl Client
sourcepub fn get_replication_configuration(
&self
) -> GetReplicationConfigurationFluentBuilder
pub fn get_replication_configuration( &self ) -> GetReplicationConfigurationFluentBuilder
Constructs a fluent builder for the GetReplicationConfiguration
operation.
- The fluent builder is configurable:
source_server_id(impl Into<String>)
/set_source_server_id(Option<String>)
:
required: trueThe ID of the Source Serve for this Replication Configuration.r
- On success, responds with
GetReplicationConfigurationOutput
with field(s):source_server_id(Option<String>)
:The ID of the Source Server for this Replication Configuration.
name(Option<String>)
:The name of the Replication Configuration.
staging_area_subnet_id(Option<String>)
:The subnet to be used by the replication staging area.
associate_default_security_group(Option<bool>)
:Whether to associate the default Elastic Disaster Recovery Security group with the Replication Configuration.
replication_servers_security_groups_ids(Option<Vec::<String>>)
:The security group IDs that will be used by the replication server.
replication_server_instance_type(Option<String>)
:The instance type to be used for the replication server.
use_dedicated_replication_server(Option<bool>)
:Whether to use a dedicated Replication Server in the replication staging area.
default_large_staging_disk_type(Option<ReplicationConfigurationDefaultLargeStagingDiskType>)
:The Staging Disk EBS volume type to be used during replication.
replicated_disks(Option<Vec::<ReplicationConfigurationReplicatedDisk>>)
:The configuration of the disks of the Source Server to be replicated.
ebs_encryption(Option<ReplicationConfigurationEbsEncryption>)
:The type of EBS encryption to be used during replication.
ebs_encryption_key_arn(Option<String>)
:The ARN of the EBS encryption key to be used during replication.
bandwidth_throttling(i64)
:Configure bandwidth throttling for the outbound data transfer rate of the Source Server in Mbps.
data_plane_routing(Option<ReplicationConfigurationDataPlaneRouting>)
:The data plane routing mechanism that will be used for replication.
create_public_ip(Option<bool>)
:Whether to create a Public IP for the Recovery Instance by default.
staging_area_tags(Option<HashMap::<String, String>>)
:A set of tags to be associated with all resources created in the replication staging area: EC2 replication server, EBS volumes, EBS snapshots, etc.
pit_policy(Option<Vec::<PitPolicyRule>>)
:The Point in time (PIT) policy to manage snapshots taken during replication.
auto_replicate_new_disks(Option<bool>)
:Whether to allow the AWS replication agent to automatically replicate newly added disks.
- On failure, responds with
SdkError<GetReplicationConfigurationError>
source§impl Client
impl Client
sourcepub fn initialize_service(&self) -> InitializeServiceFluentBuilder
pub fn initialize_service(&self) -> InitializeServiceFluentBuilder
Constructs a fluent builder for the InitializeService
operation.
- The fluent builder takes no input, just
send
it. - On success, responds with
InitializeServiceOutput
- On failure, responds with
SdkError<InitializeServiceError>
source§impl Client
impl Client
sourcepub fn list_extensible_source_servers(
&self
) -> ListExtensibleSourceServersFluentBuilder
pub fn list_extensible_source_servers( &self ) -> ListExtensibleSourceServersFluentBuilder
Constructs a fluent builder for the ListExtensibleSourceServers
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
staging_account_id(impl Into<String>)
/set_staging_account_id(Option<String>)
:
required: trueThe Id of the staging Account to retrieve extensible source servers from.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of extensible source servers to retrieve.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe token of the next extensible source server to retrieve.
- On success, responds with
ListExtensibleSourceServersOutput
with field(s):items(Option<Vec::<StagingSourceServer>>)
:A list of source servers on a staging Account that are extensible.
next_token(Option<String>)
:The token of the next extensible source server to retrieve.
- On failure, responds with
SdkError<ListExtensibleSourceServersError>
source§impl Client
impl Client
sourcepub fn list_launch_actions(&self) -> ListLaunchActionsFluentBuilder
pub fn list_launch_actions(&self) -> ListLaunchActionsFluentBuilder
Constructs a fluent builder for the ListLaunchActions
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
resource_id(impl Into<String>)
/set_resource_id(Option<String>)
:
required: trueLaunch configuration template Id or Source Server Id
filters(LaunchActionsRequestFilters)
/set_filters(Option<LaunchActionsRequestFilters>)
:
required: falseFilters to apply when listing resource launch actions.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseMaximum amount of items to return when listing resource launch actions.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseNext token to use when listing resource launch actions.
- On success, responds with
ListLaunchActionsOutput
with field(s):items(Option<Vec::<LaunchAction>>)
:List of resource launch actions.
next_token(Option<String>)
:Next token returned when listing resource launch actions.
- On failure, responds with
SdkError<ListLaunchActionsError>
source§impl Client
impl Client
sourcepub fn list_staging_accounts(&self) -> ListStagingAccountsFluentBuilder
pub fn list_staging_accounts(&self) -> ListStagingAccountsFluentBuilder
Constructs a fluent builder for the ListStagingAccounts
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of staging Accounts to retrieve.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe token of the next staging Account to retrieve.
- On success, responds with
ListStagingAccountsOutput
with field(s):accounts(Option<Vec::<Account>>)
:An array of staging AWS Accounts.
next_token(Option<String>)
:The token of the next staging Account to retrieve.
- On failure, responds with
SdkError<ListStagingAccountsError>
source§impl Client
impl Client
Constructs a fluent builder for the ListTagsForResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe ARN of the resource whose tags should be returned.
- On success, responds with
ListTagsForResourceOutput
with field(s):tags(Option<HashMap::<String, String>>)
:The tags of the requested resource.
- On failure, responds with
SdkError<ListTagsForResourceError>
source§impl Client
impl Client
sourcepub fn put_launch_action(&self) -> PutLaunchActionFluentBuilder
pub fn put_launch_action(&self) -> PutLaunchActionFluentBuilder
Constructs a fluent builder for the PutLaunchAction
operation.
- The fluent builder is configurable:
resource_id(impl Into<String>)
/set_resource_id(Option<String>)
:
required: trueLaunch configuration template Id or Source Server Id
action_code(impl Into<String>)
/set_action_code(Option<String>)
:
required: trueLaunch action code.
order(i32)
/set_order(Option<i32>)
:
required: trueLaunch action order.
action_id(impl Into<String>)
/set_action_id(Option<String>)
:
required: trueLaunch action Id.
optional(bool)
/set_optional(Option<bool>)
:
required: trueWhether the launch will not be marked as failed if this action fails.
active(bool)
/set_active(Option<bool>)
:
required: trueWhether the launch action is active.
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueLaunch action name.
action_version(impl Into<String>)
/set_action_version(Option<String>)
:
required: trueLaunch action version.
category(LaunchActionCategory)
/set_category(Option<LaunchActionCategory>)
:
required: trueLaunch action category.
parameters(impl Into<String>, LaunchActionParameter)
/set_parameters(Option<HashMap::<String, LaunchActionParameter>>)
:
required: falseLaunch action parameters.
description(impl Into<String>)
/set_description(Option<String>)
:
required: trueLaunch action description.
- On success, responds with
PutLaunchActionOutput
with field(s):resource_id(Option<String>)
:Launch configuration template Id or Source Server Id
action_id(Option<String>)
:Launch action Id.
action_code(Option<String>)
:Launch action code.
r#type(Option<LaunchActionType>)
:Launch action type.
name(Option<String>)
:Launch action name.
active(Option<bool>)
:Whether the launch action is active.
order(Option<i32>)
:Launch action order.
action_version(Option<String>)
:Launch action version.
optional(Option<bool>)
:Whether the launch will not be marked as failed if this action fails.
parameters(Option<HashMap::<String, LaunchActionParameter>>)
:Launch action parameters.
description(Option<String>)
:Launch action description.
category(Option<LaunchActionCategory>)
:Launch action category.
- On failure, responds with
SdkError<PutLaunchActionError>
source§impl Client
impl Client
sourcepub fn retry_data_replication(&self) -> RetryDataReplicationFluentBuilder
👎Deprecated: WARNING: RetryDataReplication is deprecated
pub fn retry_data_replication(&self) -> RetryDataReplicationFluentBuilder
Constructs a fluent builder for the RetryDataReplication
operation.
- The fluent builder is configurable:
source_server_id(impl Into<String>)
/set_source_server_id(Option<String>)
:
required: trueThe ID of the Source Server whose data replication should be retried.
- On success, responds with
RetryDataReplicationOutput
with field(s):source_server_id(Option<String>)
:The ID of the Source Server.
arn(Option<String>)
:The ARN of the Source Server.
tags(Option<HashMap::<String, String>>)
:The tags associated with the Source Server.
recovery_instance_id(Option<String>)
:The ID of the Recovery Instance associated with this Source Server.
last_launch_result(Option<LastLaunchResult>)
:The status of the last recovery launch of this Source Server.
data_replication_info(Option<DataReplicationInfo>)
:The Data Replication Info of the Source Server.
life_cycle(Option<LifeCycle>)
:The lifecycle information of this Source Server.
source_properties(Option<SourceProperties>)
:The source properties of the Source Server.
staging_area(Option<StagingArea>)
:The staging area of the source server.
source_cloud_properties(Option<SourceCloudProperties>)
:Source cloud properties of the Source Server.
replication_direction(Option<ReplicationDirection>)
:Replication direction of the Source Server.
reversed_direction_source_server_arn(Option<String>)
:For EC2-originated Source Servers which have been failed over and then failed back, this value will mean the ARN of the Source Server on the opposite replication direction.
source_network_id(Option<String>)
:ID of the Source Network which is protecting this Source Server’s network.
agent_version(Option<String>)
:The version of the DRS agent installed on the source server
- On failure, responds with
SdkError<RetryDataReplicationError>
source§impl Client
impl Client
sourcepub fn reverse_replication(&self) -> ReverseReplicationFluentBuilder
pub fn reverse_replication(&self) -> ReverseReplicationFluentBuilder
Constructs a fluent builder for the ReverseReplication
operation.
- The fluent builder is configurable:
recovery_instance_id(impl Into<String>)
/set_recovery_instance_id(Option<String>)
:
required: trueThe ID of the Recovery Instance that we want to reverse the replication for.
- On success, responds with
ReverseReplicationOutput
with field(s):reversed_direction_source_server_arn(Option<String>)
:ARN of created SourceServer.
- On failure, responds with
SdkError<ReverseReplicationError>
source§impl Client
impl Client
sourcepub fn start_failback_launch(&self) -> StartFailbackLaunchFluentBuilder
pub fn start_failback_launch(&self) -> StartFailbackLaunchFluentBuilder
Constructs a fluent builder for the StartFailbackLaunch
operation.
- The fluent builder is configurable:
recovery_instance_ids(impl Into<String>)
/set_recovery_instance_ids(Option<Vec::<String>>)
:
required: trueThe IDs of the Recovery Instance whose failback launch we want to request.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseThe tags to be associated with the failback launch Job.
- On success, responds with
StartFailbackLaunchOutput
with field(s):job(Option<Job>)
:The failback launch Job.
- On failure, responds with
SdkError<StartFailbackLaunchError>
source§impl Client
impl Client
sourcepub fn start_recovery(&self) -> StartRecoveryFluentBuilder
pub fn start_recovery(&self) -> StartRecoveryFluentBuilder
Constructs a fluent builder for the StartRecovery
operation.
- The fluent builder is configurable:
source_servers(StartRecoveryRequestSourceServer)
/set_source_servers(Option<Vec::<StartRecoveryRequestSourceServer>>)
:
required: trueThe Source Servers that we want to start a Recovery Job for.
is_drill(bool)
/set_is_drill(Option<bool>)
:
required: falseWhether this Source Server Recovery operation is a drill or not.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseThe tags to be associated with the Recovery Job.
- On success, responds with
StartRecoveryOutput
with field(s):job(Option<Job>)
:The Recovery Job.
- On failure, responds with
SdkError<StartRecoveryError>
source§impl Client
impl Client
sourcepub fn start_replication(&self) -> StartReplicationFluentBuilder
pub fn start_replication(&self) -> StartReplicationFluentBuilder
Constructs a fluent builder for the StartReplication
operation.
- The fluent builder is configurable:
source_server_id(impl Into<String>)
/set_source_server_id(Option<String>)
:
required: trueThe ID of the Source Server to start replication for.
- On success, responds with
StartReplicationOutput
with field(s):source_server(Option<SourceServer>)
:The Source Server that this action was targeted on.
- On failure, responds with
SdkError<StartReplicationError>
source§impl Client
impl Client
sourcepub fn start_source_network_recovery(
&self
) -> StartSourceNetworkRecoveryFluentBuilder
pub fn start_source_network_recovery( &self ) -> StartSourceNetworkRecoveryFluentBuilder
Constructs a fluent builder for the StartSourceNetworkRecovery
operation.
- The fluent builder is configurable:
source_networks(StartSourceNetworkRecoveryRequestNetworkEntry)
/set_source_networks(Option<Vec::<StartSourceNetworkRecoveryRequestNetworkEntry>>)
:
required: trueThe Source Networks that we want to start a Recovery Job for.
deploy_as_new(bool)
/set_deploy_as_new(Option<bool>)
:
required: falseDon’t update existing CloudFormation Stack, recover the network using a new stack.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseThe tags to be associated with the Source Network recovery Job.
- On success, responds with
StartSourceNetworkRecoveryOutput
with field(s):job(Option<Job>)
:The Source Network recovery Job.
- On failure, responds with
SdkError<StartSourceNetworkRecoveryError>
source§impl Client
impl Client
sourcepub fn start_source_network_replication(
&self
) -> StartSourceNetworkReplicationFluentBuilder
pub fn start_source_network_replication( &self ) -> StartSourceNetworkReplicationFluentBuilder
Constructs a fluent builder for the StartSourceNetworkReplication
operation.
- The fluent builder is configurable:
source_network_id(impl Into<String>)
/set_source_network_id(Option<String>)
:
required: trueID of the Source Network to replicate.
- On success, responds with
StartSourceNetworkReplicationOutput
with field(s):source_network(Option<SourceNetwork>)
:Source Network which was requested for replication.
- On failure, responds with
SdkError<StartSourceNetworkReplicationError>
source§impl Client
impl Client
sourcepub fn stop_failback(&self) -> StopFailbackFluentBuilder
pub fn stop_failback(&self) -> StopFailbackFluentBuilder
Constructs a fluent builder for the StopFailback
operation.
- The fluent builder is configurable:
recovery_instance_id(impl Into<String>)
/set_recovery_instance_id(Option<String>)
:
required: trueThe ID of the Recovery Instance we want to stop failback for.
- On success, responds with
StopFailbackOutput
- On failure, responds with
SdkError<StopFailbackError>
source§impl Client
impl Client
sourcepub fn stop_replication(&self) -> StopReplicationFluentBuilder
pub fn stop_replication(&self) -> StopReplicationFluentBuilder
Constructs a fluent builder for the StopReplication
operation.
- The fluent builder is configurable:
source_server_id(impl Into<String>)
/set_source_server_id(Option<String>)
:
required: trueThe ID of the Source Server to stop replication for.
- On success, responds with
StopReplicationOutput
with field(s):source_server(Option<SourceServer>)
:The Source Server that this action was targeted on.
- On failure, responds with
SdkError<StopReplicationError>
source§impl Client
impl Client
sourcepub fn stop_source_network_replication(
&self
) -> StopSourceNetworkReplicationFluentBuilder
pub fn stop_source_network_replication( &self ) -> StopSourceNetworkReplicationFluentBuilder
Constructs a fluent builder for the StopSourceNetworkReplication
operation.
- The fluent builder is configurable:
source_network_id(impl Into<String>)
/set_source_network_id(Option<String>)
:
required: trueID of the Source Network to stop replication.
- On success, responds with
StopSourceNetworkReplicationOutput
with field(s):source_network(Option<SourceNetwork>)
:Source Network which was requested to stop replication.
- On failure, responds with
SdkError<StopSourceNetworkReplicationError>
source§impl Client
impl Client
sourcepub fn tag_resource(&self) -> TagResourceFluentBuilder
pub fn tag_resource(&self) -> TagResourceFluentBuilder
Constructs a fluent builder for the TagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueARN of the resource for which tags are to be added or updated.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: trueArray of tags to be added or updated.
- On success, responds with
TagResourceOutput
- On failure, responds with
SdkError<TagResourceError>
source§impl Client
impl Client
sourcepub fn terminate_recovery_instances(
&self
) -> TerminateRecoveryInstancesFluentBuilder
pub fn terminate_recovery_instances( &self ) -> TerminateRecoveryInstancesFluentBuilder
Constructs a fluent builder for the TerminateRecoveryInstances
operation.
- The fluent builder is configurable:
recovery_instance_ids(impl Into<String>)
/set_recovery_instance_ids(Option<Vec::<String>>)
:
required: trueThe IDs of the Recovery Instances that should be terminated.
- On success, responds with
TerminateRecoveryInstancesOutput
with field(s):job(Option<Job>)
:The Job for terminating the Recovery Instances.
- On failure, responds with
SdkError<TerminateRecoveryInstancesError>
source§impl Client
impl Client
sourcepub fn untag_resource(&self) -> UntagResourceFluentBuilder
pub fn untag_resource(&self) -> UntagResourceFluentBuilder
Constructs a fluent builder for the UntagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueARN of the resource for which tags are to be removed.
tag_keys(impl Into<String>)
/set_tag_keys(Option<Vec::<String>>)
:
required: trueArray of tags to be removed.
- On success, responds with
UntagResourceOutput
- On failure, responds with
SdkError<UntagResourceError>
source§impl Client
impl Client
sourcepub fn update_failback_replication_configuration(
&self
) -> UpdateFailbackReplicationConfigurationFluentBuilder
pub fn update_failback_replication_configuration( &self ) -> UpdateFailbackReplicationConfigurationFluentBuilder
Constructs a fluent builder for the UpdateFailbackReplicationConfiguration
operation.
- The fluent builder is configurable:
recovery_instance_id(impl Into<String>)
/set_recovery_instance_id(Option<String>)
:
required: trueThe ID of the Recovery Instance.
name(impl Into<String>)
/set_name(Option<String>)
:
required: falseThe name of the Failback Replication Configuration.
bandwidth_throttling(i64)
/set_bandwidth_throttling(Option<i64>)
:
required: falseConfigure bandwidth throttling for the outbound data transfer rate of the Recovery Instance in Mbps.
use_private_ip(bool)
/set_use_private_ip(Option<bool>)
:
required: falseWhether to use Private IP for the failback replication of the Recovery Instance.
- On success, responds with
UpdateFailbackReplicationConfigurationOutput
- On failure, responds with
SdkError<UpdateFailbackReplicationConfigurationError>
source§impl Client
impl Client
sourcepub fn update_launch_configuration(
&self
) -> UpdateLaunchConfigurationFluentBuilder
pub fn update_launch_configuration( &self ) -> UpdateLaunchConfigurationFluentBuilder
Constructs a fluent builder for the UpdateLaunchConfiguration
operation.
- The fluent builder is configurable:
source_server_id(impl Into<String>)
/set_source_server_id(Option<String>)
:
required: trueThe ID of the Source Server that we want to retrieve a Launch Configuration for.
name(impl Into<String>)
/set_name(Option<String>)
:
required: falseThe name of the launch configuration.
launch_disposition(LaunchDisposition)
/set_launch_disposition(Option<LaunchDisposition>)
:
required: falseThe state of the Recovery Instance in EC2 after the recovery operation.
target_instance_type_right_sizing_method(TargetInstanceTypeRightSizingMethod)
/set_target_instance_type_right_sizing_method(Option<TargetInstanceTypeRightSizingMethod>)
:
required: falseWhether Elastic Disaster Recovery should try to automatically choose the instance type that best matches the OS, CPU, and RAM of your Source Server.
copy_private_ip(bool)
/set_copy_private_ip(Option<bool>)
:
required: falseWhether we should copy the Private IP of the Source Server to the Recovery Instance.
copy_tags(bool)
/set_copy_tags(Option<bool>)
:
required: falseWhether we want to copy the tags of the Source Server to the EC2 machine of the Recovery Instance.
licensing(Licensing)
/set_licensing(Option<Licensing>)
:
required: falseThe licensing configuration to be used for this launch configuration.
post_launch_enabled(bool)
/set_post_launch_enabled(Option<bool>)
:
required: falseWhether we want to enable post-launch actions for the Source Server.
launch_into_instance_properties(LaunchIntoInstanceProperties)
/set_launch_into_instance_properties(Option<LaunchIntoInstanceProperties>)
:
required: falseLaunch into existing instance properties.
- On success, responds with
UpdateLaunchConfigurationOutput
with field(s):source_server_id(Option<String>)
:The ID of the Source Server for this launch configuration.
name(Option<String>)
:The name of the launch configuration.
ec2_launch_template_id(Option<String>)
:The EC2 launch template ID of this launch configuration.
launch_disposition(Option<LaunchDisposition>)
:The state of the Recovery Instance in EC2 after the recovery operation.
target_instance_type_right_sizing_method(Option<TargetInstanceTypeRightSizingMethod>)
:Whether Elastic Disaster Recovery should try to automatically choose the instance type that best matches the OS, CPU, and RAM of your Source Server.
copy_private_ip(Option<bool>)
:Whether we should copy the Private IP of the Source Server to the Recovery Instance.
copy_tags(Option<bool>)
:Whether we want to copy the tags of the Source Server to the EC2 machine of the Recovery Instance.
licensing(Option<Licensing>)
:The licensing configuration to be used for this launch configuration.
post_launch_enabled(Option<bool>)
:Whether we want to activate post-launch actions for the Source Server.
launch_into_instance_properties(Option<LaunchIntoInstanceProperties>)
:Launch into existing instance properties.
- On failure, responds with
SdkError<UpdateLaunchConfigurationError>
source§impl Client
impl Client
sourcepub fn update_launch_configuration_template(
&self
) -> UpdateLaunchConfigurationTemplateFluentBuilder
pub fn update_launch_configuration_template( &self ) -> UpdateLaunchConfigurationTemplateFluentBuilder
Constructs a fluent builder for the UpdateLaunchConfigurationTemplate
operation.
- The fluent builder is configurable:
launch_configuration_template_id(impl Into<String>)
/set_launch_configuration_template_id(Option<String>)
:
required: trueLaunch Configuration Template ID.
launch_disposition(LaunchDisposition)
/set_launch_disposition(Option<LaunchDisposition>)
:
required: falseLaunch disposition.
target_instance_type_right_sizing_method(TargetInstanceTypeRightSizingMethod)
/set_target_instance_type_right_sizing_method(Option<TargetInstanceTypeRightSizingMethod>)
:
required: falseTarget instance type right-sizing method.
copy_private_ip(bool)
/set_copy_private_ip(Option<bool>)
:
required: falseCopy private IP.
copy_tags(bool)
/set_copy_tags(Option<bool>)
:
required: falseCopy tags.
licensing(Licensing)
/set_licensing(Option<Licensing>)
:
required: falseLicensing.
export_bucket_arn(impl Into<String>)
/set_export_bucket_arn(Option<String>)
:
required: falseS3 bucket ARN to export Source Network templates.
post_launch_enabled(bool)
/set_post_launch_enabled(Option<bool>)
:
required: falseWhether we want to activate post-launch actions.
launch_into_source_instance(bool)
/set_launch_into_source_instance(Option<bool>)
:
required: falseDRS will set the ‘launch into instance ID’ of any source server when performing a drill, recovery or failback to the previous region or availability zone, using the instance ID of the source instance.
- On success, responds with
UpdateLaunchConfigurationTemplateOutput
with field(s):launch_configuration_template(Option<LaunchConfigurationTemplate>)
:Updated Launch Configuration Template.
- On failure, responds with
SdkError<UpdateLaunchConfigurationTemplateError>
source§impl Client
impl Client
sourcepub fn update_replication_configuration(
&self
) -> UpdateReplicationConfigurationFluentBuilder
pub fn update_replication_configuration( &self ) -> UpdateReplicationConfigurationFluentBuilder
Constructs a fluent builder for the UpdateReplicationConfiguration
operation.
- The fluent builder is configurable:
source_server_id(impl Into<String>)
/set_source_server_id(Option<String>)
:
required: trueThe ID of the Source Server for this Replication Configuration.
name(impl Into<String>)
/set_name(Option<String>)
:
required: falseThe name of the Replication Configuration.
staging_area_subnet_id(impl Into<String>)
/set_staging_area_subnet_id(Option<String>)
:
required: falseThe subnet to be used by the replication staging area.
associate_default_security_group(bool)
/set_associate_default_security_group(Option<bool>)
:
required: falseWhether to associate the default Elastic Disaster Recovery Security group with the Replication Configuration.
replication_servers_security_groups_ids(impl Into<String>)
/set_replication_servers_security_groups_ids(Option<Vec::<String>>)
:
required: falseThe security group IDs that will be used by the replication server.
replication_server_instance_type(impl Into<String>)
/set_replication_server_instance_type(Option<String>)
:
required: falseThe instance type to be used for the replication server.
use_dedicated_replication_server(bool)
/set_use_dedicated_replication_server(Option<bool>)
:
required: falseWhether to use a dedicated Replication Server in the replication staging area.
default_large_staging_disk_type(ReplicationConfigurationDefaultLargeStagingDiskType)
/set_default_large_staging_disk_type(Option<ReplicationConfigurationDefaultLargeStagingDiskType>)
:
required: falseThe Staging Disk EBS volume type to be used during replication.
replicated_disks(ReplicationConfigurationReplicatedDisk)
/set_replicated_disks(Option<Vec::<ReplicationConfigurationReplicatedDisk>>)
:
required: falseThe configuration of the disks of the Source Server to be replicated.
ebs_encryption(ReplicationConfigurationEbsEncryption)
/set_ebs_encryption(Option<ReplicationConfigurationEbsEncryption>)
:
required: falseThe type of EBS encryption to be used during replication.
ebs_encryption_key_arn(impl Into<String>)
/set_ebs_encryption_key_arn(Option<String>)
:
required: falseThe ARN of the EBS encryption key to be used during replication.
bandwidth_throttling(i64)
/set_bandwidth_throttling(Option<i64>)
:
required: falseConfigure bandwidth throttling for the outbound data transfer rate of the Source Server in Mbps.
data_plane_routing(ReplicationConfigurationDataPlaneRouting)
/set_data_plane_routing(Option<ReplicationConfigurationDataPlaneRouting>)
:
required: falseThe data plane routing mechanism that will be used for replication.
create_public_ip(bool)
/set_create_public_ip(Option<bool>)
:
required: falseWhether to create a Public IP for the Recovery Instance by default.
staging_area_tags(impl Into<String>, impl Into<String>)
/set_staging_area_tags(Option<HashMap::<String, String>>)
:
required: falseA set of tags to be associated with all resources created in the replication staging area: EC2 replication server, EBS volumes, EBS snapshots, etc.
pit_policy(PitPolicyRule)
/set_pit_policy(Option<Vec::<PitPolicyRule>>)
:
required: falseThe Point in time (PIT) policy to manage snapshots taken during replication.
auto_replicate_new_disks(bool)
/set_auto_replicate_new_disks(Option<bool>)
:
required: falseWhether to allow the AWS replication agent to automatically replicate newly added disks.
- On success, responds with
UpdateReplicationConfigurationOutput
with field(s):source_server_id(Option<String>)
:The ID of the Source Server for this Replication Configuration.
name(Option<String>)
:The name of the Replication Configuration.
staging_area_subnet_id(Option<String>)
:The subnet to be used by the replication staging area.
associate_default_security_group(Option<bool>)
:Whether to associate the default Elastic Disaster Recovery Security group with the Replication Configuration.
replication_servers_security_groups_ids(Option<Vec::<String>>)
:The security group IDs that will be used by the replication server.
replication_server_instance_type(Option<String>)
:The instance type to be used for the replication server.
use_dedicated_replication_server(Option<bool>)
:Whether to use a dedicated Replication Server in the replication staging area.
default_large_staging_disk_type(Option<ReplicationConfigurationDefaultLargeStagingDiskType>)
:The Staging Disk EBS volume type to be used during replication.
replicated_disks(Option<Vec::<ReplicationConfigurationReplicatedDisk>>)
:The configuration of the disks of the Source Server to be replicated.
ebs_encryption(Option<ReplicationConfigurationEbsEncryption>)
:The type of EBS encryption to be used during replication.
ebs_encryption_key_arn(Option<String>)
:The ARN of the EBS encryption key to be used during replication.
bandwidth_throttling(i64)
:Configure bandwidth throttling for the outbound data transfer rate of the Source Server in Mbps.
data_plane_routing(Option<ReplicationConfigurationDataPlaneRouting>)
:The data plane routing mechanism that will be used for replication.
create_public_ip(Option<bool>)
:Whether to create a Public IP for the Recovery Instance by default.
staging_area_tags(Option<HashMap::<String, String>>)
:A set of tags to be associated with all resources created in the replication staging area: EC2 replication server, EBS volumes, EBS snapshots, etc.
pit_policy(Option<Vec::<PitPolicyRule>>)
:The Point in time (PIT) policy to manage snapshots taken during replication.
auto_replicate_new_disks(Option<bool>)
:Whether to allow the AWS replication agent to automatically replicate newly added disks.
- On failure, responds with
SdkError<UpdateReplicationConfigurationError>
source§impl Client
impl Client
sourcepub fn update_replication_configuration_template(
&self
) -> UpdateReplicationConfigurationTemplateFluentBuilder
pub fn update_replication_configuration_template( &self ) -> UpdateReplicationConfigurationTemplateFluentBuilder
Constructs a fluent builder for the UpdateReplicationConfigurationTemplate
operation.
- The fluent builder is configurable:
replication_configuration_template_id(impl Into<String>)
/set_replication_configuration_template_id(Option<String>)
:
required: trueThe Replication Configuration Template ID.
arn(impl Into<String>)
/set_arn(Option<String>)
:
required: falseThe Replication Configuration Template ARN.
staging_area_subnet_id(impl Into<String>)
/set_staging_area_subnet_id(Option<String>)
:
required: falseThe subnet to be used by the replication staging area.
associate_default_security_group(bool)
/set_associate_default_security_group(Option<bool>)
:
required: falseWhether to associate the default Elastic Disaster Recovery Security group with the Replication Configuration Template.
replication_servers_security_groups_ids(impl Into<String>)
/set_replication_servers_security_groups_ids(Option<Vec::<String>>)
:
required: falseThe security group IDs that will be used by the replication server.
replication_server_instance_type(impl Into<String>)
/set_replication_server_instance_type(Option<String>)
:
required: falseThe instance type to be used for the replication server.
use_dedicated_replication_server(bool)
/set_use_dedicated_replication_server(Option<bool>)
:
required: falseWhether to use a dedicated Replication Server in the replication staging area.
default_large_staging_disk_type(ReplicationConfigurationDefaultLargeStagingDiskType)
/set_default_large_staging_disk_type(Option<ReplicationConfigurationDefaultLargeStagingDiskType>)
:
required: falseThe Staging Disk EBS volume type to be used during replication.
ebs_encryption(ReplicationConfigurationEbsEncryption)
/set_ebs_encryption(Option<ReplicationConfigurationEbsEncryption>)
:
required: falseThe type of EBS encryption to be used during replication.
ebs_encryption_key_arn(impl Into<String>)
/set_ebs_encryption_key_arn(Option<String>)
:
required: falseThe ARN of the EBS encryption key to be used during replication.
bandwidth_throttling(i64)
/set_bandwidth_throttling(Option<i64>)
:
required: falseConfigure bandwidth throttling for the outbound data transfer rate of the Source Server in Mbps.
data_plane_routing(ReplicationConfigurationDataPlaneRouting)
/set_data_plane_routing(Option<ReplicationConfigurationDataPlaneRouting>)
:
required: falseThe data plane routing mechanism that will be used for replication.
create_public_ip(bool)
/set_create_public_ip(Option<bool>)
:
required: falseWhether to create a Public IP for the Recovery Instance by default.
staging_area_tags(impl Into<String>, impl Into<String>)
/set_staging_area_tags(Option<HashMap::<String, String>>)
:
required: falseA set of tags to be associated with all resources created in the replication staging area: EC2 replication server, EBS volumes, EBS snapshots, etc.
pit_policy(PitPolicyRule)
/set_pit_policy(Option<Vec::<PitPolicyRule>>)
:
required: falseThe Point in time (PIT) policy to manage snapshots taken during replication.
auto_replicate_new_disks(bool)
/set_auto_replicate_new_disks(Option<bool>)
:
required: falseWhether to allow the AWS replication agent to automatically replicate newly added disks.
- On success, responds with
UpdateReplicationConfigurationTemplateOutput
with field(s):replication_configuration_template_id(String)
:The Replication Configuration Template ID.
arn(Option<String>)
:The Replication Configuration Template ARN.
staging_area_subnet_id(Option<String>)
:The subnet to be used by the replication staging area.
associate_default_security_group(Option<bool>)
:Whether to associate the default Elastic Disaster Recovery Security group with the Replication Configuration Template.
replication_servers_security_groups_ids(Option<Vec::<String>>)
:The security group IDs that will be used by the replication server.
replication_server_instance_type(Option<String>)
:The instance type to be used for the replication server.
use_dedicated_replication_server(Option<bool>)
:Whether to use a dedicated Replication Server in the replication staging area.
default_large_staging_disk_type(Option<ReplicationConfigurationDefaultLargeStagingDiskType>)
:The Staging Disk EBS volume type to be used during replication.
ebs_encryption(Option<ReplicationConfigurationEbsEncryption>)
:The type of EBS encryption to be used during replication.
ebs_encryption_key_arn(Option<String>)
:The ARN of the EBS encryption key to be used during replication.
bandwidth_throttling(i64)
:Configure bandwidth throttling for the outbound data transfer rate of the Source Server in Mbps.
data_plane_routing(Option<ReplicationConfigurationDataPlaneRouting>)
:The data plane routing mechanism that will be used for replication.
create_public_ip(Option<bool>)
:Whether to create a Public IP for the Recovery Instance by default.
staging_area_tags(Option<HashMap::<String, String>>)
:A set of tags to be associated with all resources created in the replication staging area: EC2 replication server, EBS volumes, EBS snapshots, etc.
tags(Option<HashMap::<String, String>>)
:A set of tags to be associated with the Replication Configuration Template resource.
pit_policy(Option<Vec::<PitPolicyRule>>)
:The Point in time (PIT) policy to manage snapshots taken during replication.
auto_replicate_new_disks(Option<bool>)
:Whether to allow the AWS replication agent to automatically replicate newly added disks.
- On failure, responds with
SdkError<UpdateReplicationConfigurationTemplateError>
source§impl Client
impl Client
sourcepub fn from_conf(conf: Config) -> Self
pub fn from_conf(conf: Config) -> Self
Creates a new client from the service Config
.
Panics
This method will panic in the following cases:
- Retries or timeouts are enabled without a
sleep_impl
configured. - Identity caching is enabled without a
sleep_impl
andtime_source
configured. - No
behavior_version
is provided.
The panic message for each of these will have instructions on how to resolve them.
source§impl Client
impl Client
sourcepub fn new(sdk_config: &SdkConfig) -> Self
pub fn new(sdk_config: &SdkConfig) -> Self
Creates a new client from an SDK Config.
Panics
- This method will panic if the
sdk_config
is missing an async sleep implementation. If you experience this panic, set thesleep_impl
on the Config passed into this function to fix it. - This method will panic if the
sdk_config
is missing an HTTP connector. If you experience this panic, set thehttp_connector
on the Config passed into this function to fix it. - This method will panic if no
BehaviorVersion
is provided. If you experience this panic, setbehavior_version
on the Config or enable thebehavior-version-latest
Cargo feature.