1. Packages
  2. AWS
  3. API Docs
  4. opensearch
  5. getServerlessVpcEndpoint
AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi

aws.opensearch.getServerlessVpcEndpoint

Explore with Pulumi AI

AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi

Data source for managing an AWS OpenSearch Serverless VPC Endpoint.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = aws.opensearch.getServerlessVpcEndpoint({
    vpcEndpointId: "vpce-829a4487959e2a839",
});
Copy
import pulumi
import pulumi_aws as aws

example = aws.opensearch.get_serverless_vpc_endpoint(vpc_endpoint_id="vpce-829a4487959e2a839")
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/opensearch"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := opensearch.LookupServerlessVpcEndpoint(ctx, &opensearch.LookupServerlessVpcEndpointArgs{
			VpcEndpointId: "vpce-829a4487959e2a839",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = Aws.OpenSearch.GetServerlessVpcEndpoint.Invoke(new()
    {
        VpcEndpointId = "vpce-829a4487959e2a839",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.opensearch.OpensearchFunctions;
import com.pulumi.aws.opensearch.inputs.GetServerlessVpcEndpointArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = OpensearchFunctions.getServerlessVpcEndpoint(GetServerlessVpcEndpointArgs.builder()
            .vpcEndpointId("vpce-829a4487959e2a839")
            .build());

    }
}
Copy
variables:
  example:
    fn::invoke:
      function: aws:opensearch:getServerlessVpcEndpoint
      arguments:
        vpcEndpointId: vpce-829a4487959e2a839
Copy

Using getServerlessVpcEndpoint

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getServerlessVpcEndpoint(args: GetServerlessVpcEndpointArgs, opts?: InvokeOptions): Promise<GetServerlessVpcEndpointResult>
function getServerlessVpcEndpointOutput(args: GetServerlessVpcEndpointOutputArgs, opts?: InvokeOptions): Output<GetServerlessVpcEndpointResult>
Copy
def get_serverless_vpc_endpoint(vpc_endpoint_id: Optional[str] = None,
                                opts: Optional[InvokeOptions] = None) -> GetServerlessVpcEndpointResult
def get_serverless_vpc_endpoint_output(vpc_endpoint_id: Optional[pulumi.Input[str]] = None,
                                opts: Optional[InvokeOptions] = None) -> Output[GetServerlessVpcEndpointResult]
Copy
func LookupServerlessVpcEndpoint(ctx *Context, args *LookupServerlessVpcEndpointArgs, opts ...InvokeOption) (*LookupServerlessVpcEndpointResult, error)
func LookupServerlessVpcEndpointOutput(ctx *Context, args *LookupServerlessVpcEndpointOutputArgs, opts ...InvokeOption) LookupServerlessVpcEndpointResultOutput
Copy

> Note: This function is named LookupServerlessVpcEndpoint in the Go SDK.

public static class GetServerlessVpcEndpoint 
{
    public static Task<GetServerlessVpcEndpointResult> InvokeAsync(GetServerlessVpcEndpointArgs args, InvokeOptions? opts = null)
    public static Output<GetServerlessVpcEndpointResult> Invoke(GetServerlessVpcEndpointInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetServerlessVpcEndpointResult> getServerlessVpcEndpoint(GetServerlessVpcEndpointArgs args, InvokeOptions options)
public static Output<GetServerlessVpcEndpointResult> getServerlessVpcEndpoint(GetServerlessVpcEndpointArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws:opensearch/getServerlessVpcEndpoint:getServerlessVpcEndpoint
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

VpcEndpointId This property is required. string
The unique identifier of the endpoint.
VpcEndpointId This property is required. string
The unique identifier of the endpoint.
vpcEndpointId This property is required. String
The unique identifier of the endpoint.
vpcEndpointId This property is required. string
The unique identifier of the endpoint.
vpc_endpoint_id This property is required. str
The unique identifier of the endpoint.
vpcEndpointId This property is required. String
The unique identifier of the endpoint.

getServerlessVpcEndpoint Result

The following output properties are available:

CreatedDate string
The date the endpoint was created.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the endpoint.
SecurityGroupIds List<string>
The IDs of the security groups that define the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.
SubnetIds List<string>
The IDs of the subnets from which you access OpenSearch Serverless.
VpcEndpointId string
VpcId string
The ID of the VPC from which you access OpenSearch Serverless.
CreatedDate string
The date the endpoint was created.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the endpoint.
SecurityGroupIds []string
The IDs of the security groups that define the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.
SubnetIds []string
The IDs of the subnets from which you access OpenSearch Serverless.
VpcEndpointId string
VpcId string
The ID of the VPC from which you access OpenSearch Serverless.
createdDate String
The date the endpoint was created.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the endpoint.
securityGroupIds List<String>
The IDs of the security groups that define the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.
subnetIds List<String>
The IDs of the subnets from which you access OpenSearch Serverless.
vpcEndpointId String
vpcId String
The ID of the VPC from which you access OpenSearch Serverless.
createdDate string
The date the endpoint was created.
id string
The provider-assigned unique ID for this managed resource.
name string
The name of the endpoint.
securityGroupIds string[]
The IDs of the security groups that define the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.
subnetIds string[]
The IDs of the subnets from which you access OpenSearch Serverless.
vpcEndpointId string
vpcId string
The ID of the VPC from which you access OpenSearch Serverless.
created_date str
The date the endpoint was created.
id str
The provider-assigned unique ID for this managed resource.
name str
The name of the endpoint.
security_group_ids Sequence[str]
The IDs of the security groups that define the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.
subnet_ids Sequence[str]
The IDs of the subnets from which you access OpenSearch Serverless.
vpc_endpoint_id str
vpc_id str
The ID of the VPC from which you access OpenSearch Serverless.
createdDate String
The date the endpoint was created.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the endpoint.
securityGroupIds List<String>
The IDs of the security groups that define the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.
subnetIds List<String>
The IDs of the subnets from which you access OpenSearch Serverless.
vpcEndpointId String
vpcId String
The ID of the VPC from which you access OpenSearch Serverless.

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.
AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi