VpcEndpointService class
Provides a VPC Endpoint Service resource. Service consumers can create an Interface VPC Endpoint to connect to the service.
> NOTE on VPC Endpoint Services and VPC Endpoint Service Allowed Principals: This provider provides
both a standalone VPC Endpoint Service Allowed Principal resource
and a VPC Endpoint Service resource with an allowedPrincipals attribute. Do not use the same principal ARN in both
a VPC Endpoint Service resource and a VPC Endpoint Service Allowed Principal resource. Doing so will cause a conflict
and will overwrite the association.
Example Usage
Network Load Balancers
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.ec2.VpcEndpointService("example", {
acceptanceRequired: false,
networkLoadBalancerArns: [exampleAwsLb.arn],
});
import pulumi
import pulumi_aws as aws
example = aws.ec2.VpcEndpointService("example",
acceptance_required=False,
network_load_balancer_arns=[example_aws_lb["arn"]])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Ec2.VpcEndpointService("example", new()
{
AcceptanceRequired = false,
NetworkLoadBalancerArns = new[]
{
exampleAwsLb.Arn,
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/ec2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := ec2.NewVpcEndpointService(ctx, "example", &ec2.VpcEndpointServiceArgs{
AcceptanceRequired: pulumi.Bool(false),
NetworkLoadBalancerArns: pulumi.StringArray{
exampleAwsLb.Arn,
},
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_ec2_vpcendpointservice" "example" {
acceptance_required = false
network_load_balancer_arns = [exampleAwsLb.arn]
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ec2.VpcEndpointService;
import com.pulumi.aws.ec2.VpcEndpointServiceArgs;
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 VpcEndpointService("example", VpcEndpointServiceArgs.builder()
.acceptanceRequired(false)
.networkLoadBalancerArns(exampleAwsLb.arn())
.build());
}
}
resources:
example:
type: aws:ec2:VpcEndpointService
properties:
acceptanceRequired: false
networkLoadBalancerArns:
- ${exampleAwsLb.arn}
Gateway Load Balancers
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.ec2.VpcEndpointService("example", {
acceptanceRequired: false,
gatewayLoadBalancerArns: [exampleAwsLb.arn],
});
import pulumi
import pulumi_aws as aws
example = aws.ec2.VpcEndpointService("example",
acceptance_required=False,
gateway_load_balancer_arns=[example_aws_lb["arn"]])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Ec2.VpcEndpointService("example", new()
{
AcceptanceRequired = false,
GatewayLoadBalancerArns = new[]
{
exampleAwsLb.Arn,
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/ec2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := ec2.NewVpcEndpointService(ctx, "example", &ec2.VpcEndpointServiceArgs{
AcceptanceRequired: pulumi.Bool(false),
GatewayLoadBalancerArns: pulumi.StringArray{
exampleAwsLb.Arn,
},
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_ec2_vpcendpointservice" "example" {
acceptance_required = false
gateway_load_balancer_arns = [exampleAwsLb.arn]
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ec2.VpcEndpointService;
import com.pulumi.aws.ec2.VpcEndpointServiceArgs;
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 VpcEndpointService("example", VpcEndpointServiceArgs.builder()
.acceptanceRequired(false)
.gatewayLoadBalancerArns(exampleAwsLb.arn())
.build());
}
}
resources:
example:
type: aws:ec2:VpcEndpointService
properties:
acceptanceRequired: false
gatewayLoadBalancerArns:
- ${exampleAwsLb.arn}
Import
Using pulumi import, import VPC Endpoint Services using the VPC endpoint service id. For example:
$ pulumi import aws:ec2/vpcEndpointService:VpcEndpointService foo vpce-svc-0f97a19d3fa8220bc
Constructors
- VpcEndpointService(String name, {VpcEndpointServiceArgs? args, CustomResourceOptions? options})
-
Creates a new VpcEndpointService.
nameThe Pulumi resource name.argsArguments used to configure this VpcEndpointService. The set of arguments for VpcEndpointService.optionsResource options controlling this resource's behavior. - VpcEndpointService.reference(String urn)
- Creates a typed reference to an existing VpcEndpointService resource.
Properties
-
acceptanceRequired
↔ Output<
bool> -
Whether or not VPC endpoint connection requests to the service must be accepted by the service owner -
trueorfalse.latefinal -
allowedPrincipals
↔ Output<
List< String> > -
The ARNs of one or more principals allowed to discover the endpoint service.
latefinal
-
arn
↔ Output<
String> -
ARN of the VPC endpoint service.
latefinal
-
availabilityZones
↔ Output<
List< String> > -
A set of Availability Zones in which the service is available.
latefinal
-
baseEndpointDnsNames
↔ Output<
List< String> > -
A set of DNS names for the service.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
gatewayLoadBalancerArns
↔ Output<
List< String> ?> -
ARNs of one or more Gateway Load Balancers for the endpoint service.
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
-
managesVpcEndpoints
↔ Output<
bool> -
Whether or not the service manages its VPC endpoints -
trueorfalse.latefinal -
networkLoadBalancerArns
↔ Output<
List< String> ?> -
ARNs of one or more Network Load Balancers for the endpoint service.
latefinal
-
privateDnsName
↔ Output<
String> -
The private DNS name for the service.
latefinal
-
privateDnsNameConfigurations
↔ Output<
List< VpcEndpointServicePrivateDnsNameConfiguration> > -
List of objects containing information about the endpoint service private DNS name configuration.
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
-
serviceName
↔ Output<
String> -
The service name.
latefinal
-
serviceType
↔ Output<
String> -
The service type,
GatewayorInterface.latefinal -
state
↔ Output<
String> -
Verification state of the VPC endpoint service. Consumers of the endpoint service can use the private name only when the state is
verified.latefinal -
supportedIpAddressTypes
↔ Output<
List< String> > -
The supported IP address types. The possible values are
ipv4andipv6.latefinal -
supportedRegions
↔ Output<
List< String> > -
The set of regions from which service consumers can access the service.
latefinal
-
A map of tags to assign to the resource. .If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.latefinal -
A map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.latefinal -
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
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, {VpcEndpointServiceState? state, CustomResourceOptions? options}) → VpcEndpointService -
Gets an existing VpcEndpointService resource's state with the given
nameandid.