@aws-cdk/aws-neptune-alpha.DatabaseClusterAttributes

DatabaseClusterAttributes Struct

Properties that describe an existing cluster instance.

Stability

Experimental

Source

lib/cluster.ts

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as neptune_alpha from '@aws-cdk/aws-neptune-alpha';
import { aws_ec2 as ec2 } from 'aws-cdk-lib';

declare const securityGroup: ec2.SecurityGroup;
const databaseClusterAttributes: neptune_alpha.DatabaseClusterAttributes = {
  clusterEndpointAddress: 'clusterEndpointAddress',
  clusterIdentifier: 'clusterIdentifier',
  clusterResourceIdentifier: 'clusterResourceIdentifier',
  port: 123,
  readerEndpointAddress: 'readerEndpointAddress',
  securityGroup: securityGroup,
};

Properties

clusterEndpointAddressstringcluster_endpoint_addressstrclusterEndpointAddressStringClusterEndpointAddressstringClusterEndpointAddress*stringrequired#

Cluster endpoint address.

clusterIdentifierstringcluster_identifierstrclusterIdentifierStringClusterIdentifierstringClusterIdentifier*stringrequired#

Identifier for the cluster.

clusterResourceIdentifierstringcluster_resource_identifierstrclusterResourceIdentifierStringClusterResourceIdentifierstringClusterResourceIdentifier*stringrequired#

Resource Identifier for the cluster.

portnumberportint | floatportNumberPortdoublePort*float64required#

The database port.

readerEndpointAddressstringreader_endpoint_addressstrreaderEndpointAddressStringReaderEndpointAddressstringReaderEndpointAddress*stringrequired#

Reader endpoint address.

securityGroupISecurityGroupsecurity_groupISecurityGroupsecurityGroupISecurityGroupSecurityGroupISecurityGroupSecurityGroupISecurityGrouprequired#

The security group of the database cluster.