Class: AWSCDK::Backup::BackupResource

Inherits:
Jsii::Object
  • Object
show all
Defined in:
backup/backup_resource.rb

Overview

A resource to backup.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(resource = nil, tag_condition = nil, construct = nil) ⇒ BackupResource

Returns a new instance of BackupResource.

Parameters:

  • resource (String, nil) (defaults to: nil)
  • tag_condition (AWSCDK::Backup::TagCondition, nil) (defaults to: nil)
  • construct (Constructs::Construct, nil) (defaults to: nil) 


11
12
13
14
15
16
17
 
# File 'backup/backup_resource.rb', line 11

def initialize(resource = nil, tag_condition = nil, construct = nil)
  tag_condition = tag_condition.is_a?(Hash) ? ::AWSCDK::Backup::TagCondition.new(**tag_condition.transform_keys(&:to_sym)) : tag_condition
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "resource") unless resource.nil?
  Jsii::Type.check_type(tag_condition, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYmFja3VwLlRhZ0NvbmRpdGlvbiJ9")), "tagCondition") unless tag_condition.nil?
  Jsii::Type.check_type(construct, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "construct") unless construct.nil?
  Jsii::Object.instance_method(:initialize).bind(self).call(resource, tag_condition, construct)
end

Class Method Details

.from_arn(arn) ⇒ AWSCDK::Backup::BackupResource

A list of ARNs or match patterns such as arn:aws:ec2:us-east-1:123456789012:volume/*.

Parameters:

  • arn (String)

Returns:

  • (AWSCDK::Backup::BackupResource) 


31
32
33
34
 
# File 'backup/backup_resource.rb', line 31

def self.from_arn(arn)
  Jsii::Type.check_type(arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arn")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_backup.BackupResource", "fromArn", [arn])
end

.from_construct(construct) ⇒ AWSCDK::Backup::BackupResource

Adds all supported resources in a construct.

Parameters:

  • construct (Constructs::Construct) —

    The construct containing resources to backup.

Returns:

  • (AWSCDK::Backup::BackupResource) 


40
41
42
43
 
# File 'backup/backup_resource.rb', line 40

def self.from_construct(construct)
  Jsii::Type.check_type(construct, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "construct")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_backup.BackupResource", "fromConstruct", [construct])
end

.from_dynamo_db_table(table) ⇒ AWSCDK::Backup::BackupResource

A DynamoDB table.

Parameters:

Returns:

  • (AWSCDK::Backup::BackupResource) 


49
50
51
52
 
# File 'backup/backup_resource.rb', line 49

def self.from_dynamo_db_table(table)
  Jsii::Type.check_type(table, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19keW5hbW9kYi5JVGFibGVSZWYifQ==")), "table")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_backup.BackupResource", "fromDynamoDbTable", [table])
end

.from_ec2_instance(instance) ⇒ AWSCDK::Backup::BackupResource

An EC2 instance.

Parameters:

Returns:

  • (AWSCDK::Backup::BackupResource) 


58
59
60
61
 
# File 'backup/backup_resource.rb', line 58

def self.from_ec2_instance(instance)
  Jsii::Type.check_type(instance, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19lYzIuSUluc3RhbmNlUmVmIn0=")), "instance")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_backup.BackupResource", "fromEc2Instance", [instance])
end

.from_efs_file_system(file_system) ⇒ AWSCDK::Backup::BackupResource

An EFS file system.

Parameters:

Returns:

  • (AWSCDK::Backup::BackupResource) 


67
68
69
70
 
# File 'backup/backup_resource.rb', line 67

def self.from_efs_file_system(file_system)
  Jsii::Type.check_type(file_system, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19lZnMuSUZpbGVTeXN0ZW1SZWYifQ==")), "fileSystem")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_backup.BackupResource", "fromEfsFileSystem", [file_system])
end

.from_rds_database_cluster(cluster) ⇒ AWSCDK::Backup::BackupResource

A RDS database cluter.

Parameters:

Returns:

  • (AWSCDK::Backup::BackupResource) 


76
77
78
79
 
# File 'backup/backup_resource.rb', line 76

def self.from_rds_database_cluster(cluster)
  Jsii::Type.check_type(cluster, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19yZHMuSURCQ2x1c3RlclJlZiJ9")), "cluster")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_backup.BackupResource", "fromRdsDatabaseCluster", [cluster])
end

.from_rds_database_instance(instance) ⇒ AWSCDK::Backup::BackupResource

A RDS database instance.

Parameters:

Returns:

  • (AWSCDK::Backup::BackupResource) 


85
86
87
88
 
# File 'backup/backup_resource.rb', line 85

def self.from_rds_database_instance(instance)
  Jsii::Type.check_type(instance, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19yZHMuSURCSW5zdGFuY2VSZWYifQ==")), "instance")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_backup.BackupResource", "fromRdsDatabaseInstance", [instance])
end

.from_rds_serverless_cluster(cluster) ⇒ AWSCDK::Backup::BackupResource

An Aurora database instance.

Parameters:

Returns:

  • (AWSCDK::Backup::BackupResource) 


94
95
96
97
 
# File 'backup/backup_resource.rb', line 94

def self.from_rds_serverless_cluster(cluster)
  Jsii::Type.check_type(cluster, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19yZHMuSURCQ2x1c3RlclJlZiJ9")), "cluster")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_backup.BackupResource", "fromRdsServerlessCluster", [cluster])
end

.from_tag(key, value, operation = nil) ⇒ AWSCDK::Backup::BackupResource

A tag condition.

Parameters:

Returns:

  • (AWSCDK::Backup::BackupResource) 


105
106
107
108
109
110
 
# File 'backup/backup_resource.rb', line 105

def self.from_tag(key, value, operation = nil)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "value")
  Jsii::Type.check_type(operation, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYmFja3VwLlRhZ09wZXJhdGlvbiJ9")), "operation") unless operation.nil?
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_backup.BackupResource", "fromTag", [key, value, operation])
end

.jsii_overridable_methods ⇒ Object 



19
20
21
22
23
24
25
 
# File 'backup/backup_resource.rb', line 19

def self.jsii_overridable_methods
  {
    :construct => { kind: :property, name: "construct", is_optional: true },
    :resource => { kind: :property, name: "resource", is_optional: true },
    :tag_condition => { kind: :property, name: "tagCondition", is_optional: true },
  }
end

Instance Method Details

#construct ⇒ Constructs::Construct?

A construct.

Returns:

  • (Constructs::Construct, nil) 


115
116
117
 
# File 'backup/backup_resource.rb', line 115

def construct()
  jsii_get_property("construct")
end

#resource ⇒ String?

A resource.

Returns:

  • (String, nil) 


122
123
124
 
# File 'backup/backup_resource.rb', line 122

def resource()
  jsii_get_property("resource")
end

#tag_condition ⇒ AWSCDK::Backup::TagCondition?

A condition on a tag.

Returns:



129
130
131
 
# File 'backup/backup_resource.rb', line 129

def tag_condition()
  jsii_get_property("tagCondition")
end