CfnDBInstanceProps

class aws_cdk.aws_neptune.CfnDBInstanceProps(*, db_instance_class, allow_major_version_upgrade=None, auto_minor_version_upgrade=None, availability_zone=None, db_cluster_identifier=None, db_instance_identifier=None, db_parameter_group_name=None, db_snapshot_identifier=None, db_subnet_group_name=None, preferred_maintenance_window=None, tags=None)

Bases: object

Properties for defining a CfnDBInstance.

Parameters
  • db_instance_class (str) – Contains the name of the compute and memory capacity class of the DB instance. If you update this property, some interruptions may occur.

  • allow_major_version_upgrade (Union[bool, IResolvable, None]) – Indicates that major version upgrades are allowed. Changing this parameter doesn’t result in an outage and the change is asynchronously applied as soon as possible. This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the DB instance’s current version.

  • auto_minor_version_upgrade (Union[bool, IResolvable, None]) – Indicates that minor version patches are applied automatically. When updating this property, some interruptions may occur.

  • availability_zone (Optional[str]) – Specifies the name of the Availability Zone the DB instance is located in.

  • db_cluster_identifier (Optional[str]) – If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.

  • db_instance_identifier (Optional[str]) – Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

  • db_parameter_group_name (Optional[str]) – The name of an existing DB parameter group or a reference to an AWS::Neptune::DBParameterGroup resource created in the template. If any of the data members of the referenced parameter group are changed during an update, the DB instance might need to be restarted, which causes some interruption. If the parameter group contains static parameters, whether they were changed or not, an update triggers a reboot.

  • db_snapshot_identifier (Optional[str]) – This parameter is not supported. AWS::Neptune::DBInstance does not support restoring from snapshots. AWS::Neptune::DBCluster does support restoring from snapshots.

  • db_subnet_group_name (Optional[str]) – A DB subnet group to associate with the DB instance. If you update this value, the new subnet group must be a subnet group in a new virtual private cloud (VPC).

  • preferred_maintenance_window (Optional[str]) – Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

  • tags (Optional[Sequence[CfnTag]]) – An arbitrary set of tags (key-value pairs) for this DB instance.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_neptune as neptune

cfn_dBInstance_props = neptune.CfnDBInstanceProps(
    db_instance_class="dbInstanceClass",

    # the properties below are optional
    allow_major_version_upgrade=False,
    auto_minor_version_upgrade=False,
    availability_zone="availabilityZone",
    db_cluster_identifier="dbClusterIdentifier",
    db_instance_identifier="dbInstanceIdentifier",
    db_parameter_group_name="dbParameterGroupName",
    db_snapshot_identifier="dbSnapshotIdentifier",
    db_subnet_group_name="dbSubnetGroupName",
    preferred_maintenance_window="preferredMaintenanceWindow",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

allow_major_version_upgrade

Indicates that major version upgrades are allowed.

Changing this parameter doesn’t result in an outage and the change is asynchronously applied as soon as possible. This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the DB instance’s current version.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html#cfn-neptune-dbinstance-allowmajorversionupgrade

Return type

Union[bool, IResolvable, None]

auto_minor_version_upgrade

Indicates that minor version patches are applied automatically.

When updating this property, some interruptions may occur.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html#cfn-neptune-dbinstance-autominorversionupgrade

Return type

Union[bool, IResolvable, None]

availability_zone

Specifies the name of the Availability Zone the DB instance is located in.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html#cfn-neptune-dbinstance-availabilityzone

Return type

Optional[str]

db_cluster_identifier

If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html#cfn-neptune-dbinstance-dbclusteridentifier

Return type

Optional[str]

db_instance_class

Contains the name of the compute and memory capacity class of the DB instance.

If you update this property, some interruptions may occur.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html#cfn-neptune-dbinstance-dbinstanceclass

Return type

str

db_instance_identifier

Contains a user-supplied database identifier.

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html#cfn-neptune-dbinstance-dbinstanceidentifier

Return type

Optional[str]

db_parameter_group_name

The name of an existing DB parameter group or a reference to an AWS::Neptune::DBParameterGroup resource created in the template.

If any of the data members of the referenced parameter group are changed during an update, the DB instance might need to be restarted, which causes some interruption. If the parameter group contains static parameters, whether they were changed or not, an update triggers a reboot.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html#cfn-neptune-dbinstance-dbparametergroupname

Return type

Optional[str]

db_snapshot_identifier

This parameter is not supported.

AWS::Neptune::DBInstance does not support restoring from snapshots.

AWS::Neptune::DBCluster does support restoring from snapshots.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html#cfn-neptune-dbinstance-dbsnapshotidentifier

Return type

Optional[str]

db_subnet_group_name

A DB subnet group to associate with the DB instance.

If you update this value, the new subnet group must be a subnet group in a new virtual private cloud (VPC).

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html#cfn-neptune-dbinstance-dbsubnetgroupname

Return type

Optional[str]

preferred_maintenance_window

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html#cfn-neptune-dbinstance-preferredmaintenancewindow

Return type

Optional[str]

tags

An arbitrary set of tags (key-value pairs) for this DB instance.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html#cfn-neptune-dbinstance-tags

Return type

Optional[List[CfnTag]]