Class: AWSCDK::DLM::CfnLifecyclePolicy::ParametersProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
dlm/cfn_lifecycle_policy.rb

Overview

[Custom snapshot and AMI policies only] Specifies optional parameters for snapshot and AMI policies.

The set of valid parameters depends on the combination of policy type and target resource type.

If you choose to exclude boot volumes and you specify tags that consequently exclude all of the additional data volumes attached to an instance, then Amazon Data Lifecycle Manager will not create any snapshots for the affected instance, and it will emit a SnapshotsCreateFailed Amazon CloudWatch metric. For more information, see Monitor your policies using Amazon CloudWatch .

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(exclude_boot_volume: nil, exclude_data_volume_tags: nil, no_reboot: nil) ⇒ ParametersProperty

Returns a new instance of ParametersProperty.

Parameters:

  • exclude_boot_volume (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    [Custom snapshot policies that target instances only] Indicates whether to exclude the root volume from multi-volume snapshot sets.

  • exclude_data_volume_tags (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::CfnTag>, nil) (defaults to: nil) —

    [Custom snapshot policies that target instances only] The tags used to identify data (non-root) volumes to exclude from multi-volume snapshot sets.

  • no_reboot (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    [Custom AMI policies only] Indicates whether targeted instances are rebooted when the lifecycle policy runs.



1530
1531
1532
1533
1534
1535
1536
1537
 
# File 'dlm/cfn_lifecycle_policy.rb', line 1530

def initialize(exclude_boot_volume: nil, exclude_data_volume_tags: nil, no_reboot: nil)
  @exclude_boot_volume = exclude_boot_volume
  Jsii::Type.check_type(@exclude_boot_volume, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "excludeBootVolume") unless @exclude_boot_volume.nil?
  @exclude_data_volume_tags = exclude_data_volume_tags
  Jsii::Type.check_type(@exclude_data_volume_tags, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5UYWcifV19fSwia2luZCI6ImFycmF5In19XX19")), "excludeDataVolumeTags") unless @exclude_data_volume_tags.nil?
  @no_reboot = no_reboot
  Jsii::Type.check_type(@no_reboot, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "noReboot") unless @no_reboot.nil?
end

Instance Attribute Details

#exclude_boot_volume ⇒ Boolean, ... (readonly)

[Custom snapshot policies that target instances only] Indicates whether to exclude the root volume from multi-volume snapshot sets.

The default is false . If you specify true , then the root volumes attached to targeted instances will be excluded from the multi-volume snapshot sets created by the policy.

Returns:

See Also:



1545
1546
1547
 
# File 'dlm/cfn_lifecycle_policy.rb', line 1545

def exclude_boot_volume
  @exclude_boot_volume
end

#exclude_data_volume_tags ⇒ AWSCDK::IResolvable, ... (readonly)

[Custom snapshot policies that target instances only] The tags used to identify data (non-root) volumes to exclude from multi-volume snapshot sets.

If you create a snapshot lifecycle policy that targets instances and you specify tags for this parameter, then data volumes with the specified tags that are attached to targeted instances will be excluded from the multi-volume snapshot sets created by the policy.

Returns:

See Also:



1552
1553
1554
 
# File 'dlm/cfn_lifecycle_policy.rb', line 1552

def exclude_data_volume_tags
  @exclude_data_volume_tags
end

#no_reboot ⇒ Boolean, ... (readonly)

[Custom AMI policies only] Indicates whether targeted instances are rebooted when the lifecycle policy runs.

true indicates that targeted instances are not rebooted when the policy runs. false indicates that target instances are rebooted when the policy runs. The default is true (instances are not rebooted).

Returns:

See Also:



1559
1560
1561
 
# File 'dlm/cfn_lifecycle_policy.rb', line 1559

def no_reboot
  @no_reboot
end

Class Method Details

.jsii_properties ⇒ Object 



1561
1562
1563
1564
1565
1566
1567
 
# File 'dlm/cfn_lifecycle_policy.rb', line 1561

def self.jsii_properties
  {
    :exclude_boot_volume => "excludeBootVolume",
    :exclude_data_volume_tags => "excludeDataVolumeTags",
    :no_reboot => "noReboot",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1569
1570
1571
1572
1573
1574
1575
1576
1577
 
# File 'dlm/cfn_lifecycle_policy.rb', line 1569

def to_jsii
  result = {}
  result.merge!({
    "excludeBootVolume" => @exclude_boot_volume,
    "excludeDataVolumeTags" => @exclude_data_volume_tags,
    "noReboot" => @no_reboot,
  })
  result.compact
end