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.103.1 (build bef2dea)",
date="2024-10-11T15:56:02.213Z")
@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:
-
Nested Class Summary
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
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
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 TypeMethodDescriptionThe unique identifier of the endpoint.getName()
The name of the endpoint.The unique identifiers of the security groups that define the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.The ID of the subnets from which you access OpenSearch Serverless.getVpcId()
The ID of the VPC from which you access OpenSearch Serverless.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
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
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
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
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- 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 classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrId
The unique identifier of the endpoint.For example,
vpce-050f79086ee71ac05
. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getName
The name of the endpoint. -
setName
The name of the endpoint. -
getSubnetIds
The ID of the subnets from which you access OpenSearch Serverless. -
setSubnetIds
The ID of the subnets from which you access OpenSearch Serverless. -
getVpcId
The ID of the VPC from which you access OpenSearch Serverless. -
setVpcId
The ID of the VPC from which you access OpenSearch Serverless. -
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
The unique identifiers of the security groups that define the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.
-