VpcEndpointAssociation class
Manages a firewall endpoint for an AWS Network Firewall firewall.
Use aws.networkfirewall.VpcEndpointAssociation to establish new firewall endpoints in any Availability Zone where the firewall is already being used. The first use of a firewall in an Availability Zone must be defined by aws.networkfirewall.Firewall resource and subnetMapping argument.
Example Usage
Basic Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.networkfirewall.VpcEndpointAssociation("example", {
subnetMapping: {
subnetId: exampleAwsSubnet.id,
},
firewallArn: exampleAwsNetworkfirewallFirewall.arn,
vpcId: exampleAwsVpc.id,
tags: {
Name: "example endpoint",
},
});
import pulumi
import pulumi_aws as aws
example = aws.networkfirewall.VpcEndpointAssociation("example",
subnet_mapping={
"subnet_id": example_aws_subnet["id"],
},
firewall_arn=example_aws_networkfirewall_firewall["arn"],
vpc_id=example_aws_vpc["id"],
tags={
"Name": "example endpoint",
})
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.NetworkFirewall.VpcEndpointAssociation("example", new()
{
SubnetMapping = new Aws.NetworkFirewall.Inputs.VpcEndpointAssociationSubnetMappingArgs
{
SubnetId = exampleAwsSubnet.Id,
},
FirewallArn = exampleAwsNetworkfirewallFirewall.Arn,
VpcId = exampleAwsVpc.Id,
Tags =
{
{ "Name", "example endpoint" },
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/networkfirewall"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := networkfirewall.NewVpcEndpointAssociation(ctx, "example", &networkfirewall.VpcEndpointAssociationArgs{
SubnetMapping: &networkfirewall.VpcEndpointAssociationSubnetMappingArgs{
SubnetId: pulumi.Any(exampleAwsSubnet.Id),
},
FirewallArn: pulumi.Any(exampleAwsNetworkfirewallFirewall.Arn),
VpcId: pulumi.Any(exampleAwsVpc.Id),
Tags: pulumi.StringMap{
"Name": pulumi.String("example endpoint"),
},
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_networkfirewall_vpcendpointassociation" "example" {
subnet_mapping = {
subnet_id = exampleAwsSubnet.id
}
firewall_arn = exampleAwsNetworkfirewallFirewall.arn
vpc_id = exampleAwsVpc.id
tags = {
"Name" = "example endpoint"
}
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.networkfirewall.VpcEndpointAssociation;
import com.pulumi.aws.networkfirewall.VpcEndpointAssociationArgs;
import com.pulumi.aws.networkfirewall.inputs.VpcEndpointAssociationSubnetMappingArgs;
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 VpcEndpointAssociation("example", VpcEndpointAssociationArgs.builder()
.subnetMapping(VpcEndpointAssociationSubnetMappingArgs.builder()
.subnetId(exampleAwsSubnet.id())
.build())
.firewallArn(exampleAwsNetworkfirewallFirewall.arn())
.vpcId(exampleAwsVpc.id())
.tags(Map.of("Name", "example endpoint"))
.build());
}
}
resources:
example:
type: aws:networkfirewall:VpcEndpointAssociation
properties:
subnetMapping:
subnetId: ${exampleAwsSubnet.id}
firewallArn: ${exampleAwsNetworkfirewallFirewall.arn}
vpcId: ${exampleAwsVpc.id}
tags:
Name: example endpoint
Import
Using pulumi import, import Network Firewall VPC Endpoint Association using the vpcEndpointAssociationArn. For example:
$ pulumi import aws:networkfirewall/vpcEndpointAssociation:VpcEndpointAssociation example arn:aws:network-firewall:us-west-1:123456789012:vpc-endpoint-association/example
Constructors
- VpcEndpointAssociation(String name, {VpcEndpointAssociationArgs? args, CustomResourceOptions? options})
-
Creates a new VpcEndpointAssociation.
nameThe Pulumi resource name.argsArguments used to configure this VpcEndpointAssociation. The set of arguments for VpcEndpointAssociation.optionsResource options controlling this resource's behavior. - VpcEndpointAssociation.reference(String urn)
- Creates a typed reference to an existing VpcEndpointAssociation resource.
Properties
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
description
↔ Output<
String?> -
A description of the VPC endpoint association.
latefinal
-
firewallArn
↔ Output<
String> -
The ARN that identifies the firewall.
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
-
subnetMapping
↔ Output<
VpcEndpointAssociationSubnetMapping> -
The ID for a subnet that's used in an association with a firewall. See Subnet Mapping below for details.
latefinal
-
Map of resource tags to associate with 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 -
timeouts
↔ Output<
VpcEndpointAssociationTimeouts?> -
latefinal
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
-
vpcEndpointAssociationArn
↔ Output<
String> -
ARN of the VPC Endpoint Association.
latefinal
-
vpcEndpointAssociationId
↔ Output<
String> -
The unique identifier of the VPC endpoint association.
latefinal
-
vpcEndpointAssociationStatuses
↔ Output<
List< VpcEndpointAssociationVpcEndpointAssociationStatus> > -
Nested list of information about the current status of the VPC Endpoint Association.
latefinal
-
vpcId
↔ Output<
String> -
The unique identifier of the VPC for the endpoint association.
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, {VpcEndpointAssociationState? state, CustomResourceOptions? options}) → VpcEndpointAssociation -
Gets an existing VpcEndpointAssociation resource's state with the given
nameandid.