1. Packages
  2. AWS Classic
  3. API Docs
  4. ec2
  5. TrafficMirrorFilter

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.45.0 published on Tuesday, Jul 16, 2024 by Pulumi

aws.ec2.TrafficMirrorFilter

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.45.0 published on Tuesday, Jul 16, 2024 by Pulumi

    Provides an Traffic mirror filter.
    Read limits and considerations for traffic mirroring

    Example Usage

    To create a basic traffic mirror filter

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const foo = new aws.ec2.TrafficMirrorFilter("foo", {
        description: "traffic mirror filter - example",
        networkServices: ["amazon-dns"],
    });
    
    import pulumi
    import pulumi_aws as aws
    
    foo = aws.ec2.TrafficMirrorFilter("foo",
        description="traffic mirror filter - example",
        network_services=["amazon-dns"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ec2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := ec2.NewTrafficMirrorFilter(ctx, "foo", &ec2.TrafficMirrorFilterArgs{
    			Description: pulumi.String("traffic mirror filter - example"),
    			NetworkServices: pulumi.StringArray{
    				pulumi.String("amazon-dns"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var foo = new Aws.Ec2.TrafficMirrorFilter("foo", new()
        {
            Description = "traffic mirror filter - example",
            NetworkServices = new[]
            {
                "amazon-dns",
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.ec2.TrafficMirrorFilter;
    import com.pulumi.aws.ec2.TrafficMirrorFilterArgs;
    import java.util.List;
    import java.util.ArrayList;
    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 foo = new TrafficMirrorFilter("foo", TrafficMirrorFilterArgs.builder()
                .description("traffic mirror filter - example")
                .networkServices("amazon-dns")
                .build());
    
        }
    }
    
    resources:
      foo:
        type: aws:ec2:TrafficMirrorFilter
        properties:
          description: traffic mirror filter - example
          networkServices:
            - amazon-dns
    

    Create TrafficMirrorFilter Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new TrafficMirrorFilter(name: string, args?: TrafficMirrorFilterArgs, opts?: CustomResourceOptions);
    @overload
    def TrafficMirrorFilter(resource_name: str,
                            args: Optional[TrafficMirrorFilterArgs] = None,
                            opts: Optional[ResourceOptions] = None)
    
    @overload
    def TrafficMirrorFilter(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            description: Optional[str] = None,
                            network_services: Optional[Sequence[str]] = None,
                            tags: Optional[Mapping[str, str]] = None)
    func NewTrafficMirrorFilter(ctx *Context, name string, args *TrafficMirrorFilterArgs, opts ...ResourceOption) (*TrafficMirrorFilter, error)
    public TrafficMirrorFilter(string name, TrafficMirrorFilterArgs? args = null, CustomResourceOptions? opts = null)
    public TrafficMirrorFilter(String name, TrafficMirrorFilterArgs args)
    public TrafficMirrorFilter(String name, TrafficMirrorFilterArgs args, CustomResourceOptions options)
    
    type: aws:ec2:TrafficMirrorFilter
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args TrafficMirrorFilterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args TrafficMirrorFilterArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args TrafficMirrorFilterArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TrafficMirrorFilterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TrafficMirrorFilterArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var trafficMirrorFilterResource = new Aws.Ec2.TrafficMirrorFilter("trafficMirrorFilterResource", new()
    {
        Description = "string",
        NetworkServices = new[]
        {
            "string",
        },
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := ec2.NewTrafficMirrorFilter(ctx, "trafficMirrorFilterResource", &ec2.TrafficMirrorFilterArgs{
    	Description: pulumi.String("string"),
    	NetworkServices: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    var trafficMirrorFilterResource = new TrafficMirrorFilter("trafficMirrorFilterResource", TrafficMirrorFilterArgs.builder()
        .description("string")
        .networkServices("string")
        .tags(Map.of("string", "string"))
        .build());
    
    traffic_mirror_filter_resource = aws.ec2.TrafficMirrorFilter("trafficMirrorFilterResource",
        description="string",
        network_services=["string"],
        tags={
            "string": "string",
        })
    
    const trafficMirrorFilterResource = new aws.ec2.TrafficMirrorFilter("trafficMirrorFilterResource", {
        description: "string",
        networkServices: ["string"],
        tags: {
            string: "string",
        },
    });
    
    type: aws:ec2:TrafficMirrorFilter
    properties:
        description: string
        networkServices:
            - string
        tags:
            string: string
    

    TrafficMirrorFilter Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The TrafficMirrorFilter resource accepts the following input properties:

    Description string
    A description of the filter.
    NetworkServices List<string>
    List of amazon network services that should be mirrored. Valid values: amazon-dns.
    Tags Dictionary<string, string>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    Description string
    A description of the filter.
    NetworkServices []string
    List of amazon network services that should be mirrored. Valid values: amazon-dns.
    Tags map[string]string
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    description String
    A description of the filter.
    networkServices List<String>
    List of amazon network services that should be mirrored. Valid values: amazon-dns.
    tags Map<String,String>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    description string
    A description of the filter.
    networkServices string[]
    List of amazon network services that should be mirrored. Valid values: amazon-dns.
    tags {[key: string]: string}
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    description str
    A description of the filter.
    network_services Sequence[str]
    List of amazon network services that should be mirrored. Valid values: amazon-dns.
    tags Mapping[str, str]
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    description String
    A description of the filter.
    networkServices List<String>
    List of amazon network services that should be mirrored. Valid values: amazon-dns.
    tags Map<String>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the TrafficMirrorFilter resource produces the following output properties:

    Arn string
    The ARN of the traffic mirror filter.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    The ARN of the traffic mirror filter.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The ARN of the traffic mirror filter.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    The ARN of the traffic mirror filter.
    id string
    The provider-assigned unique ID for this managed resource.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    The ARN of the traffic mirror filter.
    id str
    The provider-assigned unique ID for this managed resource.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The ARN of the traffic mirror filter.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Look up Existing TrafficMirrorFilter Resource

    Get an existing TrafficMirrorFilter resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: TrafficMirrorFilterState, opts?: CustomResourceOptions): TrafficMirrorFilter
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            arn: Optional[str] = None,
            description: Optional[str] = None,
            network_services: Optional[Sequence[str]] = None,
            tags: Optional[Mapping[str, str]] = None,
            tags_all: Optional[Mapping[str, str]] = None) -> TrafficMirrorFilter
    func GetTrafficMirrorFilter(ctx *Context, name string, id IDInput, state *TrafficMirrorFilterState, opts ...ResourceOption) (*TrafficMirrorFilter, error)
    public static TrafficMirrorFilter Get(string name, Input<string> id, TrafficMirrorFilterState? state, CustomResourceOptions? opts = null)
    public static TrafficMirrorFilter get(String name, Output<String> id, TrafficMirrorFilterState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arn string
    The ARN of the traffic mirror filter.
    Description string
    A description of the filter.
    NetworkServices List<string>
    List of amazon network services that should be mirrored. Valid values: amazon-dns.
    Tags Dictionary<string, string>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    The ARN of the traffic mirror filter.
    Description string
    A description of the filter.
    NetworkServices []string
    List of amazon network services that should be mirrored. Valid values: amazon-dns.
    Tags map[string]string
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The ARN of the traffic mirror filter.
    description String
    A description of the filter.
    networkServices List<String>
    List of amazon network services that should be mirrored. Valid values: amazon-dns.
    tags Map<String,String>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    The ARN of the traffic mirror filter.
    description string
    A description of the filter.
    networkServices string[]
    List of amazon network services that should be mirrored. Valid values: amazon-dns.
    tags {[key: string]: string}
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    The ARN of the traffic mirror filter.
    description str
    A description of the filter.
    network_services Sequence[str]
    List of amazon network services that should be mirrored. Valid values: amazon-dns.
    tags Mapping[str, str]
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The ARN of the traffic mirror filter.
    description String
    A description of the filter.
    networkServices List<String>
    List of amazon network services that should be mirrored. Valid values: amazon-dns.
    tags Map<String>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Import

    Using pulumi import, import traffic mirror filter using the id. For example:

    $ pulumi import aws:ec2/trafficMirrorFilter:TrafficMirrorFilter foo tmf-0fbb93ddf38198f64
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.45.0 published on Tuesday, Jul 16, 2024 by Pulumi