Class: Aws::DLM::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
Includes:
ClientStubs
Defined in:
lib/aws-sdk-dlm/client.rb

Overview

An API client for DLM. To construct a client, you need to configure a ‘:region` and `:credentials`.

client = Aws::DLM::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).

See #initialize for a full list of supported configuration options.

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials. This can be an instance of any one of the following classes:

    • ‘Aws::Credentials` - Used for configuring static, non-refreshing credentials.

    • ‘Aws::SharedCredentials` - Used for loading static credentials from a shared file, such as `~/.aws/config`.

    • ‘Aws::AssumeRoleCredentials` - Used when you need to assume a role.

    • ‘Aws::AssumeRoleWebIdentityCredentials` - Used when you need to assume a role after providing credentials via the web.

    • ‘Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an access token generated from `aws login`.

    • ‘Aws::ProcessCredentials` - Used for loading credentials from a process that outputs to stdout.

    • ‘Aws::InstanceProfileCredentials` - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • ‘Aws::ECSCredentials` - Used for loading credentials from instances running in ECS.

    • ‘Aws::CognitoIdentityCredentials` - Used for loading credentials from the Cognito Identity service.

    When ‘:credentials` are not configured directly, the following locations will be searched for credentials:

    • ‘Aws.config`

    • The ‘:access_key_id`, `:secret_access_key`, `:session_token`, and `:account_id` options.

    • ENV, ENV, ENV, and ENV

    • ‘~/.aws/credentials`

    • ‘~/.aws/config`

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of ‘Aws::InstanceProfileCredentials` or `Aws::ECSCredentials` to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV to true.

  • :region (required, String) —

    The AWS region to connect to. The configured ‘:region` is used to determine the service `:endpoint`. When not passed, a default `:region` is searched for in the following locations:

  • :access_key_id (String)
  • :account_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to ‘true`, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to `false`.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in ‘adaptive` retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a `RetryCapacityNotAvailableError` and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false —

    When ‘true`, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When ‘true`, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in ‘standard` and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See Aws::DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :disable_request_compression (Boolean) — default: false —

    When set to ‘true’ the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the ‘:endpoint` option directly. This is normally constructed from the `:region` option. Configuring `:endpoint` is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to ‘true`, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the ‘:logger` at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in ‘standard` and `adaptive` retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, ‘default’ is used.

  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the ‘legacy` retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the ‘legacy` retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the ‘legacy` retry mode.

    @see www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the ‘legacy` retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the ‘legacy` retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • ‘legacy` - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • ‘standard` - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • ‘adaptive` - An experimental retry mode that includes all the functionality of `standard` mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default ‘:sigv4a_signing_region_set` is searched for in the following locations:

  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    ** Please note ** When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses ‘NoOpTelemetryProvider` which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the

    ‘opentelemetry-sdk` gem and then, pass in an instance of a `Aws::Telemetry::OTelProvider` for telemetry provider.

  • :token_provider (Aws::TokenProvider) —

    A Bearer Token Provider. This can be an instance of any one of the following classes:

    • ‘Aws::StaticTokenProvider` - Used for configuring static, non-refreshing tokens.

    • ‘Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an access token generated from `aws login`.

    When ‘:token_provider` is not configured directly, the `Aws::TokenProviderChain` will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to ‘true`, dualstack enabled endpoints (with `.aws` TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to ‘true`, fips compatible endpoints will be used if available. When a `fips` region is used, the region is normalized and this config is set to `true`.

  • :validate_params (Boolean) — default: true —

    When ‘true`, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::DLM::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to ‘#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::DLM::EndpointParameters`.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has “Expect” header set to “100-continue”. Defaults to ‘nil` which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like ‘proxy.com:123’.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When ‘true`, HTTP debug output will be sent to the `:logger`.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a ‘content-length`).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When ‘true`, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When ‘true`, SSL peer certificates are verified when establishing a connection.



444
445
446
 
# File 'lib/aws-sdk-dlm/client.rb', line 444

def initialize(*args)
  super
end

Class Attribute Details

.identifier ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



1385
1386
1387
 
# File 'lib/aws-sdk-dlm/client.rb', line 1385

def identifier
  @identifier
end

Class Method Details

.errors_module ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



1388
1389
1390
 
# File 'lib/aws-sdk-dlm/client.rb', line 1388

def errors_module
  Errors
end

Instance Method Details

#build_request(operation_name, params = {}) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

  • params ({}) (defaults to: {}) 


1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
 
# File 'lib/aws-sdk-dlm/client.rb', line 1358

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  tracer = config.telemetry_provider.tracer_provider.tracer(
    Aws::Telemetry.module_to_tracer_name('Aws::DLM')
  )
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config,
    tracer: tracer
  )
  context[:gem_name] = 'aws-sdk-dlm'
  context[:gem_version] = '1.81.0'
  Seahorse::Client::Request.new(handlers, context)
end

#create_lifecycle_policy(params = {}) ⇒ Types::CreateLifecyclePolicyResponse

Creates an Amazon Data Lifecycle Manager lifecycle policy. Amazon Data Lifecycle Manager supports the following policy types:

  • Custom EBS snapshot policy

  • Custom EBS-backed AMI policy

  • Cross-account copy event policy

  • Default policy for EBS snapshots

  • Default policy for EBS-backed AMIs

For more information, see [ Default policies vs custom policies].

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.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/policy-differences.html

Examples:

Request syntax with placeholder values


resp = client.create_lifecycle_policy({
  execution_role_arn: "ExecutionRoleArn", # required
  description: "PolicyDescription", # required
  state: "ENABLED", # required, accepts ENABLED, DISABLED
  policy_details: {
    policy_type: "EBS_SNAPSHOT_MANAGEMENT", # accepts EBS_SNAPSHOT_MANAGEMENT, IMAGE_MANAGEMENT, EVENT_BASED_POLICY
    resource_types: ["VOLUME"], # accepts VOLUME, INSTANCE
    resource_locations: ["CLOUD"], # accepts CLOUD, OUTPOST
    target_tags: [
      {
        key: "String", # required
        value: "String", # required
      },
    ],
    schedules: [
      {
        name: "ScheduleName",
        copy_tags: false,
        tags_to_add: [
          {
            key: "String", # required
            value: "String", # required
          },
        ],
        variable_tags: [
          {
            key: "String", # required
            value: "String", # required
          },
        ],
        create_rule: {
          location: "CLOUD", # accepts CLOUD, OUTPOST_LOCAL
          interval: 1,
          interval_unit: "HOURS", # accepts HOURS
          times: ["Time"],
          cron_expression: "CronExpression",
          scripts: [
            {
              stages: ["PRE"], # accepts PRE, POST
              execution_handler_service: "AWS_SYSTEMS_MANAGER", # accepts AWS_SYSTEMS_MANAGER
              execution_handler: "ExecutionHandler", # required
              execute_operation_on_script_failure: false,
              execution_timeout: 1,
              maximum_retry_count: 1,
            },
          ],
        },
        retain_rule: {
          count: 1,
          interval: 1,
          interval_unit: "DAYS", # accepts DAYS, WEEKS, MONTHS, YEARS
        },
        fast_restore_rule: {
          count: 1,
          interval: 1,
          interval_unit: "DAYS", # accepts DAYS, WEEKS, MONTHS, YEARS
          availability_zones: ["AvailabilityZone"], # required
        },
        cross_region_copy_rules: [
          {
            target_region: "TargetRegion",
            target: "Target",
            encrypted: false, # required
            cmk_arn: "CmkArn",
            copy_tags: false,
            retain_rule: {
              interval: 1,
              interval_unit: "DAYS", # accepts DAYS, WEEKS, MONTHS, YEARS
            },
            deprecate_rule: {
              interval: 1,
              interval_unit: "DAYS", # accepts DAYS, WEEKS, MONTHS, YEARS
            },
          },
        ],
        share_rules: [
          {
            target_accounts: ["AwsAccountId"], # required
            unshare_interval: 1,
            unshare_interval_unit: "DAYS", # accepts DAYS, WEEKS, MONTHS, YEARS
          },
        ],
        deprecate_rule: {
          count: 1,
          interval: 1,
          interval_unit: "DAYS", # accepts DAYS, WEEKS, MONTHS, YEARS
        },
        archive_rule: {
          retain_rule: { # required
            retention_archive_tier: { # required
              count: 1,
              interval: 1,
              interval_unit: "DAYS", # accepts DAYS, WEEKS, MONTHS, YEARS
            },
          },
        },
      },
    ],
    parameters: {
      exclude_boot_volume: false,
      no_reboot: false,
      exclude_data_volume_tags: [
        {
          key: "String", # required
          value: "String", # required
        },
      ],
    },
    event_source: {
      type: "MANAGED_CWE", # required, accepts MANAGED_CWE
      parameters: {
        event_type: "shareSnapshot", # required, accepts shareSnapshot
        snapshot_owner: ["AwsAccountId"], # required
        description_regex: "DescriptionRegex", # required
      },
    },
    actions: [
      {
        name: "ActionName", # required
        cross_region_copy: [ # required
          {
            target: "Target", # required
            encryption_configuration: { # required
              encrypted: false, # required
              cmk_arn: "CmkArn",
            },
            retain_rule: {
              interval: 1,
              interval_unit: "DAYS", # accepts DAYS, WEEKS, MONTHS, YEARS
            },
          },
        ],
      },
    ],
    policy_language: "SIMPLIFIED", # accepts SIMPLIFIED, STANDARD
    resource_type: "VOLUME", # accepts VOLUME, INSTANCE
    create_interval: 1,
    retain_interval: 1,
    copy_tags: false,
    cross_region_copy_targets: [
      {
        target_region: "TargetRegion",
      },
    ],
    extend_deletion: false,
    exclusions: {
      exclude_boot_volumes: false,
      exclude_volume_types: ["VolumeTypeValues"],
      exclude_tags: [
        {
          key: "String", # required
          value: "String", # required
        },
      ],
    },
  },
  tags: {
    "TagKey" => "TagValue",
  },
  default_policy: "VOLUME", # accepts VOLUME, INSTANCE
  create_interval: 1,
  retain_interval: 1,
  copy_tags: false,
  extend_deletion: false,
  cross_region_copy_targets: [
    {
      target_region: "TargetRegion",
    },
  ],
  exclusions: {
    exclude_boot_volumes: false,
    exclude_volume_types: ["VolumeTypeValues"],
    exclude_tags: [
      {
        key: "String", # required
        value: "String", # required
      },
    ],
  },
})

Response structure


resp.policy_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :execution_role_arn (required, String) —

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

  • :description (required, String) —

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

  • :state (required, String) —

    The activation state of the lifecycle policy after creation.

  • :policy_details (Types::PolicyDetails) —

    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 (Hash<String,String>) —

    The tags to apply to the lifecycle policy during creation.

  • :default_policy (String) —

    **[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 (Integer) —

    **[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 (Integer) —

    **[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 (Boolean) —

    **[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 (Boolean) —

    **[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 (Array<Types::CrossRegionCopyTarget>) —

    **[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 (Types::Exclusions) —

    **[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.

Returns:

See Also:



761
762
763
764
 
# File 'lib/aws-sdk-dlm/client.rb', line 761

def create_lifecycle_policy(params = {}, options = {})
  req = build_request(:create_lifecycle_policy, params)
  req.send_request(options)
end

#delete_lifecycle_policy(params = {}) ⇒ Struct

Deletes the specified lifecycle policy and halts the automated operations that the policy specified.

For more information about deleting a policy, see [Delete lifecycle policies].

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/view-modify-delete.html#delete

Examples:

Request syntax with placeholder values


resp = client.delete_lifecycle_policy({
  policy_id: "PolicyId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :policy_id (required, String) —

    The identifier of the lifecycle policy.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



791
792
793
794
 
# File 'lib/aws-sdk-dlm/client.rb', line 791

def delete_lifecycle_policy(params = {}, options = {})
  req = build_request(:delete_lifecycle_policy, params)
  req.send_request(options)
end

#get_lifecycle_policies(params = {}) ⇒ Types::GetLifecyclePoliciesResponse

Gets summary information about all or the specified data lifecycle policies.

To get complete information about a policy, use [GetLifecyclePolicy].

[1]: docs.aws.amazon.com/dlm/latest/APIReference/API_GetLifecyclePolicy.html

Examples:

Request syntax with placeholder values


resp = client.get_lifecycle_policies({
  policy_ids: ["PolicyId"],
  state: "ENABLED", # accepts ENABLED, DISABLED, ERROR
  resource_types: ["VOLUME"], # accepts VOLUME, INSTANCE
  target_tags: ["TagFilter"],
  tags_to_add: ["TagFilter"],
  default_policy_type: "VOLUME", # accepts VOLUME, INSTANCE, ALL
})

Response structure


resp.policies #=> Array
resp.policies[0].policy_id #=> String
resp.policies[0].description #=> String
resp.policies[0].state #=> String, one of "ENABLED", "DISABLED", "ERROR"
resp.policies[0].tags #=> Hash
resp.policies[0].tags["TagKey"] #=> String
resp.policies[0].policy_type #=> String, one of "EBS_SNAPSHOT_MANAGEMENT", "IMAGE_MANAGEMENT", "EVENT_BASED_POLICY"
resp.policies[0].default_policy #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :policy_ids (Array<String>) —

    The identifiers of the data lifecycle policies.

  • :state (String) —

    The activation state.

  • :resource_types (Array<String>) —

    The resource type.

  • :target_tags (Array<String>) —

    The target tag for a policy.

    Tags are strings in the format ‘key=value`.

  • :tags_to_add (Array<String>) —

    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 (String) —

    **[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

Returns:

See Also:



868
869
870
871
 
# File 'lib/aws-sdk-dlm/client.rb', line 868

def get_lifecycle_policies(params = {}, options = {})
  req = build_request(:get_lifecycle_policies, params)
  req.send_request(options)
end

#get_lifecycle_policy(params = {}) ⇒ Types::GetLifecyclePolicyResponse

Gets detailed information about the specified lifecycle policy.

Examples:

Request syntax with placeholder values


resp = client.get_lifecycle_policy({
  policy_id: "PolicyId", # required
})

Response structure


resp.policy.policy_id #=> String
resp.policy.description #=> String
resp.policy.state #=> String, one of "ENABLED", "DISABLED", "ERROR"
resp.policy.status_message #=> String
resp.policy.execution_role_arn #=> String
resp.policy.date_created #=> Time
resp.policy.date_modified #=> Time
resp.policy.policy_details.policy_type #=> String, one of "EBS_SNAPSHOT_MANAGEMENT", "IMAGE_MANAGEMENT", "EVENT_BASED_POLICY"
resp.policy.policy_details.resource_types #=> Array
resp.policy.policy_details.resource_types[0] #=> String, one of "VOLUME", "INSTANCE"
resp.policy.policy_details.resource_locations #=> Array
resp.policy.policy_details.resource_locations[0] #=> String, one of "CLOUD", "OUTPOST"
resp.policy.policy_details.target_tags #=> Array
resp.policy.policy_details.target_tags[0].key #=> String
resp.policy.policy_details.target_tags[0].value #=> String
resp.policy.policy_details.schedules #=> Array
resp.policy.policy_details.schedules[0].name #=> String
resp.policy.policy_details.schedules[0].copy_tags #=> Boolean
resp.policy.policy_details.schedules[0].tags_to_add #=> Array
resp.policy.policy_details.schedules[0].tags_to_add[0].key #=> String
resp.policy.policy_details.schedules[0].tags_to_add[0].value #=> String
resp.policy.policy_details.schedules[0].variable_tags #=> Array
resp.policy.policy_details.schedules[0].variable_tags[0].key #=> String
resp.policy.policy_details.schedules[0].variable_tags[0].value #=> String
resp.policy.policy_details.schedules[0].create_rule.location #=> String, one of "CLOUD", "OUTPOST_LOCAL"
resp.policy.policy_details.schedules[0].create_rule.interval #=> Integer
resp.policy.policy_details.schedules[0].create_rule.interval_unit #=> String, one of "HOURS"
resp.policy.policy_details.schedules[0].create_rule.times #=> Array
resp.policy.policy_details.schedules[0].create_rule.times[0] #=> String
resp.policy.policy_details.schedules[0].create_rule.cron_expression #=> String
resp.policy.policy_details.schedules[0].create_rule.scripts #=> Array
resp.policy.policy_details.schedules[0].create_rule.scripts[0].stages #=> Array
resp.policy.policy_details.schedules[0].create_rule.scripts[0].stages[0] #=> String, one of "PRE", "POST"
resp.policy.policy_details.schedules[0].create_rule.scripts[0].execution_handler_service #=> String, one of "AWS_SYSTEMS_MANAGER"
resp.policy.policy_details.schedules[0].create_rule.scripts[0].execution_handler #=> String
resp.policy.policy_details.schedules[0].create_rule.scripts[0].execute_operation_on_script_failure #=> Boolean
resp.policy.policy_details.schedules[0].create_rule.scripts[0].execution_timeout #=> Integer
resp.policy.policy_details.schedules[0].create_rule.scripts[0].maximum_retry_count #=> Integer
resp.policy.policy_details.schedules[0].retain_rule.count #=> Integer
resp.policy.policy_details.schedules[0].retain_rule.interval #=> Integer
resp.policy.policy_details.schedules[0].retain_rule.interval_unit #=> String, one of "DAYS", "WEEKS", "MONTHS", "YEARS"
resp.policy.policy_details.schedules[0].fast_restore_rule.count #=> Integer
resp.policy.policy_details.schedules[0].fast_restore_rule.interval #=> Integer
resp.policy.policy_details.schedules[0].fast_restore_rule.interval_unit #=> String, one of "DAYS", "WEEKS", "MONTHS", "YEARS"
resp.policy.policy_details.schedules[0].fast_restore_rule.availability_zones #=> Array
resp.policy.policy_details.schedules[0].fast_restore_rule.availability_zones[0] #=> String
resp.policy.policy_details.schedules[0].cross_region_copy_rules #=> Array
resp.policy.policy_details.schedules[0].cross_region_copy_rules[0].target_region #=> String
resp.policy.policy_details.schedules[0].cross_region_copy_rules[0].target #=> String
resp.policy.policy_details.schedules[0].cross_region_copy_rules[0].encrypted #=> Boolean
resp.policy.policy_details.schedules[0].cross_region_copy_rules[0].cmk_arn #=> String
resp.policy.policy_details.schedules[0].cross_region_copy_rules[0].copy_tags #=> Boolean
resp.policy.policy_details.schedules[0].cross_region_copy_rules[0].retain_rule.interval #=> Integer
resp.policy.policy_details.schedules[0].cross_region_copy_rules[0].retain_rule.interval_unit #=> String, one of "DAYS", "WEEKS", "MONTHS", "YEARS"
resp.policy.policy_details.schedules[0].cross_region_copy_rules[0].deprecate_rule.interval #=> Integer
resp.policy.policy_details.schedules[0].cross_region_copy_rules[0].deprecate_rule.interval_unit #=> String, one of "DAYS", "WEEKS", "MONTHS", "YEARS"
resp.policy.policy_details.schedules[0].share_rules #=> Array
resp.policy.policy_details.schedules[0].share_rules[0].target_accounts #=> Array
resp.policy.policy_details.schedules[0].share_rules[0].target_accounts[0] #=> String
resp.policy.policy_details.schedules[0].share_rules[0].unshare_interval #=> Integer
resp.policy.policy_details.schedules[0].share_rules[0].unshare_interval_unit #=> String, one of "DAYS", "WEEKS", "MONTHS", "YEARS"
resp.policy.policy_details.schedules[0].deprecate_rule.count #=> Integer
resp.policy.policy_details.schedules[0].deprecate_rule.interval #=> Integer
resp.policy.policy_details.schedules[0].deprecate_rule.interval_unit #=> String, one of "DAYS", "WEEKS", "MONTHS", "YEARS"
resp.policy.policy_details.schedules[0].archive_rule.retain_rule.retention_archive_tier.count #=> Integer
resp.policy.policy_details.schedules[0].archive_rule.retain_rule.retention_archive_tier.interval #=> Integer
resp.policy.policy_details.schedules[0].archive_rule.retain_rule.retention_archive_tier.interval_unit #=> String, one of "DAYS", "WEEKS", "MONTHS", "YEARS"
resp.policy.policy_details.parameters.exclude_boot_volume #=> Boolean
resp.policy.policy_details.parameters.no_reboot #=> Boolean
resp.policy.policy_details.parameters.exclude_data_volume_tags #=> Array
resp.policy.policy_details.parameters.exclude_data_volume_tags[0].key #=> String
resp.policy.policy_details.parameters.exclude_data_volume_tags[0].value #=> String
resp.policy.policy_details.event_source.type #=> String, one of "MANAGED_CWE"
resp.policy.policy_details.event_source.parameters.event_type #=> String, one of "shareSnapshot"
resp.policy.policy_details.event_source.parameters.snapshot_owner #=> Array
resp.policy.policy_details.event_source.parameters.snapshot_owner[0] #=> String
resp.policy.policy_details.event_source.parameters.description_regex #=> String
resp.policy.policy_details.actions #=> Array
resp.policy.policy_details.actions[0].name #=> String
resp.policy.policy_details.actions[0].cross_region_copy #=> Array
resp.policy.policy_details.actions[0].cross_region_copy[0].target #=> String
resp.policy.policy_details.actions[0].cross_region_copy[0].encryption_configuration.encrypted #=> Boolean
resp.policy.policy_details.actions[0].cross_region_copy[0].encryption_configuration.cmk_arn #=> String
resp.policy.policy_details.actions[0].cross_region_copy[0].retain_rule.interval #=> Integer
resp.policy.policy_details.actions[0].cross_region_copy[0].retain_rule.interval_unit #=> String, one of "DAYS", "WEEKS", "MONTHS", "YEARS"
resp.policy.policy_details.policy_language #=> String, one of "SIMPLIFIED", "STANDARD"
resp.policy.policy_details.resource_type #=> String, one of "VOLUME", "INSTANCE"
resp.policy.policy_details.create_interval #=> Integer
resp.policy.policy_details.retain_interval #=> Integer
resp.policy.policy_details.copy_tags #=> Boolean
resp.policy.policy_details.cross_region_copy_targets #=> Array
resp.policy.policy_details.cross_region_copy_targets[0].target_region #=> String
resp.policy.policy_details.extend_deletion #=> Boolean
resp.policy.policy_details.exclusions.exclude_boot_volumes #=> Boolean
resp.policy.policy_details.exclusions.exclude_volume_types #=> Array
resp.policy.policy_details.exclusions.exclude_volume_types[0] #=> String
resp.policy.policy_details.exclusions.exclude_tags #=> Array
resp.policy.policy_details.exclusions.exclude_tags[0].key #=> String
resp.policy.policy_details.exclusions.exclude_tags[0].value #=> String
resp.policy.tags #=> Hash
resp.policy.tags["TagKey"] #=> String
resp.policy.policy_arn #=> String
resp.policy.default_policy #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :policy_id (required, String) —

    The identifier of the lifecycle policy.

Returns:

See Also:



998
999
1000
1001
 
# File 'lib/aws-sdk-dlm/client.rb', line 998

def get_lifecycle_policy(params = {}, options = {})
  req = build_request(:get_lifecycle_policy, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

Lists the tags for the specified resource.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "PolicyArn", # required
})

Response structure


resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource.

Returns:

See Also:



1027
1028
1029
1030
 
# File 'lib/aws-sdk-dlm/client.rb', line 1027

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

Adds the specified tags to the specified resource.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "PolicyArn", # required
  tags: { # required
    "TagKey" => "TagValue",
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource.

  • :tags (required, Hash<String,String>) —

    One or more tags.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1055
1056
1057
1058
 
# File 'lib/aws-sdk-dlm/client.rb', line 1055

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

Removes the specified tags from the specified resource.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "PolicyArn", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource.

  • :tag_keys (required, Array<String>) —

    The tag keys.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1081
1082
1083
1084
 
# File 'lib/aws-sdk-dlm/client.rb', line 1081

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_lifecycle_policy(params = {}) ⇒ Struct

Updates the specified lifecycle policy.

For more information about updating a policy, see [Modify lifecycle policies].

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/view-modify-delete.html#modify

Examples:

Request syntax with placeholder values


resp = client.update_lifecycle_policy({
  policy_id: "PolicyId", # required
  execution_role_arn: "ExecutionRoleArn",
  state: "ENABLED", # accepts ENABLED, DISABLED
  description: "PolicyDescription",
  policy_details: {
    policy_type: "EBS_SNAPSHOT_MANAGEMENT", # accepts EBS_SNAPSHOT_MANAGEMENT, IMAGE_MANAGEMENT, EVENT_BASED_POLICY
    resource_types: ["VOLUME"], # accepts VOLUME, INSTANCE
    resource_locations: ["CLOUD"], # accepts CLOUD, OUTPOST
    target_tags: [
      {
        key: "String", # required
        value: "String", # required
      },
    ],
    schedules: [
      {
        name: "ScheduleName",
        copy_tags: false,
        tags_to_add: [
          {
            key: "String", # required
            value: "String", # required
          },
        ],
        variable_tags: [
          {
            key: "String", # required
            value: "String", # required
          },
        ],
        create_rule: {
          location: "CLOUD", # accepts CLOUD, OUTPOST_LOCAL
          interval: 1,
          interval_unit: "HOURS", # accepts HOURS
          times: ["Time"],
          cron_expression: "CronExpression",
          scripts: [
            {
              stages: ["PRE"], # accepts PRE, POST
              execution_handler_service: "AWS_SYSTEMS_MANAGER", # accepts AWS_SYSTEMS_MANAGER
              execution_handler: "ExecutionHandler", # required
              execute_operation_on_script_failure: false,
              execution_timeout: 1,
              maximum_retry_count: 1,
            },
          ],
        },
        retain_rule: {
          count: 1,
          interval: 1,
          interval_unit: "DAYS", # accepts DAYS, WEEKS, MONTHS, YEARS
        },
        fast_restore_rule: {
          count: 1,
          interval: 1,
          interval_unit: "DAYS", # accepts DAYS, WEEKS, MONTHS, YEARS
          availability_zones: ["AvailabilityZone"], # required
        },
        cross_region_copy_rules: [
          {
            target_region: "TargetRegion",
            target: "Target",
            encrypted: false, # required
            cmk_arn: "CmkArn",
            copy_tags: false,
            retain_rule: {
              interval: 1,
              interval_unit: "DAYS", # accepts DAYS, WEEKS, MONTHS, YEARS
            },
            deprecate_rule: {
              interval: 1,
              interval_unit: "DAYS", # accepts DAYS, WEEKS, MONTHS, YEARS
            },
          },
        ],
        share_rules: [
          {
            target_accounts: ["AwsAccountId"], # required
            unshare_interval: 1,
            unshare_interval_unit: "DAYS", # accepts DAYS, WEEKS, MONTHS, YEARS
          },
        ],
        deprecate_rule: {
          count: 1,
          interval: 1,
          interval_unit: "DAYS", # accepts DAYS, WEEKS, MONTHS, YEARS
        },
        archive_rule: {
          retain_rule: { # required
            retention_archive_tier: { # required
              count: 1,
              interval: 1,
              interval_unit: "DAYS", # accepts DAYS, WEEKS, MONTHS, YEARS
            },
          },
        },
      },
    ],
    parameters: {
      exclude_boot_volume: false,
      no_reboot: false,
      exclude_data_volume_tags: [
        {
          key: "String", # required
          value: "String", # required
        },
      ],
    },
    event_source: {
      type: "MANAGED_CWE", # required, accepts MANAGED_CWE
      parameters: {
        event_type: "shareSnapshot", # required, accepts shareSnapshot
        snapshot_owner: ["AwsAccountId"], # required
        description_regex: "DescriptionRegex", # required
      },
    },
    actions: [
      {
        name: "ActionName", # required
        cross_region_copy: [ # required
          {
            target: "Target", # required
            encryption_configuration: { # required
              encrypted: false, # required
              cmk_arn: "CmkArn",
            },
            retain_rule: {
              interval: 1,
              interval_unit: "DAYS", # accepts DAYS, WEEKS, MONTHS, YEARS
            },
          },
        ],
      },
    ],
    policy_language: "SIMPLIFIED", # accepts SIMPLIFIED, STANDARD
    resource_type: "VOLUME", # accepts VOLUME, INSTANCE
    create_interval: 1,
    retain_interval: 1,
    copy_tags: false,
    cross_region_copy_targets: [
      {
        target_region: "TargetRegion",
      },
    ],
    extend_deletion: false,
    exclusions: {
      exclude_boot_volumes: false,
      exclude_volume_types: ["VolumeTypeValues"],
      exclude_tags: [
        {
          key: "String", # required
          value: "String", # required
        },
      ],
    },
  },
  create_interval: 1,
  retain_interval: 1,
  copy_tags: false,
  extend_deletion: false,
  cross_region_copy_targets: [
    {
      target_region: "TargetRegion",
    },
  ],
  exclusions: {
    exclude_boot_volumes: false,
    exclude_volume_types: ["VolumeTypeValues"],
    exclude_tags: [
      {
        key: "String", # required
        value: "String", # required
      },
    ],
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :policy_id (required, String) —

    The identifier of the lifecycle policy.

  • :execution_role_arn (String) —

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

  • :state (String) —

    The desired activation state of the lifecycle policy after creation.

  • :description (String) —

    A description of the lifecycle policy.

  • :policy_details (Types::PolicyDetails) —

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

  • :create_interval (Integer) —

    **[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 (Integer) —

    **[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 (Boolean) —

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

  • :extend_deletion (Boolean) —

    **[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 (Array<Types::CrossRegionCopyTarget>) —

    **[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 (Types::Exclusions) —

    **[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.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1349
1350
1351
1352
 
# File 'lib/aws-sdk-dlm/client.rb', line 1349

def update_lifecycle_policy(params = {}, options = {})
  req = build_request(:update_lifecycle_policy, params)
  req.send_request(options)
end

#waiter_names ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


1378
1379
1380
 
# File 'lib/aws-sdk-dlm/client.rb', line 1378

def waiter_names
  []
end