Package software.amazon.awscdk.services.neptunegraph

Class CfnGraph

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.neptunegraph.CfnGraph
All Implemented Interfaces:
IInspectable, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)", date="2024-07-12T19:34:05.895Z") @Stability(Stable) public class CfnGraph extends CfnResource implements IInspectable, ITaggableV2
The AWS ::NeptuneGraph::Graph resource creates an graph.

is a memory-optimized graph database engine for analytics. For more information, see .

You can use AWS ::NeptuneGraph::Graph.DeletionProtection to help guard against unintended deletion of your graph.

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.*;
 CfnGraph cfnGraph = CfnGraph.Builder.create(this, "MyCfnGraph")
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnGraph

      protected CfnGraph(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnGraph

      protected CfnGraph(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnGraph

      @Stability(Stable) public CfnGraph(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnGraphProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrEndpoint

      @Stability(Stable) @NotNull public String getAttrEndpoint()
      The connection endpoint for the graph.

      For example: g-12a3bcdef4.us-east-1.neptune-graph.amazonaws.com

    • getAttrGraphArn

      @Stability(Stable) @NotNull public String getAttrGraphArn()
      The ARN of the graph.

      For example: arn:aws:neptune-graph:us-east-1:111122223333:graph/g-12a3bcdef4

    • getAttrGraphId

      @Stability(Stable) @NotNull public String getAttrGraphId()
      The ID of the graph.

      For example: g-12a3bcdef4

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getProvisionedMemory

      @Stability(Stable) @NotNull public Number getProvisionedMemory()
      The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph.

    • setProvisionedMemory

      @Stability(Stable) public void setProvisionedMemory(@NotNull Number value)
      The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph.

    • getDeletionProtection

      @Stability(Stable) @Nullable public Object getDeletionProtection()
      A value that indicates whether the graph has deletion protection enabled.

    • setDeletionProtection

      @Stability(Stable) public void setDeletionProtection(@Nullable Boolean value)
      A value that indicates whether the graph has deletion protection enabled.

    • setDeletionProtection

      @Stability(Stable) public void setDeletionProtection(@Nullable IResolvable value)
      A value that indicates whether the graph has deletion protection enabled.

    • getGraphName

      @Stability(Stable) @Nullable public String getGraphName()
      The graph name.

      For example: my-graph-1 .

    • setGraphName

      @Stability(Stable) public void setGraphName(@Nullable String value)
      The graph name.

      For example: my-graph-1 .

    • getPublicConnectivity

      @Stability(Stable) @Nullable public Object getPublicConnectivity()
      Specifies whether or not the graph can be reachable over the internet.

      All access to graphs is IAM authenticated.

    • setPublicConnectivity

      @Stability(Stable) public void setPublicConnectivity(@Nullable Boolean value)
      Specifies whether or not the graph can be reachable over the internet.

      All access to graphs is IAM authenticated.

    • setPublicConnectivity

      @Stability(Stable) public void setPublicConnectivity(@Nullable IResolvable value)
      Specifies whether or not the graph can be reachable over the internet.

      All access to graphs is IAM authenticated.

    • getReplicaCount

      @Stability(Stable) @Nullable public Number getReplicaCount()
      The number of replicas in other AZs.

    • setReplicaCount

      @Stability(Stable) public void setReplicaCount(@Nullable Number value)
      The number of replicas in other AZs.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      Adds metadata tags to the new graph.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      Adds metadata tags to the new graph.

    • getVectorSearchConfiguration

      @Stability(Stable) @Nullable public Object getVectorSearchConfiguration()
      Specifies the number of dimensions for vector embeddings that will be loaded into the graph.

    • setVectorSearchConfiguration

      @Stability(Stable) public void setVectorSearchConfiguration(@Nullable IResolvable value)
      Specifies the number of dimensions for vector embeddings that will be loaded into the graph.

    • setVectorSearchConfiguration

      @Stability(Stable) public void setVectorSearchConfiguration(@Nullable CfnGraph.VectorSearchConfigurationProperty value)
      Specifies the number of dimensions for vector embeddings that will be loaded into the graph.