Package software.amazon.awscdk.services.neptune.alpha

Class DatabaseClusterProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.neptune.alpha.DatabaseClusterProps.Jsii$Proxy

All Implemented Interfaces:

DatabaseClusterProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

DatabaseClusterProps

@Stability(Experimental)
@Internal
public static final class DatabaseClusterProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements DatabaseClusterProps

An implementation for DatabaseClusterProps

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.neptune.alpha.DatabaseClusterProps

DatabaseClusterProps.Builder, DatabaseClusterProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(DatabaseClusterProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the DatabaseClusterProps.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final List<IRole>	getAssociatedRoles()	(experimental) A list of AWS Identity and Access Management (IAM) role that can be used by the cluster to access other AWS services.
final Boolean	getAutoMinorVersionUpgrade()	(experimental) If set to true, Neptune will automatically update the engine of the entire cluster to the latest minor version after a stabilization window of 2 to 3 weeks.
final Duration	getBackupRetention()	(experimental) How many days to retain the backup.
final List<LogType>	getCloudwatchLogsExports()	(experimental) The list of log types that need to be enabled for exporting to CloudWatch Logs.
final RetentionDays	getCloudwatchLogsRetention()	(experimental) The number of days log events are kept in CloudWatch Logs.
final IRole	getCloudwatchLogsRetentionRole()	(experimental) The IAM role for the Lambda function associated with the custom resource that sets the retention policy.
final IClusterParameterGroup	getClusterParameterGroup()	(experimental) Additional parameters to pass to the database engine.
final Boolean	getCopyTagsToSnapshot()	(experimental) Whether to copy tags to the snapshot when a snapshot is created.
final String	getDbClusterName()	(experimental) An optional identifier for the cluster.
final Boolean	getDeletionProtection()	(experimental) Indicates whether the DB cluster should have deletion protection enabled.
final EngineVersion	getEngineVersion()	(experimental) What version of the database to start.
final Boolean	getIamAuthentication()	(experimental) Map AWS Identity and Access Management (IAM) accounts to database accounts.
final String	getInstanceIdentifierBase()	(experimental) Base identifier for instances.
final Number	getInstances()	(experimental) Number of Neptune compute instances.
final InstanceType	getInstanceType()	(experimental) What type of instance to start for the replicas.
final IKeyRef	getKmsKey()	(experimental) The KMS key for storage encryption.
final IParameterGroup	getParameterGroup()	(experimental) The DB parameter group to associate with the instance.
final Number	getPort()	(experimental) The port number on which the DB instances in the DB cluster accept connections.
final String	getPreferredBackupWindow()	(experimental) A daily time range in 24-hours UTC format in which backups preferably execute.
final String	getPreferredMaintenanceWindow()	(experimental) A weekly time range in which maintenance should preferably execute.
final RemovalPolicy	getRemovalPolicy()	(experimental) The removal policy to apply when the cluster and its instances are removed or replaced during a stack update, or when the stack is deleted.
final List<ISecurityGroup>	getSecurityGroups()	(experimental) Security group.
final ServerlessScalingConfiguration	getServerlessScalingConfiguration()	(experimental) Specify minimum and maximum NCUs capacity for a serverless cluster.
final Boolean	getStorageEncrypted()	(experimental) Whether to enable storage encryption.
final ISubnetGroup	getSubnetGroup()	(experimental) Existing subnet group for the cluster.
final IVpc	getVpc()	(experimental) What subnets to run the Neptune instances in.
final SubnetSelection	getVpcSubnets()	(experimental) Where to place the instances within the VPC.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(DatabaseClusterProps.Builder builder)

Constructor that initializes the object based on literal property values passed by the DatabaseClusterProps.Builder.

Method Details

getInstanceType

public final InstanceType getInstanceType()

Description copied from interface: DatabaseClusterProps

(experimental) What type of instance to start for the replicas.

Specified by:

getInstanceType in interface DatabaseClusterProps

getVpc

public final IVpc getVpc()

Description copied from interface: DatabaseClusterProps

(experimental) What subnets to run the Neptune instances in.

Must be at least 2 subnets in two different AZs.

Specified by:

getVpc in interface DatabaseClusterProps

getAssociatedRoles

public final List<IRole> getAssociatedRoles()

Description copied from interface: DatabaseClusterProps

(experimental) A list of AWS Identity and Access Management (IAM) role that can be used by the cluster to access other AWS services.

Default: - No role is attached to the cluster.

Specified by:

getAssociatedRoles in interface DatabaseClusterProps

getAutoMinorVersionUpgrade

public final Boolean getAutoMinorVersionUpgrade()

Description copied from interface: DatabaseClusterProps

(experimental) If set to true, Neptune will automatically update the engine of the entire cluster to the latest minor version after a stabilization window of 2 to 3 weeks.

Default: - false

Specified by:

getAutoMinorVersionUpgrade in interface DatabaseClusterProps

getBackupRetention

public final Duration getBackupRetention()

Description copied from interface: DatabaseClusterProps

(experimental) How many days to retain the backup.

Default: - cdk.Duration.days(1)

Specified by:

getBackupRetention in interface DatabaseClusterProps

getCloudwatchLogsExports

public final List<LogType> getCloudwatchLogsExports()

Description copied from interface: DatabaseClusterProps

(experimental) The list of log types that need to be enabled for exporting to CloudWatch Logs.

Default: - no log exports

Specified by:

getCloudwatchLogsExports in interface DatabaseClusterProps

See Also:

• https://docs.aws.amazon.com/neptune/latest/userguide/auditing.html#auditing-enable

getCloudwatchLogsRetention

public final RetentionDays getCloudwatchLogsRetention()

Description copied from interface: DatabaseClusterProps

(experimental) The number of days log events are kept in CloudWatch Logs.

When updating this property, unsetting it doesn't remove the log retention policy. To remove the retention policy, set the value to Infinity.

Default: - logs never expire

Specified by:

getCloudwatchLogsRetention in interface DatabaseClusterProps

getCloudwatchLogsRetentionRole

public final IRole getCloudwatchLogsRetentionRole()

Description copied from interface: DatabaseClusterProps

(experimental) The IAM role for the Lambda function associated with the custom resource that sets the retention policy.

Default: - a new role is created.

Specified by:

getCloudwatchLogsRetentionRole in interface DatabaseClusterProps

getClusterParameterGroup

public final IClusterParameterGroup getClusterParameterGroup()

Description copied from interface: DatabaseClusterProps

(experimental) Additional parameters to pass to the database engine.

Default: - No parameter group.

Specified by:

getClusterParameterGroup in interface DatabaseClusterProps

getCopyTagsToSnapshot

public final Boolean getCopyTagsToSnapshot()

Description copied from interface: DatabaseClusterProps

(experimental) Whether to copy tags to the snapshot when a snapshot is created.

Default: - false

Specified by:

getCopyTagsToSnapshot in interface DatabaseClusterProps

getDbClusterName

public final String getDbClusterName()

Description copied from interface: DatabaseClusterProps

(experimental) An optional identifier for the cluster.

Default: - A name is automatically generated.

Specified by:

getDbClusterName in interface DatabaseClusterProps

getDeletionProtection

public final Boolean getDeletionProtection()

Description copied from interface: DatabaseClusterProps

(experimental) Indicates whether the DB cluster should have deletion protection enabled.

Default: - true if ``removalPolicy`` is RETAIN, false otherwise

Specified by:

getDeletionProtection in interface DatabaseClusterProps

getEngineVersion

public final EngineVersion getEngineVersion()

Description copied from interface: DatabaseClusterProps

(experimental) What version of the database to start.

Default: - The default engine version.

Specified by:

getEngineVersion in interface DatabaseClusterProps

getIamAuthentication

public final Boolean getIamAuthentication()

Description copied from interface: DatabaseClusterProps

(experimental) Map AWS Identity and Access Management (IAM) accounts to database accounts.

Default: - `false`

Specified by:

getIamAuthentication in interface DatabaseClusterProps

getInstanceIdentifierBase

public final String getInstanceIdentifierBase()

Description copied from interface: DatabaseClusterProps

(experimental) Base identifier for instances.

Every replica is named by appending the replica number to this string, 1-based.

Default: - `dbClusterName` is used with the word "Instance" appended. If `dbClusterName` is not provided, the identifier is automatically generated.

Specified by:

getInstanceIdentifierBase in interface DatabaseClusterProps

getInstances

public final Number getInstances()

Description copied from interface: DatabaseClusterProps

(experimental) Number of Neptune compute instances.

Default: 1

Specified by:

getInstances in interface DatabaseClusterProps

getKmsKey

public final IKeyRef getKmsKey()

Description copied from interface: DatabaseClusterProps

(experimental) The KMS key for storage encryption.

Default: - default master key.

Specified by:

getKmsKey in interface DatabaseClusterProps

getParameterGroup

public final IParameterGroup getParameterGroup()

Description copied from interface: DatabaseClusterProps

(experimental) The DB parameter group to associate with the instance.

Default: no parameter group

Specified by:

getParameterGroup in interface DatabaseClusterProps

getPort

public final Number getPort()

Description copied from interface: DatabaseClusterProps

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

Default: 8182

Specified by:

getPort in interface DatabaseClusterProps

getPreferredBackupWindow

public final String getPreferredBackupWindow()

Description copied from interface: DatabaseClusterProps

(experimental) A daily time range in 24-hours UTC format in which backups preferably execute.

Must be at least 30 minutes long.

Example: '01:00-02:00'

Default: - a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see

Specified by:

getPreferredBackupWindow in interface DatabaseClusterProps

getPreferredMaintenanceWindow

public final String getPreferredMaintenanceWindow()

Description copied from interface: DatabaseClusterProps

(experimental) A weekly time range in which maintenance should preferably execute.

Must be at least 30 minutes long.

Example: 'tue:04:17-tue:04:47'

Default: - 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week.

Specified by:

getPreferredMaintenanceWindow in interface DatabaseClusterProps

getRemovalPolicy

public final RemovalPolicy getRemovalPolicy()

Description copied from interface: DatabaseClusterProps

(experimental) The removal policy to apply when the cluster and its instances are removed or replaced during a stack update, or when the stack is deleted.

This removal policy also applies to the implicit security group created for the cluster if one is not supplied as a parameter.

Default: - Retain cluster.

Specified by:

getRemovalPolicy in interface DatabaseClusterProps

getSecurityGroups

public final List<ISecurityGroup> getSecurityGroups()

Description copied from interface: DatabaseClusterProps

(experimental) Security group.

Default: a new security group is created.

Specified by:

getSecurityGroups in interface DatabaseClusterProps

getServerlessScalingConfiguration

public final ServerlessScalingConfiguration getServerlessScalingConfiguration()

Description copied from interface: DatabaseClusterProps

(experimental) Specify minimum and maximum NCUs capacity for a serverless cluster.

See https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-capacity-scaling.html

Default: - required if instanceType is db.serverless

Specified by:

getServerlessScalingConfiguration in interface DatabaseClusterProps

getStorageEncrypted

public final Boolean getStorageEncrypted()

Description copied from interface: DatabaseClusterProps

(experimental) Whether to enable storage encryption.

Default: true

Specified by:

getStorageEncrypted in interface DatabaseClusterProps

getSubnetGroup

public final ISubnetGroup getSubnetGroup()

Description copied from interface: DatabaseClusterProps

(experimental) Existing subnet group for the cluster.

Default: - a new subnet group will be created.

Specified by:

getSubnetGroup in interface DatabaseClusterProps

getVpcSubnets

public final SubnetSelection getVpcSubnets()

Description copied from interface: DatabaseClusterProps

(experimental) Where to place the instances within the VPC.

Default: private subnets

Specified by:

getVpcSubnets in interface DatabaseClusterProps

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object