@aws-cdk_aws-neptune-alpha.IDatabaseCluster

interface IDatabaseCluster ๐Ÿ”น

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

Implemented by DatabaseCluster

Obtainable from DatabaseClusterBase.fromDatabaseClusterAttributes()

Create a clustered database with a given number of instances.

Properties

NameTypeDescription
clusterEndpoint๐Ÿ”นEndpointThe endpoint to use for read/write operations.
clusterIdentifier๐Ÿ”นstringIdentifier of the cluster.
clusterReadEndpoint๐Ÿ”นEndpointEndpoint to use for load-balanced read-only operations.
clusterResourceIdentifier๐Ÿ”นstringResource identifier of the cluster.
connections๐Ÿ”นConnectionsThe network connections associated with this resource.
env๐Ÿ”นResourceEnvironmentThe environment this resource belongs to.
node๐Ÿ”นNodeThe tree node.
stack๐Ÿ”นStackThe stack in which this resource is defined.

clusterEndpoint๐Ÿ”น

Type: Endpoint

The endpoint to use for read/write operations.


clusterIdentifier๐Ÿ”น

Type: string

Identifier of the cluster.


clusterReadEndpoint๐Ÿ”น

Type: Endpoint

Endpoint to use for load-balanced read-only operations.


clusterResourceIdentifier๐Ÿ”น

Type: string

Resource identifier of the cluster.


connections๐Ÿ”น

Type: Connections

The network connections associated with this resource.


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.


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.
grant(grantee, ...actions)๐Ÿ”นGrant the given identity the specified actions.
grantConnect(grantee)๐Ÿ”นGrant the given identity connection access to the database.
metric(metricName, props?)๐Ÿ”นReturn the given named metric associated with this DatabaseCluster instance.

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


grant(grantee, ...actions)๐Ÿ”น

public grant(grantee: IGrantable, ...actions: string[]): Grant

Parameters

  • grantee IGrantable โ€” the identity to be granted the actions.
  • actions string โ€” the data-access actions.

Returns

  • Grant

Grant the given identity the specified actions.

See also: https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html


grantConnect(grantee)๐Ÿ”น

public grantConnect(grantee: IGrantable): Grant

Parameters

  • grantee IGrantable

Returns

  • Grant

Grant the given identity connection access to the database.


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 DatabaseCluster instance.

See also: https://docs.aws.amazon.com/neptune/latest/userguide/cw-dimensions.html