Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. neptunegraph
  5. Graph
AWS v6.82.2 published on Thursday, Jun 12, 2025 by Pulumi
pulumi/pulumi-aws

aws.neptunegraph.Graph

Explore with Pulumi AI

aws logo
AWS v6.82.2 published on Thursday, Jun 12, 2025 by Pulumi
pulumi/pulumi-aws

    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", {
    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",
    vectorSearchConfiguration: {
        vectorSearchDimension: 128,
    },
    tags: {
        Environment: "Development",
        ModifiedBy: "AWS",
    },
});

    import pulumi
import pulumi_aws as aws

# Create Neptune Graph
example = aws.neptunegraph.Graph("example",
    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",
    vector_search_configuration={
        "vector_search_dimension": 128,
    },
    tags={
        "Environment": "Development",
        "ModifiedBy": "AWS",
    })

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/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{
			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"),
			VectorSearchConfiguration: &neptunegraph.GraphVectorSearchConfigurationArgs{
				VectorSearchDimension: pulumi.Int(128),
			},
			Tags: pulumi.StringMap{
				"Environment": pulumi.String("Development"),
				"ModifiedBy":  pulumi.String("AWS"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    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()
    {
        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",
        VectorSearchConfiguration = new Aws.NeptuneGraph.Inputs.GraphVectorSearchConfigurationArgs
        {
            VectorSearchDimension = 128,
        },
        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.List;
import java.util.ArrayList;
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()
            .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")
            .vectorSearchConfiguration(GraphVectorSearchConfigurationArgs.builder()
                .vectorSearchDimension(128)
                .build())
            .tags(Map.ofEntries(
                Map.entry("Environment", "Development"),
                Map.entry("ModifiedBy", "AWS")
            ))
            .build());

    }
}

    resources:
  # Create Neptune Graph
  example:
    type: aws:neptunegraph:Graph
    properties:
      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
      vectorSearchConfiguration:
        vectorSearchDimension: 128
      tags:
        Environment: Development
        ModifiedBy: AWS

    Create Graph Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Graph(name: string, args: GraphArgs, opts?: CustomResourceOptions);
    @overload
def Graph(resource_name: str,
          args: GraphArgs,
          opts: Optional[ResourceOptions] = None)

@overload
def Graph(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          provisioned_memory: Optional[int] = None,
          deletion_protection: Optional[bool] = None,
          graph_name: Optional[str] = None,
          graph_name_prefix: Optional[str] = None,
          kms_key_identifier: Optional[str] = None,
          public_connectivity: Optional[bool] = None,
          replica_count: Optional[int] = None,
          tags: Optional[Mapping[str, str]] = None,
          timeouts: Optional[GraphTimeoutsArgs] = None,
          vector_search_configuration: Optional[GraphVectorSearchConfigurationArgs] = None)
    func NewGraph(ctx *Context, name string, args GraphArgs, opts ...ResourceOption) (*Graph, error)
    public Graph(string name, GraphArgs args, CustomResourceOptions? opts = null)
    public Graph(String name, GraphArgs args)
public Graph(String name, GraphArgs args, CustomResourceOptions options)

    type: aws:neptunegraph:Graph
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args GraphArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args GraphArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args GraphArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GraphArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GraphArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var awsGraphResource = new Aws.NeptuneGraph.Graph("awsGraphResource", new()
{
    ProvisionedMemory = 0,
    DeletionProtection = false,
    GraphName = "string",
    GraphNamePrefix = "string",
    KmsKeyIdentifier = "string",
    PublicConnectivity = false,
    ReplicaCount = 0,
    Tags = 
    {
        { "string", "string" },
    },
    Timeouts = new Aws.NeptuneGraph.Inputs.GraphTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Update = "string",
    },
    VectorSearchConfiguration = new Aws.NeptuneGraph.Inputs.GraphVectorSearchConfigurationArgs
    {
        VectorSearchDimension = 0,
    },
});

    example, err := neptunegraph.NewGraph(ctx, "awsGraphResource", &neptunegraph.GraphArgs{
	ProvisionedMemory:  pulumi.Int(0),
	DeletionProtection: pulumi.Bool(false),
	GraphName:          pulumi.String("string"),
	GraphNamePrefix:    pulumi.String("string"),
	KmsKeyIdentifier:   pulumi.String("string"),
	PublicConnectivity: pulumi.Bool(false),
	ReplicaCount:       pulumi.Int(0),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Timeouts: &neptunegraph.GraphTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
		Update: pulumi.String("string"),
	},
	VectorSearchConfiguration: &neptunegraph.GraphVectorSearchConfigurationArgs{
		VectorSearchDimension: pulumi.Int(0),
	},
})

    var awsGraphResource = new com.pulumi.aws.neptunegraph.Graph("awsGraphResource", com.pulumi.aws.neptunegraph.GraphArgs.builder()
    .provisionedMemory(0)
    .deletionProtection(false)
    .graphName("string")
    .graphNamePrefix("string")
    .kmsKeyIdentifier("string")
    .publicConnectivity(false)
    .replicaCount(0)
    .tags(Map.of("string", "string"))
    .timeouts(GraphTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .update("string")
        .build())
    .vectorSearchConfiguration(GraphVectorSearchConfigurationArgs.builder()
        .vectorSearchDimension(0)
        .build())
    .build());

    aws_graph_resource = aws.neptunegraph.Graph("awsGraphResource",
    provisioned_memory=0,
    deletion_protection=False,
    graph_name="string",
    graph_name_prefix="string",
    kms_key_identifier="string",
    public_connectivity=False,
    replica_count=0,
    tags={
        "string": "string",
    },
    timeouts={
        "create": "string",
        "delete": "string",
        "update": "string",
    },
    vector_search_configuration={
        "vector_search_dimension": 0,
    })

    const awsGraphResource = new aws.neptunegraph.Graph("awsGraphResource", {
    provisionedMemory: 0,
    deletionProtection: false,
    graphName: "string",
    graphNamePrefix: "string",
    kmsKeyIdentifier: "string",
    publicConnectivity: false,
    replicaCount: 0,
    tags: {
        string: "string",
    },
    timeouts: {
        create: "string",
        "delete": "string",
        update: "string",
    },
    vectorSearchConfiguration: {
        vectorSearchDimension: 0,
    },
});

    type: aws:neptunegraph:Graph
properties:
    deletionProtection: false
    graphName: string
    graphNamePrefix: string
    kmsKeyIdentifier: string
    provisionedMemory: 0
    publicConnectivity: false
    replicaCount: 0
    tags:
        string: string
    timeouts:
        create: string
        delete: string
        update: string
    vectorSearchConfiguration:
        vectorSearchDimension: 0

    Graph Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Graph resource accepts the following input properties:

    ProvisionedMemory int

    The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph.

    The following arguments are optional:

    DeletionProtection bool
    Value that indicates whether the Graph has deletion protection enabled. The graph can't be deleted when deletion protection is enabled.
    GraphName string
    The graph name. For example: my-graph-1. The name must contain from 1 to 63 letters, numbers, or hyphens, and its first character must be a letter. It cannot end with a hyphen or contain two consecutive hyphens. If you don't specify a graph name, a unique graph name is generated for you using the prefix graph-for, followed by a combination of Stack Name and a UUID.
    GraphNamePrefix string
    Allows user to specify name prefix and have remainder of name automatically generated.
    KmsKeyIdentifier 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).
    PublicConnectivity 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 Domain Name System (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.
    ReplicaCount 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.
    Tags Dictionary<string, string>
    The tags associated with this graph. (see below for nested schema of tags)
    Timeouts GraphTimeouts
    VectorSearchConfiguration GraphVectorSearchConfiguration
    Vector Search Configuration (see below for nested schema of vector_search_configuration)
    ProvisionedMemory int

    The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph.

    The following arguments are optional:

    DeletionProtection bool
    Value that indicates whether the Graph has deletion protection enabled. The graph can't be deleted when deletion protection is enabled.
    GraphName string
    The graph name. For example: my-graph-1. The name must contain from 1 to 63 letters, numbers, or hyphens, and its first character must be a letter. It cannot end with a hyphen or contain two consecutive hyphens. If you don't specify a graph name, a unique graph name is generated for you using the prefix graph-for, followed by a combination of Stack Name and a UUID.
    GraphNamePrefix string
    Allows user to specify name prefix and have remainder of name automatically generated.
    KmsKeyIdentifier 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).
    PublicConnectivity 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 Domain Name System (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.
    ReplicaCount 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.
    Tags map[string]string
    The tags associated with this graph. (see below for nested schema of tags)
    Timeouts GraphTimeoutsArgs
    VectorSearchConfiguration GraphVectorSearchConfigurationArgs
    Vector Search Configuration (see below for nested schema of vector_search_configuration)
    provisionedMemory Integer

    The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph.

    The following arguments are optional:

    deletionProtection Boolean
    Value that indicates whether the Graph has deletion protection enabled. The graph can't be deleted when deletion protection is enabled.
    graphName String
    The graph name. For example: my-graph-1. The name must contain from 1 to 63 letters, numbers, or hyphens, and its first character must be a letter. It cannot end with a hyphen or contain two consecutive hyphens. If you don't specify a graph name, a unique graph name is generated for you using the prefix graph-for, followed by a combination of Stack Name and a UUID.
    graphNamePrefix String
    Allows user to specify name prefix and have remainder of name automatically generated.
    kmsKeyIdentifier 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).
    publicConnectivity Boolean
    Specifies whether the Graph can be reached over the internet. Access to all graphs requires IAM authentication. When the Graph is publicly reachable, its Domain Name System (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.
    replicaCount Integer
    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.
    tags Map<String,String>
    The tags associated with this graph. (see below for nested schema of tags)
    timeouts GraphTimeouts
    vectorSearchConfiguration GraphVectorSearchConfiguration
    Vector Search Configuration (see below for nested schema of vector_search_configuration)
    provisionedMemory number

    The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph.

    The following arguments are optional:

    deletionProtection boolean
    Value that indicates whether the Graph has deletion protection enabled. The graph can't be deleted when deletion protection is enabled.
    graphName string
    The graph name. For example: my-graph-1. The name must contain from 1 to 63 letters, numbers, or hyphens, and its first character must be a letter. It cannot end with a hyphen or contain two consecutive hyphens. If you don't specify a graph name, a unique graph name is generated for you using the prefix graph-for, followed by a combination of Stack Name and a UUID.
    graphNamePrefix string
    Allows user to specify name prefix and have remainder of name automatically generated.
    kmsKeyIdentifier 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).
    publicConnectivity boolean
    Specifies whether the Graph can be reached over the internet. Access to all graphs requires IAM authentication. When the Graph is publicly reachable, its Domain Name System (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.
    replicaCount number
    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.
    tags {[key: string]: string}
    The tags associated with this graph. (see below for nested schema of tags)
    timeouts GraphTimeouts
    vectorSearchConfiguration GraphVectorSearchConfiguration
    Vector Search Configuration (see below for nested schema of vector_search_configuration)
    provisioned_memory int

    The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph.

    The following arguments are optional:

    deletion_protection bool
    Value that indicates whether the Graph has deletion protection enabled. The graph can't be deleted when deletion protection is enabled.
    graph_name str
    The graph name. For example: my-graph-1. The name must contain from 1 to 63 letters, numbers, or hyphens, and its first character must be a letter. It cannot end with a hyphen or contain two consecutive hyphens. If you don't specify a graph name, a unique graph name is generated for you using the prefix graph-for, followed by a combination of Stack Name and a UUID.
    graph_name_prefix str
    Allows user to specify name prefix and have remainder of name automatically generated.
    kms_key_identifier str
    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).
    public_connectivity 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 Domain Name System (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.
    replica_count 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.
    tags Mapping[str, str]
    The tags associated with this graph. (see below for nested schema of tags)
    timeouts GraphTimeoutsArgs
    vector_search_configuration GraphVectorSearchConfigurationArgs
    Vector Search Configuration (see below for nested schema of vector_search_configuration)
    provisionedMemory Number

    The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph.

    The following arguments are optional:

    deletionProtection Boolean
    Value that indicates whether the Graph has deletion protection enabled. The graph can't be deleted when deletion protection is enabled.
    graphName String
    The graph name. For example: my-graph-1. The name must contain from 1 to 63 letters, numbers, or hyphens, and its first character must be a letter. It cannot end with a hyphen or contain two consecutive hyphens. If you don't specify a graph name, a unique graph name is generated for you using the prefix graph-for, followed by a combination of Stack Name and a UUID.
    graphNamePrefix String
    Allows user to specify name prefix and have remainder of name automatically generated.
    kmsKeyIdentifier 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).
    publicConnectivity Boolean
    Specifies whether the Graph can be reached over the internet. Access to all graphs requires IAM authentication. When the Graph is publicly reachable, its Domain Name System (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.
    replicaCount Number
    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.
    tags Map<String>
    The tags associated with this graph. (see below for nested schema of tags)
    timeouts Property Map
    vectorSearchConfiguration Property Map
    Vector Search Configuration (see below for nested schema of vector_search_configuration)

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Graph resource produces the following output properties:

    Arn string
    (String) Graph resource ARN
    Endpoint string
    (String) The connection endpoint for the graph. For example: g-12a3bcdef4.us-east-1.neptune-graph.amazonaws.com
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll Dictionary<string, string>

    Deprecated: Please use tags instead.

    Arn string
    (String) Graph resource ARN
    Endpoint string
    (String) The connection endpoint for the graph. For example: g-12a3bcdef4.us-east-1.neptune-graph.amazonaws.com
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll map[string]string

    Deprecated: Please use tags instead.

    arn String
    (String) Graph resource ARN
    endpoint String
    (String) The connection endpoint for the graph. For example: g-12a3bcdef4.us-east-1.neptune-graph.amazonaws.com
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String,String>

    Deprecated: Please use tags instead.

    arn string
    (String) Graph resource ARN
    endpoint string
    (String) The connection endpoint for the graph. For example: g-12a3bcdef4.us-east-1.neptune-graph.amazonaws.com
    id string
    The provider-assigned unique ID for this managed resource.
    tagsAll {[key: string]: string}

    Deprecated: Please use tags instead.

    arn str
    (String) Graph resource ARN
    endpoint str
    (String) The connection endpoint for the graph. For example: g-12a3bcdef4.us-east-1.neptune-graph.amazonaws.com
    id str
    The provider-assigned unique ID for this managed resource.
    tags_all Mapping[str, str]

    Deprecated: Please use tags instead.

    arn String
    (String) Graph resource ARN
    endpoint String
    (String) The connection endpoint for the graph. For example: g-12a3bcdef4.us-east-1.neptune-graph.amazonaws.com
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String>

    Deprecated: Please use tags instead.

    Look up Existing Graph Resource

    Get an existing Graph resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: GraphState, opts?: CustomResourceOptions): Graph
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        deletion_protection: Optional[bool] = None,
        endpoint: Optional[str] = None,
        graph_name: Optional[str] = None,
        graph_name_prefix: Optional[str] = None,
        kms_key_identifier: Optional[str] = None,
        provisioned_memory: Optional[int] = None,
        public_connectivity: Optional[bool] = None,
        replica_count: Optional[int] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        timeouts: Optional[GraphTimeoutsArgs] = None,
        vector_search_configuration: Optional[GraphVectorSearchConfigurationArgs] = None) -> Graph
    func GetGraph(ctx *Context, name string, id IDInput, state *GraphState, opts ...ResourceOption) (*Graph, error)
    public static Graph Get(string name, Input<string> id, GraphState? state, CustomResourceOptions? opts = null)
    public static Graph get(String name, Output<String> id, GraphState state, CustomResourceOptions options)
    resources:  _:    type: aws:neptunegraph:Graph    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arn string
    (String) Graph resource ARN
    DeletionProtection bool
    Value that indicates whether the Graph has deletion protection enabled. The graph can't be deleted when deletion protection is enabled.
    Endpoint string
    (String) The connection endpoint for the graph. For example: g-12a3bcdef4.us-east-1.neptune-graph.amazonaws.com
    GraphName string
    The graph name. For example: my-graph-1. The name must contain from 1 to 63 letters, numbers, or hyphens, and its first character must be a letter. It cannot end with a hyphen or contain two consecutive hyphens. If you don't specify a graph name, a unique graph name is generated for you using the prefix graph-for, followed by a combination of Stack Name and a UUID.
    GraphNamePrefix string
    Allows user to specify name prefix and have remainder of name automatically generated.
    KmsKeyIdentifier 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).
    ProvisionedMemory int

    The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph.

    The following arguments are optional:

    PublicConnectivity 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 Domain Name System (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.
    ReplicaCount 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.
    Tags Dictionary<string, string>
    The tags associated with this graph. (see below for nested schema of tags)
    TagsAll Dictionary<string, string>

    Deprecated: Please use tags instead.

    Timeouts GraphTimeouts
    VectorSearchConfiguration GraphVectorSearchConfiguration
    Vector Search Configuration (see below for nested schema of vector_search_configuration)
    Arn string
    (String) Graph resource ARN
    DeletionProtection bool
    Value that indicates whether the Graph has deletion protection enabled. The graph can't be deleted when deletion protection is enabled.
    Endpoint string
    (String) The connection endpoint for the graph. For example: g-12a3bcdef4.us-east-1.neptune-graph.amazonaws.com
    GraphName string
    The graph name. For example: my-graph-1. The name must contain from 1 to 63 letters, numbers, or hyphens, and its first character must be a letter. It cannot end with a hyphen or contain two consecutive hyphens. If you don't specify a graph name, a unique graph name is generated for you using the prefix graph-for, followed by a combination of Stack Name and a UUID.
    GraphNamePrefix string
    Allows user to specify name prefix and have remainder of name automatically generated.
    KmsKeyIdentifier 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).
    ProvisionedMemory int

    The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph.

    The following arguments are optional:

    PublicConnectivity 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 Domain Name System (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.
    ReplicaCount 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.
    Tags map[string]string
    The tags associated with this graph. (see below for nested schema of tags)
    TagsAll map[string]string

    Deprecated: Please use tags instead.

    Timeouts GraphTimeoutsArgs
    VectorSearchConfiguration GraphVectorSearchConfigurationArgs
    Vector Search Configuration (see below for nested schema of vector_search_configuration)
    arn String
    (String) Graph resource ARN
    deletionProtection Boolean
    Value that indicates whether the Graph has deletion protection enabled. The graph can't be deleted when deletion protection is enabled.
    endpoint String
    (String) The connection endpoint for the graph. For example: g-12a3bcdef4.us-east-1.neptune-graph.amazonaws.com
    graphName String
    The graph name. For example: my-graph-1. The name must contain from 1 to 63 letters, numbers, or hyphens, and its first character must be a letter. It cannot end with a hyphen or contain two consecutive hyphens. If you don't specify a graph name, a unique graph name is generated for you using the prefix graph-for, followed by a combination of Stack Name and a UUID.
    graphNamePrefix String
    Allows user to specify name prefix and have remainder of name automatically generated.
    kmsKeyIdentifier 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).
    provisionedMemory Integer

    The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph.

    The following arguments are optional:

    publicConnectivity Boolean
    Specifies whether the Graph can be reached over the internet. Access to all graphs requires IAM authentication. When the Graph is publicly reachable, its Domain Name System (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.
    replicaCount Integer
    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.
    tags Map<String,String>
    The tags associated with this graph. (see below for nested schema of tags)
    tagsAll Map<String,String>

    Deprecated: Please use tags instead.

    timeouts GraphTimeouts
    vectorSearchConfiguration GraphVectorSearchConfiguration
    Vector Search Configuration (see below for nested schema of vector_search_configuration)
    arn string
    (String) Graph resource ARN
    deletionProtection boolean
    Value that indicates whether the Graph has deletion protection enabled. The graph can't be deleted when deletion protection is enabled.
    endpoint string
    (String) The connection endpoint for the graph. For example: g-12a3bcdef4.us-east-1.neptune-graph.amazonaws.com
    graphName string
    The graph name. For example: my-graph-1. The name must contain from 1 to 63 letters, numbers, or hyphens, and its first character must be a letter. It cannot end with a hyphen or contain two consecutive hyphens. If you don't specify a graph name, a unique graph name is generated for you using the prefix graph-for, followed by a combination of Stack Name and a UUID.
    graphNamePrefix string
    Allows user to specify name prefix and have remainder of name automatically generated.
    kmsKeyIdentifier 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).
    provisionedMemory number

    The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph.

    The following arguments are optional:

    publicConnectivity boolean
    Specifies whether the Graph can be reached over the internet. Access to all graphs requires IAM authentication. When the Graph is publicly reachable, its Domain Name System (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.
    replicaCount number
    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.
    tags {[key: string]: string}
    The tags associated with this graph. (see below for nested schema of tags)
    tagsAll {[key: string]: string}

    Deprecated: Please use tags instead.

    timeouts GraphTimeouts
    vectorSearchConfiguration GraphVectorSearchConfiguration
    Vector Search Configuration (see below for nested schema of vector_search_configuration)
    arn str
    (String) Graph resource ARN
    deletion_protection bool
    Value that indicates whether the Graph has deletion protection enabled. The graph can't be deleted when deletion protection is enabled.
    endpoint str
    (String) The connection endpoint for the graph. For example: g-12a3bcdef4.us-east-1.neptune-graph.amazonaws.com
    graph_name str
    The graph name. For example: my-graph-1. The name must contain from 1 to 63 letters, numbers, or hyphens, and its first character must be a letter. It cannot end with a hyphen or contain two consecutive hyphens. If you don't specify a graph name, a unique graph name is generated for you using the prefix graph-for, followed by a combination of Stack Name and a UUID.
    graph_name_prefix str
    Allows user to specify name prefix and have remainder of name automatically generated.
    kms_key_identifier str
    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).
    provisioned_memory int

    The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph.

    The following arguments are optional:

    public_connectivity 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 Domain Name System (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.
    replica_count 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.
    tags Mapping[str, str]
    The tags associated with this graph. (see below for nested schema of tags)
    tags_all Mapping[str, str]

    Deprecated: Please use tags instead.

    timeouts GraphTimeoutsArgs
    vector_search_configuration GraphVectorSearchConfigurationArgs
    Vector Search Configuration (see below for nested schema of vector_search_configuration)
    arn String
    (String) Graph resource ARN
    deletionProtection Boolean
    Value that indicates whether the Graph has deletion protection enabled. The graph can't be deleted when deletion protection is enabled.
    endpoint String
    (String) The connection endpoint for the graph. For example: g-12a3bcdef4.us-east-1.neptune-graph.amazonaws.com
    graphName String
    The graph name. For example: my-graph-1. The name must contain from 1 to 63 letters, numbers, or hyphens, and its first character must be a letter. It cannot end with a hyphen or contain two consecutive hyphens. If you don't specify a graph name, a unique graph name is generated for you using the prefix graph-for, followed by a combination of Stack Name and a UUID.
    graphNamePrefix String
    Allows user to specify name prefix and have remainder of name automatically generated.
    kmsKeyIdentifier 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).
    provisionedMemory Number

    The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph.

    The following arguments are optional:

    publicConnectivity Boolean
    Specifies whether the Graph can be reached over the internet. Access to all graphs requires IAM authentication. When the Graph is publicly reachable, its Domain Name System (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.
    replicaCount Number
    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.
    tags Map<String>
    The tags associated with this graph. (see below for nested schema of tags)
    tagsAll Map<String>

    Deprecated: Please use tags instead.

    timeouts Property Map
    vectorSearchConfiguration Property Map
    Vector Search Configuration (see below for nested schema of vector_search_configuration)

    Supporting Types

    GraphTimeouts, GraphTimeoutsArgs

    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    Update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    Update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    update String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    update str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    update String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).

    GraphVectorSearchConfiguration, GraphVectorSearchConfigurationArgs

    VectorSearchDimension int
    Specifies the number of dimensions for vector embeddings. Value must be between 1 and 65,535.
    VectorSearchDimension int
    Specifies the number of dimensions for vector embeddings. Value must be between 1 and 65,535.
    vectorSearchDimension Integer
    Specifies the number of dimensions for vector embeddings. Value must be between 1 and 65,535.
    vectorSearchDimension number
    Specifies the number of dimensions for vector embeddings. Value must be between 1 and 65,535.
    vector_search_dimension int
    Specifies the number of dimensions for vector embeddings. Value must be between 1 and 65,535.
    vectorSearchDimension Number
    Specifies the number of dimensions for vector embeddings. Value must be between 1 and 65,535.

    Import

    Using pulumi import, import aws_neptunegraph_graph using the graph identifier. For example:

    $ pulumi import aws:neptunegraph/graph:Graph example "graph_id"

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.82.2 published on Thursday, Jun 12, 2025 by Pulumi
    pulumi/pulumi-aws