Struct aws_sdk_dlm::Client

pub struct Client { /* private fields */ }

Client for Amazon Data Lifecycle Manager

Client for invoking operations on Amazon Data Lifecycle Manager. Each operation on Amazon Data Lifecycle Manager 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_dlm::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Builder 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_dlm::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 CreateLifecyclePolicy operation has a Client::create_lifecycle_policy, 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_lifecycle_policy()
    .execution_role_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

impl Client

pub fn create_lifecycle_policy(&self) -> CreateLifecyclePolicyFluentBuilder

Constructs a fluent builder for the CreateLifecyclePolicy operation.

• The fluent builder is configurable:
  • execution_role_arn(impl Into<String>) / set_execution_role_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: true
    

    A description of the lifecycle policy. The characters ^[0-9A-Za-z _-]+$ are supported.

    
    
  • state(SettablePolicyStateValues) / set_state(Option<SettablePolicyStateValues>):
    required: true
    

    The activation state of the lifecycle policy after creation.

    
    
  • policy_details(PolicyDetails) / set_policy_details(Option<PolicyDetails>):
    required: false
    

    The configuration details of the lifecycle policy.

    If you create a default policy, you can specify the request parameters either in the request body, or in the PolicyDetails request structure, but not both.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags to apply to the lifecycle policy during creation.

    
    
  • default_policy(DefaultPolicyTypeValues) / set_default_policy(Option<DefaultPolicyTypeValues>):
    required: false
    

    [Default policies only] Specify the type of default policy to create.

    • To create a default policy for EBS snapshots, that creates snapshots of all volumes in the Region that do not have recent backups, specify VOLUME.

    • To create a default policy for EBS-backed AMIs, that creates EBS-backed AMIs from all instances in the Region that do not have recent backups, specify INSTANCE.

    
    
  • create_interval(i32) / set_create_interval(Option<i32>):
    required: false
    

    [Default policies only] Specifies how often the policy should run and create snapshots or AMIs. The creation frequency can range from 1 to 7 days. If you do not specify a value, the default is 1.

    Default: 1

    
    
  • retain_interval(i32) / set_retain_interval(Option<i32>):
    required: false
    

    [Default policies only] Specifies how long the policy should retain snapshots or AMIs before deleting them. The retention period can range from 2 to 14 days, but it must be greater than the creation frequency to ensure that the policy retains at least 1 snapshot or AMI at any given time. If you do not specify a value, the default is 7.

    Default: 7

    
    
  • copy_tags(bool) / set_copy_tags(Option<bool>):
    required: false
    

    [Default policies only] Indicates whether the policy should copy tags from the source resource to the snapshot or AMI. If you do not specify a value, the default is false.

    Default: false

    
    
  • extend_deletion(bool) / set_extend_deletion(Option<bool>):
    required: false
    

    [Default policies only] Defines the snapshot or AMI retention behavior for the policy if the source volume or instance is deleted, or if the policy enters the error, disabled, or deleted state.

    By default (ExtendDeletion=false):

    • If a source resource is deleted, Amazon Data Lifecycle Manager will continue to delete previously created snapshots or AMIs, up to but not including the last one, based on the specified retention period. If you want Amazon Data Lifecycle Manager to delete all snapshots or AMIs, including the last one, specify true.

    • If a policy enters the error, disabled, or deleted state, Amazon Data Lifecycle Manager stops deleting snapshots and AMIs. If you want Amazon Data Lifecycle Manager to continue deleting snapshots or AMIs, including the last one, if the policy enters one of these states, specify true.

    If you enable extended deletion (ExtendDeletion=true), you override both default behaviors simultaneously.

    If you do not specify a value, the default is false.

    Default: false

    
    
  • cross_region_copy_targets(CrossRegionCopyTarget) / set_cross_region_copy_targets(Option<Vec::<CrossRegionCopyTarget>>):
    required: false
    

    [Default policies only] Specifies destination Regions for snapshot or AMI copies. You can specify up to 3 destination Regions. If you do not want to create cross-Region copies, omit this parameter.

    
    
  • exclusions(Exclusions) / set_exclusions(Option<Exclusions>):
    required: false
    

    [Default policies only] Specifies exclusion parameters for volumes or instances for which you do not want to create snapshots or AMIs. The policy will not create snapshots or AMIs for target resources that match any of the specified exclusion parameters.

    
    
• On success, responds with CreateLifecyclePolicyOutput with field(s):
  • policy_id(Option<String>):

    The identifier of the lifecycle policy.

• On failure, responds with SdkError<CreateLifecyclePolicyError>

impl Client

pub fn delete_lifecycle_policy(&self) -> DeleteLifecyclePolicyFluentBuilder

Constructs a fluent builder for the DeleteLifecyclePolicy operation.

• The fluent builder is configurable:
  • policy_id(impl Into<String>) / set_policy_id(Option<String>):
    required: true
    

    The identifier of the lifecycle policy.

    
    
• On success, responds with DeleteLifecyclePolicyOutput
• On failure, responds with SdkError<DeleteLifecyclePolicyError>

impl Client

pub fn get_lifecycle_policies(&self) -> GetLifecyclePoliciesFluentBuilder

Constructs a fluent builder for the GetLifecyclePolicies operation.

• The fluent builder is configurable:
  • policy_ids(impl Into<String>) / set_policy_ids(Option<Vec::<String>>):
    required: false
    

    The identifiers of the data lifecycle policies.

    
    
  • state(GettablePolicyStateValues) / set_state(Option<GettablePolicyStateValues>):
    required: false
    

    The activation state.

    
    
  • resource_types(ResourceTypeValues) / set_resource_types(Option<Vec::<ResourceTypeValues>>):
    required: false
    

    The resource type.

    
    
  • target_tags(impl Into<String>) / set_target_tags(Option<Vec::<String>>):
    required: false
    

    The target tag for a policy.

    Tags are strings in the format key=value.

    
    
  • tags_to_add(impl Into<String>) / set_tags_to_add(Option<Vec::<String>>):
    required: false
    

    The tags to add to objects created by the policy.

    Tags are strings in the format key=value.

    These user-defined tags are added in addition to the Amazon Web Services-added lifecycle tags.

    
    
  • default_policy_type(DefaultPoliciesTypeValues) / set_default_policy_type(Option<DefaultPoliciesTypeValues>):
    required: false
    

    [Default policies only] Specifies the type of default policy to get. Specify one of the following:

    • VOLUME - To get only the default policy for EBS snapshots

    • INSTANCE - To get only the default policy for EBS-backed AMIs

    • ALL - To get all default policies

    
    
• On success, responds with GetLifecyclePoliciesOutput with field(s):
  • policies(Option<Vec::<LifecyclePolicySummary>>):

    Summary information about the lifecycle policies.

• On failure, responds with SdkError<GetLifecyclePoliciesError>

impl Client

pub fn get_lifecycle_policy(&self) -> GetLifecyclePolicyFluentBuilder

Constructs a fluent builder for the GetLifecyclePolicy operation.

• The fluent builder is configurable:
  • policy_id(impl Into<String>) / set_policy_id(Option<String>):
    required: true
    

    The identifier of the lifecycle policy.

    
    
• On success, responds with GetLifecyclePolicyOutput with field(s):
  • policy(Option<LifecyclePolicy>):

    Detailed information about the lifecycle policy.

• On failure, responds with SdkError<GetLifecyclePolicyError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource.

    
    
• On success, responds with ListTagsForResourceOutput with field(s):
  • tags(Option<HashMap::<String, String>>):

    Information about the tags.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

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: true
    

    The Amazon Resource Name (ARN) of the resource.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: true
    

    One or more tags.

    
    
• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

impl Client

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: true
    

    The Amazon Resource Name (ARN) of the resource.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

    The tag keys.

    
    
• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

impl Client

pub fn update_lifecycle_policy(&self) -> UpdateLifecyclePolicyFluentBuilder

Constructs a fluent builder for the UpdateLifecyclePolicy operation.

• The fluent builder is configurable:
  • policy_id(impl Into<String>) / set_policy_id(Option<String>):
    required: true
    

    The identifier of the lifecycle policy.

    
    
  • execution_role_arn(impl Into<String>) / set_execution_role_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.

    
    
  • state(SettablePolicyStateValues) / set_state(Option<SettablePolicyStateValues>):
    required: false
    

    The desired activation state of the lifecycle policy after creation.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A description of the lifecycle policy.

    
    
  • policy_details(PolicyDetails) / set_policy_details(Option<PolicyDetails>):
    required: false
    

    The configuration of the lifecycle policy. You cannot update the policy type or the resource type.

    
    
  • create_interval(i32) / set_create_interval(Option<i32>):
    required: false
    

    [Default policies only] Specifies how often the policy should run and create snapshots or AMIs. The creation frequency can range from 1 to 7 days.

    
    
  • retain_interval(i32) / set_retain_interval(Option<i32>):
    required: false
    

    [Default policies only] Specifies how long the policy should retain snapshots or AMIs before deleting them. The retention period can range from 2 to 14 days, but it must be greater than the creation frequency to ensure that the policy retains at least 1 snapshot or AMI at any given time.

    
    
  • copy_tags(bool) / set_copy_tags(Option<bool>):
    required: false
    

    [Default policies only] Indicates whether the policy should copy tags from the source resource to the snapshot or AMI.

    
    
  • extend_deletion(bool) / set_extend_deletion(Option<bool>):
    required: false
    

    [Default policies only] Defines the snapshot or AMI retention behavior for the policy if the source volume or instance is deleted, or if the policy enters the error, disabled, or deleted state.

    By default (ExtendDeletion=false):

    • If a source resource is deleted, Amazon Data Lifecycle Manager will continue to delete previously created snapshots or AMIs, up to but not including the last one, based on the specified retention period. If you want Amazon Data Lifecycle Manager to delete all snapshots or AMIs, including the last one, specify true.

    • If a policy enters the error, disabled, or deleted state, Amazon Data Lifecycle Manager stops deleting snapshots and AMIs. If you want Amazon Data Lifecycle Manager to continue deleting snapshots or AMIs, including the last one, if the policy enters one of these states, specify true.

    If you enable extended deletion (ExtendDeletion=true), you override both default behaviors simultaneously.

    Default: false

    
    
  • cross_region_copy_targets(CrossRegionCopyTarget) / set_cross_region_copy_targets(Option<Vec::<CrossRegionCopyTarget>>):
    required: false
    

    [Default policies only] Specifies destination Regions for snapshot or AMI copies. You can specify up to 3 destination Regions. If you do not want to create cross-Region copies, omit this parameter.

    
    
  • exclusions(Exclusions) / set_exclusions(Option<Exclusions>):
    required: false
    

    [Default policies only] Specifies exclusion parameters for volumes or instances for which you do not want to create snapshots or AMIs. The policy will not create snapshots or AMIs for target resources that match any of the specified exclusion parameters.

    
    
• On success, responds with UpdateLifecyclePolicyOutput
• On failure, responds with SdkError<UpdateLifecyclePolicyError>

impl Client

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 and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

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 the sleep_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 the http_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, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.