EC2 / Client / create_traffic_mirror_target

create_traffic_mirror_target#

EC2.Client.create_traffic_mirror_target(**kwargs)#

Creates a target for your Traffic Mirror session.

A Traffic Mirror target is the destination for mirrored traffic. The Traffic Mirror source and the Traffic Mirror target (monitoring appliances) can be in the same VPC, or in different VPCs connected via VPC peering or a transit gateway.

A Traffic Mirror target can be a network interface, a Network Load Balancer, or a Gateway Load Balancer endpoint.

To use the target in a Traffic Mirror session, use CreateTrafficMirrorSession.

See also: AWS API Documentation

Request Syntax

response = client.create_traffic_mirror_target(
    NetworkInterfaceId='string',
    NetworkLoadBalancerArn='string',
    Description='string',
    TagSpecifications=[
        {
            'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    DryRun=True|False,
    ClientToken='string',
    GatewayLoadBalancerEndpointId='string'
)
Parameters:
  • NetworkInterfaceId (string) – The network interface ID that is associated with the target.

  • NetworkLoadBalancerArn (string) – The Amazon Resource Name (ARN) of the Network Load Balancer that is associated with the target.

  • Description (string) – The description of the Traffic Mirror target.

  • TagSpecifications (list) –

    The tags to assign to the Traffic Mirror target.

    • (dict) –

      The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail.

      Note

      The Valid Values lists all the resource types that can be tagged. However, the action you’re using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you’re using, you’ll get an error.

      • ResourceType (string) –

        The type of resource to tag on creation.

      • Tags (list) –

        The tags to apply to the resource.

        • (dict) –

          Describes a tag.

          • Key (string) –

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.

          • Value (string) –

            The value of the tag.

            Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

  • DryRun (boolean) – Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

  • ClientToken (string) –

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

    This field is autopopulated if not provided.

  • GatewayLoadBalancerEndpointId (string) – The ID of the Gateway Load Balancer endpoint.

Return type:

dict

Returns:

Response Syntax

{
    'TrafficMirrorTarget': {
        'TrafficMirrorTargetId': 'string',
        'NetworkInterfaceId': 'string',
        'NetworkLoadBalancerArn': 'string',
        'Type': 'network-interface'|'network-load-balancer'|'gateway-load-balancer-endpoint',
        'Description': 'string',
        'OwnerId': 'string',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'GatewayLoadBalancerEndpointId': 'string'
    },
    'ClientToken': 'string'
}

Response Structure

  • (dict) –

    • TrafficMirrorTarget (dict) –

      Information about the Traffic Mirror target.

      • TrafficMirrorTargetId (string) –

        The ID of the Traffic Mirror target.

      • NetworkInterfaceId (string) –

        The network interface ID that is attached to the target.

      • NetworkLoadBalancerArn (string) –

        The Amazon Resource Name (ARN) of the Network Load Balancer.

      • Type (string) –

        The type of Traffic Mirror target.

      • Description (string) –

        Information about the Traffic Mirror target.

      • OwnerId (string) –

        The ID of the account that owns the Traffic Mirror target.

      • Tags (list) –

        The tags assigned to the Traffic Mirror target.

        • (dict) –

          Describes a tag.

          • Key (string) –

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.

          • Value (string) –

            The value of the tag.

            Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

      • GatewayLoadBalancerEndpointId (string) –

        The ID of the Gateway Load Balancer endpoint.

    • ClientToken (string) –

      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.