Package software.amazon.awscdk.services.opensearchserverless

Interface CfnVpcEndpointProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnVpcEndpointProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.109.0 (build c221850)",
           date="2025-03-14T03:25:01.758Z")
@Stability(Stable)
public interface CfnVpcEndpointProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnVpcEndpoint.

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.*;
 CfnVpcEndpointProps cfnVpcEndpointProps = CfnVpcEndpointProps.builder()
         .name("name")
         .subnetIds(List.of("subnetIds"))
         .vpcId("vpcId")
         // the properties below are optional
         .securityGroupIds(List.of("securityGroupIds"))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-vpcendpoint.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnVpcEndpointProps.Builder	builder()
String	getName()	The name of the endpoint.
default 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.
List<String>	getSubnetIds()	The ID of the subnets from which you access OpenSearch Serverless.
String	getVpcId()	The ID of the VPC from which you access OpenSearch Serverless.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

The name of the endpoint.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-vpcendpoint.html#cfn-opensearchserverless-vpcendpoint-name

getSubnetIds

@Stability(Stable)
@NotNull
List<String> getSubnetIds()

The ID of the subnets from which you access OpenSearch Serverless.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-vpcendpoint.html#cfn-opensearchserverless-vpcendpoint-subnetids

getVpcId

@Stability(Stable)
@NotNull
String getVpcId()

The ID of the VPC from which you access OpenSearch Serverless.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-vpcendpoint.html#cfn-opensearchserverless-vpcendpoint-vpcid

getSecurityGroupIds

@Stability(Stable)
@Nullable
default 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-vpcendpoint.html#cfn-opensearchserverless-vpcendpoint-securitygroupids

builder

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

Returns:

a CfnVpcEndpointProps.Builder of CfnVpcEndpointProps