You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::DLM::Types::CreateLifecyclePolicyRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateLifecyclePolicyRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  execution_role_arn: "ExecutionRoleArn", # required
  description: "PolicyDescription", # required
  state: "ENABLED", # required, accepts ENABLED, DISABLED
  policy_details: { # required
    policy_type: "EBS_SNAPSHOT_MANAGEMENT", # accepts EBS_SNAPSHOT_MANAGEMENT, IMAGE_MANAGEMENT
    resource_types: ["VOLUME"], # accepts VOLUME, INSTANCE
    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: {
          interval: 1,
          interval_unit: "HOURS", # accepts HOURS
          times: ["Time"],
          cron_expression: "CronExpression",
        },
        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", # required
            encrypted: false, # required
            cmk_arn: "CmkArn",
            copy_tags: false,
            retain_rule: {
              interval: 1,
              interval_unit: "DAYS", # accepts DAYS, WEEKS, MONTHS, YEARS
            },
          },
        ],
      },
    ],
    parameters: {
      exclude_boot_volume: false,
      no_reboot: false,
    },
  },
  tags: {
    "TagKey" => "TagValue",
  },
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#description ⇒ String

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

Returns:

  • (String) —

    A description 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.

Returns:

  • (String) —

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

#policy_details ⇒ Types::PolicyDetails

The configuration details of the lifecycle policy.

Returns:

#state ⇒ String

The desired activation state of the lifecycle policy after creation.

Possible values:

  • ENABLED
  • DISABLED

Returns:

  • (String) —

    The desired activation state of the lifecycle policy after creation.

#tags ⇒ Hash<String,String>

The tags to apply to the lifecycle policy during creation.

Returns:

  • (Hash<String,String>) —

    The tags to apply to the lifecycle policy during creation.