Package software.amazon.awscdk.services.neptunegraph

Interface CfnGraphProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnGraphProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:24:04.844Z")
@Stability(Stable)
public interface CfnGraphProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnGraph.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.neptunegraph.*;
 CfnGraphProps cfnGraphProps = CfnGraphProps.builder()
         .provisionedMemory(123)
         // the properties below are optional
         .deletionProtection(false)
         .graphName("graphName")
         .publicConnectivity(false)
         .replicaCount(123)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .vectorSearchConfiguration(VectorSearchConfigurationProperty.builder()
                 .vectorSearchDimension(123)
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptunegraph-graph.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnGraphProps.Builder	A builder for CfnGraphProps
static final class	CfnGraphProps.Jsii$Proxy	An implementation for CfnGraphProps

Method Summary

Modifier and Type	Method	Description
static CfnGraphProps.Builder	builder()
default Object	getDeletionProtection()	A value that indicates whether the graph has deletion protection enabled.
default String	getGraphName()	The graph name.
Number	getProvisionedMemory()	The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph.
default Object	getPublicConnectivity()	Specifies whether or not the graph can be reachable over the internet.
default Number	getReplicaCount()	The number of replicas in other AZs.
default List<CfnTag>	getTags()	Adds metadata tags to the new graph.
default Object	getVectorSearchConfiguration()	Specifies the number of dimensions for vector embeddings that will be loaded into the graph.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getProvisionedMemory

@Stability(Stable)
@NotNull
Number getProvisionedMemory()

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

Min = 128

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptunegraph-graph.html#cfn-neptunegraph-graph-provisionedmemory

getDeletionProtection

@Stability(Stable)
@Nullable
default Object getDeletionProtection()

A value that indicates whether the graph has deletion protection enabled.

The graph can't be deleted when deletion protection is enabled.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptunegraph-graph.html#cfn-neptunegraph-graph-deletionprotection

getGraphName

@Stability(Stable)
@Nullable
default String getGraphName()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptunegraph-graph.html#cfn-neptunegraph-graph-graphname

getPublicConnectivity

@Stability(Stable)
@Nullable
default Object getPublicConnectivity()

Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated.

When the graph is publicly available, its domain name system (DNS) endpoint resolves to the public IP address from the internet. When the graph isn't publicly available, 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.

If enabling public connectivity for the first time, there will be a delay while it is enabled.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptunegraph-graph.html#cfn-neptunegraph-graph-publicconnectivity

getReplicaCount

@Stability(Stable)
@Nullable
default Number getReplicaCount()

The number of replicas in other AZs.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptunegraph-graph.html#cfn-neptunegraph-graph-replicacount

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

Adds metadata tags to the new graph.

These tags can also be used with cost allocation reporting, or used in a Condition statement in an IAM policy.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptunegraph-graph.html#cfn-neptunegraph-graph-tags

getVectorSearchConfiguration

@Stability(Stable)
@Nullable
default Object getVectorSearchConfiguration()

Specifies the number of dimensions for vector embeddings that will be loaded into the graph.

The value is specified as dimension= value. Max = 65,535

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptunegraph-graph.html#cfn-neptunegraph-graph-vectorsearchconfiguration

builder

@Stability(Stable)
static CfnGraphProps.Builder builder()

Returns:

a CfnGraphProps.Builder of CfnGraphProps