Class: AWSCDK::RDS::CfnCustomDBEngineVersion

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggableV2, Interfaces::AWSRDS::ICustomDBEngineVersionRef
Defined in:
rds/cfn_custom_db_engine_version.rb

Overview

Creates a custom DB engine version (CEV).

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnCustomDBEngineVersion

Create a new AWS::RDS::CustomDBEngineVersion.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

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

  • props (AWSCDK::RDS::CfnCustomDBEngineVersionProps) —

    Resource properties.



18
19
20
21
22
23
24
 
# File 'rds/cfn_custom_db_engine_version.rb', line 18

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

Class Method Details

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


184
185
186
 
# File 'rds/cfn_custom_db_engine_version.rb', line 184

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

.is_cfn_custom_db_engine_version(x) ⇒ Boolean

Checks whether the given object is a CfnCustomDBEngineVersion.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


86
87
88
89
 
# File 'rds/cfn_custom_db_engine_version.rb', line 86

def self.is_cfn_custom_db_engine_version(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_rds.CfnCustomDBEngineVersion", "isCfnCustomDBEngineVersion", [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
 
# File 'rds/cfn_custom_db_engine_version.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_db_engine_version_arn => { kind: :property, name: "attrDbEngineVersionArn", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :custom_db_engine_version_ref => { kind: :property, name: "customDbEngineVersionRef", is_optional: false },
    :engine => { kind: :property, name: "engine", is_optional: false },
    :engine_version => { kind: :property, name: "engineVersion", is_optional: false },
    :database_installation_files => { kind: :property, name: "databaseInstallationFiles", is_optional: true },
    :database_installation_files_s3_bucket_name => { kind: :property, name: "databaseInstallationFilesS3BucketName", is_optional: true },
    :database_installation_files_s3_prefix => { kind: :property, name: "databaseInstallationFilesS3Prefix", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :image_id => { kind: :property, name: "imageId", is_optional: true },
    :kms_key_id => { kind: :property, name: "kmsKeyId", is_optional: true },
    :manifest => { kind: :property, name: "manifest", is_optional: true },
    :source_custom_db_engine_version_identifier => { kind: :property, name: "sourceCustomDbEngineVersionIdentifier", is_optional: true },
    :status => { kind: :property, name: "status", is_optional: true },
    :tags => { kind: :property, name: "tags", is_optional: true },
    :use_aws_provided_latest_image => { kind: :property, name: "useAwsProvidedLatestImage", 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.



400
401
402
403
 
# File 'rds/cfn_custom_db_engine_version.rb', line 400

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:



412
413
414
415
 
# File 'rds/cfn_custom_db_engine_version.rb', line 412

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:



422
423
424
425
 
# File 'rds/cfn_custom_db_engine_version.rb', line 422

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:



433
434
435
436
437
 
# File 'rds/cfn_custom_db_engine_version.rb', line 433

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.


490
491
492
493
494
 
# File 'rds/cfn_custom_db_engine_version.rb', line 490

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.



500
501
502
503
 
# File 'rds/cfn_custom_db_engine_version.rb', line 500

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.



512
513
514
515
516
 
# File 'rds/cfn_custom_db_engine_version.rb', line 512

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:



525
526
527
528
 
# File 'rds/cfn_custom_db_engine_version.rb', line 525

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:



547
548
549
550
551
552
 
# File 'rds/cfn_custom_db_engine_version.rb', line 547

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_db_engine_version_arn ⇒ String

The ARN of the custom engine version.

Returns:

  • (String) 


191
192
193
 
# File 'rds/cfn_custom_db_engine_version.rb', line 191

def attr_db_engine_version_arn()
  jsii_get_property("attrDbEngineVersionArn")
end

#cdk_tag_manager ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



198
199
200
 
# File 'rds/cfn_custom_db_engine_version.rb', line 198

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



137
138
139
 
# File 'rds/cfn_custom_db_engine_version.rb', line 137

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


142
143
144
 
# File 'rds/cfn_custom_db_engine_version.rb', line 142

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


556
557
558
559
 
# File 'rds/cfn_custom_db_engine_version.rb', line 556

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


147
148
149
 
# File 'rds/cfn_custom_db_engine_version.rb', line 147

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


154
155
156
 
# File 'rds/cfn_custom_db_engine_version.rb', line 154

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


99
100
101
 
# File 'rds/cfn_custom_db_engine_version.rb', line 99

def creation_stack()
  jsii_get_property("creationStack")
end

#custom_db_engine_version_ref ⇒ AWSCDK::Interfaces::AWSRDS::CustomDBEngineVersionReference

A reference to a CustomDBEngineVersion resource.

Returns:



205
206
207
 
# File 'rds/cfn_custom_db_engine_version.rb', line 205

def custom_db_engine_version_ref()
  jsii_get_property("customDbEngineVersionRef")
end

#database_installation_files ⇒ Array<String>?

Returns:

  • (Array<String>, nil) 


234
235
236
 
# File 'rds/cfn_custom_db_engine_version.rb', line 234

def database_installation_files()
  jsii_get_property("databaseInstallationFiles")
end

#database_installation_files=(value) ⇒ Object 



238
239
240
241
 
# File 'rds/cfn_custom_db_engine_version.rb', line 238

def database_installation_files=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "databaseInstallationFiles") unless value.nil?
  jsii_set_property("databaseInstallationFiles", value)
end

#database_installation_files_s3_bucket_name ⇒ String?

The name of an Amazon S3 bucket that contains database installation files for your CEV.

Returns:

  • (String, nil) 


246
247
248
 
# File 'rds/cfn_custom_db_engine_version.rb', line 246

def database_installation_files_s3_bucket_name()
  jsii_get_property("databaseInstallationFilesS3BucketName")
end

#database_installation_files_s3_bucket_name=(value) ⇒ Object 



250
251
252
253
 
# File 'rds/cfn_custom_db_engine_version.rb', line 250

def database_installation_files_s3_bucket_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "databaseInstallationFilesS3BucketName") unless value.nil?
  jsii_set_property("databaseInstallationFilesS3BucketName", value)
end

#database_installation_files_s3_prefix ⇒ String?

The Amazon S3 directory that contains the database installation files for your CEV.

Returns:

  • (String, nil) 


258
259
260
 
# File 'rds/cfn_custom_db_engine_version.rb', line 258

def database_installation_files_s3_prefix()
  jsii_get_property("databaseInstallationFilesS3Prefix")
end

#database_installation_files_s3_prefix=(value) ⇒ Object 



262
263
264
265
 
# File 'rds/cfn_custom_db_engine_version.rb', line 262

def database_installation_files_s3_prefix=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "databaseInstallationFilesS3Prefix") unless value.nil?
  jsii_set_property("databaseInstallationFilesS3Prefix", value)
end

#description ⇒ String?

An optional description of your CEV.

Returns:

  • (String, nil) 


270
271
272
 
# File 'rds/cfn_custom_db_engine_version.rb', line 270

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



274
275
276
277
 
# File 'rds/cfn_custom_db_engine_version.rb', line 274

def description=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless value.nil?
  jsii_set_property("description", value)
end

#engine ⇒ String

The database engine to use for your custom engine version (CEV).

Returns:

  • (String) 


212
213
214
 
# File 'rds/cfn_custom_db_engine_version.rb', line 212

def engine()
  jsii_get_property("engine")
end

#engine=(value) ⇒ Object 



216
217
218
219
 
# File 'rds/cfn_custom_db_engine_version.rb', line 216

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

#engine_version ⇒ String

The name of your CEV.

Returns:

  • (String) 


224
225
226
 
# File 'rds/cfn_custom_db_engine_version.rb', line 224

def engine_version()
  jsii_get_property("engineVersion")
end

#engine_version=(value) ⇒ Object 



228
229
230
231
 
# File 'rds/cfn_custom_db_engine_version.rb', line 228

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



159
160
161
 
# File 'rds/cfn_custom_db_engine_version.rb', line 159

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:



569
570
571
572
573
 
# File 'rds/cfn_custom_db_engine_version.rb', line 569

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:



580
581
582
583
 
# File 'rds/cfn_custom_db_engine_version.rb', line 580

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#image_id ⇒ String?

A value that indicates the ID of the AMI.

Returns:

  • (String, nil) 


282
283
284
 
# File 'rds/cfn_custom_db_engine_version.rb', line 282

def image_id()
  jsii_get_property("imageId")
end

#image_id=(value) ⇒ Object 



286
287
288
289
 
# File 'rds/cfn_custom_db_engine_version.rb', line 286

def image_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "imageId") unless value.nil?
  jsii_set_property("imageId", value)
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



650
651
652
653
 
# File 'rds/cfn_custom_db_engine_version.rb', line 650

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#kms_key_id ⇒ String?

The AWS KMS key identifier for an encrypted CEV.

Returns:

  • (String, nil) 


294
295
296
 
# File 'rds/cfn_custom_db_engine_version.rb', line 294

def kms_key_id()
  jsii_get_property("kmsKeyId")
end

#kms_key_id=(value) ⇒ Object 



298
299
300
301
 
# File 'rds/cfn_custom_db_engine_version.rb', line 298

def kms_key_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "kmsKeyId") unless value.nil?
  jsii_set_property("kmsKeyId", value)
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) 


111
112
113
 
# File 'rds/cfn_custom_db_engine_version.rb', line 111

def logical_id()
  jsii_get_property("logicalId")
end

#manifest ⇒ String?

The CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3. Specify the name/value pairs in a file or a quoted string. RDS Custom applies the patches in the order in which they are listed.

Returns:

  • (String, nil) 


306
307
308
 
# File 'rds/cfn_custom_db_engine_version.rb', line 306

def manifest()
  jsii_get_property("manifest")
end

#manifest=(value) ⇒ Object 



310
311
312
313
 
# File 'rds/cfn_custom_db_engine_version.rb', line 310

def manifest=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "manifest") unless value.nil?
  jsii_set_property("manifest", value)
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


94
95
96
 
# File 'rds/cfn_custom_db_engine_version.rb', line 94

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:



591
592
593
 
# File 'rds/cfn_custom_db_engine_version.rb', line 591

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:



598
599
600
 
# File 'rds/cfn_custom_db_engine_version.rb', line 598

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.



391
392
393
394
 
# File 'rds/cfn_custom_db_engine_version.rb', line 391

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) 


130
131
132
 
# File 'rds/cfn_custom_db_engine_version.rb', line 130

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.

Parameters:



609
610
611
612
 
# File 'rds/cfn_custom_db_engine_version.rb', line 609

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


616
617
618
619
 
# File 'rds/cfn_custom_db_engine_version.rb', line 616

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:



626
627
628
629
630
 
# File 'rds/cfn_custom_db_engine_version.rb', line 626

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.



635
636
637
 
# File 'rds/cfn_custom_db_engine_version.rb', line 635

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#source_custom_db_engine_version_identifier ⇒ String?

The ARN of a CEV to use as a source for creating a new CEV.

Returns:

  • (String, nil) 


318
319
320
 
# File 'rds/cfn_custom_db_engine_version.rb', line 318

def source_custom_db_engine_version_identifier()
  jsii_get_property("sourceCustomDbEngineVersionIdentifier")
end

#source_custom_db_engine_version_identifier=(value) ⇒ Object 



322
323
324
325
 
# File 'rds/cfn_custom_db_engine_version.rb', line 322

def source_custom_db_engine_version_identifier=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "sourceCustomDbEngineVersionIdentifier") unless value.nil?
  jsii_set_property("sourceCustomDbEngineVersionIdentifier", value)
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



120
121
122
 
# File 'rds/cfn_custom_db_engine_version.rb', line 120

def stack()
  jsii_get_property("stack")
end

#status ⇒ String?

A value that indicates the status of a custom engine version (CEV).

Returns:

  • (String, nil) 


330
331
332
 
# File 'rds/cfn_custom_db_engine_version.rb', line 330

def status()
  jsii_get_property("status")
end

#status=(value) ⇒ Object 



334
335
336
337
 
# File 'rds/cfn_custom_db_engine_version.rb', line 334

def status=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "status") unless value.nil?
  jsii_set_property("status", value)
end

#tags ⇒ Array<AWSCDK::CfnTag>?

A list of tags.

Returns:



342
343
344
 
# File 'rds/cfn_custom_db_engine_version.rb', line 342

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object 



346
347
348
349
350
 
# File 'rds/cfn_custom_db_engine_version.rb', line 346

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



367
368
369
 
# File 'rds/cfn_custom_db_engine_version.rb', line 367

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


167
168
169
 
# File 'rds/cfn_custom_db_engine_version.rb', line 167

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


177
178
179
 
# File 'rds/cfn_custom_db_engine_version.rb', line 177

def updated_properties()
  jsii_get_property("updatedProperties")
end

#use_aws_provided_latest_image ⇒ Boolean, ...

Specifies whether to use the latest service-provided Amazon Machine Image (AMI) for the CEV.

Returns:



355
356
357
 
# File 'rds/cfn_custom_db_engine_version.rb', line 355

def use_aws_provided_latest_image()
  jsii_get_property("useAwsProvidedLatestImage")
end

#use_aws_provided_latest_image=(value) ⇒ Object 



359
360
361
362
 
# File 'rds/cfn_custom_db_engine_version.rb', line 359

def use_aws_provided_latest_image=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "useAwsProvidedLatestImage") unless value.nil?
  jsii_set_property("useAwsProvidedLatestImage", value)
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


641
642
643
644
 
# File 'rds/cfn_custom_db_engine_version.rb', line 641

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) 


380
381
382
383
384
385
 
# File 'rds/cfn_custom_db_engine_version.rb', line 380

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