ServerlessVpcEndpoint class
Resource for managing an AWS OpenSearchServerless VPC Endpoint.
Example Usage
Basic Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.opensearch.ServerlessVpcEndpoint("example", {
name: "myendpoint",
subnetIds: [exampleAwsSubnet.id],
vpcId: exampleAwsVpc.id,
});
import pulumi
import pulumi_aws as aws
example = aws.opensearch.ServerlessVpcEndpoint("example",
name="myendpoint",
subnet_ids=[example_aws_subnet["id"]],
vpc_id=example_aws_vpc["id"])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.OpenSearch.ServerlessVpcEndpoint("example", new()
{
Name = "myendpoint",
SubnetIds = new[]
{
exampleAwsSubnet.Id,
},
VpcId = exampleAwsVpc.Id,
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/opensearch"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := opensearch.NewServerlessVpcEndpoint(ctx, "example", &opensearch.ServerlessVpcEndpointArgs{
Name: pulumi.String("myendpoint"),
SubnetIds: pulumi.StringArray{
exampleAwsSubnet.Id,
},
VpcId: pulumi.Any(exampleAwsVpc.Id),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_opensearch_serverlessvpcendpoint" "example" {
name = "myendpoint"
subnet_ids = [exampleAwsSubnet.id]
vpc_id = exampleAwsVpc.id
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.opensearch.ServerlessVpcEndpoint;
import com.pulumi.aws.opensearch.ServerlessVpcEndpointArgs;
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 example = new ServerlessVpcEndpoint("example", ServerlessVpcEndpointArgs.builder()
.name("myendpoint")
.subnetIds(exampleAwsSubnet.id())
.vpcId(exampleAwsVpc.id())
.build());
}
}
resources:
example:
type: aws:opensearch:ServerlessVpcEndpoint
properties:
name: myendpoint
subnetIds:
- ${exampleAwsSubnet.id}
vpcId: ${exampleAwsVpc.id}
Import
Identity Schema
Required
id(String) Unique identifier for the VPC endpoint.
Optional
accountId(String) AWS Account where this resource is managed.region(String) Region where this resource is managed.
Using pulumi import, import OpenSearchServerless Vpc Endpoint using the id. For example:
$ pulumi import aws:opensearch/serverlessVpcEndpoint:ServerlessVpcEndpoint example vpce-8012925589
Constructors
- ServerlessVpcEndpoint(String name, {ServerlessVpcEndpointArgs? args, CustomResourceOptions? options})
-
Creates a new ServerlessVpcEndpoint.
nameThe Pulumi resource name.argsArguments used to configure this ServerlessVpcEndpoint. The set of arguments for ServerlessVpcEndpoint.optionsResource options controlling this resource's behavior. - ServerlessVpcEndpoint.reference(String urn)
- Creates a typed reference to an existing ServerlessVpcEndpoint resource.
Properties
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
- 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
-
name
↔ Output<
String> -
Name of the interface endpoint.
latefinal
-
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
-
securityGroupIds
↔ Output<
List< String> > -
One or more security groups that define the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint. Up to 5 security groups can be provided.
latefinal
-
subnetIds
↔ Output<
List< String> > -
One or more subnet IDs from which you'll access OpenSearch Serverless. Up to 6 subnets can be provided.
latefinal
-
timeouts
↔ Output<
ServerlessVpcEndpointTimeouts?> -
latefinal
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
-
vpcId
↔ Output<
String> -
ID of the VPC from which you'll access OpenSearch Serverless.
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, {ServerlessVpcEndpointState? state, CustomResourceOptions? options}) → ServerlessVpcEndpoint -
Gets an existing ServerlessVpcEndpoint resource's state with the given
nameandid.