Class: AWSCDK::DLM::CfnLifecyclePolicy

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSDLM::ILifecyclePolicyRef
Defined in:
dlm/cfn_lifecycle_policy.rb

Overview

Specifies a lifecycle policy, which is used to automate operations on Amazon EBS resources.

The properties are required when you add a lifecycle policy and optional when you update a lifecycle policy.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props = nil) ⇒ CfnLifecyclePolicy

Create a new AWS::DLM::LifecyclePolicy.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::DLM::CfnLifecyclePolicyProps, nil) (defaults to: nil) —

    Resource properties.



20
21
22
23
24
25
26
 
# File 'dlm/cfn_lifecycle_policy.rb', line 20

def initialize(scope, id, props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::DLM::CfnLifecyclePolicyProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZGxtLkNmbkxpZmVjeWNsZVBvbGljeVByb3BzIn0=")), "props") unless props.nil?
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_lifecycle_policy(resource) ⇒ String

Parameters:

Returns:

  • (String) 


86
87
88
89
 
# File 'dlm/cfn_lifecycle_policy.rb', line 86

def self.arn_for_lifecycle_policy(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19kbG0uSUxpZmVjeWNsZVBvbGljeVJlZiJ9")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_dlm.CfnLifecyclePolicy", "arnForLifecyclePolicy", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


193
194
195
 
# File 'dlm/cfn_lifecycle_policy.rb', line 193

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_dlm.CfnLifecyclePolicy", "CFN_RESOURCE_TYPE_NAME")
end

.is_cfn_lifecycle_policy(x) ⇒ Boolean

Checks whether the given object is a CfnLifecyclePolicy.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


95
96
97
98
 
# File 'dlm/cfn_lifecycle_policy.rb', line 95

def self.is_cfn_lifecycle_policy(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_dlm.CfnLifecyclePolicy", "isCfnLifecyclePolicy", [x])
end

.jsii_overridable_methods ⇒ Object 



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'dlm/cfn_lifecycle_policy.rb', line 28

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_arn => { kind: :property, name: "attrArn", is_optional: false },
    :attr_id => { kind: :property, name: "attrId", is_optional: false },
    :lifecycle_policy_ref => { kind: :property, name: "lifecyclePolicyRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :copy_tags => { kind: :property, name: "copyTags", is_optional: true },
    :create_interval => { kind: :property, name: "createInterval", is_optional: true },
    :cross_region_copy_targets => { kind: :property, name: "crossRegionCopyTargets", is_optional: true },
    :default_policy => { kind: :property, name: "defaultPolicy", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :exclusions => { kind: :property, name: "exclusions", is_optional: true },
    :execution_role_arn => { kind: :property, name: "executionRoleArn", is_optional: true },
    :extend_deletion => { kind: :property, name: "extendDeletion", is_optional: true },
    :policy_details => { kind: :property, name: "policyDetails", is_optional: true },
    :retain_interval => { kind: :property, name: "retainInterval", is_optional: true },
    :state => { kind: :property, name: "state", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



406
407
408
409
 
# File 'dlm/cfn_lifecycle_policy.rb', line 406

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:



418
419
420
421
 
# File 'dlm/cfn_lifecycle_policy.rb', line 418

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



428
429
430
431
 
# File 'dlm/cfn_lifecycle_policy.rb', line 428

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



439
440
441
442
443
 
# File 'dlm/cfn_lifecycle_policy.rb', line 439

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


496
497
498
499
500
 
# File 'dlm/cfn_lifecycle_policy.rb', line 496

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String) —

    The path to the property.



506
507
508
509
 
# File 'dlm/cfn_lifecycle_policy.rb', line 506

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



518
519
520
521
522
 
# File 'dlm/cfn_lifecycle_policy.rb', line 518

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



531
532
533
534
 
# File 'dlm/cfn_lifecycle_policy.rb', line 531

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy = nil, options = nil) ⇒ void

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

See Also:



553
554
555
556
557
558
 
# File 'dlm/cfn_lifecycle_policy.rb', line 553

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_arn ⇒ String

The Amazon Resource Name (ARN) of the lifecycle policy.

Returns:

  • (String) 


200
201
202
 
# File 'dlm/cfn_lifecycle_policy.rb', line 200

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_id ⇒ String

Returns:

  • (String) 


205
206
207
 
# File 'dlm/cfn_lifecycle_policy.rb', line 205

def attr_id()
  jsii_get_property("attrId")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

Returns:



146
147
148
 
# File 'dlm/cfn_lifecycle_policy.rb', line 146

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


151
152
153
 
# File 'dlm/cfn_lifecycle_policy.rb', line 151

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


562
563
564
565
 
# File 'dlm/cfn_lifecycle_policy.rb', line 562

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


156
157
158
 
# File 'dlm/cfn_lifecycle_policy.rb', line 156

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


163
164
165
 
# File 'dlm/cfn_lifecycle_policy.rb', line 163

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#copy_tags ⇒ Boolean, ...

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

Returns:



226
227
228
 
# File 'dlm/cfn_lifecycle_policy.rb', line 226

def copy_tags()
  jsii_get_property("copyTags")
end

#copy_tags=(value) ⇒ Object 



230
231
232
233
 
# File 'dlm/cfn_lifecycle_policy.rb', line 230

def copy_tags=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "copyTags") unless value.nil?
  jsii_set_property("copyTags", value)
end

#create_interval ⇒ Numeric?

[Default policies only] Specifies how often the policy should run and create snapshots or AMIs.

Returns:

  • (Numeric, nil) 


238
239
240
 
# File 'dlm/cfn_lifecycle_policy.rb', line 238

def create_interval()
  jsii_get_property("createInterval")
end

#create_interval=(value) ⇒ Object 



242
243
244
245
 
# File 'dlm/cfn_lifecycle_policy.rb', line 242

def create_interval=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "createInterval") unless value.nil?
  jsii_set_property("createInterval", value)
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


108
109
110
 
# File 'dlm/cfn_lifecycle_policy.rb', line 108

def creation_stack()
  jsii_get_property("creationStack")
end

#cross_region_copy_targets ⇒ AWSCDK::IResolvable, ...

[Default policies only] Specifies destination Regions for snapshot or AMI copies.

Returns:



250
251
252
 
# File 'dlm/cfn_lifecycle_policy.rb', line 250

def cross_region_copy_targets()
  jsii_get_property("crossRegionCopyTargets")
end

#cross_region_copy_targets=(value) ⇒ Object 



254
255
256
257
 
# File 'dlm/cfn_lifecycle_policy.rb', line 254

def cross_region_copy_targets=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZGxtLkNmbkxpZmVjeWNsZVBvbGljeS5Dcm9zc1JlZ2lvbkNvcHlUYXJnZXRQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "crossRegionCopyTargets") unless value.nil?
  jsii_set_property("crossRegionCopyTargets", value)
end

#default_policy ⇒ String?

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

Returns:

  • (String, nil) 


262
263
264
 
# File 'dlm/cfn_lifecycle_policy.rb', line 262

def default_policy()
  jsii_get_property("defaultPolicy")
end

#default_policy=(value) ⇒ Object 



266
267
268
269
 
# File 'dlm/cfn_lifecycle_policy.rb', line 266

def default_policy=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "defaultPolicy") unless value.nil?
  jsii_set_property("defaultPolicy", value)
end

#description ⇒ String?

A description of the lifecycle policy.

Returns:

  • (String, nil) 


274
275
276
 
# File 'dlm/cfn_lifecycle_policy.rb', line 274

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



278
279
280
281
 
# File 'dlm/cfn_lifecycle_policy.rb', line 278

def description=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless value.nil?
  jsii_set_property("description", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



168
169
170
 
# File 'dlm/cfn_lifecycle_policy.rb', line 168

def env()
  jsii_get_property("env")
end

#exclusions ⇒ AWSCDK::IResolvable, ...

[Default policies only] Specifies exclusion parameters for volumes or instances for which you do not want to create snapshots or AMIs.

Returns:



286
287
288
 
# File 'dlm/cfn_lifecycle_policy.rb', line 286

def exclusions()
  jsii_get_property("exclusions")
end

#exclusions=(value) ⇒ Object 



290
291
292
293
294
 
# File 'dlm/cfn_lifecycle_policy.rb', line 290

def exclusions=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::DLM::CfnLifecyclePolicy::ExclusionsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19kbG0uQ2ZuTGlmZWN5Y2xlUG9saWN5LkV4Y2x1c2lvbnNQcm9wZXJ0eSJ9XX19")), "exclusions") unless value.nil?
  jsii_set_property("exclusions", value)
end

#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, nil) 


299
300
301
 
# File 'dlm/cfn_lifecycle_policy.rb', line 299

def execution_role_arn()
  jsii_get_property("executionRoleArn")
end

#execution_role_arn=(value) ⇒ Object 



303
304
305
306
 
# File 'dlm/cfn_lifecycle_policy.rb', line 303

def execution_role_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "executionRoleArn") unless value.nil?
  jsii_set_property("executionRoleArn", value)
end

#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.

Returns:



311
312
313
 
# File 'dlm/cfn_lifecycle_policy.rb', line 311

def extend_deletion()
  jsii_get_property("extendDeletion")
end

#extend_deletion=(value) ⇒ Object 



315
316
317
318
 
# File 'dlm/cfn_lifecycle_policy.rb', line 315

def extend_deletion=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "extendDeletion") unless value.nil?
  jsii_set_property("extendDeletion", value)
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



575
576
577
578
579
 
# File 'dlm/cfn_lifecycle_policy.rb', line 575

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



586
587
588
589
 
# File 'dlm/cfn_lifecycle_policy.rb', line 586

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



656
657
658
659
 
# File 'dlm/cfn_lifecycle_policy.rb', line 656

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#lifecycle_policy_ref ⇒ AWSCDK::Interfaces::AWSDLM::LifecyclePolicyReference

A reference to a LifecyclePolicy resource.

Returns:



212
213
214
 
# File 'dlm/cfn_lifecycle_policy.rb', line 212

def lifecycle_policy_ref()
  jsii_get_property("lifecyclePolicyRef")
end

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


120
121
122
 
# File 'dlm/cfn_lifecycle_policy.rb', line 120

def logical_id()
  jsii_get_property("logicalId")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


103
104
105
 
# File 'dlm/cfn_lifecycle_policy.rb', line 103

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



597
598
599
 
# File 'dlm/cfn_lifecycle_policy.rb', line 597

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



604
605
606
 
# File 'dlm/cfn_lifecycle_policy.rb', line 604

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



397
398
399
400
 
# File 'dlm/cfn_lifecycle_policy.rb', line 397

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#policy_details ⇒ AWSCDK::IResolvable, ...

The configuration details of the lifecycle policy.

Returns:



323
324
325
 
# File 'dlm/cfn_lifecycle_policy.rb', line 323

def policy_details()
  jsii_get_property("policyDetails")
end

#policy_details=(value) ⇒ Object 



327
328
329
330
331
 
# File 'dlm/cfn_lifecycle_policy.rb', line 327

def policy_details=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::DLM::CfnLifecyclePolicy::PolicyDetailsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19kbG0uQ2ZuTGlmZWN5Y2xlUG9saWN5LlBvbGljeURldGFpbHNQcm9wZXJ0eSJ9XX19")), "policyDetails") unless value.nil?
  jsii_set_property("policyDetails", value)
end

#ref ⇒ String

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String) 


139
140
141
 
# File 'dlm/cfn_lifecycle_policy.rb', line 139

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



615
616
617
618
 
# File 'dlm/cfn_lifecycle_policy.rb', line 615

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


622
623
624
625
 
# File 'dlm/cfn_lifecycle_policy.rb', line 622

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



632
633
634
635
636
 
# File 'dlm/cfn_lifecycle_policy.rb', line 632

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#retain_interval ⇒ Numeric?

[Default policies only] Specifies how long the policy should retain snapshots or AMIs before deleting them.

Returns:

  • (Numeric, nil) 


336
337
338
 
# File 'dlm/cfn_lifecycle_policy.rb', line 336

def retain_interval()
  jsii_get_property("retainInterval")
end

#retain_interval=(value) ⇒ Object 



340
341
342
343
 
# File 'dlm/cfn_lifecycle_policy.rb', line 340

def retain_interval=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "retainInterval") unless value.nil?
  jsii_set_property("retainInterval", value)
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



641
642
643
 
# File 'dlm/cfn_lifecycle_policy.rb', line 641

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



129
130
131
 
# File 'dlm/cfn_lifecycle_policy.rb', line 129

def stack()
  jsii_get_property("stack")
end

#state ⇒ String?

The activation state of the lifecycle policy.

Returns:

  • (String, nil) 


348
349
350
 
# File 'dlm/cfn_lifecycle_policy.rb', line 348

def state()
  jsii_get_property("state")
end

#state=(value) ⇒ Object 



352
353
354
355
 
# File 'dlm/cfn_lifecycle_policy.rb', line 352

def state=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "state") unless value.nil?
  jsii_set_property("state", value)
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



219
220
221
 
# File 'dlm/cfn_lifecycle_policy.rb', line 219

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

The tags to apply to the lifecycle policy during creation.

Returns:



360
361
362
 
# File 'dlm/cfn_lifecycle_policy.rb', line 360

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



364
365
366
367
368
 
# File 'dlm/cfn_lifecycle_policy.rb', line 364

def tags_raw=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tagsRaw") unless value.nil?
  jsii_set_property("tagsRaw", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



373
374
375
 
# File 'dlm/cfn_lifecycle_policy.rb', line 373

def to_string()
  jsii_call_method("toString", [])
end

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


176
177
178
 
# File 'dlm/cfn_lifecycle_policy.rb', line 176

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


186
187
188
 
# File 'dlm/cfn_lifecycle_policy.rb', line 186

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


647
648
649
650
 
# File 'dlm/cfn_lifecycle_policy.rb', line 647

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


386
387
388
389
390
391
 
# File 'dlm/cfn_lifecycle_policy.rb', line 386

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end