Class: AWSCDK::DocDB::CfnGlobalClusterProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
doc_db/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(global_cluster_identifier:, deletion_protection: nil, engine: nil, engine_version: nil, source_db_cluster_identifier: nil, storage_encrypted: nil, tags: nil) ⇒ CfnGlobalClusterProps

Returns a new instance of CfnGlobalClusterProps.

Parameters:

  • global_cluster_identifier (String) —

    The cluster identifier of the global cluster.

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

    Indicates whether the global cluster has deletion protection enabled.

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

    The database engine to use for this global cluster.

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

    The engine version to use for this global cluster.

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

    The Amazon Resource Name (ARN) to use as the primary cluster of the global cluster.

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

    Indicates whether the global cluster has storage encryption enabled.

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

    The tags to be assigned to the Amazon DocumentDB resource.



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

def initialize(global_cluster_identifier:, deletion_protection: nil, engine: nil, engine_version: nil, source_db_cluster_identifier: nil, storage_encrypted: nil, tags: nil)
  @global_cluster_identifier = global_cluster_identifier
  Jsii::Type.check_type(@global_cluster_identifier, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "globalClusterIdentifier")
  @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?
  @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)

Indicates whether the global cluster has deletion protection enabled.

The global cluster can't be deleted when deletion protection is enabled.

Returns:

See Also:



44
45
46
 
# File 'doc_db/cfn_global_cluster_props.rb', line 44

def deletion_protection
  @deletion_protection
end

#engine ⇒ String? (readonly)

Note:

Default: - "docdb"

The database engine to use for this global cluster.

Returns:

  • (String, nil)

See Also:



50
51
52
 
# File 'doc_db/cfn_global_cluster_props.rb', line 50

def engine
  @engine
end

#engine_version ⇒ String? (readonly)

The engine version to use for this global cluster.

Returns:

  • (String, nil)

See Also:



55
56
57
 
# File 'doc_db/cfn_global_cluster_props.rb', line 55

def engine_version
  @engine_version
end

#global_cluster_identifier ⇒ String (readonly)

The cluster identifier of the global cluster.

Returns:

  • (String)

See Also:



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

def global_cluster_identifier
  @global_cluster_identifier
end

#source_db_cluster_identifier ⇒ String? (readonly)

The Amazon Resource Name (ARN) to use as the primary cluster of the global cluster.

You may also choose to instead specify the DBClusterIdentifier. If you provide a value for this parameter, don't specify values for the following settings because Amazon DocumentDB uses the values from the specified source DB cluster: Engine, EngineVersion, StorageEncrypted

Returns:

  • (String, nil)

See Also:



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

def source_db_cluster_identifier
  @source_db_cluster_identifier
end

#storage_encrypted ⇒ Boolean, ... (readonly)

Indicates whether the global cluster has storage encryption enabled.

Returns:

See Also:



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

def storage_encrypted
  @storage_encrypted
end

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

The tags to be assigned to the Amazon DocumentDB resource.

Returns:

See Also:



72
73
74
 
# File 'doc_db/cfn_global_cluster_props.rb', line 72

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



74
75
76
77
78
79
80
81
82
83
84
 
# File 'doc_db/cfn_global_cluster_props.rb', line 74

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

Instance Method Details

#to_jsii ⇒ Object 



86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'doc_db/cfn_global_cluster_props.rb', line 86

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