DatabaseInstanceProps

class aws_cdk.aws_neptune.DatabaseInstanceProps(*, cluster, instance_type, availability_zone=None, db_instance_name=None, parameter_group=None, removal_policy=None)

Bases: object

(experimental) Construction properties for a DatabaseInstanceNew.

Parameters
  • cluster (IDatabaseCluster) – (experimental) The Neptune database cluster the instance should launch into.

  • instance_type (InstanceType) – (experimental) What type of instance to start for the replicas.

  • availability_zone (Optional[str]) – (experimental) The name of the Availability Zone where the DB instance will be located. Default: - no preference

  • db_instance_name (Optional[str]) – (experimental) A name for the DB instance. If you specify a name, AWS CloudFormation converts it to lowercase. Default: - a CloudFormation generated name

  • parameter_group (Optional[IParameterGroup]) – (experimental) The DB parameter group to associate with the instance. Default: no parameter group

  • removal_policy (Optional[RemovalPolicy]) – (experimental) The CloudFormation policy to apply when the instance is removed from the stack or replaced during an update. Default: RemovalPolicy.Retain

Stability

experimental

Example:

replica1 = neptune.DatabaseInstance(self, "Instance",
    cluster=cluster,
    instance_type=neptune.InstanceType.R5_LARGE
)

Attributes

availability_zone

(experimental) The name of the Availability Zone where the DB instance will be located.

Default
  • no preference

Stability

experimental

Return type

Optional[str]

cluster

(experimental) The Neptune database cluster the instance should launch into.

Stability

experimental

Return type

IDatabaseCluster

db_instance_name

(experimental) A name for the DB instance.

If you specify a name, AWS CloudFormation converts it to lowercase.

Default
  • a CloudFormation generated name

Stability

experimental

Return type

Optional[str]

instance_type

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

Stability

experimental

Return type

InstanceType

parameter_group

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

Default

no parameter group

Stability

experimental

Return type

Optional[IParameterGroup]

removal_policy

(experimental) The CloudFormation policy to apply when the instance is removed from the stack or replaced during an update.

Default

RemovalPolicy.Retain

Stability

experimental

Return type

Optional[RemovalPolicy]