Class: AWSCDK::Neptune::CfnGlobalClusterProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
neptune/cfn_global_cluster_props.rb

Overview

Properties for defining a CfnGlobalCluster.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(deletion_protection: nil, engine: nil, engine_version: nil, global_cluster_identifier: nil, source_db_cluster_identifier: nil, storage_encrypted: nil, tags: nil) ⇒ CfnGlobalClusterProps

Returns a new instance of CfnGlobalClusterProps.

Parameters:

  • deletion_protection (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    Whether deletion protection is enabled.

  • engine (String, nil) (defaults to: nil) —

    The name of the database engine.

  • engine_version (String, nil) (defaults to: nil) —

    The version number of the database engine.

  • global_cluster_identifier (String, nil) (defaults to: nil) —

    The cluster identifier of the global database cluster.

  • source_db_cluster_identifier (String, nil) (defaults to: nil) —

    The Amazon Resource Name (ARN) of an existing Neptune DB cluster to use as the primary cluster of the new global database.

  • storage_encrypted (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    Whether the global database cluster is storage encrypted.

  • tags (Array<AWSCDK::CfnTag>, nil) (defaults to: nil) —

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



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
 
# File 'neptune/cfn_global_cluster_props.rb', line 16

def initialize(deletion_protection: nil, engine: nil, engine_version: nil, global_cluster_identifier: nil, source_db_cluster_identifier: nil, storage_encrypted: nil, tags: nil)
  @deletion_protection = deletion_protection
  Jsii::Type.check_type(@deletion_protection, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "deletionProtection") unless @deletion_protection.nil?
  @engine = engine
  Jsii::Type.check_type(@engine, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "engine") unless @engine.nil?
  @engine_version = engine_version
  Jsii::Type.check_type(@engine_version, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "engineVersion") unless @engine_version.nil?
  @global_cluster_identifier = global_cluster_identifier
  Jsii::Type.check_type(@global_cluster_identifier, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "globalClusterIdentifier") unless @global_cluster_identifier.nil?
  @source_db_cluster_identifier = source_db_cluster_identifier
  Jsii::Type.check_type(@source_db_cluster_identifier, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "sourceDbClusterIdentifier") unless @source_db_cluster_identifier.nil?
  @storage_encrypted = storage_encrypted
  Jsii::Type.check_type(@storage_encrypted, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "storageEncrypted") unless @storage_encrypted.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
end

Instance Attribute Details

#deletion_protection ⇒ Boolean, ... (readonly)

Whether deletion protection is enabled.

Returns:

See Also:



37
38
39
 
# File 'neptune/cfn_global_cluster_props.rb', line 37

def deletion_protection
  @deletion_protection
end

#engine ⇒ String? (readonly)

The name of the database engine.

Returns:

  • (String, nil)

See Also:



42
43
44
 
# File 'neptune/cfn_global_cluster_props.rb', line 42

def engine
  @engine
end

#engine_version ⇒ String? (readonly)

The version number of the database engine.

Returns:

  • (String, nil)

See Also:



47
48
49
 
# File 'neptune/cfn_global_cluster_props.rb', line 47

def engine_version
  @engine_version
end

#global_cluster_identifier ⇒ String? (readonly)

The cluster identifier of the global database cluster.

Returns:

  • (String, nil)

See Also:



52
53
54
 
# File 'neptune/cfn_global_cluster_props.rb', line 52

def global_cluster_identifier
  @global_cluster_identifier
end

#source_db_cluster_identifier ⇒ String? (readonly)

The Amazon Resource Name (ARN) of an existing Neptune DB cluster to use as the primary cluster of the new global database.

Returns:

  • (String, nil)

See Also:



57
58
59
 
# File 'neptune/cfn_global_cluster_props.rb', line 57

def source_db_cluster_identifier
  @source_db_cluster_identifier
end

#storage_encrypted ⇒ Boolean, ... (readonly)

Whether the global database cluster is storage encrypted.

Returns:

See Also:



62
63
64
 
# File 'neptune/cfn_global_cluster_props.rb', line 62

def storage_encrypted
  @storage_encrypted
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

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

Returns:

See Also:



67
68
69
 
# File 'neptune/cfn_global_cluster_props.rb', line 67

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



69
70
71
72
73
74
75
76
77
78
79
 
# File 'neptune/cfn_global_cluster_props.rb', line 69

def self.jsii_properties
  {
    :deletion_protection => "deletionProtection",
    :engine => "engine",
    :engine_version => "engineVersion",
    :global_cluster_identifier => "globalClusterIdentifier",
    :source_db_cluster_identifier => "sourceDbClusterIdentifier",
    :storage_encrypted => "storageEncrypted",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'neptune/cfn_global_cluster_props.rb', line 81

def to_jsii
  result = {}
  result.merge!({
    "deletionProtection" => @deletion_protection,
    "engine" => @engine,
    "engineVersion" => @engine_version,
    "globalClusterIdentifier" => @global_cluster_identifier,
    "sourceDbClusterIdentifier" => @source_db_cluster_identifier,
    "storageEncrypted" => @storage_encrypted,
    "tags" => @tags,
  })
  result.compact
end