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, publicly_accessible=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. When you change this parameter for an existing DB cluster, CloudFormation will replace your existing DB cluster with a new, empty one that uses the engine version you specified.
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]) – (deprecated) 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).
publicly_accessible (Union[bool, IResolvable, None]) – Indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible and you connect from outside of the DB instance’s virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB instance, the endpoint resolves to the private IP address. Access to the DB instance is ultimately controlled by the security group it uses. That public access isn’t permitted if the security group assigned to the DB cluster doesn’t permit it. When the DB instance isn’t publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – An arbitrary set of tags (key-value pairs) for this DB instance.

See:

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.
from aws_cdk import 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",
    publicly_accessible=False,
    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.

When you change this parameter for an existing DB cluster, CloudFormation will replace your existing DB cluster with a new, empty one that uses the engine version you specified.

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

auto_minor_version_upgrade

Indicates that minor version patches are applied automatically.

When updating this property, some interruptions may occur.

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

availability_zone

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

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

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.

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

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.

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

db_instance_identifier

Contains a user-supplied database identifier.

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

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

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.

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

db_snapshot_identifier

(deprecated) This parameter is not supported.

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

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

Deprecated:: this property has been deprecated
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html#cfn-neptune-dbinstance-dbsnapshotidentifier
Stability:: deprecated

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

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

preferred_maintenance_window

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

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

publicly_accessible

Indicates whether the DB instance is publicly accessible.

When the DB instance is publicly accessible and you connect from outside of the DB instance’s virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB instance, the endpoint resolves to the private IP address. Access to the DB instance is ultimately controlled by the security group it uses. That public access isn’t permitted if the security group assigned to the DB cluster doesn’t permit it.

When the DB instance isn’t publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

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

tags

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

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