Package software.amazon.awscdk.services.neptunegraph

Class CfnPrivateGraphEndpoint

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.CfnPrivateGraphEndpoint
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IPrivateGraphEndpointRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-12T17:54:17.679Z") @Stability(Stable) public class CfnPrivateGraphEndpoint extends CfnResource implements IInspectable, IPrivateGraphEndpointRef
Create a private graph endpoint to allow private access from to the graph from within a VPC.

You can attach security groups to the private graph endpoint.

VPC endpoint charges apply.

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.*;
 CfnPrivateGraphEndpoint cfnPrivateGraphEndpoint = CfnPrivateGraphEndpoint.Builder.create(this, "MyCfnPrivateGraphEndpoint")
         .graphIdentifier("graphIdentifier")
         .vpcId("vpcId")
         // the properties below are optional
         .securityGroupIds(List.of("securityGroupIds"))
         .subnetIds(List.of("subnetIds"))
         .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

    • CfnPrivateGraphEndpoint

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

    • CfnPrivateGraphEndpoint

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

    • CfnPrivateGraphEndpoint

      @Stability(Stable) public CfnPrivateGraphEndpoint(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnPrivateGraphEndpointProps props)
      Create a new AWS::NeptuneGraph::PrivateGraphEndpoint.

      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

    • isCfnPrivateGraphEndpoint

      @Stability(Stable) @NotNull public static Boolean isCfnPrivateGraphEndpoint(@NotNull Object x)
      Checks whether the given object is a CfnPrivateGraphEndpoint.

      Parameters:
      x - This parameter is required.

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

    • getAttrPrivateGraphEndpointIdentifier

      @Stability(Stable) @NotNull public String getAttrPrivateGraphEndpointIdentifier()
      PrivateGraphEndpoint resource identifier generated by concatenating the associated GraphIdentifier and VpcId with an underscore separator.

      For example, if GraphIdentifier is g-12a3bcdef4 and VpcId is vpc-111122223333aabbc , the generated PrivateGraphEndpointIdentifier will be g-12a3bcdef4_vpc-111122223333aabbc .

    • getAttrVpcEndpointId

      @Stability(Stable) @NotNull public String getAttrVpcEndpointId()
      VPC endpoint that provides a private connection between the Graph and specified VPC.

      For example: vpce-aabbaabbaabbaabba .

    • getCfnProperties

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

    • getPrivateGraphEndpointRef

      @Stability(Stable) @NotNull public PrivateGraphEndpointReference getPrivateGraphEndpointRef()
      A reference to a PrivateGraphEndpoint resource.
      Specified by:
      getPrivateGraphEndpointRef in interface IPrivateGraphEndpointRef

    • getGraphIdentifier

      @Stability(Stable) @NotNull public String getGraphIdentifier()
      The unique identifier of the Neptune Analytics graph.

    • setGraphIdentifier

      @Stability(Stable) public void setGraphIdentifier(@NotNull String value)
      The unique identifier of the Neptune Analytics graph.

    • getVpcId

      @Stability(Stable) @NotNull public String getVpcId()
      The VPC in which the private graph endpoint needs to be created.

    • setVpcId

      @Stability(Stable) public void setVpcId(@NotNull String value)
      The VPC in which the private graph endpoint needs to be created.

    • getSecurityGroupIds

      @Stability(Stable) @Nullable public List<String> getSecurityGroupIds()
      Security groups to be attached to the private graph endpoint..

    • setSecurityGroupIds

      @Stability(Stable) public void setSecurityGroupIds(@Nullable List<String> value)
      Security groups to be attached to the private graph endpoint..

    • getSubnetIds

      @Stability(Stable) @Nullable public List<String> getSubnetIds()
      Subnets in which private graph endpoint ENIs are created.

    • setSubnetIds

      @Stability(Stable) public void setSubnetIds(@Nullable List<String> value)
      Subnets in which private graph endpoint ENIs are created.