Graph class
The aws.neptunegraph.Graph resource creates an Amazon Analytics Graph.
Example Usage
Neptune Graph (with Vector Search configuration)
Creates a Neptune Graph with 16GB provisioned memory, vector search capability with 128 dimensions, and a single replica for high availability.
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
// Create Neptune Graph
const example = new aws.neptunegraph.Graph("example", {
vectorSearchConfiguration: {
vectorSearchDimension: 128,
},
graphName: "example-graph-test-20250203",
provisionedMemory: 16,
deletionProtection: false,
publicConnectivity: false,
replicaCount: 1,
kmsKeyIdentifier: "arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012",
tags: {
Environment: "Development",
ModifiedBy: "AWS",
},
});
import pulumi
import pulumi_aws as aws
# Create Neptune Graph
example = aws.neptunegraph.Graph("example",
vector_search_configuration={
"vector_search_dimension": 128,
},
graph_name="example-graph-test-20250203",
provisioned_memory=16,
deletion_protection=False,
public_connectivity=False,
replica_count=1,
kms_key_identifier="arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012",
tags={
"Environment": "Development",
"ModifiedBy": "AWS",
})
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
// Create Neptune Graph
var example = new Aws.NeptuneGraph.Graph("example", new()
{
VectorSearchConfiguration = new Aws.NeptuneGraph.Inputs.GraphVectorSearchConfigurationArgs
{
VectorSearchDimension = 128,
},
GraphName = "example-graph-test-20250203",
ProvisionedMemory = 16,
DeletionProtection = false,
PublicConnectivity = false,
ReplicaCount = 1,
KmsKeyIdentifier = "arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012",
Tags =
{
{ "Environment", "Development" },
{ "ModifiedBy", "AWS" },
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/neptunegraph"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
// Create Neptune Graph
_, err := neptunegraph.NewGraph(ctx, "example", &neptunegraph.GraphArgs{
VectorSearchConfiguration: &neptunegraph.GraphVectorSearchConfigurationArgs{
VectorSearchDimension: pulumi.Int(128),
},
GraphName: pulumi.String("example-graph-test-20250203"),
ProvisionedMemory: pulumi.Int(16),
DeletionProtection: pulumi.Bool(false),
PublicConnectivity: pulumi.Bool(false),
ReplicaCount: pulumi.Int(1),
KmsKeyIdentifier: pulumi.String("arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012"),
Tags: pulumi.StringMap{
"Environment": pulumi.String("Development"),
"ModifiedBy": pulumi.String("AWS"),
},
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
# Create Neptune Graph
resource "aws_neptunegraph_graph" "example" {
vector_search_configuration = {
vector_search_dimension = 128
}
graph_name = "example-graph-test-20250203"
provisioned_memory = 16
deletion_protection = false
public_connectivity = false
replica_count = 1
kms_key_identifier = "arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012"
tags = {
"Environment" = "Development"
"ModifiedBy" = "AWS"
}
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.neptunegraph.Graph;
import com.pulumi.aws.neptunegraph.GraphArgs;
import com.pulumi.aws.neptunegraph.inputs.GraphVectorSearchConfigurationArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
// Create Neptune Graph
var example = new Graph("example", GraphArgs.builder()
.vectorSearchConfiguration(GraphVectorSearchConfigurationArgs.builder()
.vectorSearchDimension(128)
.build())
.graphName("example-graph-test-20250203")
.provisionedMemory(16)
.deletionProtection(false)
.publicConnectivity(false)
.replicaCount(1)
.kmsKeyIdentifier("arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012")
.tags(Map.ofEntries(
Map.entry("Environment", "Development"),
Map.entry("ModifiedBy", "AWS")
))
.build());
}
}
resources:
# Create Neptune Graph
example:
type: aws:neptunegraph:Graph
properties:
vectorSearchConfiguration:
vectorSearchDimension: 128
graphName: example-graph-test-20250203
provisionedMemory: 16
deletionProtection: false
publicConnectivity: false
replicaCount: 1
kmsKeyIdentifier: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
tags:
Environment: Development
ModifiedBy: AWS
Import
Using pulumi import, import aws.neptunegraph.Graph using the graph identifier. For example:
$ pulumi import aws:neptunegraph/graph:Graph example "graph_id"
Constructors
- Graph(String name, {GraphArgs? args, CustomResourceOptions? options})
-
Creates a new Graph.
nameThe Pulumi resource name.argsArguments used to configure this Graph. The set of arguments for Graph.optionsResource options controlling this resource's behavior. - Graph.reference(String urn)
- Creates a typed reference to an existing Graph resource.
Properties
-
arn
↔ Output<
String> -
(String) Graph resource ARN
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
deletionProtection
↔ Output<
bool> -
Value that indicates whether the Graph has deletion protection enabled. The graph can't be deleted when deletion protection is enabled.
latefinal
-
endpoint
↔ Output<
String> -
(String) The connection endpoint for the graph. For example:
g-12a3bcdef4.us-east-1.neptune-graph.amazonaws.comlatefinal -
graphName
↔ Output<
String> -
Contains a user-supplied name for the Graph. If omitted, Terraform will assign a random, unique identifier.
latefinal
-
graphNamePrefix
↔ Output<
String?> -
Allows user to specify name prefix and have remainder of name automatically generated.
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
kmsKeyIdentifier
↔ Output<
String> -
The ARN for the KMS encryption key. By Default, Neptune Analytics will use an AWS provided key ("AWS_OWNED_KEY"). This parameter is used if you want to encrypt the graph using a KMS Customer Managed Key (CMK).
latefinal
-
provisionedMemory
↔ Output<
int> -
The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph.
latefinal
-
publicConnectivity
↔ Output<
bool> -
Specifies whether the Graph can be reached over the internet. Access to all graphs requires IAM authentication. When the Graph is publicly reachable, its DNS endpoint resolves to the public IP address from the internet. When the Graph isn't publicly reachable, you need to create a PrivateGraphEndpoint in a given VPC to ensure the DNS name resolves to a private IP address that is reachable from the VPC.
latefinal
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
replicaCount
↔ Output<
int> -
Specifies the number of replicas you want when finished. All replicas will be provisioned in different availability zones. Replica Count should always be less than or equal to 2.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
Key-value tags for the graph. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.latefinal -
A map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.latefinal -
timeouts
↔ Output<
GraphTimeouts?> -
latefinal
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
-
vectorSearchConfiguration
↔ Output<
GraphVectorSearchConfiguration?> -
Vector Search Configuration (see below for nested schema of vector_search_configuration)
latefinal
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited