VpcEndpoint class

Manages an AWS Elasticsearch VPC Endpoint. Creates an Amazon elasticsearch Service-managed VPC endpoint.

Example Usage

Basic Usage

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

const foo = new aws.elasticsearch.VpcEndpoint("foo", {
    vpcOptions: {
        securityGroupIds: [
            test.id,
            test2.id,
        ],
        subnetIds: [
            testAwsSubnet.id,
            test2AwsSubnet.id,
        ],
    },
    domainArn: domain1.arn,
});
import pulumi
import pulumi_aws as aws

foo = aws.elasticsearch.VpcEndpoint("foo",
    vpc_options={
        "security_group_ids": [
            test["id"],
            test2["id"],
        ],
        "subnet_ids": [
            test_aws_subnet["id"],
            test2_aws_subnet["id"],
        ],
    },
    domain_arn=domain1["arn"])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var foo = new Aws.ElasticSearch.VpcEndpoint("foo", new()
    {
        VpcOptions = new Aws.ElasticSearch.Inputs.VpcEndpointVpcOptionsArgs
        {
            SecurityGroupIds = new[]
            {
                test.Id,
                test2.Id,
            },
            SubnetIds = new[]
            {
                testAwsSubnet.Id,
                test2AwsSubnet.Id,
            },
        },
        DomainArn = domain1.Arn,
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/elasticsearch"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := elasticsearch.NewVpcEndpoint(ctx, "foo", &elasticsearch.VpcEndpointArgs{
			VpcOptions: &elasticsearch.VpcEndpointVpcOptionsArgs{
				SecurityGroupIds: pulumi.StringArray{
					test.Id,
					test2.Id,
				},
				SubnetIds: pulumi.StringArray{
					testAwsSubnet.Id,
					test2AwsSubnet.Id,
				},
			},
			DomainArn: pulumi.Any(domain1.Arn),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_elasticsearch_vpcendpoint" "foo" {
  vpc_options = {
    security_group_ids = [test.id, test2.id]
    subnet_ids         = [testAwsSubnet.id, test2AwsSubnet.id]
  }
  domain_arn = domain1.arn
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.elasticsearch.VpcEndpoint;
import com.pulumi.aws.elasticsearch.VpcEndpointArgs;
import com.pulumi.aws.elasticsearch.inputs.VpcEndpointVpcOptionsArgs;
import java.util.ArrayList;
import java.util.Arrays;
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) {
        var foo = new VpcEndpoint("foo", VpcEndpointArgs.builder()
            .vpcOptions(VpcEndpointVpcOptionsArgs.builder()
                .securityGroupIds(
                    test.id(),
                    test2.id())
                .subnetIds(
                    testAwsSubnet.id(),
                    test2AwsSubnet.id())
                .build())
            .domainArn(domain1.arn())
            .build());

    }
}
resources:
  foo:
    type: aws:elasticsearch:VpcEndpoint
    properties:
      vpcOptions:
        securityGroupIds:
          - ${test.id}
          - ${test2.id}
        subnetIds:
          - ${testAwsSubnet.id}
          - ${test2AwsSubnet.id}
      domainArn: ${domain1.arn}

Import

Using pulumi import, import elasticsearch VPC endpoints using the id. For example:

$ pulumi import aws:elasticsearch/vpcEndpoint:VpcEndpoint example endpoint-id

Constructors

VpcEndpoint(String name, {VpcEndpointArgs? args, CustomResourceOptions? options})
Creates a new VpcEndpoint. name The Pulumi resource name. args Arguments used to configure this VpcEndpoint. The set of arguments for VpcEndpoint. options Resource options controlling this resource's behavior.
VpcEndpoint.reference(String urn)
Creates a typed reference to an existing VpcEndpoint resource.

Properties

childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
domainArn ↔ Output<String>
ARN of the domain to create the endpoint for
latefinal
endpoint ↔ Output<String>
The connection endpoint ID for connecting to the domain.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited
vpcOptions ↔ Output<VpcEndpointVpcOptions>
Options to specify the subnets and security groups for the endpoint.
latefinal

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {VpcEndpointState? state, CustomResourceOptions? options}) → VpcEndpoint
Gets an existing VpcEndpoint resource's state with the given name and id.