software.amazon.awscdk.services.opensearchserverless

Class CfnVpcEndpoint

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.opensearchserverless.CfnVpcEndpoint

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:39.019Z")
public class CfnVpcEndpoint
extends CfnResource
implements IInspectable

A CloudFormation `AWS::OpenSearchServerless::VpcEndpoint`.

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();
 

Nested Class Summary

Nested Classes

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

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnVpcEndpoint(Construct scope, java.lang.String id, CfnVpcEndpointProps props) Create a new `AWS::OpenSearchServerless::VpcEndpoint`.
protected	CfnVpcEndpoint(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnVpcEndpoint(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttrId() The unique identifier of the endpoint.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getName() The name of the endpoint.
java.util.List<java.lang.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.
java.util.List<java.lang.String>	getSubnetIds() The ID of the subnets from which you access OpenSearch Serverless.
java.lang.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 java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setName(java.lang.String value) The name of the endpoint.
void	setSecurityGroupIds(java.util.List<java.lang.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(java.util.List<java.lang.String> value) The ID of the subnets from which you access OpenSearch Serverless.
void	setVpcId(java.lang.String value) The ID of the VPC from which you access OpenSearch Serverless.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnVpcEndpoint

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

CfnVpcEndpoint

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

CfnVpcEndpoint

public CfnVpcEndpoint(Construct scope,
                      java.lang.String id,
                      CfnVpcEndpointProps props)

Create a new `AWS::OpenSearchServerless::VpcEndpoint`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrId

public java.lang.String getAttrId()

The unique identifier of the endpoint.

For example, vpce-050f79086ee71ac05 .

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getName

public java.lang.String getName()

The name of the endpoint.

setName

public void setName(java.lang.String value)

The name of the endpoint.

getSubnetIds

public java.util.List<java.lang.String> getSubnetIds()

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

setSubnetIds

public void setSubnetIds(java.util.List<java.lang.String> value)

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

getVpcId

public java.lang.String getVpcId()

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

setVpcId

public void setVpcId(java.lang.String value)

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

getSecurityGroupIds

public java.util.List<java.lang.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

public void setSecurityGroupIds(java.util.List<java.lang.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.