DatabaseClusterProps¶

class aws_cdk.aws_neptune.DatabaseClusterProps(*, instance_type, vpc, associated_roles=None, auto_minor_version_upgrade=None, backup_retention=None, cluster_parameter_group=None, db_cluster_name=None, deletion_protection=None, engine_version=None, iam_authentication=None, instance_identifier_base=None, instances=None, kms_key=None, parameter_group=None, port=None, preferred_backup_window=None, preferred_maintenance_window=None, removal_policy=None, security_groups=None, storage_encrypted=None, subnet_group=None, vpc_subnets=None)¶

Bases: object

(experimental) Properties for a new database cluster.

Parameters

instance_type (InstanceType) – (experimental) What type of instance to start for the replicas.
vpc (IVpc) – (experimental) What subnets to run the Neptune instances in. Must be at least 2 subnets in two different AZs.
associated_roles (Optional[Sequence[IRole]]) – (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.
auto_minor_version_upgrade (Optional[bool]) – (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
backup_retention (Optional[Duration]) – (experimental) How many days to retain the backup. Default: - cdk.Duration.days(1)
cluster_parameter_group (Optional[IClusterParameterGroup]) – (experimental) Additional parameters to pass to the database engine. Default: - No parameter group.
db_cluster_name (Optional[str]) – (experimental) An optional identifier for the cluster. Default: - A name is automatically generated.
deletion_protection (Optional[bool]) – (experimental) Indicates whether the DB cluster should have deletion protection enabled. Default: - true if removalPolicy is RETAIN, false otherwise
engine_version (Optional[EngineVersion]) – (experimental) What version of the database to start. Default: - The default engine version.
iam_authentication (Optional[bool]) – (experimental) Map AWS Identity and Access Management (IAM) accounts to database accounts. Default: - false
instance_identifier_base (Optional[str]) – (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.
instances (Union[int, float, None]) – (experimental) Number of Neptune compute instances. Default: 1
kms_key (Optional[IKey]) – (experimental) The KMS key for storage encryption. Default: - default master key.
parameter_group (Optional[IParameterGroup]) – (experimental) The DB parameter group to associate with the instance. Default: no parameter group
port (Union[int, float, None]) – (experimental) The port the Neptune cluster will listen on. Default: - The default engine port
preferred_backup_window (Optional[str]) – (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
preferred_maintenance_window (Optional[str]) – (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.
removal_policy (Optional[RemovalPolicy]) – (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.
security_groups (Optional[Sequence[ISecurityGroup]]) – (experimental) Security group. Default: a new security group is created.
storage_encrypted (Optional[bool]) – (experimental) Whether to enable storage encryption. Default: true
subnet_group (Optional[ISubnetGroup]) – (experimental) Existing subnet group for the cluster. Default: - a new subnet group will be created.
vpc_subnets (Union[SubnetSelection, Dict[str, Any], None]) – (experimental) Where to place the instances within the VPC. Default: private subnets

Stability

experimental

ExampleMetadata

infused

Example:

cluster = neptune.DatabaseCluster(self, "Database",
    vpc=vpc,
    instance_type=neptune.InstanceType.R5_LARGE,
    instances=2
)

Attributes

associated_roles¶

(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.

Stability

experimental

Return type

Optional[List[IRole]]

auto_minor_version_upgrade¶

(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

Stability

experimental

Return type

Optional[bool]

backup_retention¶

(experimental) How many days to retain the backup.

Default

cdk.Duration.days(1)

Stability

experimental

Return type

Optional[Duration]

cluster_parameter_group¶

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

Default

No parameter group.

Stability

experimental

Return type

Optional[IClusterParameterGroup]

db_cluster_name¶

(experimental) An optional identifier for the cluster.

Default

A name is automatically generated.

Stability

experimental

Return type

Optional[str]

deletion_protection¶

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

Default

true if removalPolicy is RETAIN, false otherwise

Stability

experimental

Return type

Optional[bool]

engine_version¶

(experimental) What version of the database to start.

Default

The default engine version.

Stability

experimental

Return type

Optional[EngineVersion]

iam_authentication¶

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

Default

false

Stability

experimental

Return type

Optional[bool]

instance_identifier_base¶

(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.

Stability: experimental
Return type: Optional[str]

instance_type¶

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

Stability: experimental
Return type: InstanceType

instances¶

(experimental) Number of Neptune compute instances.

Default: 1
Stability: experimental
Return type: Union[int, float, None]

kms_key¶

(experimental) The KMS key for storage encryption.

Default

default master key.

Stability

experimental

Return type

Optional[IKey]

parameter_group¶

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

Default: no parameter group
Stability: experimental
Return type: Optional[IParameterGroup]

port¶

(experimental) The port the Neptune cluster will listen on.

Default

The default engine port

Stability

experimental

Return type

Union[int, float, None]

preferred_backup_window¶

(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

Stability: experimental
Return type: Optional[str]

preferred_maintenance_window¶

(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.

Stability: experimental
Return type: Optional[str]

removal_policy¶

(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.

Stability

experimental

Return type

Optional[RemovalPolicy]

security_groups¶

(experimental) Security group.

Default: a new security group is created.
Stability: experimental
Return type: Optional[List[ISecurityGroup]]

storage_encrypted¶

(experimental) Whether to enable storage encryption.

Default: true
Stability: experimental
Return type: Optional[bool]

subnet_group¶

(experimental) Existing subnet group for the cluster.

Default

a new subnet group will be created.

Stability

experimental

Return type

Optional[ISubnetGroup]

vpc¶

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

Must be at least 2 subnets in two different AZs.

Stability: experimental
Return type: IVpc

vpc_subnets¶

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

Default: private subnets
Stability: experimental
Return type: Optional[SubnetSelection]