Class: AWSCDK::Neptune::CfnDBClusterProps

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

Overview

Properties for defining a CfnDBCluster.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(associated_roles: nil, availability_zones: nil, backup_retention_period: nil, copy_tags_to_snapshot: nil, db_cluster_identifier: nil, db_cluster_parameter_group_name: nil, db_instance_parameter_group_name: nil, db_port: nil, db_subnet_group_name: nil, deletion_protection: nil, enable_cloudwatch_logs_exports: nil, engine_version: nil, global_cluster_identifier: nil, iam_auth_enabled: nil, kms_key_id: nil, network_type: nil, preferred_backup_window: nil, preferred_maintenance_window: nil, restore_to_time: nil, restore_type: nil, serverless_scaling_configuration: nil, snapshot_identifier: nil, source_db_cluster_identifier: nil, storage_encrypted: nil, tags: nil, use_latest_restorable_time: nil, vpc_security_group_ids: nil) ⇒ CfnDBClusterProps

Returns a new instance of CfnDBClusterProps.

Parameters:

  • associated_roles (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::Neptune::CfnDBCluster::DBClusterRoleProperty>, nil) (defaults to: nil) —

    Provides a list of the Amazon Identity and Access Management (IAM) roles that are associated with the DB cluster.

  • availability_zones (Array<String>, nil) (defaults to: nil) —

    Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.

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

    Specifies the number of days for which automatic DB snapshots are retained.

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

    If set to true , tags are copied to any snapshot of the DB cluster that is created..

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

    Contains a user-supplied DB cluster identifier.

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

    Provides the name of the DB cluster parameter group.

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

    The name of the DB parameter group to apply to all instances of the DB cluster.

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

    The port number on which the DB instances in the DB cluster accept connections.

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

    Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.

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

    Indicates whether or not the DB cluster has deletion protection enabled.

  • enable_cloudwatch_logs_exports (Array<String>, nil) (defaults to: nil) —

    Specifies a list of log types that are enabled for export to CloudWatch Logs.

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

    Indicates the database engine version.

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

    The ID of the Neptune global database to which this new DB cluster should be added.

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

    True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

  • kms_key_id (String, AWSCDK::Interfaces::AWSKMS::IKeyRef, nil) (defaults to: nil) —

    The Amazon Resource Name (ARN) of the KMS key that is used to encrypt the database instances in the DB cluster, such as arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef .

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

    The network type of the DB cluster.

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

    Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod .

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

    Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

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

    Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

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

    Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

  • serverless_scaling_configuration (AWSCDK::IResolvable, AWSCDK::Neptune::CfnDBCluster::ServerlessScalingConfigurationProperty, nil) (defaults to: nil) —

    Contains the scaling configuration of an Neptune Serverless DB cluster.

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

    Specifies the identifier for a DB cluster snapshot. Must match the identifier of an existing snapshot.

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

    Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

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

    Indicates whether the DB cluster is encrypted.

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

    The tags assigned to this cluster.

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

    Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

  • vpc_security_group_ids (Array<String, AWSCDK::Interfaces::AWSEC2::ISecurityGroupRef>, nil) (defaults to: nil) —

    Provides a list of VPC security groups that the DB cluster belongs to.



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
84
85
86
87
88
89
90
91
 
# File 'neptune/cfn_db_cluster_props.rb', line 36

def initialize(associated_roles: nil, availability_zones: nil, backup_retention_period: nil, copy_tags_to_snapshot: nil, db_cluster_identifier: nil, db_cluster_parameter_group_name: nil, db_instance_parameter_group_name: nil, db_port: nil, db_subnet_group_name: nil, deletion_protection: nil, enable_cloudwatch_logs_exports: nil, engine_version: nil, global_cluster_identifier: nil, iam_auth_enabled: nil, kms_key_id: nil, network_type: nil, preferred_backup_window: nil, preferred_maintenance_window: nil, restore_to_time: nil, restore_type: nil, serverless_scaling_configuration: nil, snapshot_identifier: nil, source_db_cluster_identifier: nil, storage_encrypted: nil, tags: nil, use_latest_restorable_time: nil, vpc_security_group_ids: nil)
  @associated_roles = associated_roles
  Jsii::Type.check_type(@associated_roles, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfbmVwdHVuZS5DZm5EQkNsdXN0ZXIuREJDbHVzdGVyUm9sZVByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "associatedRoles") unless @associated_roles.nil?
  @availability_zones = availability_zones
  Jsii::Type.check_type(@availability_zones, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "availabilityZones") unless @availability_zones.nil?
  @backup_retention_period = backup_retention_period
  Jsii::Type.check_type(@backup_retention_period, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "backupRetentionPeriod") unless @backup_retention_period.nil?
  @copy_tags_to_snapshot = copy_tags_to_snapshot
  Jsii::Type.check_type(@copy_tags_to_snapshot, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "copyTagsToSnapshot") unless @copy_tags_to_snapshot.nil?
  @db_cluster_identifier = db_cluster_identifier
  Jsii::Type.check_type(@db_cluster_identifier, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dbClusterIdentifier") unless @db_cluster_identifier.nil?
  @db_cluster_parameter_group_name = db_cluster_parameter_group_name
  Jsii::Type.check_type(@db_cluster_parameter_group_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dbClusterParameterGroupName") unless @db_cluster_parameter_group_name.nil?
  @db_instance_parameter_group_name = db_instance_parameter_group_name
  Jsii::Type.check_type(@db_instance_parameter_group_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dbInstanceParameterGroupName") unless @db_instance_parameter_group_name.nil?
  @db_port = db_port
  Jsii::Type.check_type(@db_port, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "dbPort") unless @db_port.nil?
  @db_subnet_group_name = db_subnet_group_name
  Jsii::Type.check_type(@db_subnet_group_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dbSubnetGroupName") unless @db_subnet_group_name.nil?
  @deletion_protection = deletion_protection
  Jsii::Type.check_type(@deletion_protection, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "deletionProtection") unless @deletion_protection.nil?
  @enable_cloudwatch_logs_exports = enable_cloudwatch_logs_exports
  Jsii::Type.check_type(@enable_cloudwatch_logs_exports, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "enableCloudwatchLogsExports") unless @enable_cloudwatch_logs_exports.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?
  @iam_auth_enabled = iam_auth_enabled
  Jsii::Type.check_type(@iam_auth_enabled, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "iamAuthEnabled") unless @iam_auth_enabled.nil?
  @kms_key_id = kms_key_id
  Jsii::Type.check_type(@kms_key_id, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoic3RyaW5nIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19rbXMuSUtleVJlZiJ9XX19")), "kmsKeyId") unless @kms_key_id.nil?
  @network_type = network_type
  Jsii::Type.check_type(@network_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "networkType") unless @network_type.nil?
  @preferred_backup_window = preferred_backup_window
  Jsii::Type.check_type(@preferred_backup_window, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "preferredBackupWindow") unless @preferred_backup_window.nil?
  @preferred_maintenance_window = preferred_maintenance_window
  Jsii::Type.check_type(@preferred_maintenance_window, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "preferredMaintenanceWindow") unless @preferred_maintenance_window.nil?
  @restore_to_time = restore_to_time
  Jsii::Type.check_type(@restore_to_time, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "restoreToTime") unless @restore_to_time.nil?
  @restore_type = restore_type
  Jsii::Type.check_type(@restore_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "restoreType") unless @restore_type.nil?
  @serverless_scaling_configuration = serverless_scaling_configuration.is_a?(Hash) ? ::AWSCDK::Neptune::CfnDBCluster::ServerlessScalingConfigurationProperty.new(**serverless_scaling_configuration.transform_keys(&:to_sym)) : serverless_scaling_configuration
  Jsii::Type.check_type(@serverless_scaling_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19uZXB0dW5lLkNmbkRCQ2x1c3Rlci5TZXJ2ZXJsZXNzU2NhbGluZ0NvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "serverlessScalingConfiguration") unless @serverless_scaling_configuration.nil?
  @snapshot_identifier = snapshot_identifier
  Jsii::Type.check_type(@snapshot_identifier, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "snapshotIdentifier") unless @snapshot_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?
  @use_latest_restorable_time = use_latest_restorable_time
  Jsii::Type.check_type(@use_latest_restorable_time, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "useLatestRestorableTime") unless @use_latest_restorable_time.nil?
  @vpc_security_group_ids = vpc_security_group_ids
  Jsii::Type.check_type(@vpc_security_group_ids, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InVuaW9uIjp7InR5cGVzIjpbeyJwcmltaXRpdmUiOiJzdHJpbmcifSx7ImZxbiI6ImF3cy1jZGstbGliLmludGVyZmFjZXMuYXdzX2VjMi5JU2VjdXJpdHlHcm91cFJlZiJ9XX19LCJraW5kIjoiYXJyYXkifX0=")), "vpcSecurityGroupIds") unless @vpc_security_group_ids.nil?
end

Instance Attribute Details

#associated_roles ⇒ AWSCDK::IResolvable, ... (readonly)

Provides a list of the Amazon Identity and Access Management (IAM) roles that are associated with the DB cluster.

IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon services on your behalf.

Returns:

See Also:



99
100
101
 
# File 'neptune/cfn_db_cluster_props.rb', line 99

def associated_roles
  @associated_roles
end

#availability_zones ⇒ Array<String>? (readonly)

Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.

Returns:

  • (Array<String>, nil)

See Also:



104
105
106
 
# File 'neptune/cfn_db_cluster_props.rb', line 104

def availability_zones
  @availability_zones
end

#backup_retention_period ⇒ Numeric? (readonly)

Note:

Default: - 1

Specifies the number of days for which automatic DB snapshots are retained.

An update may require some interruption. See ModifyDBInstance in the Amazon Neptune User Guide for more information.

Returns:

  • (Numeric, nil)

See Also:



112
113
114
 
# File 'neptune/cfn_db_cluster_props.rb', line 112

def backup_retention_period
  @backup_retention_period
end

#copy_tags_to_snapshot ⇒ Boolean, ... (readonly)

If set to true , tags are copied to any snapshot of the DB cluster that is created..

Returns:

See Also:



117
118
119
 
# File 'neptune/cfn_db_cluster_props.rb', line 117

def copy_tags_to_snapshot
  @copy_tags_to_snapshot
end

#db_cluster_identifier ⇒ String? (readonly)

Contains a user-supplied DB cluster identifier.

This identifier is the unique key that identifies a DB cluster.

Returns:

  • (String, nil)

See Also:



124
125
126
 
# File 'neptune/cfn_db_cluster_props.rb', line 124

def db_cluster_identifier
  @db_cluster_identifier
end

#db_cluster_parameter_group_name ⇒ String? (readonly)

Provides the name of the DB cluster parameter group.

An update may require some interruption. See ModifyDBInstance in the Amazon Neptune User Guide for more information.

Returns:

  • (String, nil)

See Also:



131
132
133
 
# File 'neptune/cfn_db_cluster_props.rb', line 131

def db_cluster_parameter_group_name
  @db_cluster_parameter_group_name
end

#db_instance_parameter_group_name ⇒ String? (readonly)

The name of the DB parameter group to apply to all instances of the DB cluster.

Used only in case of a major engine version upgrade request

Note that when you apply a parameter group using DBInstanceParameterGroupName , parameter changes are applied immediately, not during the next maintenance window.

Constraints - The DB parameter group must be in the same DB parameter group family as the target DB cluster version.

  • The DBInstanceParameterGroupName parameter is only valid for major engine version upgrades.

Returns:

  • (String, nil)

See Also:



144
145
146
 
# File 'neptune/cfn_db_cluster_props.rb', line 144

def db_instance_parameter_group_name
  @db_instance_parameter_group_name
end

#db_port ⇒ Numeric? (readonly)

The port number on which the DB instances in the DB cluster accept connections.

If not specified, the default port used is 8182 .

The Port property will soon be deprecated. Please update existing templates to use the new DBPort property that has the same functionality.

Returns:

  • (Numeric, nil)

See Also:



153
154
155
 
# File 'neptune/cfn_db_cluster_props.rb', line 153

def db_port
  @db_port
end

#db_subnet_group_name ⇒ String? (readonly)

Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.

Returns:

  • (String, nil)

See Also:



158
159
160
 
# File 'neptune/cfn_db_cluster_props.rb', line 158

def db_subnet_group_name
  @db_subnet_group_name
end

#deletion_protection ⇒ Boolean, ... (readonly)

Indicates whether or not the DB cluster has deletion protection enabled.

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

Returns:

See Also:



165
166
167
 
# File 'neptune/cfn_db_cluster_props.rb', line 165

def deletion_protection
  @deletion_protection
end

#enable_cloudwatch_logs_exports ⇒ Array<String>? (readonly)

Specifies a list of log types that are enabled for export to CloudWatch Logs.

Returns:

  • (Array<String>, nil)

See Also:



170
171
172
 
# File 'neptune/cfn_db_cluster_props.rb', line 170

def enable_cloudwatch_logs_exports
  @enable_cloudwatch_logs_exports
end

#engine_version ⇒ String? (readonly)

Indicates the database engine version.

Returns:

  • (String, nil)

See Also:



175
176
177
 
# File 'neptune/cfn_db_cluster_props.rb', line 175

def engine_version
  @engine_version
end

#global_cluster_identifier ⇒ String? (readonly)

The ID of the Neptune global database to which this new DB cluster should be added.

Returns:

  • (String, nil)

See Also:



180
181
182
 
# File 'neptune/cfn_db_cluster_props.rb', line 180

def global_cluster_identifier
  @global_cluster_identifier
end

#iam_auth_enabled ⇒ Boolean, ... (readonly)

True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

Returns:

See Also:



185
186
187
 
# File 'neptune/cfn_db_cluster_props.rb', line 185

def iam_auth_enabled
  @iam_auth_enabled
end

#kms_key_id ⇒ String, ... (readonly)

The Amazon Resource Name (ARN) of the KMS key that is used to encrypt the database instances in the DB cluster, such as arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef .

If you enable the StorageEncrypted property but don't specify this property, the default KMS key is used. If you specify this property, you must set the StorageEncrypted property to true .

Returns:

See Also:



192
193
194
 
# File 'neptune/cfn_db_cluster_props.rb', line 192

def kms_key_id
  @kms_key_id
end

#network_type ⇒ String? (readonly)

The network type of the DB cluster.

Returns:

  • (String, nil)

See Also:



197
198
199
 
# File 'neptune/cfn_db_cluster_props.rb', line 197

def network_type
  @network_type
end

#preferred_backup_window ⇒ String? (readonly)

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod .

An update may require some interruption.

Returns:

  • (String, nil)

See Also:



204
205
206
 
# File 'neptune/cfn_db_cluster_props.rb', line 204

def preferred_backup_window
  @preferred_backup_window
end

#preferred_maintenance_window ⇒ String? (readonly)

Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Returns:

  • (String, nil)

See Also:



209
210
211
 
# File 'neptune/cfn_db_cluster_props.rb', line 209

def preferred_maintenance_window
  @preferred_maintenance_window
end

#restore_to_time ⇒ String? (readonly)

Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.

If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.

Returns:

  • (String, nil)

See Also:



218
219
220
 
# File 'neptune/cfn_db_cluster_props.rb', line 218

def restore_to_time
  @restore_to_time
end

#restore_type ⇒ String? (readonly)

Note:

Default: - "full-copy"

Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.

If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.

Returns:

  • (String, nil)

See Also:



228
229
230
 
# File 'neptune/cfn_db_cluster_props.rb', line 228

def restore_type
  @restore_type
end

#serverless_scaling_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

Contains the scaling configuration of an Neptune Serverless DB cluster.

Returns:

See Also:



233
234
235
 
# File 'neptune/cfn_db_cluster_props.rb', line 233

def serverless_scaling_configuration
  @serverless_scaling_configuration
end

#snapshot_identifier ⇒ String? (readonly)

Specifies the identifier for a DB cluster snapshot. Must match the identifier of an existing snapshot.

After you restore a DB cluster using a SnapshotIdentifier , you must specify the same SnapshotIdentifier for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed.

However, if you don't specify the SnapshotIdentifier , an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, the DB cluster is restored from the snapshot specified by the SnapshotIdentifier , and the original DB cluster is deleted.

Returns:

  • (String, nil)

See Also:



242
243
244
 
# File 'neptune/cfn_db_cluster_props.rb', line 242

def snapshot_identifier
  @snapshot_identifier
end

#source_db_cluster_identifier ⇒ String? (readonly)

Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.

If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.

Returns:

  • (String, nil)

See Also:



251
252
253
 
# File 'neptune/cfn_db_cluster_props.rb', line 251

def source_db_cluster_identifier
  @source_db_cluster_identifier
end

#storage_encrypted ⇒ Boolean, ... (readonly)

Indicates whether the DB cluster is encrypted.

If you specify the KmsKeyId property, then you must enable encryption and set this property to true .

If you enable the StorageEncrypted property but don't specify the KmsKeyId property, then the default KMS key is used. If you specify the KmsKeyId property, then that KMS key is used to encrypt the database instances in the DB cluster.

If you specify the SourceDBClusterIdentifier property, and don't specify this property or disable it, the value is inherited from the source DB cluster. If the source DB cluster is encrypted, the KmsKeyId property from the source cluster is used.

If you specify the DBSnapshotIdentifier and don't specify this property or disable it, the value is inherited from the snapshot and the specified KmsKeyId property from the snapshot is used.

Returns:

See Also:



264
265
266
 
# File 'neptune/cfn_db_cluster_props.rb', line 264

def storage_encrypted
  @storage_encrypted
end

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

The tags assigned to this cluster.

Returns:

See Also:



269
270
271
 
# File 'neptune/cfn_db_cluster_props.rb', line 269

def tags
  @tags
end

#use_latest_restorable_time ⇒ Boolean, ... (readonly)

Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.

If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.

Returns:

See Also:



278
279
280
 
# File 'neptune/cfn_db_cluster_props.rb', line 278

def use_latest_restorable_time
  @use_latest_restorable_time
end

#vpc_security_group_ids ⇒ Array<String, AWSCDK::Interfaces::AWSEC2::ISecurityGroupRef>? (readonly)

Provides a list of VPC security groups that the DB cluster belongs to.

Returns:

See Also:



283
284
285
 
# File 'neptune/cfn_db_cluster_props.rb', line 283

def vpc_security_group_ids
  @vpc_security_group_ids
end

Class Method Details

.jsii_properties ⇒ Object 



285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'neptune/cfn_db_cluster_props.rb', line 285

def self.jsii_properties
  {
    :associated_roles => "associatedRoles",
    :availability_zones => "availabilityZones",
    :backup_retention_period => "backupRetentionPeriod",
    :copy_tags_to_snapshot => "copyTagsToSnapshot",
    :db_cluster_identifier => "dbClusterIdentifier",
    :db_cluster_parameter_group_name => "dbClusterParameterGroupName",
    :db_instance_parameter_group_name => "dbInstanceParameterGroupName",
    :db_port => "dbPort",
    :db_subnet_group_name => "dbSubnetGroupName",
    :deletion_protection => "deletionProtection",
    :enable_cloudwatch_logs_exports => "enableCloudwatchLogsExports",
    :engine_version => "engineVersion",
    :global_cluster_identifier => "globalClusterIdentifier",
    :iam_auth_enabled => "iamAuthEnabled",
    :kms_key_id => "kmsKeyId",
    :network_type => "networkType",
    :preferred_backup_window => "preferredBackupWindow",
    :preferred_maintenance_window => "preferredMaintenanceWindow",
    :restore_to_time => "restoreToTime",
    :restore_type => "restoreType",
    :serverless_scaling_configuration => "serverlessScalingConfiguration",
    :snapshot_identifier => "snapshotIdentifier",
    :source_db_cluster_identifier => "sourceDbClusterIdentifier",
    :storage_encrypted => "storageEncrypted",
    :tags => "tags",
    :use_latest_restorable_time => "useLatestRestorableTime",
    :vpc_security_group_ids => "vpcSecurityGroupIds",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'neptune/cfn_db_cluster_props.rb', line 317

def to_jsii
  result = {}
  result.merge!({
    "associatedRoles" => @associated_roles,
    "availabilityZones" => @availability_zones,
    "backupRetentionPeriod" => @backup_retention_period,
    "copyTagsToSnapshot" => @copy_tags_to_snapshot,
    "dbClusterIdentifier" => @db_cluster_identifier,
    "dbClusterParameterGroupName" => @db_cluster_parameter_group_name,
    "dbInstanceParameterGroupName" => @db_instance_parameter_group_name,
    "dbPort" => @db_port,
    "dbSubnetGroupName" => @db_subnet_group_name,
    "deletionProtection" => @deletion_protection,
    "enableCloudwatchLogsExports" => @enable_cloudwatch_logs_exports,
    "engineVersion" => @engine_version,
    "globalClusterIdentifier" => @global_cluster_identifier,
    "iamAuthEnabled" => @iam_auth_enabled,
    "kmsKeyId" => @kms_key_id,
    "networkType" => @network_type,
    "preferredBackupWindow" => @preferred_backup_window,
    "preferredMaintenanceWindow" => @preferred_maintenance_window,
    "restoreToTime" => @restore_to_time,
    "restoreType" => @restore_type,
    "serverlessScalingConfiguration" => @serverless_scaling_configuration,
    "snapshotIdentifier" => @snapshot_identifier,
    "sourceDbClusterIdentifier" => @source_db_cluster_identifier,
    "storageEncrypted" => @storage_encrypted,
    "tags" => @tags,
    "useLatestRestorableTime" => @use_latest_restorable_time,
    "vpcSecurityGroupIds" => @vpc_security_group_ids,
  })
  result.compact
end