NetworkAcl class

Provides an network ACL resource. You might set up network ACLs with rules similar to your security groups in order to add an additional layer of security to your VPC.

> NOTE on Network ACLs and Network ACL Rules: This provider currently provides both a standalone Network ACL Rule resource and a Network ACL resource with rules defined in-line. At this time you cannot use a Network ACL with in-line rules in conjunction with any Network ACL Rule resources. Doing so will cause a conflict of rule settings and will overwrite rules.

> NOTE on Network ACLs and Network ACL Associations: the provider provides both a standalone network ACL association resource and a network ACL resource with a subnetIds attribute. Do not use the same subnet ID in both a network ACL resource and a network ACL association resource. Doing so will cause a conflict of associations and will overwrite the association.

Example Usage

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

const main = new aws.ec2.NetworkAcl("main", {
    egress: [{
        protocol: "tcp",
        ruleNo: 200,
        action: "allow",
        cidrBlock: "10.3.0.0/18",
        fromPort: 443,
        toPort: 443,
    }],
    ingress: [{
        protocol: "tcp",
        ruleNo: 100,
        action: "allow",
        cidrBlock: "10.3.0.0/18",
        fromPort: 80,
        toPort: 80,
    }],
    vpcId: mainAwsVpc.id,
    tags: {
        Name: "main",
    },
});
import pulumi
import pulumi_aws as aws

main = aws.ec2.NetworkAcl("main",
    egress=[{
        "protocol": "tcp",
        "rule_no": 200,
        "action": "allow",
        "cidr_block": "10.3.0.0/18",
        "from_port": 443,
        "to_port": 443,
    }],
    ingress=[{
        "protocol": "tcp",
        "rule_no": 100,
        "action": "allow",
        "cidr_block": "10.3.0.0/18",
        "from_port": 80,
        "to_port": 80,
    }],
    vpc_id=main_aws_vpc["id"],
    tags={
        "Name": "main",
    })
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var main = new Aws.Ec2.NetworkAcl("main", new()
    {
        Egress = new[]
        {
            new Aws.Ec2.Inputs.NetworkAclEgressArgs
            {
                Protocol = "tcp",
                RuleNo = 200,
                Action = "allow",
                CidrBlock = "10.3.0.0/18",
                FromPort = 443,
                ToPort = 443,
            },
        },
        Ingress = new[]
        {
            new Aws.Ec2.Inputs.NetworkAclIngressArgs
            {
                Protocol = "tcp",
                RuleNo = 100,
                Action = "allow",
                CidrBlock = "10.3.0.0/18",
                FromPort = 80,
                ToPort = 80,
            },
        },
        VpcId = mainAwsVpc.Id,
        Tags =
        {
            { "Name", "main" },
        },
    });

});
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.NewNetworkAcl(ctx, "main", &ec2.NetworkAclArgs{
			Egress: ec2.NetworkAclEgressArray{
				&ec2.NetworkAclEgressArgs{
					Protocol:  pulumi.String("tcp"),
					RuleNo:    pulumi.Int(200),
					Action:    pulumi.String("allow"),
					CidrBlock: pulumi.String("10.3.0.0/18"),
					FromPort:  pulumi.Int(443),
					ToPort:    pulumi.Int(443),
				},
			},
			Ingress: ec2.NetworkAclIngressArray{
				&ec2.NetworkAclIngressArgs{
					Protocol:  pulumi.String("tcp"),
					RuleNo:    pulumi.Int(100),
					Action:    pulumi.String("allow"),
					CidrBlock: pulumi.String("10.3.0.0/18"),
					FromPort:  pulumi.Int(80),
					ToPort:    pulumi.Int(80),
				},
			},
			VpcId: pulumi.Any(mainAwsVpc.Id),
			Tags: pulumi.StringMap{
				"Name": pulumi.String("main"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_ec2_networkacl" "main" {
  egress {
    protocol   = "tcp"
    rule_no    = 200
    action     = "allow"
    cidr_block = "10.3.0.0/18"
    from_port  = 443
    to_port    = 443
  }
  ingress {
    protocol   = "tcp"
    rule_no    = 100
    action     = "allow"
    cidr_block = "10.3.0.0/18"
    from_port  = 80
    to_port    = 80
  }
  vpc_id = mainAwsVpc.id
  tags = {
    "Name" = "main"
  }
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ec2.NetworkAcl;
import com.pulumi.aws.ec2.NetworkAclArgs;
import com.pulumi.aws.ec2.inputs.NetworkAclEgressArgs;
import com.pulumi.aws.ec2.inputs.NetworkAclIngressArgs;
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 main = new NetworkAcl("main", NetworkAclArgs.builder()
            .egress(NetworkAclEgressArgs.builder()
                .protocol("tcp")
                .ruleNo(200)
                .action("allow")
                .cidrBlock("10.3.0.0/18")
                .fromPort(443)
                .toPort(443)
                .build())
            .ingress(NetworkAclIngressArgs.builder()
                .protocol("tcp")
                .ruleNo(100)
                .action("allow")
                .cidrBlock("10.3.0.0/18")
                .fromPort(80)
                .toPort(80)
                .build())
            .vpcId(mainAwsVpc.id())
            .tags(Map.of("Name", "main"))
            .build());

    }
}
resources:
  main:
    type: aws:ec2:NetworkAcl
    properties:
      egress:
        - protocol: tcp
          ruleNo: 200
          action: allow
          cidrBlock: 10.3.0.0/18
          fromPort: 443
          toPort: 443
      ingress:
        - protocol: tcp
          ruleNo: 100
          action: allow
          cidrBlock: 10.3.0.0/18
          fromPort: 80
          toPort: 80
      vpcId: ${mainAwsVpc.id}
      tags:
        Name: main

Import

Using pulumi import, import Network ACLs using the id. For example:

$ pulumi import aws:ec2/networkAcl:NetworkAcl main acl-7aaabd18

Constructors

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

Properties

arn ↔ Output<String>
The ARN of the network ACL
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
egress ↔ Output<List<NetworkAclEgress>>
Specifies an egress rule. Parameters defined below.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
ingress ↔ Output<List<NetworkAclIngress>>
Specifies an ingress rule. Parameters defined below.
latefinal
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
ownerId ↔ Output<String>
The ID of the AWS account that owns the network ACL.
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
subnetIds ↔ Output<List<String>>
A list of Subnet IDs to apply the ACL to
latefinal
tags ↔ Output<Map<String, String>?>
A map of tags to assign to the resource. 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>>
A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited
vpcId ↔ Output<String>
The ID of the associated VPC.
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, {NetworkAclState? state, CustomResourceOptions? options}) → NetworkAcl
Gets an existing NetworkAcl resource's state with the given name and id.