Package software.amazon.awscdk.services.osis

Interface CfnPipeline.VpcEndpointProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPipeline.VpcEndpointProperty.Jsii$Proxy

Enclosing class:

CfnPipeline

@Stability(Stable)
public static interface CfnPipeline.VpcEndpointProperty
extends software.amazon.jsii.JsiiSerializable

An OpenSearch Ingestion-managed VPC endpoint that will access one or more pipelines.

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.osis.*;
 VpcEndpointProperty vpcEndpointProperty = VpcEndpointProperty.builder()
         .vpcEndpointId("vpcEndpointId")
         .vpcId("vpcId")
         .vpcOptions(VpcOptionsProperty.builder()
                 .subnetIds(List.of("subnetIds"))
                 // the properties below are optional
                 .securityGroupIds(List.of("securityGroupIds"))
                 .vpcAttachmentOptions(VpcAttachmentOptionsProperty.builder()
                         .attachToVpc(false)
                         .cidrBlock("cidrBlock")
                         .build())
                 .vpcEndpointManagement("vpcEndpointManagement")
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-osis-pipeline-vpcendpoint.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnPipeline.VpcEndpointProperty.Builder	builder()
default String	getVpcEndpointId()	The unique identifier of the endpoint.
default String	getVpcId()	The ID for your VPC.
default Object	getVpcOptions()	Information about the VPC, including associated subnets and security groups.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getVpcEndpointId

@Stability(Stable)
@Nullable
default String getVpcEndpointId()

The unique identifier of the endpoint.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-osis-pipeline-vpcendpoint.html#cfn-osis-pipeline-vpcendpoint-vpcendpointid

getVpcId

@Stability(Stable)
@Nullable
default String getVpcId()

The ID for your VPC.

AWS PrivateLink generates this value when you create a VPC.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-osis-pipeline-vpcendpoint.html#cfn-osis-pipeline-vpcendpoint-vpcid

getVpcOptions

@Stability(Stable)
@Nullable
default Object getVpcOptions()

Information about the VPC, including associated subnets and security groups.

Returns union: either IResolvable or CfnPipeline.VpcOptionsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-osis-pipeline-vpcendpoint.html#cfn-osis-pipeline-vpcendpoint-vpcoptions

builder

@Stability(Stable)
static CfnPipeline.VpcEndpointProperty.Builder builder()

Returns:

a CfnPipeline.VpcEndpointProperty.Builder of CfnPipeline.VpcEndpointProperty