software.amazon.awscdk.services.neptune.alpha.package-info Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of neptune-alpha Show documentation
The CDK Construct Library for AWS::Neptune
There is a newer version: 2.168.0-alpha.0
/**
 * Amazon Neptune Construct Library
 * 
 * ---
 * 

 * 
 * 

 * 

 * 
 * The APIs of higher level constructs in this module are experimental and under active development.
 * They are subject to non-backward compatible changes or removal in any future version. These are
 * not subject to the Semantic Versioning model and breaking changes will be
 * announced in the release notes. This means that while you may use them, you may need to update
 * your source code when upgrading to a newer version of this package.
 * 

 * 
 * 
 * 

 * 
 * 
 * 

 * Amazon Neptune is a fast, reliable, fully managed graph database service that makes it easy to build and run applications that work with highly connected datasets. The core of Neptune is a purpose-built, high-performance graph database engine. This engine is optimized for storing billions of relationships and querying the graph with milliseconds latency. Neptune supports the popular graph query languages Apache TinkerPop Gremlin and W3C’s SPARQL, enabling you to build queries that efficiently navigate highly connected datasets.
 * 

 * The @aws-cdk/aws-neptune package contains primitives for setting up Neptune database clusters and instances.
 * 

 * 
 * import software.amazon.awscdk.services.neptune.alpha.*;
 * 
 * 
 * 
Starting a Neptune Database
 * 
 * To set up a Neptune database, define a DatabaseCluster. You must always launch a database in a VPC.
 * 

 * 
 * DatabaseCluster cluster = DatabaseCluster.Builder.create(this, "Database")
 *         .vpc(vpc)
 *         .instanceType(InstanceType.R5_LARGE)
 *         .build();
 * 
 * 
 * By default only writer instance is provisioned with this construct.
 * 

 * 
Connecting
 * 
 * To control who can access the cluster, use the .connections attribute. Neptune databases have a default port, so
 * you don't need to specify the port:
 * 

 * 
 * cluster.connections.allowDefaultPortFromAnyIpv4("Open to the world");
 * 
 * 
 * The endpoints to access your database cluster will be available as the .clusterEndpoint and .clusterReadEndpoint
 * attributes:
 * 

 * 
 * String writeAddress = cluster.getClusterEndpoint().getSocketAddress();
 * 
 * 
 * 
IAM Authentication
 * 
 * You can also authenticate to a database cluster using AWS Identity and Access Management (IAM) database authentication;
 * See https://docs.aws.amazon.com/neptune/latest/userguide/iam-auth.html for more information and a list of supported
 * versions and limitations.
 * 

 * The following example shows enabling IAM authentication for a database cluster and granting connection access to an IAM role.
 * 

 * 
 * DatabaseCluster cluster = DatabaseCluster.Builder.create(this, "Cluster")
 *         .vpc(vpc)
 *         .instanceType(InstanceType.R5_LARGE)
 *         .iamAuthentication(true)
 *         .build();
 * Role role = Role.Builder.create(this, "DBRole").assumedBy(new AccountPrincipal(this.account)).build();
 * cluster.grantConnect(role);
 * 
 * 
 * 
Customizing parameters
 * 
 * Neptune allows configuring database behavior by supplying custom parameter groups.  For more details, refer to the
 * following link: https://docs.aws.amazon.com/neptune/latest/userguide/parameters.html
 * 

 * 
 * ClusterParameterGroup clusterParams = ClusterParameterGroup.Builder.create(this, "ClusterParams")
 *         .description("Cluster parameter group")
 *         .parameters(Map.of(
 *                 "neptune_enable_audit_log", "1"))
 *         .build();
 * 
 * ParameterGroup dbParams = ParameterGroup.Builder.create(this, "DbParams")
 *         .description("Db parameter group")
 *         .parameters(Map.of(
 *                 "neptune_query_timeout", "120000"))
 *         .build();
 * 
 * DatabaseCluster cluster = DatabaseCluster.Builder.create(this, "Database")
 *         .vpc(vpc)
 *         .instanceType(InstanceType.R5_LARGE)
 *         .clusterParameterGroup(clusterParams)
 *         .parameterGroup(dbParams)
 *         .build();
 * 
 * 
 * 
Adding replicas
 * 
 * DatabaseCluster allows launching replicas along with the writer instance. This can be specified using the instanceCount
 * attribute.
 * 

 * 
 * DatabaseCluster cluster = DatabaseCluster.Builder.create(this, "Database")
 *         .vpc(vpc)
 *         .instanceType(InstanceType.R5_LARGE)
 *         .instances(2)
 *         .build();
 * 
 * 
 * Additionally it is also possible to add replicas using DatabaseInstance for an existing cluster.
 * 

 * 
 * DatabaseInstance replica1 = DatabaseInstance.Builder.create(this, "Instance")
 *         .cluster(cluster)
 *         .instanceType(InstanceType.R5_LARGE)
 *         .build();
 * 
 */
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
package software.amazon.awscdk.services.neptune.alpha;