Class: AWSCDK::Backup::CfnLogicallyAirGappedBackupVault
- Inherits:
-
CfnResource
- Object
- CfnResource
- AWSCDK::Backup::CfnLogicallyAirGappedBackupVault
- Includes:
- IInspectable, ITaggableV2, Interfaces::AWSBackup::ILogicallyAirGappedBackupVaultRef
- Defined in:
- backup/cfn_logically_air_gapped_backup_vault.rb
Overview
Creates a logical container to where backups may be copied.
This request includes a name, the Region, the maximum number of retention days, the minimum number of retention days, and optionally can include tags and a creator request ID.
Do not include sensitive data, such as passport numbers, in the name of a backup vault.
Class Method Summary collapse
- .arn_for_logically_air_gapped_backup_vault(resource) ⇒ String
-
.CFN_RESOURCE_TYPE_NAME ⇒ String
The CloudFormation resource type name for this resource class.
-
.from_backup_vault_name(scope, id, backup_vault_name) ⇒ AWSCDK::Interfaces::AWSBackup::ILogicallyAirGappedBackupVaultRef
Creates a new ILogicallyAirGappedBackupVaultRef from a backupVaultName.
-
.is_cfn_logically_air_gapped_backup_vault(x) ⇒ Boolean
Checks whether the given object is a CfnLogicallyAirGappedBackupVault.
- .jsii_overridable_methods ⇒ Object
Instance Method Summary collapse
-
#access_policy ⇒ Object
The backup vault access policy document in JSON format.
- #access_policy=(value) ⇒ Object
-
#add_deletion_override(path) ⇒ void
Syntactic sugar for
addOverride(path, undefined). -
#add_dependency(target) ⇒ void
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
-
#add_depends_on(target) ⇒ void
deprecated
Deprecated.
use addDependency
-
#add_metadata(key, value) ⇒ void
Add a value to the CloudFormation Resource Metadata.
-
#add_override(path, value) ⇒ void
Adds an override to the synthesized CloudFormation resource.
-
#add_property_deletion_override(property_path) ⇒ void
Adds an override that deletes the value of a property from the resource definition.
-
#add_property_override(property_path, value) ⇒ void
Adds an override to a resource property.
-
#apply_cross_stack_reference_strength(strength) ⇒ void
Sets the cross-stack reference strength for this resource.
-
#apply_removal_policy(policy = nil, options = nil) ⇒ void
Sets the deletion policy of the resource based on the removal policy specified.
-
#attr_backup_vault_arn ⇒ String
The ARN of the backup vault.
-
#attr_vault_state ⇒ String
The vault state.
-
#attr_vault_type ⇒ String
The vault type.
-
#backup_vault_name ⇒ String
The name of a logical container where backups are stored.
- #backup_vault_name=(value) ⇒ Object
-
#backup_vault_tags ⇒ Hash{String => String}?
The tags to assign to the vault.
- #backup_vault_tags=(value) ⇒ Object
-
#cdk_tag_manager ⇒ AWSCDK::TagManager
Tag Manager which manages the tags for this resource.
-
#cfn_options ⇒ AWSCDK::ICfnResourceOptions
Options for this resource, such as condition, update policy etc.
- #cfn_properties ⇒ Hash{String => Object}
- #cfn_property_name(cdk_property_name) ⇒ String?
- #cfn_property_names ⇒ Hash{String => String}
-
#cfn_resource_type ⇒ String
AWS resource type.
- #creation_stack ⇒ Array<String>
-
#encryption_key_arn ⇒ String?
The server-side encryption key that is used to protect your backups;.
- #encryption_key_arn=(value) ⇒ Object
- #env ⇒ AWSCDK::Interfaces::ResourceEnvironment
-
#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference
Returns a token for an runtime attribute of this resource.
-
#get_metadata(key) ⇒ Object
Retrieve a value value from the CloudFormation Resource Metadata.
-
#initialize(scope, id, props) ⇒ CfnLogicallyAirGappedBackupVault
constructor
Create a new
AWS::Backup::LogicallyAirGappedBackupVault. -
#inspect(inspector) ⇒ void
Examines the CloudFormation resource and discloses attributes.
-
#logical_id ⇒ String
The logical ID for this CloudFormation stack element.
-
#logically_air_gapped_backup_vault_ref ⇒ AWSCDK::Interfaces::AWSBackup::LogicallyAirGappedBackupVaultReference
A reference to a LogicallyAirGappedBackupVault resource.
-
#max_retention_days ⇒ Numeric
The maximum retention period that the vault retains its recovery points.
- #max_retention_days=(value) ⇒ Object
-
#min_retention_days ⇒ Numeric
This setting specifies the minimum retention period that the vault retains its recovery points.
- #min_retention_days=(value) ⇒ Object
-
#mpa_approval_team_arn ⇒ String?
The Amazon Resource Name (ARN) of the MPA approval team to associate with the backup vault.
- #mpa_approval_team_arn=(value) ⇒ Object
-
#node ⇒ Constructs::Node
The tree node.
-
#notifications ⇒ AWSCDK::IResolvable, ...
Returns event notifications for the specified backup vault.
- #notifications=(value) ⇒ Object
-
#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>
Retrieves an array of resources this resource depends on.
-
#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>
Get a shallow copy of dependencies between this resource and other resources in the same stack.
-
#override_logical_id(new_logical_id) ⇒ void
Overrides the auto-generated logical ID with a specific ID.
-
#ref ⇒ String
Return a string that will be resolved to a CloudFormation
{ Ref }for this element. -
#remove_dependency(target) ⇒ void
Indicates that this resource no longer depends on another resource.
- #render_properties(props) ⇒ Hash{String => Object}
-
#replace_dependency(target, new_target) ⇒ void
Replaces one dependency with another.
-
#should_synthesize ⇒ Boolean
Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
-
#stack ⇒ AWSCDK::Stack
The stack in which this element is defined.
-
#to_string ⇒ String
Returns a string representation of this construct.
-
#updated_properites ⇒ Hash{String => Object}
deprecated
Deprecated.
use
updatedPropertiesReturn properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource. -
#updated_properties ⇒ Hash{String => Object}
Return properties modified after initiation.
- #validate_properties(_properties) ⇒ void
-
#with(*mixins) ⇒ Constructs::IConstruct
Applies one or more mixins to this construct.
Constructor Details
#initialize(scope, id, props) ⇒ CfnLogicallyAirGappedBackupVault
Create a new AWS::Backup::LogicallyAirGappedBackupVault.
22 23 24 25 26 27 28 |
# File 'backup/cfn_logically_air_gapped_backup_vault.rb', line 22 def initialize(scope, id, props) props = props.is_a?(Hash) ? ::AWSCDK::Backup::CfnLogicallyAirGappedBackupVaultProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYmFja3VwLkNmbkxvZ2ljYWxseUFpckdhcHBlZEJhY2t1cFZhdWx0UHJvcHMifQ==")), "props") Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props) end |
Class Method Details
.arn_for_logically_air_gapped_backup_vault(resource) ⇒ String
85 86 87 88 |
# File 'backup/cfn_logically_air_gapped_backup_vault.rb', line 85 def self.arn_for_logically_air_gapped_backup_vault(resource) Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19iYWNrdXAuSUxvZ2ljYWxseUFpckdhcHBlZEJhY2t1cFZhdWx0UmVmIn0=")), "resource") Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_backup.CfnLogicallyAirGappedBackupVault", "arnForLogicallyAirGappedBackupVault", [resource]) end |
.CFN_RESOURCE_TYPE_NAME ⇒ String
The CloudFormation resource type name for this resource class.
205 206 207 |
# File 'backup/cfn_logically_air_gapped_backup_vault.rb', line 205 def self.CFN_RESOURCE_TYPE_NAME() Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_backup.CfnLogicallyAirGappedBackupVault", "CFN_RESOURCE_TYPE_NAME") end |
.from_backup_vault_name(scope, id, backup_vault_name) ⇒ AWSCDK::Interfaces::AWSBackup::ILogicallyAirGappedBackupVaultRef
Creates a new ILogicallyAirGappedBackupVaultRef from a backupVaultName.
96 97 98 99 100 101 |
# File 'backup/cfn_logically_air_gapped_backup_vault.rb', line 96 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.CfnLogicallyAirGappedBackupVault", "fromBackupVaultName", [scope, id, backup_vault_name]) end |
.is_cfn_logically_air_gapped_backup_vault(x) ⇒ Boolean
Checks whether the given object is a CfnLogicallyAirGappedBackupVault.
107 108 109 110 |
# File 'backup/cfn_logically_air_gapped_backup_vault.rb', line 107 def self.is_cfn_logically_air_gapped_backup_vault(x) Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x") Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_backup.CfnLogicallyAirGappedBackupVault", "isCfnLogicallyAirGappedBackupVault", [x]) end |
.jsii_overridable_methods ⇒ Object
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 |
# File 'backup/cfn_logically_air_gapped_backup_vault.rb', line 30 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_backup_vault_arn => { kind: :property, name: "attrBackupVaultArn", is_optional: false }, :attr_vault_state => { kind: :property, name: "attrVaultState", is_optional: false }, :attr_vault_type => { kind: :property, name: "attrVaultType", is_optional: false }, :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false }, :logically_air_gapped_backup_vault_ref => { kind: :property, name: "logicallyAirGappedBackupVaultRef", is_optional: false }, :access_policy => { kind: :property, name: "accessPolicy", is_optional: false }, :backup_vault_name => { kind: :property, name: "backupVaultName", is_optional: false }, :max_retention_days => { kind: :property, name: "maxRetentionDays", is_optional: false }, :min_retention_days => { kind: :property, name: "minRetentionDays", is_optional: false }, :backup_vault_tags => { kind: :property, name: "backupVaultTags", is_optional: true }, :encryption_key_arn => { kind: :property, name: "encryptionKeyArn", is_optional: true }, :mpa_approval_team_arn => { kind: :property, name: "mpaApprovalTeamArn", is_optional: true }, :notifications => { kind: :property, name: "notifications", 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
#access_policy ⇒ Object
The backup vault access policy document in JSON format.
251 252 253 |
# File 'backup/cfn_logically_air_gapped_backup_vault.rb', line 251 def access_policy() jsii_get_property("accessPolicy") end |
#access_policy=(value) ⇒ Object
255 256 257 258 |
# File 'backup/cfn_logically_air_gapped_backup_vault.rb', line 255 def access_policy=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "accessPolicy") jsii_set_property("accessPolicy", value) end |
#add_deletion_override(path) ⇒ void
This method returns an undefined value.
Syntactic sugar for addOverride(path, undefined).
383 384 385 386 |
# File 'backup/cfn_logically_air_gapped_backup_vault.rb', line 383 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.
395 396 397 398 |
# File 'backup/cfn_logically_air_gapped_backup_vault.rb', line 395 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
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.
405 406 407 408 |
# File 'backup/cfn_logically_air_gapped_backup_vault.rb', line 405 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.
416 417 418 419 420 |
# File 'backup/cfn_logically_air_gapped_backup_vault.rb', line 416 def (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.
473 474 475 476 477 |
# File 'backup/cfn_logically_air_gapped_backup_vault.rb', line 473 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.
483 484 485 486 |
# File 'backup/cfn_logically_air_gapped_backup_vault.rb', line 483 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).
495 496 497 498 499 |
# File 'backup/cfn_logically_air_gapped_backup_vault.rb', line 495 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.
508 509 510 511 |
# File 'backup/cfn_logically_air_gapped_backup_vault.rb', line 508 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:
530 531 532 533 534 535 |
# File 'backup/cfn_logically_air_gapped_backup_vault.rb', line 530 def apply_removal_policy(policy = nil, = nil) Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil? = .is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**.transform_keys(&:to_sym)) : Jsii::Type.check_type(, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless .nil? jsii_call_method("applyRemovalPolicy", [policy, ]) end |
#attr_backup_vault_arn ⇒ String
The ARN of the backup vault.
212 213 214 |
# File 'backup/cfn_logically_air_gapped_backup_vault.rb', line 212 def attr_backup_vault_arn() jsii_get_property("attrBackupVaultArn") end |
#attr_vault_state ⇒ String
The vault state.
The possible values are CREATING , AVAILABLE , and FAILED .
221 222 223 |
# File 'backup/cfn_logically_air_gapped_backup_vault.rb', line 221 def attr_vault_state() jsii_get_property("attrVaultState") end |
#attr_vault_type ⇒ String
The vault type.
The possible values are BACKUP_VAULT and LOGICALLY_AIR_GAPPED_BACKUP_VAULT .
230 231 232 |
# File 'backup/cfn_logically_air_gapped_backup_vault.rb', line 230 def attr_vault_type() jsii_get_property("attrVaultType") end |
#backup_vault_name ⇒ String
The name of a logical container where backups are stored.
263 264 265 |
# File 'backup/cfn_logically_air_gapped_backup_vault.rb', line 263 def backup_vault_name() jsii_get_property("backupVaultName") end |
#backup_vault_name=(value) ⇒ Object
267 268 269 270 |
# File 'backup/cfn_logically_air_gapped_backup_vault.rb', line 267 def backup_vault_name=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "backupVaultName") jsii_set_property("backupVaultName", value) end |
#backup_vault_tags ⇒ Hash{String => String}?
The tags to assign to the vault.
299 300 301 |
# File 'backup/cfn_logically_air_gapped_backup_vault.rb', line 299 def () jsii_get_property("backupVaultTags") end |
#backup_vault_tags=(value) ⇒ Object
303 304 305 306 |
# File 'backup/cfn_logically_air_gapped_backup_vault.rb', line 303 def (value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoibWFwIn19")), "backupVaultTags") unless value.nil? jsii_set_property("backupVaultTags", value) end |
#cdk_tag_manager ⇒ AWSCDK::TagManager
Tag Manager which manages the tags for this resource.
237 238 239 |
# File 'backup/cfn_logically_air_gapped_backup_vault.rb', line 237 def cdk_tag_manager() jsii_get_property("cdkTagManager") end |
#cfn_options ⇒ AWSCDK::ICfnResourceOptions
Options for this resource, such as condition, update policy etc.
158 159 160 |
# File 'backup/cfn_logically_air_gapped_backup_vault.rb', line 158 def () jsii_get_property("cfnOptions") end |
#cfn_properties ⇒ Hash{String => Object}
163 164 165 |
# File 'backup/cfn_logically_air_gapped_backup_vault.rb', line 163 def cfn_properties() jsii_get_property("cfnProperties") end |
#cfn_property_name(cdk_property_name) ⇒ String?
539 540 541 542 |
# File 'backup/cfn_logically_air_gapped_backup_vault.rb', line 539 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}
168 169 170 |
# File 'backup/cfn_logically_air_gapped_backup_vault.rb', line 168 def cfn_property_names() jsii_get_property("cfnPropertyNames") end |
#cfn_resource_type ⇒ String
AWS resource type.
175 176 177 |
# File 'backup/cfn_logically_air_gapped_backup_vault.rb', line 175 def cfn_resource_type() jsii_get_property("cfnResourceType") end |
#creation_stack ⇒ Array<String>
120 121 122 |
# File 'backup/cfn_logically_air_gapped_backup_vault.rb', line 120 def creation_stack() jsii_get_property("creationStack") end |
#encryption_key_arn ⇒ String?
The server-side encryption key that is used to protect your backups;
for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab .
313 314 315 |
# File 'backup/cfn_logically_air_gapped_backup_vault.rb', line 313 def encryption_key_arn() jsii_get_property("encryptionKeyArn") end |
#encryption_key_arn=(value) ⇒ Object
317 318 319 320 |
# File 'backup/cfn_logically_air_gapped_backup_vault.rb', line 317 def encryption_key_arn=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "encryptionKeyArn") unless value.nil? jsii_set_property("encryptionKeyArn", value) end |
#env ⇒ AWSCDK::Interfaces::ResourceEnvironment
180 181 182 |
# File 'backup/cfn_logically_air_gapped_backup_vault.rb', line 180 def env() jsii_get_property("env") 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.
552 553 554 555 556 |
# File 'backup/cfn_logically_air_gapped_backup_vault.rb', line 552 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.
563 564 565 566 |
# File 'backup/cfn_logically_air_gapped_backup_vault.rb', line 563 def (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.
633 634 635 636 |
# File 'backup/cfn_logically_air_gapped_backup_vault.rb', line 633 def inspect(inspector) Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector") jsii_call_method("inspect", [inspector]) 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).
132 133 134 |
# File 'backup/cfn_logically_air_gapped_backup_vault.rb', line 132 def logical_id() jsii_get_property("logicalId") end |
#logically_air_gapped_backup_vault_ref ⇒ AWSCDK::Interfaces::AWSBackup::LogicallyAirGappedBackupVaultReference
A reference to a LogicallyAirGappedBackupVault resource.
244 245 246 |
# File 'backup/cfn_logically_air_gapped_backup_vault.rb', line 244 def logically_air_gapped_backup_vault_ref() jsii_get_property("logicallyAirGappedBackupVaultRef") end |
#max_retention_days ⇒ Numeric
The maximum retention period that the vault retains its recovery points.
275 276 277 |
# File 'backup/cfn_logically_air_gapped_backup_vault.rb', line 275 def max_retention_days() jsii_get_property("maxRetentionDays") end |
#max_retention_days=(value) ⇒ Object
279 280 281 282 |
# File 'backup/cfn_logically_air_gapped_backup_vault.rb', line 279 def max_retention_days=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "maxRetentionDays") jsii_set_property("maxRetentionDays", value) end |
#min_retention_days ⇒ Numeric
This setting specifies the minimum retention period that the vault retains its recovery points.
287 288 289 |
# File 'backup/cfn_logically_air_gapped_backup_vault.rb', line 287 def min_retention_days() jsii_get_property("minRetentionDays") end |
#min_retention_days=(value) ⇒ Object
291 292 293 294 |
# File 'backup/cfn_logically_air_gapped_backup_vault.rb', line 291 def min_retention_days=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "minRetentionDays") jsii_set_property("minRetentionDays", value) end |
#mpa_approval_team_arn ⇒ String?
The Amazon Resource Name (ARN) of the MPA approval team to associate with the backup vault.
325 326 327 |
# File 'backup/cfn_logically_air_gapped_backup_vault.rb', line 325 def mpa_approval_team_arn() jsii_get_property("mpaApprovalTeamArn") end |
#mpa_approval_team_arn=(value) ⇒ Object
329 330 331 332 |
# File 'backup/cfn_logically_air_gapped_backup_vault.rb', line 329 def mpa_approval_team_arn=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "mpaApprovalTeamArn") unless value.nil? jsii_set_property("mpaApprovalTeamArn", value) end |
#node ⇒ Constructs::Node
The tree node.
115 116 117 |
# File 'backup/cfn_logically_air_gapped_backup_vault.rb', line 115 def node() jsii_get_property("node") end |
#notifications ⇒ AWSCDK::IResolvable, ...
Returns event notifications for the specified backup vault.
337 338 339 |
# File 'backup/cfn_logically_air_gapped_backup_vault.rb', line 337 def notifications() jsii_get_property("notifications") end |
#notifications=(value) ⇒ Object
341 342 343 344 345 |
# File 'backup/cfn_logically_air_gapped_backup_vault.rb', line 341 def notifications=(value) value = value.is_a?(Hash) ? ::AWSCDK::Backup::CfnLogicallyAirGappedBackupVault::NotificationObjectTypeProperty.new(**value.transform_keys(&:to_sym)) : value Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iYWNrdXAuQ2ZuTG9naWNhbGx5QWlyR2FwcGVkQmFja3VwVmF1bHQuTm90aWZpY2F0aW9uT2JqZWN0VHlwZVByb3BlcnR5In1dfX0=")), "notifications") unless value.nil? jsii_set_property("notifications", value) 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.
574 575 576 |
# File 'backup/cfn_logically_air_gapped_backup_vault.rb', line 574 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.
581 582 583 |
# File 'backup/cfn_logically_air_gapped_backup_vault.rb', line 581 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.
374 375 376 377 |
# File 'backup/cfn_logically_air_gapped_backup_vault.rb', line 374 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 |
#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 }).
151 152 153 |
# File 'backup/cfn_logically_air_gapped_backup_vault.rb', line 151 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.
592 593 594 595 |
# File 'backup/cfn_logically_air_gapped_backup_vault.rb', line 592 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}
599 600 601 602 |
# File 'backup/cfn_logically_air_gapped_backup_vault.rb', line 599 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.
609 610 611 612 613 |
# File 'backup/cfn_logically_air_gapped_backup_vault.rb', line 609 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 |
#should_synthesize ⇒ Boolean
Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
618 619 620 |
# File 'backup/cfn_logically_air_gapped_backup_vault.rb', line 618 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).
141 142 143 |
# File 'backup/cfn_logically_air_gapped_backup_vault.rb', line 141 def stack() jsii_get_property("stack") end |
#to_string ⇒ String
Returns a string representation of this construct.
350 351 352 |
# File 'backup/cfn_logically_air_gapped_backup_vault.rb', line 350 def to_string() jsii_call_method("toString", []) end |
#updated_properites ⇒ Hash{String => Object}
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.
188 189 190 |
# File 'backup/cfn_logically_air_gapped_backup_vault.rb', line 188 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.
198 199 200 |
# File 'backup/cfn_logically_air_gapped_backup_vault.rb', line 198 def updated_properties() jsii_get_property("updatedProperties") end |
#validate_properties(_properties) ⇒ void
This method returns an undefined value.
624 625 626 627 |
# File 'backup/cfn_logically_air_gapped_backup_vault.rb', line 624 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.
363 364 365 366 367 368 |
# File 'backup/cfn_logically_air_gapped_backup_vault.rb', line 363 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 |