Package com.pulumi.aws.neptunegraph

Class Graph

  • public class Graph
extends com.pulumi.resources.CustomResource
    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. 
     
 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());
 
     }
 }
    ## Import Using `pulumi import`, import `aws.neptunegraph.Graph` using the graph identifier. For example: ```sh $ pulumi import aws:neptunegraph/graph:Graph example "graph_id" ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Constructor Summary

      Constructors 
      Constructor Description
      Graph​(java.lang.String name)  
      Graph​(java.lang.String name, GraphArgs args)  
      Graph​(java.lang.String name, GraphArgs args, com.pulumi.resources.CustomResourceOptions options)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.lang.Boolean> deletionProtection()  
      com.pulumi.core.Output<java.lang.String> endpoint()  
      static Graph get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, GraphState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> graphName()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> graphNamePrefix()  
      com.pulumi.core.Output<java.lang.String> kmsKeyIdentifier()  
      com.pulumi.core.Output<java.lang.Integer> provisionedMemory()  
      com.pulumi.core.Output<java.lang.Boolean> publicConnectivity()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.Integer> replicaCount()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  
      com.pulumi.core.Output<java.util.Optional<GraphTimeouts>> timeouts()  
      com.pulumi.core.Output<java.util.Optional<GraphVectorSearchConfiguration>> vectorSearchConfiguration()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • Graph

        public Graph​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • Graph

        public Graph​(java.lang.String name,
             GraphArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • Graph

        public Graph​(java.lang.String name,
             GraphArgs args,
             @Nullable
             com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        (String) Graph resource ARN

      • deletionProtection

        public com.pulumi.core.Output<java.lang.Boolean> deletionProtection()
        Returns:
        Value that indicates whether the Graph has deletion protection enabled. The graph can't be deleted when deletion protection is enabled.

      • endpoint

        public com.pulumi.core.Output<java.lang.String> endpoint()
        Returns:
        (String) The connection endpoint for the graph. For example: `g-12a3bcdef4.us-east-1.neptune-graph.amazonaws.com`

      • graphName

        public com.pulumi.core.Output<java.lang.String> graphName()
        Returns:
        Contains a user-supplied name for the Graph. If omitted, Terraform will assign a random, unique identifier.

      • graphNamePrefix

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> graphNamePrefix()
        Returns:
        Allows user to specify name prefix and have remainder of name automatically generated.

      • kmsKeyIdentifier

        public com.pulumi.core.Output<java.lang.String> kmsKeyIdentifier()
        Returns:
        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

        public com.pulumi.core.Output<java.lang.Integer> provisionedMemory()
        Returns:
        The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph. The following arguments are optional:

      • publicConnectivity

        public com.pulumi.core.Output<java.lang.Boolean> publicConnectivity()
        Returns:
        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.

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • replicaCount

        public com.pulumi.core.Output<java.lang.Integer> replicaCount()
        Returns:
        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

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Key-value tags for the graph. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
        Returns:
        A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

      • timeouts

        public com.pulumi.core.Output<java.util.Optional<GraphTimeouts>> timeouts()

      • vectorSearchConfiguration

        public com.pulumi.core.Output<java.util.Optional<GraphVectorSearchConfiguration>> vectorSearchConfiguration()
        Returns:
        Vector Search Configuration (see below for nested schema of vector_search_configuration)

      • get

        public static Graph get​(java.lang.String name,
                        com.pulumi.core.Output<java.lang.String> id,
                        @Nullable
                        GraphState state,
                        @Nullable
                        com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.