Class: AWSCDK::Lightsail::CfnDatabaseSnapshot

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggableV2, Interfaces::AWSLightsail::IDatabaseSnapshotRef
Defined in:
lightsail/cfn_database_snapshot.rb

Overview

Resource Type definition for AWS::Lightsail::DatabaseSnapshot.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnDatabaseSnapshot

Create a new AWS::Lightsail::DatabaseSnapshot.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

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

  • props (AWSCDK::Lightsail::CfnDatabaseSnapshotProps) —

    Resource properties.



18
19
20
21
22
23
24
 
# File 'lightsail/cfn_database_snapshot.rb', line 18

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::Lightsail::CfnDatabaseSnapshotProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfbGlnaHRzYWlsLkNmbkRhdGFiYXNlU25hcHNob3RQcm9wcyJ9")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_database_snapshot(resource) ⇒ String

Parameters:

Returns:

  • (String) 


87
88
89
90
 
# File 'lightsail/cfn_database_snapshot.rb', line 87

def self.arn_for_database_snapshot(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19saWdodHNhaWwuSURhdGFiYXNlU25hcHNob3RSZWYifQ==")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_lightsail.CfnDatabaseSnapshot", "arnForDatabaseSnapshot", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


194
195
196
 
# File 'lightsail/cfn_database_snapshot.rb', line 194

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

.is_cfn_database_snapshot(x) ⇒ Boolean

Checks whether the given object is a CfnDatabaseSnapshot.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


96
97
98
99
 
# File 'lightsail/cfn_database_snapshot.rb', line 96

def self.is_cfn_database_snapshot(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_lightsail.CfnDatabaseSnapshot", "isCfnDatabaseSnapshot", [x])
end

.jsii_overridable_methods ⇒ Object 



26
27
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
83
 
# File 'lightsail/cfn_database_snapshot.rb', line 26

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_created_at => { kind: :property, name: "attrCreatedAt", is_optional: false },
    :attr_engine => { kind: :property, name: "attrEngine", is_optional: false },
    :attr_engine_version => { kind: :property, name: "attrEngineVersion", is_optional: false },
    :attr_from_relational_database_arn => { kind: :property, name: "attrFromRelationalDatabaseArn", is_optional: false },
    :attr_from_relational_database_blueprint_id => { kind: :property, name: "attrFromRelationalDatabaseBlueprintId", is_optional: false },
    :attr_from_relational_database_bundle_id => { kind: :property, name: "attrFromRelationalDatabaseBundleId", is_optional: false },
    :attr_from_relational_database_name => { kind: :property, name: "attrFromRelationalDatabaseName", is_optional: false },
    :attr_location => { kind: :property, name: "attrLocation", is_optional: false },
    :attr_name => { kind: :property, name: "attrName", is_optional: false },
    :attr_resource_type => { kind: :property, name: "attrResourceType", is_optional: false },
    :attr_size_in_gb => { kind: :property, name: "attrSizeInGb", is_optional: false },
    :attr_state => { kind: :property, name: "attrState", is_optional: false },
    :attr_support_code => { kind: :property, name: "attrSupportCode", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :database_snapshot_ref => { kind: :property, name: "databaseSnapshotRef", is_optional: false },
    :relational_database_name => { kind: :property, name: "relationalDatabaseName", is_optional: false },
    :relational_database_snapshot_name => { kind: :property, name: "relationalDatabaseSnapshotName", is_optional: false },
    :tags => { kind: :property, name: "tags", 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.



387
388
389
390
 
# File 'lightsail/cfn_database_snapshot.rb', line 387

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:



399
400
401
402
 
# File 'lightsail/cfn_database_snapshot.rb', line 399

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:



409
410
411
412
 
# File 'lightsail/cfn_database_snapshot.rb', line 409

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:



420
421
422
423
424
 
# File 'lightsail/cfn_database_snapshot.rb', line 420

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.


477
478
479
480
481
 
# File 'lightsail/cfn_database_snapshot.rb', line 477

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.



487
488
489
490
 
# File 'lightsail/cfn_database_snapshot.rb', line 487

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.



499
500
501
502
503
 
# File 'lightsail/cfn_database_snapshot.rb', line 499

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:



512
513
514
515
 
# File 'lightsail/cfn_database_snapshot.rb', line 512

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:



534
535
536
537
538
539
 
# File 'lightsail/cfn_database_snapshot.rb', line 534

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 database snapshot.

Returns:

  • (String) 


201
202
203
 
# File 'lightsail/cfn_database_snapshot.rb', line 201

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_created_at ⇒ String

The timestamp when the database snapshot was created.

Returns:

  • (String) 


208
209
210
 
# File 'lightsail/cfn_database_snapshot.rb', line 208

def attr_created_at()
  jsii_get_property("attrCreatedAt")
end

#attr_engine ⇒ String

The software of the database snapshot (for example, MySQL).

Returns:

  • (String) 


215
216
217
 
# File 'lightsail/cfn_database_snapshot.rb', line 215

def attr_engine()
  jsii_get_property("attrEngine")
end

#attr_engine_version ⇒ String

The database engine version for the database snapshot (for example, 5.7.23).

Returns:

  • (String) 


222
223
224
 
# File 'lightsail/cfn_database_snapshot.rb', line 222

def attr_engine_version()
  jsii_get_property("attrEngineVersion")
end

#attr_from_relational_database_arn ⇒ String

The Amazon Resource Name (ARN) of the database from which the database snapshot was created.

Returns:

  • (String) 


229
230
231
 
# File 'lightsail/cfn_database_snapshot.rb', line 229

def attr_from_relational_database_arn()
  jsii_get_property("attrFromRelationalDatabaseArn")
end

#attr_from_relational_database_blueprint_id ⇒ String

The blueprint ID of the database from which the database snapshot was created.

A blueprint describes the major engine version of a database.

Returns:

  • (String) 


238
239
240
 
# File 'lightsail/cfn_database_snapshot.rb', line 238

def attr_from_relational_database_blueprint_id()
  jsii_get_property("attrFromRelationalDatabaseBlueprintId")
end

#attr_from_relational_database_bundle_id ⇒ String

The bundle ID of the database from which the database snapshot was created.

Returns:

  • (String) 


245
246
247
 
# File 'lightsail/cfn_database_snapshot.rb', line 245

def attr_from_relational_database_bundle_id()
  jsii_get_property("attrFromRelationalDatabaseBundleId")
end

#attr_from_relational_database_name ⇒ String

The name of the source database from which the database snapshot was created.

Returns:

  • (String) 


252
253
254
 
# File 'lightsail/cfn_database_snapshot.rb', line 252

def attr_from_relational_database_name()
  jsii_get_property("attrFromRelationalDatabaseName")
end

#attr_location ⇒ AWSCDK::IResolvable

The Region name and Availability Zone where the database snapshot is located.

Returns:



259
260
261
 
# File 'lightsail/cfn_database_snapshot.rb', line 259

def attr_location()
  jsii_get_property("attrLocation")
end

#attr_name ⇒ String

The name of the database snapshot.

Returns:

  • (String) 


266
267
268
 
# File 'lightsail/cfn_database_snapshot.rb', line 266

def attr_name()
  jsii_get_property("attrName")
end

#attr_resource_type ⇒ String

The Lightsail resource type.

Returns:

  • (String) 


273
274
275
 
# File 'lightsail/cfn_database_snapshot.rb', line 273

def attr_resource_type()
  jsii_get_property("attrResourceType")
end

#attr_size_in_gb ⇒ Numeric

The size of the disk in GB (for example, 32) for the database snapshot.

Returns:

  • (Numeric) 


280
281
282
 
# File 'lightsail/cfn_database_snapshot.rb', line 280

def attr_size_in_gb()
  jsii_get_property("attrSizeInGb")
end

#attr_state ⇒ String

The state of the database snapshot.

Returns:

  • (String) 


287
288
289
 
# File 'lightsail/cfn_database_snapshot.rb', line 287

def attr_state()
  jsii_get_property("attrState")
end

#attr_support_code ⇒ String

The support code for the database snapshot.

Include this code in your email to support when you have questions about a database snapshot in Lightsail. This code enables our support team to look up your Lightsail information more easily.

Returns:

  • (String) 


296
297
298
 
# File 'lightsail/cfn_database_snapshot.rb', line 296

def attr_support_code()
  jsii_get_property("attrSupportCode")
end

#cdk_tag_manager ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



303
304
305
 
# File 'lightsail/cfn_database_snapshot.rb', line 303

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



147
148
149
 
# File 'lightsail/cfn_database_snapshot.rb', line 147

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


152
153
154
 
# File 'lightsail/cfn_database_snapshot.rb', line 152

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


543
544
545
546
 
# File 'lightsail/cfn_database_snapshot.rb', line 543

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


157
158
159
 
# File 'lightsail/cfn_database_snapshot.rb', line 157

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


164
165
166
 
# File 'lightsail/cfn_database_snapshot.rb', line 164

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


109
110
111
 
# File 'lightsail/cfn_database_snapshot.rb', line 109

def creation_stack()
  jsii_get_property("creationStack")
end

#database_snapshot_ref ⇒ AWSCDK::Interfaces::AWSLightsail::DatabaseSnapshotReference

A reference to a DatabaseSnapshot resource.

Returns:



310
311
312
 
# File 'lightsail/cfn_database_snapshot.rb', line 310

def database_snapshot_ref()
  jsii_get_property("databaseSnapshotRef")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



169
170
171
 
# File 'lightsail/cfn_database_snapshot.rb', line 169

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.

Parameters:

Returns:



556
557
558
559
560
 
# File 'lightsail/cfn_database_snapshot.rb', line 556

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:



567
568
569
570
 
# File 'lightsail/cfn_database_snapshot.rb', line 567

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:



637
638
639
640
 
# File 'lightsail/cfn_database_snapshot.rb', line 637

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

Returns:

  • (String) 


121
122
123
 
# File 'lightsail/cfn_database_snapshot.rb', line 121

def logical_id()
  jsii_get_property("logicalId")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


104
105
106
 
# File 'lightsail/cfn_database_snapshot.rb', line 104

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:



578
579
580
 
# File 'lightsail/cfn_database_snapshot.rb', line 578

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:



585
586
587
 
# File 'lightsail/cfn_database_snapshot.rb', line 585

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.



378
379
380
381
 
# File 'lightsail/cfn_database_snapshot.rb', line 378

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

Returns:

  • (String) 


140
141
142
 
# File 'lightsail/cfn_database_snapshot.rb', line 140

def ref()
  jsii_get_property("ref")
end

#relational_database_name ⇒ String

The name of the database on which to base your new snapshot.

Returns:

  • (String) 


317
318
319
 
# File 'lightsail/cfn_database_snapshot.rb', line 317

def relational_database_name()
  jsii_get_property("relationalDatabaseName")
end

#relational_database_name=(value) ⇒ Object 



321
322
323
324
 
# File 'lightsail/cfn_database_snapshot.rb', line 321

def relational_database_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "relationalDatabaseName")
  jsii_set_property("relationalDatabaseName", value)
end

#relational_database_snapshot_name ⇒ String

The name for your new database snapshot.

Returns:

  • (String) 


329
330
331
 
# File 'lightsail/cfn_database_snapshot.rb', line 329

def relational_database_snapshot_name()
  jsii_get_property("relationalDatabaseSnapshotName")
end

#relational_database_snapshot_name=(value) ⇒ Object 



333
334
335
336
 
# File 'lightsail/cfn_database_snapshot.rb', line 333

def relational_database_snapshot_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "relationalDatabaseSnapshotName")
  jsii_set_property("relationalDatabaseSnapshotName", value)
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:



596
597
598
599
 
# File 'lightsail/cfn_database_snapshot.rb', line 596

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


603
604
605
606
 
# File 'lightsail/cfn_database_snapshot.rb', line 603

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:



613
614
615
616
617
 
# File 'lightsail/cfn_database_snapshot.rb', line 613

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.

Returns:

  • (Boolean) —

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



622
623
624
 
# File 'lightsail/cfn_database_snapshot.rb', line 622

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:



130
131
132
 
# File 'lightsail/cfn_database_snapshot.rb', line 130

def stack()
  jsii_get_property("stack")
end

#tags ⇒ Array<AWSCDK::CfnTag>?

An array of key-value pairs to apply to this resource.

Returns:



341
342
343
 
# File 'lightsail/cfn_database_snapshot.rb', line 341

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object 



345
346
347
348
349
 
# File 'lightsail/cfn_database_snapshot.rb', line 345

def tags=(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=")), "tags") unless value.nil?
  jsii_set_property("tags", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



354
355
356
 
# File 'lightsail/cfn_database_snapshot.rb', line 354

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


177
178
179
 
# File 'lightsail/cfn_database_snapshot.rb', line 177

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


187
188
189
 
# File 'lightsail/cfn_database_snapshot.rb', line 187

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


628
629
630
631
 
# File 'lightsail/cfn_database_snapshot.rb', line 628

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) 


367
368
369
370
371
372
 
# File 'lightsail/cfn_database_snapshot.rb', line 367

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