Endpoint class

Resource for managing an AWS EC2 Verified Access Endpoint.

Example Usage

ALB Example

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

const example = new aws.verifiedaccess.Endpoint("example", {
    loadBalancerOptions: {
        loadBalancerArn: exampleAwsLb.arn,
        port: 443,
        protocol: "https",
        subnetIds: .map(subnet => (subnet.id)),
    },
    applicationDomain: "example.com",
    attachmentType: "vpc",
    description: "example",
    domainCertificateArn: exampleAwsAcmCertificate.arn,
    endpointDomainPrefix: "example",
    endpointType: "load-balancer",
    securityGroupIds: [exampleAwsSecurityGroup.id],
    verifiedAccessGroupId: exampleAwsVerifiedaccessGroup.id,
});
import pulumi
import pulumi_aws as aws

example = aws.verifiedaccess.Endpoint("example",
    load_balancer_options={
        "load_balancer_arn": example_aws_lb["arn"],
        "port": 443,
        "protocol": "https",
        "subnet_ids": [subnet["id"] for subnet in public],
    },
    application_domain="example.com",
    attachment_type="vpc",
    description="example",
    domain_certificate_arn=example_aws_acm_certificate["arn"],
    endpoint_domain_prefix="example",
    endpoint_type="load-balancer",
    security_group_ids=[example_aws_security_group["id"]],
    verified_access_group_id=example_aws_verifiedaccess_group["id"])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.VerifiedAccess.Endpoint("example", new()
    {
        LoadBalancerOptions = new Aws.VerifiedAccess.Inputs.EndpointLoadBalancerOptionsArgs
        {
            LoadBalancerArn = exampleAwsLb.Arn,
            Port = 443,
            Protocol = "https",
            SubnetIds = .Select(subnet =>
            {
                return subnet.Id;
            }).ToList(),
        },
        ApplicationDomain = "example.com",
        AttachmentType = "vpc",
        Description = "example",
        DomainCertificateArn = exampleAwsAcmCertificate.Arn,
        EndpointDomainPrefix = "example",
        EndpointType = "load-balancer",
        SecurityGroupIds = new[]
        {
            exampleAwsSecurityGroup.Id,
        },
        VerifiedAccessGroupId = exampleAwsVerifiedaccessGroup.Id,
    });

});
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_verifiedaccess_endpoint" "example" {
  load_balancer_options = {
    load_balancer_arn = exampleAwsLb.arn
    port              = 443
    protocol          = "https"
    subnet_ids        = [for subnet in public : subnet.id]
  }
  application_domain       = "example.com"
  attachment_type          = "vpc"
  description              = "example"
  domain_certificate_arn   = exampleAwsAcmCertificate.arn
  endpoint_domain_prefix   = "example"
  endpoint_type            = "load-balancer"
  security_group_ids       = [exampleAwsSecurityGroup.id]
  verified_access_group_id = exampleAwsVerifiedaccessGroup.id
}

Network Interface Example

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

const example = new aws.verifiedaccess.Endpoint("example", {
    networkInterfaceOptions: {
        networkInterfaceId: exampleAwsNetworkInterface.id,
        port: 443,
        protocol: "https",
    },
    applicationDomain: "example.com",
    attachmentType: "vpc",
    description: "example",
    domainCertificateArn: exampleAwsAcmCertificate.arn,
    endpointDomainPrefix: "example",
    endpointType: "network-interface",
    securityGroupIds: [exampleAwsSecurityGroup.id],
    verifiedAccessGroupId: exampleAwsVerifiedaccessGroup.id,
});
import pulumi
import pulumi_aws as aws

example = aws.verifiedaccess.Endpoint("example",
    network_interface_options={
        "network_interface_id": example_aws_network_interface["id"],
        "port": 443,
        "protocol": "https",
    },
    application_domain="example.com",
    attachment_type="vpc",
    description="example",
    domain_certificate_arn=example_aws_acm_certificate["arn"],
    endpoint_domain_prefix="example",
    endpoint_type="network-interface",
    security_group_ids=[example_aws_security_group["id"]],
    verified_access_group_id=example_aws_verifiedaccess_group["id"])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.VerifiedAccess.Endpoint("example", new()
    {
        NetworkInterfaceOptions = new Aws.VerifiedAccess.Inputs.EndpointNetworkInterfaceOptionsArgs
        {
            NetworkInterfaceId = exampleAwsNetworkInterface.Id,
            Port = 443,
            Protocol = "https",
        },
        ApplicationDomain = "example.com",
        AttachmentType = "vpc",
        Description = "example",
        DomainCertificateArn = exampleAwsAcmCertificate.Arn,
        EndpointDomainPrefix = "example",
        EndpointType = "network-interface",
        SecurityGroupIds = new[]
        {
            exampleAwsSecurityGroup.Id,
        },
        VerifiedAccessGroupId = exampleAwsVerifiedaccessGroup.Id,
    });

});
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := verifiedaccess.NewEndpoint(ctx, "example", &verifiedaccess.EndpointArgs{
			NetworkInterfaceOptions: &verifiedaccess.EndpointNetworkInterfaceOptionsArgs{
				NetworkInterfaceId: pulumi.Any(exampleAwsNetworkInterface.Id),
				Port:               pulumi.Int(443),
				Protocol:           pulumi.String("https"),
			},
			ApplicationDomain:    pulumi.String("example.com"),
			AttachmentType:       pulumi.String("vpc"),
			Description:          pulumi.String("example"),
			DomainCertificateArn: pulumi.Any(exampleAwsAcmCertificate.Arn),
			EndpointDomainPrefix: pulumi.String("example"),
			EndpointType:         pulumi.String("network-interface"),
			SecurityGroupIds: pulumi.StringArray{
				exampleAwsSecurityGroup.Id,
			},
			VerifiedAccessGroupId: pulumi.Any(exampleAwsVerifiedaccessGroup.Id),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_verifiedaccess_endpoint" "example" {
  network_interface_options = {
    network_interface_id = exampleAwsNetworkInterface.id
    port                 = 443
    protocol             = "https"
  }
  application_domain       = "example.com"
  attachment_type          = "vpc"
  description              = "example"
  domain_certificate_arn   = exampleAwsAcmCertificate.arn
  endpoint_domain_prefix   = "example"
  endpoint_type            = "network-interface"
  security_group_ids       = [exampleAwsSecurityGroup.id]
  verified_access_group_id = exampleAwsVerifiedaccessGroup.id
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.verifiedaccess.Endpoint;
import com.pulumi.aws.verifiedaccess.EndpointArgs;
import com.pulumi.aws.verifiedaccess.inputs.EndpointNetworkInterfaceOptionsArgs;
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 Endpoint("example", EndpointArgs.builder()
            .networkInterfaceOptions(EndpointNetworkInterfaceOptionsArgs.builder()
                .networkInterfaceId(exampleAwsNetworkInterface.id())
                .port(443)
                .protocol("https")
                .build())
            .applicationDomain("example.com")
            .attachmentType("vpc")
            .description("example")
            .domainCertificateArn(exampleAwsAcmCertificate.arn())
            .endpointDomainPrefix("example")
            .endpointType("network-interface")
            .securityGroupIds(exampleAwsSecurityGroup.id())
            .verifiedAccessGroupId(exampleAwsVerifiedaccessGroup.id())
            .build());

    }
}
resources:
  example:
    type: aws:verifiedaccess:Endpoint
    properties:
      networkInterfaceOptions:
        networkInterfaceId: ${exampleAwsNetworkInterface.id}
        port: 443
        protocol: https
      applicationDomain: example.com
      attachmentType: vpc
      description: example
      domainCertificateArn: ${exampleAwsAcmCertificate.arn}
      endpointDomainPrefix: example
      endpointType: network-interface
      securityGroupIds:
        - ${exampleAwsSecurityGroup.id}
      verifiedAccessGroupId: ${exampleAwsVerifiedaccessGroup.id}

Cidr Example

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

const example = new aws.verifiedaccess.Endpoint("example", {
    cidrOptions: {
        portRanges: [{
            fromPort: 443,
            toPort: 443,
        }],
        cidr: test[0].cidrBlock,
        protocol: "tcp",
        subnetIds: .map(subnet => (subnet.id)),
    },
    attachmentType: "vpc",
    description: "example",
    endpointType: "cidr",
    securityGroupIds: [testAwsSecurityGroup.id],
    verifiedAccessGroupId: testAwsVerifiedaccessGroup.id,
});
import pulumi
import pulumi_aws as aws

example = aws.verifiedaccess.Endpoint("example",
    cidr_options={
        "port_ranges": [{
            "from_port": 443,
            "to_port": 443,
        }],
        "cidr": test[0]["cidrBlock"],
        "protocol": "tcp",
        "subnet_ids": [subnet["id"] for subnet in test],
    },
    attachment_type="vpc",
    description="example",
    endpoint_type="cidr",
    security_group_ids=[test_aws_security_group["id"]],
    verified_access_group_id=test_aws_verifiedaccess_group["id"])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.VerifiedAccess.Endpoint("example", new()
    {
        CidrOptions = new Aws.VerifiedAccess.Inputs.EndpointCidrOptionsArgs
        {
            PortRanges = new[]
            {
                new Aws.VerifiedAccess.Inputs.EndpointCidrOptionsPortRangeArgs
                {
                    FromPort = 443,
                    ToPort = 443,
                },
            },
            Cidr = test[0].CidrBlock,
            Protocol = "tcp",
            SubnetIds = .Select(subnet =>
            {
                return subnet.Id;
            }).ToList(),
        },
        AttachmentType = "vpc",
        Description = "example",
        EndpointType = "cidr",
        SecurityGroupIds = new[]
        {
            testAwsSecurityGroup.Id,
        },
        VerifiedAccessGroupId = testAwsVerifiedaccessGroup.Id,
    });

});
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_verifiedaccess_endpoint" "example" {
  cidr_options = {
    port_ranges = [{
      "fromPort" = 443
      "toPort"   = 443
    }]
    cidr       = test[0].cidrBlock
    protocol   = "tcp"
    subnet_ids = [for subnet in test : subnet.id]
  }
  attachment_type          = "vpc"
  description              = "example"
  endpoint_type            = "cidr"
  security_group_ids       = [testAwsSecurityGroup.id]
  verified_access_group_id = testAwsVerifiedaccessGroup.id
}

Import

Using pulumi import, import Verified Access Instances using the id. For example:

$ pulumi import aws:verifiedaccess/endpoint:Endpoint example vae-8012925589

Constructors

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

Properties

applicationDomain ↔ Output<String?>
The DNS name for users to reach your application. This parameter is required if the endpoint type is load-balancer or network-interface.
latefinal
attachmentType ↔ Output<String>
The type of attachment. Currently, only vpc is supported.
latefinal
childResources → Set<Resource>
finalinherited
cidrOptions ↔ Output<EndpointCidrOptions?>
The CIDR block details. This parameter is required if the endpoint type is cidr.
latefinal
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
description ↔ Output<String?>
A description for the Verified Access endpoint.
latefinal
deviceValidationDomain ↔ Output<String>
Returned if endpoint has a device trust provider attached.
latefinal
domainCertificateArn ↔ Output<String?>
The ARN of the public TLS/SSL certificate in AWS Certificate Manager to associate with the endpoint. The CN in the certificate must match the DNS name your end users will use to reach your application. This parameter is required if the endpoint type is load-balancer or network-interface.
latefinal
endpointDomain ↔ Output<String>
A DNS name that is generated for the endpoint.
latefinal
endpointDomainPrefix ↔ Output<String?>
A custom identifier that is prepended to the DNS name that is generated for the endpoint.
latefinal
endpointType ↔ Output<String>
The type of Verified Access endpoint to create. Currently load-balancer or network-interface are supported.
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
loadBalancerOptions ↔ Output<EndpointLoadBalancerOptions?>
The load balancer details. This parameter is required if the endpoint type is load-balancer.
latefinal
networkInterfaceOptions ↔ Output<EndpointNetworkInterfaceOptions?>
The network interface details. This parameter is required if the endpoint type is network-interface.
latefinal
policyDocument ↔ Output<String?>
The policy document that is associated with this resource.
latefinal
rdsOptions ↔ Output<EndpointRdsOptions?>
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>?>
List of the the security groups IDs to associate with the Verified Access endpoint.
latefinal
sseSpecification ↔ Output<EndpointSseSpecification>
The options in use for server side encryption.
latefinal
tags ↔ Output<Map<String, String>?>
Key-value tags for the Verified Access Endpoint. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
latefinal
tagsAll ↔ Output<Map<String, String>>
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited
verifiedAccessGroupId ↔ Output<String>
The ID of the Verified Access group to associate the endpoint with.
latefinal
verifiedAccessInstanceId ↔ Output<String>
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, {EndpointState? state, CustomResourceOptions? options}) → Endpoint
Gets an existing Endpoint resource's state with the given name and id.