Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. neptunegraph
  5. Graph

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.neptunegraph.Graph

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

The AWS::NeptuneGraph::Graph resource creates an Amazon NeptuneGraph Graph.

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,
          public_connectivity: Optional[bool] = None,
          replica_count: Optional[int] = None,
          tags: Optional[Sequence[_root_inputs.TagArgs]] = 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-native:neptunegraph:Graph
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. GraphArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. GraphArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. GraphArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. GraphArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

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 This property is required. int
Memory for the Graph.
DeletionProtection bool

Value that indicates whether the Graph has deletion protection enabled. The graph can't be deleted when deletion protection is enabled.

Default: If not specified, the default value is true.

GraphName string

Contains a user-supplied name for the Graph.

If you don't specify a name, we generate a unique Graph Name using a combination of Stack Name and a UUID comprising of 4 characters.

Important: If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

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.

Default: If not specified, the default value is false.

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.

Default: If not specified, the default value is 1.

Tags List<Pulumi.AwsNative.Inputs.Tag>
The tags associated with this graph.
VectorSearchConfiguration Pulumi.AwsNative.NeptuneGraph.Inputs.GraphVectorSearchConfiguration
Vector Search Configuration
ProvisionedMemory This property is required. int
Memory for the Graph.
DeletionProtection bool

Value that indicates whether the Graph has deletion protection enabled. The graph can't be deleted when deletion protection is enabled.

Default: If not specified, the default value is true.

GraphName string

Contains a user-supplied name for the Graph.

If you don't specify a name, we generate a unique Graph Name using a combination of Stack Name and a UUID comprising of 4 characters.

Important: If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

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.

Default: If not specified, the default value is false.

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.

Default: If not specified, the default value is 1.

Tags TagArgs
The tags associated with this graph.
VectorSearchConfiguration GraphVectorSearchConfigurationArgs
Vector Search Configuration
provisionedMemory This property is required. Integer
Memory for the Graph.
deletionProtection Boolean

Value that indicates whether the Graph has deletion protection enabled. The graph can't be deleted when deletion protection is enabled.

Default: If not specified, the default value is true.

graphName String

Contains a user-supplied name for the Graph.

If you don't specify a name, we generate a unique Graph Name using a combination of Stack Name and a UUID comprising of 4 characters.

Important: If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

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.

Default: If not specified, the default value is false.

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.

Default: If not specified, the default value is 1.

tags List<Tag>
The tags associated with this graph.
vectorSearchConfiguration GraphVectorSearchConfiguration
Vector Search Configuration
provisionedMemory This property is required. number
Memory for the Graph.
deletionProtection boolean

Value that indicates whether the Graph has deletion protection enabled. The graph can't be deleted when deletion protection is enabled.

Default: If not specified, the default value is true.

graphName string

Contains a user-supplied name for the Graph.

If you don't specify a name, we generate a unique Graph Name using a combination of Stack Name and a UUID comprising of 4 characters.

Important: If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

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.

Default: If not specified, the default value is false.

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.

Default: If not specified, the default value is 1.

tags Tag[]
The tags associated with this graph.
vectorSearchConfiguration GraphVectorSearchConfiguration
Vector Search Configuration
provisioned_memory This property is required. int
Memory for the Graph.
deletion_protection bool

Value that indicates whether the Graph has deletion protection enabled. The graph can't be deleted when deletion protection is enabled.

Default: If not specified, the default value is true.

graph_name str

Contains a user-supplied name for the Graph.

If you don't specify a name, we generate a unique Graph Name using a combination of Stack Name and a UUID comprising of 4 characters.

Important: If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

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.

Default: If not specified, the default value is false.

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.

Default: If not specified, the default value is 1.

tags Sequence[TagArgs]
The tags associated with this graph.
vector_search_configuration GraphVectorSearchConfigurationArgs
Vector Search Configuration
provisionedMemory This property is required. Number
Memory for the Graph.
deletionProtection Boolean

Value that indicates whether the Graph has deletion protection enabled. The graph can't be deleted when deletion protection is enabled.

Default: If not specified, the default value is true.

graphName String

Contains a user-supplied name for the Graph.

If you don't specify a name, we generate a unique Graph Name using a combination of Stack Name and a UUID comprising of 4 characters.

Important: If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

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.

Default: If not specified, the default value is false.

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.

Default: If not specified, the default value is 1.

tags List<Property Map>
The tags associated with this graph.
vectorSearchConfiguration Property Map
Vector Search Configuration

Outputs

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

Endpoint string
The connection endpoint for the graph. For example: g-12a3bcdef4.us-east-1.neptune-graph.amazonaws.com
GraphArn string
Graph resource ARN
GraphId string
The auto-generated id assigned by the service.
Id string
The provider-assigned unique ID for this managed resource.
Endpoint string
The connection endpoint for the graph. For example: g-12a3bcdef4.us-east-1.neptune-graph.amazonaws.com
GraphArn string
Graph resource ARN
GraphId string
The auto-generated id assigned by the service.
Id string
The provider-assigned unique ID for this managed resource.
endpoint String
The connection endpoint for the graph. For example: g-12a3bcdef4.us-east-1.neptune-graph.amazonaws.com
graphArn String
Graph resource ARN
graphId String
The auto-generated id assigned by the service.
id String
The provider-assigned unique ID for this managed resource.
endpoint string
The connection endpoint for the graph. For example: g-12a3bcdef4.us-east-1.neptune-graph.amazonaws.com
graphArn string
Graph resource ARN
graphId string
The auto-generated id assigned by the service.
id string
The provider-assigned unique ID for this managed resource.
endpoint str
The connection endpoint for the graph. For example: g-12a3bcdef4.us-east-1.neptune-graph.amazonaws.com
graph_arn str
Graph resource ARN
graph_id str
The auto-generated id assigned by the service.
id str
The provider-assigned unique ID for this managed resource.
endpoint String
The connection endpoint for the graph. For example: g-12a3bcdef4.us-east-1.neptune-graph.amazonaws.com
graphArn String
Graph resource ARN
graphId String
The auto-generated id assigned by the service.
id String
The provider-assigned unique ID for this managed resource.

Supporting Types

GraphVectorSearchConfiguration
, GraphVectorSearchConfigurationArgs

VectorSearchDimension This property is required. int
The vector search dimension
VectorSearchDimension This property is required. int
The vector search dimension
vectorSearchDimension This property is required. Integer
The vector search dimension
vectorSearchDimension This property is required. number
The vector search dimension
vector_search_dimension This property is required. int
The vector search dimension
vectorSearchDimension This property is required. Number
The vector search dimension

Tag
, TagArgs

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native