Package software.amazon.awscdk.services.opensearchserverless

Class CfnVpcEndpoint

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.opensearchserverless.CfnVpcEndpoint
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IVpcEndpointRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-12-01T16:02:25.252Z") @Stability(Stable) public class CfnVpcEndpoint extends CfnResource implements IInspectable, IVpcEndpointRef
Creates an OpenSearch Serverless-managed interface VPC endpoint.

For more information, see Access Amazon OpenSearch Serverless using an interface endpoint .

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.opensearchserverless.*;
 CfnVpcEndpoint cfnVpcEndpoint = CfnVpcEndpoint.Builder.create(this, "MyCfnVpcEndpoint")
         .name("name")
         .subnetIds(List.of("subnetIds"))
         .vpcId("vpcId")
         // the properties below are optional
         .securityGroupIds(List.of("securityGroupIds"))
         .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

    • CfnVpcEndpoint

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

    • CfnVpcEndpoint

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

    • CfnVpcEndpoint

      @Stability(Stable) public CfnVpcEndpoint(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnVpcEndpointProps props)
      Create a new AWS::OpenSearchServerless::VpcEndpoint.

      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

    • isCfnVpcEndpoint

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

      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.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The unique identifier of the endpoint.

      For example, vpce-050f79086ee71ac05 .

    • getCfnProperties

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

    • getVpcEndpointRef

      @Stability(Stable) @NotNull public VpcEndpointReference getVpcEndpointRef()
      A reference to a VpcEndpoint resource.
      Specified by:
      getVpcEndpointRef in interface IVpcEndpointRef

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the endpoint.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the endpoint.

    • getSubnetIds

      @Stability(Stable) @NotNull public List<String> getSubnetIds()
      The ID of the subnets from which you access OpenSearch Serverless.

    • setSubnetIds

      @Stability(Stable) public void setSubnetIds(@NotNull List<String> value)
      The ID of the subnets from which you access OpenSearch Serverless.

    • getVpcId

      @Stability(Stable) @NotNull public String getVpcId()
      The ID of the VPC from which you access OpenSearch Serverless.

    • setVpcId

      @Stability(Stable) public void setVpcId(@NotNull String value)
      The ID of the VPC from which you access OpenSearch Serverless.

    • getSecurityGroupIds

      @Stability(Stable) @Nullable public List<String> getSecurityGroupIds()
      The unique identifiers of the security groups that define the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.

    • setSecurityGroupIds

      @Stability(Stable) public void setSecurityGroupIds(@Nullable List<String> value)
      The unique identifiers of the security groups that define the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.