Class: AWSCDK::Backup::BackupVault

Inherits:
Resource
  • Object
show all
Includes:
IBackupVault
Defined in:
backup/backup_vault.rb

Overview

A backup vault.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of BackupVault.

Parameters:



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

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

Class Method Details

.from_backup_vault_arn(scope, id, backup_vault_arn) ⇒ AWSCDK::Backup::IBackupVault

Import an existing backup vault by arn.

Parameters:

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

Returns:



48
49
50
51
52
53
 
# File 'backup/backup_vault.rb', line 48

def self.from_backup_vault_arn(scope, id, backup_vault_arn)
  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_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "backupVaultArn")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_backup.BackupVault", "fromBackupVaultArn", [scope, id, backup_vault_arn])
end

.from_backup_vault_name(scope, id, backup_vault_name) ⇒ AWSCDK::Backup::IBackupVault

Import an existing backup vault by name.

Parameters:

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

Returns:



61
62
63
64
65
66
 
# File 'backup/backup_vault.rb', line 61

def self.from_backup_vault_name(scope, id, backup_vault_name)
  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_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "backupVaultName")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_backup.BackupVault", "fromBackupVaultName", [scope, id, backup_vault_name])
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
 
# File 'backup/backup_vault.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_vault_arn => { kind: :property, name: "backupVaultArn", is_optional: false },
    :backup_vault_name => { kind: :property, name: "backupVaultName", is_optional: false },
    :backup_vault_ref => { kind: :property, name: "backupVaultRef", 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_to_access_policy => { kind: :method, name: "addToAccessPolicy", is_optional: false },
    :block_recovery_point_deletion => { kind: :method, name: "blockRecoveryPointDeletion", is_optional: false },
    :grant => { kind: :method, name: "grant", is_optional: false },
  }
end

.PROPERTY_INJECTION_ID ⇒ String

Uniquely identifies this class.

Returns:

  • (String) 


114
115
116
 
# File 'backup/backup_vault.rb', line 114

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

Instance Method Details

#add_to_access_policy(statement) ⇒ void

This method returns an undefined value.

Adds a statement to the vault access policy.

Parameters:



233
234
235
236
 
# File 'backup/backup_vault.rb', line 233

def add_to_access_policy(statement)
  Jsii::Type.check_type(statement, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLlBvbGljeVN0YXRlbWVudCJ9")), "statement")
  jsii_call_method("addToAccessPolicy", [statement])
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:



172
173
174
175
 
# File 'backup/backup_vault.rb', line 172

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:



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

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

#backup_vault_arn ⇒ String

The ARN of the backup vault.

Returns:

  • (String) 


121
122
123
 
# File 'backup/backup_vault.rb', line 121

def backup_vault_arn()
  jsii_get_property("backupVaultArn")
end

#backup_vault_name ⇒ String

The name of a logical container where backups are stored.

Returns:

  • (String) 


128
129
130
 
# File 'backup/backup_vault.rb', line 128

def backup_vault_name()
  jsii_get_property("backupVaultName")
end

#backup_vault_ref ⇒ AWSCDK::Interfaces::AWSBackup::BackupVaultReference

A reference to a BackupVault resource.

Returns:



135
136
137
 
# File 'backup/backup_vault.rb', line 135

def backup_vault_ref()
  jsii_get_property("backupVaultRef")
end

#block_recovery_point_deletion ⇒ void

This method returns an undefined value.

Adds a statement to the vault access policy that prevents anyone from deleting a recovery point.



241
242
243
 
# File 'backup/backup_vault.rb', line 241

def block_recovery_point_deletion()
  jsii_call_method("blockRecoveryPointDeletion", [])
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:



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

def env()
  jsii_get_property("env")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


195
196
197
 
# File 'backup/backup_vault.rb', line 195

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) 


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

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) 


224
225
226
227
 
# File 'backup/backup_vault.rb', line 224

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

#grant(grantee, *actions) ⇒ AWSCDK::IAM::Grant

Grant the actions defined in actions to the given grantee on this Backup Vault resource.

[disable-awslint:no-grants]

Parameters:

  • grantee (AWSCDK::IAM::IGrantable) —

    Principal to grant right to.

  • actions (Array<String>) —

    The actions to grant.

Returns:



252
253
254
255
256
257
258
 
# File 'backup/backup_vault.rb', line 252

def grant(grantee, *actions)
  Jsii::Type.check_type(grantee, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "grantee")
  actions.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "actions[#{index}]")
  end
  jsii_call_method("grant", [grantee, *actions])
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


71
72
73
 
# File 'backup/backup_vault.rb', line 71

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) 


100
101
102
 
# File 'backup/backup_vault.rb', line 100

def physical_name()
  jsii_get_property("physicalName")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



107
108
109
 
# File 'backup/backup_vault.rb', line 107

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


142
143
144
 
# File 'backup/backup_vault.rb', line 142

def to_string()
  jsii_call_method("toString", [])
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) 


155
156
157
158
159
160
 
# File 'backup/backup_vault.rb', line 155

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