Class: AWSCDK::Backup::BackupPlan

Inherits:
Resource
  • Object
show all
Includes:
IBackupPlan
Defined in:
backup/backup_plan.rb

Overview

A backup plan.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of BackupPlan.

Parameters:



12
13
14
15
16
17
18
 
# File 'backup/backup_plan.rb', line 12

def initialize(scope, id, props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::Backup::BackupPlanProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYmFja3VwLkJhY2t1cFBsYW5Qcm9wcyJ9")), "props") unless props.nil?
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.daily35_day_retention(scope, id, backup_vault = nil) ⇒ AWSCDK::Backup::BackupPlan

Daily with 35 day retention.

Parameters:

Returns:

  • (AWSCDK::Backup::BackupPlan) 


49
50
51
52
53
54
 
# File 'backup/backup_plan.rb', line 49

def self.daily35_day_retention(scope, id, backup_vault = nil)
  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(backup_vault, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19iYWNrdXAuSUJhY2t1cFZhdWx0UmVmIn0=")), "backupVault") unless backup_vault.nil?
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_backup.BackupPlan", "daily35DayRetention", [scope, id, backup_vault])
end

.daily_monthly1_year_retention(scope, id, backup_vault = nil) ⇒ AWSCDK::Backup::BackupPlan

Daily and monthly with 1 year retention.

Parameters:

Returns:

  • (AWSCDK::Backup::BackupPlan) 


62
63
64
65
66
67
 
# File 'backup/backup_plan.rb', line 62

def self.daily_monthly1_year_retention(scope, id, backup_vault = nil)
  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(backup_vault, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19iYWNrdXAuSUJhY2t1cFZhdWx0UmVmIn0=")), "backupVault") unless backup_vault.nil?
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_backup.BackupPlan", "dailyMonthly1YearRetention", [scope, id, backup_vault])
end

.daily_weekly_monthly5_year_retention(scope, id, backup_vault = nil) ⇒ AWSCDK::Backup::BackupPlan

Daily, weekly and monthly with 5 year retention.

Parameters:

Returns:

  • (AWSCDK::Backup::BackupPlan) 


75
76
77
78
79
80
 
# File 'backup/backup_plan.rb', line 75

def self.daily_weekly_monthly5_year_retention(scope, id, backup_vault = nil)
  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(backup_vault, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19iYWNrdXAuSUJhY2t1cFZhdWx0UmVmIn0=")), "backupVault") unless backup_vault.nil?
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_backup.BackupPlan", "dailyWeeklyMonthly5YearRetention", [scope, id, backup_vault])
end

.daily_weekly_monthly7_year_retention(scope, id, backup_vault = nil) ⇒ AWSCDK::Backup::BackupPlan

Daily, weekly and monthly with 7 year retention.

Parameters:

Returns:

  • (AWSCDK::Backup::BackupPlan) 


88
89
90
91
92
93
 
# File 'backup/backup_plan.rb', line 88

def self.daily_weekly_monthly7_year_retention(scope, id, backup_vault = nil)
  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(backup_vault, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19iYWNrdXAuSUJhY2t1cFZhdWx0UmVmIn0=")), "backupVault") unless backup_vault.nil?
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_backup.BackupPlan", "dailyWeeklyMonthly7YearRetention", [scope, id, backup_vault])
end

.from_backup_plan_id(scope, id, backup_plan_id) ⇒ AWSCDK::Backup::IBackupPlan

Import an existing backup plan.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • backup_plan_id (String)

Returns:



101
102
103
104
105
106
 
# File 'backup/backup_plan.rb', line 101

def self.from_backup_plan_id(scope, id, backup_plan_id)
  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(backup_plan_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "backupPlanId")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_backup.BackupPlan", "fromBackupPlanId", [scope, id, backup_plan_id])
end

.jsii_overridable_methods ⇒ Object 



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
 
# File 'backup/backup_plan.rb', line 20

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :physical_name => { kind: :property, name: "physicalName", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :backup_plan_arn => { kind: :property, name: "backupPlanArn", is_optional: false },
    :backup_plan_id => { kind: :property, name: "backupPlanId", is_optional: false },
    :backup_plan_ref => { kind: :property, name: "backupPlanRef", is_optional: false },
    :backup_vault => { kind: :property, name: "backupVault", is_optional: false },
    :version_id => { kind: :property, name: "versionId", is_optional: false },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", 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 },
    :generate_physical_name => { kind: :method, name: "generatePhysicalName", is_optional: false },
    :get_resource_arn_attribute => { kind: :method, name: "getResourceArnAttribute", is_optional: false },
    :get_resource_name_attribute => { kind: :method, name: "getResourceNameAttribute", is_optional: false },
    :add_rule => { kind: :method, name: "addRule", is_optional: false },
    :add_selection => { kind: :method, name: "addSelection", is_optional: false },
  }
end

.PROPERTY_INJECTION_ID ⇒ String

Uniquely identifies this class.

Returns:

  • (String) 


154
155
156
 
# File 'backup/backup_plan.rb', line 154

def self.PROPERTY_INJECTION_ID()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_backup.BackupPlan", "PROPERTY_INJECTION_ID")
end

Instance Method Details

#add_rule(rule) ⇒ void

This method returns an undefined value.

Adds a rule to a plan.

Parameters:



287
288
289
290
 
# File 'backup/backup_plan.rb', line 287

def add_rule(rule)
  Jsii::Type.check_type(rule, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYmFja3VwLkJhY2t1cFBsYW5SdWxlIn0=")), "rule")
  jsii_call_method("addRule", [rule])
end

#add_selection(id, options) ⇒ AWSCDK::Backup::BackupSelection

Adds a selection to this plan.

Parameters:

Returns:



297
298
299
300
301
302
 
# File 'backup/backup_plan.rb', line 297

def add_selection(id, options)
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  options = options.is_a?(Hash) ? ::AWSCDK::Backup::BackupSelectionOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYmFja3VwLkJhY2t1cFNlbGVjdGlvbk9wdGlvbnMifQ==")), "options")
  jsii_call_method("addSelection", [id, options])
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Override the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

Parameters:



226
227
228
229
 
# File 'backup/backup_plan.rb', line 226

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) ⇒ void

This method returns an undefined value.

Apply the given removal policy to this resource.

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

Parameters:



243
244
245
246
 
# File 'backup/backup_plan.rb', line 243

def apply_removal_policy(policy)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy")
  jsii_call_method("applyRemovalPolicy", [policy])
end

#backup_plan_arn ⇒ String

The ARN of the backup plan.

Returns:

  • (String) 


161
162
163
 
# File 'backup/backup_plan.rb', line 161

def backup_plan_arn()
  jsii_get_property("backupPlanArn")
end

#backup_plan_id ⇒ String

The identifier of the backup plan.

Returns:

  • (String) 


168
169
170
 
# File 'backup/backup_plan.rb', line 168

def backup_plan_id()
  jsii_get_property("backupPlanId")
end

#backup_plan_ref ⇒ AWSCDK::Interfaces::AWSBackup::BackupPlanReference

A reference to a BackupPlan resource.

Returns:



175
176
177
 
# File 'backup/backup_plan.rb', line 175

def backup_plan_ref()
  jsii_get_property("backupPlanRef")
end

#backup_vault ⇒ AWSCDK::Backup::IBackupVault

The backup vault where backups are stored if not defined at the rule level.

Returns:



182
183
184
 
# File 'backup/backup_plan.rb', line 182

def backup_vault()
  jsii_get_property("backupVault")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

Returns:



126
127
128
 
# File 'backup/backup_plan.rb', line 126

def env()
  jsii_get_property("env")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


249
250
251
 
# File 'backup/backup_plan.rb', line 249

def generate_physical_name()
  jsii_call_method("generatePhysicalName", [])
end

#get_resource_arn_attribute(arn_attr, arn_components) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. bucket.bucketArn).

Normally, this token will resolve to arn_attr, but if the resource is referenced across environments, arn_components will be used to synthesize a concrete ARN with the resource's physical name. Make sure to reference this.physicalName in arn_components.

Parameters:

  • arn_attr (String) —

    The CFN attribute which resolves to the ARN of the resource.

  • arn_components (AWSCDK::ARNComponents) —

    The format of the ARN of this resource.

Returns:

  • (String) 


263
264
265
266
267
268
 
# File 'backup/backup_plan.rb', line 263

def get_resource_arn_attribute(arn_attr, arn_components)
  Jsii::Type.check_type(arn_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arnAttr")
  arn_components = arn_components.is_a?(Hash) ? ::AWSCDK::ARNComponents.new(**arn_components.transform_keys(&:to_sym)) : arn_components
  Jsii::Type.check_type(arn_components, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5Bcm5Db21wb25lbnRzIn0=")), "arnComponents")
  jsii_call_method("getResourceArnAttribute", [arn_attr, arn_components])
end

#get_resource_name_attribute(name_attr) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. bucket.bucketName).

Normally, this token will resolve to name_attr, but if the resource is referenced across environments, it will be resolved to this.physicalName, which will be a concrete name.

Parameters:

  • name_attr (String) —

    The CFN attribute which resolves to the resource's name.

Returns:

  • (String) 


278
279
280
281
 
# File 'backup/backup_plan.rb', line 278

def get_resource_name_attribute(name_attr)
  Jsii::Type.check_type(name_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "nameAttr")
  jsii_call_method("getResourceNameAttribute", [name_attr])
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


111
112
113
 
# File 'backup/backup_plan.rb', line 111

def node()
  jsii_get_property("node")
end

#physical_name ⇒ String

Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.

This value will resolve to one of the following:

  • a concrete value (e.g. "my-awesome-bucket")
  • undefined, when a name should be generated by CloudFormation
  • a concrete name generated automatically during synthesis, in cross-environment scenarios.

Returns:

  • (String) 


140
141
142
 
# File 'backup/backup_plan.rb', line 140

def physical_name()
  jsii_get_property("physicalName")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



147
148
149
 
# File 'backup/backup_plan.rb', line 147

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


196
197
198
 
# File 'backup/backup_plan.rb', line 196

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

#version_id ⇒ String

Version Id.

Returns:

  • (String) 


189
190
191
 
# File 'backup/backup_plan.rb', line 189

def version_id()
  jsii_get_property("versionId")
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) 


209
210
211
212
213
214
 
# File 'backup/backup_plan.rb', line 209

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