@aws-cdk_aws-neptune-alpha.DatabaseInstance

class DatabaseInstance (construct) ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.Neptune.Alpha.DatabaseInstance
Gogithub.com/aws/aws-cdk-go/awscdkneptunealpha/v2#DatabaseInstance
Javasoftware.amazon.awscdk.services.neptune.alpha.DatabaseInstance
Pythonaws_cdk.aws_neptune_alpha.DatabaseInstance
TypeScript (source)@aws-cdk/aws-neptune-alpha ยป DatabaseInstance

Implements IConstruct, IDependable, IResource, IDatabaseInstance

A database instance.

Example

const replica1 = new neptune.DatabaseInstance(this, 'Instance', {
  cluster,
  instanceType: neptune.InstanceType.R5_LARGE,
});

Initializer

new DatabaseInstance(scope: Construct, id: string, props: DatabaseInstanceProps)

Parameters

  • scope Construct
  • id string
  • props DatabaseInstanceProps

Construct Props

NameTypeDescription
cluster๐Ÿ”นIDatabaseClusterThe Neptune database cluster the instance should launch into.
instanceType๐Ÿ”นInstanceTypeWhat type of instance to start for the replicas.
availabilityZone?๐Ÿ”นstringThe name of the Availability Zone where the DB instance will be located.
dbInstanceName?๐Ÿ”นstringA name for the DB instance.
parameterGroup?๐Ÿ”นIParameterGroupThe DB parameter group to associate with the instance.
removalPolicy?๐Ÿ”นRemovalPolicyThe CloudFormation policy to apply when the instance is removed from the stack or replaced during an update.

cluster๐Ÿ”น

Type: IDatabaseCluster

The Neptune database cluster the instance should launch into.


instanceType๐Ÿ”น

Type: InstanceType

What type of instance to start for the replicas.


availabilityZone?๐Ÿ”น

Type: string (optional, default: no preference)

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


dbInstanceName?๐Ÿ”น

Type: string (optional, default: a CloudFormation generated name)

A name for the DB instance.

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


parameterGroup?๐Ÿ”น

Type: IParameterGroup (optional, default: no parameter group)

The DB parameter group to associate with the instance.


removalPolicy?๐Ÿ”น

Type: RemovalPolicy (optional, default: RemovalPolicy.Retain)

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

Properties

NameTypeDescription
cluster๐Ÿ”นIDatabaseClusterThe instance's database cluster.
dbInstanceEndpointAddress๐Ÿ”นstringThe instance endpoint address.
dbInstanceEndpointPort๐Ÿ”นstringThe instance endpoint port.
env๐Ÿ”นResourceEnvironmentThe environment this resource belongs to.
instanceEndpoint๐Ÿ”นEndpointThe instance endpoint.
instanceIdentifier๐Ÿ”นstringThe instance identifier.
node๐Ÿ”นNodeThe tree node.
stack๐Ÿ”นStackThe stack in which this resource is defined.

cluster๐Ÿ”น

Type: IDatabaseCluster

The instance's database cluster.


dbInstanceEndpointAddress๐Ÿ”น

Type: string

The instance endpoint address.


dbInstanceEndpointPort๐Ÿ”น

Type: string

The instance endpoint port.


env๐Ÿ”น

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.


instanceEndpoint๐Ÿ”น

Type: Endpoint

The instance endpoint.


instanceIdentifier๐Ÿ”น

Type: string

The instance identifier.


node๐Ÿ”น

Type: Node

The tree node.


stack๐Ÿ”น

Type: Stack

The stack in which this resource is defined.

Methods

NameDescription
applyRemovalPolicy(policy)๐Ÿ”นApply the given removal policy to this resource.
metric(metricName, props?)๐Ÿ”นReturn the given named metric associated with this database instance.
toString()๐Ÿ”นReturns a string representation of this construct.

applyRemovalPolicy(policy)๐Ÿ”น

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

  • policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).


metric(metricName, props?)๐Ÿ”น

public metric(metricName: string, props?: MetricOptions): Metric

Parameters

  • metricName string
  • props MetricOptions

Returns

  • Metric

Return the given named metric associated with this database instance.


toString()๐Ÿ”น

public toString(): string

Returns

  • string

Returns a string representation of this construct.