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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:10.253Z")
@Stability(Stable)
public class CfnVpcEndpoint
extends CfnResource
implements IInspectable

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:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnVpcEndpoint.Builder	A fluent builder for CfnVpcEndpoint.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnVpcEndpoint(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnVpcEndpoint(software.amazon.jsii.JsiiObjectRef objRef)
	CfnVpcEndpoint(software.constructs.Construct scope, String id, CfnVpcEndpointProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrId()	The unique identifier of the endpoint.
protected Map<String,Object>	getCfnProperties()
String	getName()	The name of the endpoint.
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.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setName(String value)	The name of the endpoint.
void	setSecurityGroupIds(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.
void	setSubnetIds(List<String> value)	The ID of the subnets from which you access OpenSearch Serverless.
void	setVpcId(String value)	The ID of the VPC from which you access OpenSearch Serverless.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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)

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.

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

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.