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.93.0 (build 1706ca5)",
           date="2024-01-03T18:29:29.311Z")
@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()	Value that indicates whether the Graph has deletion protection enabled.
default String	getGraphName()	Contains a user-supplied name for the Graph.
Number	getProvisionedMemory()	Memory for the Graph.
default Object	getPublicConnectivity()	Specifies whether the Graph can be reached over the internet.
default Number	getReplicaCount()	Specifies the number of replicas you want when finished.
default List<CfnTag>	getTags()	The tags associated with this graph.
default Object	getVectorSearchConfiguration()	The vector search configuration.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getProvisionedMemory

@Stability(Stable)
@NotNull
Number getProvisionedMemory()

Memory for the Graph.

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()

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.

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()

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.

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 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.

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()

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.

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()

The tags associated with this graph.

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()

The vector search configuration.

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