Skip to content
v2.277.0

Experimental

@aws-cdk/aws-neptune-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

DatabaseClusterAttributes Struct ​

Properties that describe an existing cluster instance.

Example ​

ts
// 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,
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_neptune_alpha as neptune_alpha
from aws_cdk import aws_ec2 as ec2

# security_group: ec2.SecurityGroup

database_cluster_attributes = neptune_alpha.DatabaseClusterAttributes(
    cluster_endpoint_address="clusterEndpointAddress",
    cluster_identifier="clusterIdentifier",
    cluster_resource_identifier="clusterResourceIdentifier",
    port=123,
    reader_endpoint_address="readerEndpointAddress",
    security_group=security_group
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.neptune.alpha.*;
import software.amazon.awscdk.services.ec2.*;

SecurityGroup securityGroup;

DatabaseClusterAttributes databaseClusterAttributes = DatabaseClusterAttributes.builder()
        .clusterEndpointAddress("clusterEndpointAddress")
        .clusterIdentifier("clusterIdentifier")
        .clusterResourceIdentifier("clusterResourceIdentifier")
        .port(123)
        .readerEndpointAddress("readerEndpointAddress")
        .securityGroup(securityGroup)
        .build();
csharp
// Install: dotnet add package Amazon.CDK.AWS.Neptune.Alpha
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Neptune.Alpha;
using Amazon.CDK.AWS.EC2;

SecurityGroup securityGroup;

var databaseClusterAttributes = new DatabaseClusterAttributes {
    ClusterEndpointAddress = "clusterEndpointAddress",
    ClusterIdentifier = "clusterIdentifier",
    ClusterResourceIdentifier = "clusterResourceIdentifier",
    Port = 123,
    ReaderEndpointAddress = "readerEndpointAddress",
    SecurityGroup = securityGroup
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdkneptunealpha/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import neptune_alpha "github.com/aws/aws-cdk-go/awscdkneptunealpha"
import "github.com/aws/aws-cdk-go/awscdk"

var securityGroup SecurityGroup

databaseClusterAttributes := &DatabaseClusterAttributes{
	ClusterEndpointAddress: jsii.String("clusterEndpointAddress"),
	ClusterIdentifier: jsii.String("clusterIdentifier"),
	ClusterResourceIdentifier: jsii.String("clusterResourceIdentifier"),
	Port: jsii.Number(123),
	ReaderEndpointAddress: jsii.String("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.