Class: AWSCDK::RDS::CfnDBShardGroupProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
rds/cfn_db_shard_group_props.rb

Overview

Properties for defining a CfnDBShardGroup.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(db_cluster_identifier:, max_acu:, compute_redundancy: nil, db_shard_group_identifier: nil, min_acu: nil, publicly_accessible: nil, tags: nil) ⇒ CfnDBShardGroupProps

Returns a new instance of CfnDBShardGroupProps.

Parameters:

  • db_cluster_identifier (String) —

    The name of the primary DB cluster for the DB shard group.

  • max_acu (Numeric) —

    The maximum capacity of the DB shard group in Aurora capacity units (ACUs).

  • compute_redundancy (Numeric, nil) (defaults to: nil) —

    Specifies whether to create standby standby DB data access shard for the DB shard group.

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

    The name of the DB shard group.

  • min_acu (Numeric, nil) (defaults to: nil) —

    The minimum capacity of the DB shard group in Aurora capacity units (ACUs).

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

    Specifies whether the DB shard group is publicly accessible.

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

    An optional set of key-value pairs to associate arbitrary data of your choosing with the DB shard group.



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

def initialize(db_cluster_identifier:, max_acu:, compute_redundancy: nil, db_shard_group_identifier: nil, min_acu: nil, publicly_accessible: nil, tags: nil)
  @db_cluster_identifier = db_cluster_identifier
  Jsii::Type.check_type(@db_cluster_identifier, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dbClusterIdentifier")
  @max_acu = max_acu
  Jsii::Type.check_type(@max_acu, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "maxAcu")
  @compute_redundancy = compute_redundancy
  Jsii::Type.check_type(@compute_redundancy, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "computeRedundancy") unless @compute_redundancy.nil?
  @db_shard_group_identifier = db_shard_group_identifier
  Jsii::Type.check_type(@db_shard_group_identifier, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dbShardGroupIdentifier") unless @db_shard_group_identifier.nil?
  @min_acu = min_acu
  Jsii::Type.check_type(@min_acu, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "minAcu") unless @min_acu.nil?
  @publicly_accessible = publicly_accessible
  Jsii::Type.check_type(@publicly_accessible, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "publiclyAccessible") unless @publicly_accessible.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

#compute_redundancy ⇒ Numeric? (readonly)

Specifies whether to create standby standby DB data access shard for the DB shard group.

Valid values are the following:

  • 0 - Creates a DB shard group without a standby DB data access shard. This is the default value.
  • 1 - Creates a DB shard group with a standby DB data access shard in a different Availability Zone (AZ).
  • 2 - Creates a DB shard group with two standby DB data access shard in two different AZs.

Returns:

  • (Numeric, nil)

See Also:



53
54
55
 
# File 'rds/cfn_db_shard_group_props.rb', line 53

def compute_redundancy
  @compute_redundancy
end

#db_cluster_identifier ⇒ String (readonly)

The name of the primary DB cluster for the DB shard group.

Returns:

  • (String)

See Also:



37
38
39
 
# File 'rds/cfn_db_shard_group_props.rb', line 37

def db_cluster_identifier
  @db_cluster_identifier
end

#db_shard_group_identifier ⇒ String? (readonly)

The name of the DB shard group.

Returns:

  • (String, nil)

See Also:



58
59
60
 
# File 'rds/cfn_db_shard_group_props.rb', line 58

def db_shard_group_identifier
  @db_shard_group_identifier
end

#max_acu ⇒ Numeric (readonly)

The maximum capacity of the DB shard group in Aurora capacity units (ACUs).

Returns:

  • (Numeric)

See Also:



42
43
44
 
# File 'rds/cfn_db_shard_group_props.rb', line 42

def max_acu
  @max_acu
end

#min_acu ⇒ Numeric? (readonly)

The minimum capacity of the DB shard group in Aurora capacity units (ACUs).

Returns:

  • (Numeric, nil)

See Also:



63
64
65
 
# File 'rds/cfn_db_shard_group_props.rb', line 63

def min_acu
  @min_acu
end

#publicly_accessible ⇒ Boolean, ... (readonly)

Specifies whether the DB shard group is publicly accessible.

When the DB shard group is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB shard group's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB shard group's VPC. Access to the DB shard group is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB shard group doesn't permit it.

When the DB shard group isn't publicly accessible, it is an internal DB shard group with a DNS name that resolves to a private IP address.

Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

  • If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB shard group is private.
  • If the default VPC in the target Region has an internet gateway attached to it, the DB shard group is public.

If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

  • If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB shard group is private.
  • If the subnets are part of a VPC that has an internet gateway attached to it, the DB shard group is public.

Returns:

See Also:



84
85
86
 
# File 'rds/cfn_db_shard_group_props.rb', line 84

def publicly_accessible
  @publicly_accessible
end

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

An optional set of key-value pairs to associate arbitrary data of your choosing with the DB shard group.

Returns:

See Also:



89
90
91
 
# File 'rds/cfn_db_shard_group_props.rb', line 89

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



91
92
93
94
95
96
97
98
99
100
101
 
# File 'rds/cfn_db_shard_group_props.rb', line 91

def self.jsii_properties
  {
    :db_cluster_identifier => "dbClusterIdentifier",
    :max_acu => "maxAcu",
    :compute_redundancy => "computeRedundancy",
    :db_shard_group_identifier => "dbShardGroupIdentifier",
    :min_acu => "minAcu",
    :publicly_accessible => "publiclyAccessible",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'rds/cfn_db_shard_group_props.rb', line 103

def to_jsii
  result = {}
  result.merge!({
    "dbClusterIdentifier" => @db_cluster_identifier,
    "maxAcu" => @max_acu,
    "computeRedundancy" => @compute_redundancy,
    "dbShardGroupIdentifier" => @db_shard_group_identifier,
    "minAcu" => @min_acu,
    "publiclyAccessible" => @publicly_accessible,
    "tags" => @tags,
  })
  result.compact
end