Class CfnDBInstanceProps

Properties for defining a CfnDBInstance.

Inheritance

System.Object

CfnDBInstanceProps

Implements

ICfnDBInstanceProps

Namespace: Amazon.CDK.AWS.Neptune

Assembly: Amazon.CDK.AWS.Neptune.dll

Syntax (csharp)

public class CfnDBInstanceProps : Object, ICfnDBInstanceProps

Syntax (vb)

Public Class CfnDBInstanceProps
    Inherits Object
    Implements ICfnDBInstanceProps

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Neptune;

var cfnDBInstanceProps = new CfnDBInstanceProps {
    DbInstanceClass = "dbInstanceClass",

    // the properties below are optional
    AllowMajorVersionUpgrade = false,
    AutoMinorVersionUpgrade = false,
    AvailabilityZone = "availabilityZone",
    DbClusterIdentifier = "dbClusterIdentifier",
    DbInstanceIdentifier = "dbInstanceIdentifier",
    DbParameterGroupName = "dbParameterGroupName",
    DbSnapshotIdentifier = "dbSnapshotIdentifier",
    DbSubnetGroupName = "dbSubnetGroupName",
    PreferredMaintenanceWindow = "preferredMaintenanceWindow",
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } }
};

Synopsis

Constructors

CfnDBInstanceProps()

Properties

AllowMajorVersionUpgrade	Indicates that major version upgrades are allowed.
AutoMinorVersionUpgrade	Indicates that minor version patches are applied automatically.
AvailabilityZone	Specifies the name of the Availability Zone the DB instance is located in.
DbClusterIdentifier	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.
DbInstanceClass	Contains the name of the compute and memory capacity class of the DB instance.
DbInstanceIdentifier	Contains a user-supplied database identifier.
DbParameterGroupName	The name of an existing DB parameter group or a reference to an AWS::Neptune::DBParameterGroup resource created in the template.
DbSnapshotIdentifier	This parameter is not supported.
DbSubnetGroupName	A DB subnet group to associate with the DB instance.
PreferredMaintenanceWindow	Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Tags	An arbitrary set of tags (key-value pairs) for this DB instance.

Constructors

CfnDBInstanceProps()

public CfnDBInstanceProps()

Properties

AllowMajorVersionUpgrade

Indicates that major version upgrades are allowed.

public object AllowMajorVersionUpgrade { get; set; }

Property Value

System.Object

Remarks

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.

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

AutoMinorVersionUpgrade

Indicates that minor version patches are applied automatically.

public object AutoMinorVersionUpgrade { get; set; }

Property Value

System.Object

Remarks

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

AvailabilityZone

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

public string AvailabilityZone { get; set; }

Property Value

System.String

Remarks

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

DbClusterIdentifier

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.

public string DbClusterIdentifier { get; set; }

Property Value

System.String

Remarks

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

DbInstanceClass

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

public string DbInstanceClass { get; set; }

Property Value

System.String

Remarks

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

DbInstanceIdentifier

Contains a user-supplied database identifier.

public string DbInstanceIdentifier { get; set; }

Property Value

System.String

Remarks

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

DbParameterGroupName

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

public string DbParameterGroupName { get; set; }

Property Value

System.String

Remarks

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

DbSnapshotIdentifier

This parameter is not supported.

public string DbSnapshotIdentifier { get; set; }

Property Value

System.String

Remarks

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

DbSubnetGroupName

A DB subnet group to associate with the DB instance.

public string DbSubnetGroupName { get; set; }

Property Value

System.String

Remarks

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

PreferredMaintenanceWindow

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

public string PreferredMaintenanceWindow { get; set; }

Property Value

System.String

Remarks

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

Implements

ICfnDBInstanceProps