Package software.amazon.awscdk.services.ec2

Class CfnTrafficMirrorTarget

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.ec2.CfnTrafficMirrorTarget
All Implemented Interfaces:
IInspectable, ITrafficMirrorTargetRef, IEnvironmentAware, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-11-13T16:10:03.229Z") @Stability(Stable) public class CfnTrafficMirrorTarget extends CfnResource implements IInspectable, ITrafficMirrorTargetRef, ITaggable
Specifies 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 AWS::EC2::TrafficMirrorSession .

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ec2.*;
 CfnTrafficMirrorTarget cfnTrafficMirrorTarget = CfnTrafficMirrorTarget.Builder.create(this, "MyCfnTrafficMirrorTarget")
         .description("description")
         .gatewayLoadBalancerEndpointId("gatewayLoadBalancerEndpointId")
         .networkInterfaceId("networkInterfaceId")
         .networkLoadBalancerArn("networkLoadBalancerArn")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnTrafficMirrorTarget

      protected CfnTrafficMirrorTarget(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnTrafficMirrorTarget

      protected CfnTrafficMirrorTarget(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnTrafficMirrorTarget

      @Stability(Stable) public CfnTrafficMirrorTarget(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnTrafficMirrorTargetProps props)
      Create a new AWS::EC2::TrafficMirrorTarget.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties.

    • CfnTrafficMirrorTarget

      @Stability(Stable) public CfnTrafficMirrorTarget(@NotNull software.constructs.Construct scope, @NotNull String id)
      Create a new AWS::EC2::TrafficMirrorTarget.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.

  • Method Details

    • fromTrafficMirrorTargetId

      @Stability(Stable) @NotNull public static ITrafficMirrorTargetRef fromTrafficMirrorTargetId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String trafficMirrorTargetId)
      Creates a new ITrafficMirrorTargetRef from a trafficMirrorTargetId.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      trafficMirrorTargetId - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getTrafficMirrorTargetRef

      @Stability(Stable) @NotNull public TrafficMirrorTargetReference getTrafficMirrorTargetRef()
      A reference to a TrafficMirrorTarget resource.
      Specified by:
      getTrafficMirrorTargetRef in interface ITrafficMirrorTargetRef

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of the Traffic Mirror target.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description of the Traffic Mirror target.

    • getGatewayLoadBalancerEndpointId

      @Stability(Stable) @Nullable public String getGatewayLoadBalancerEndpointId()
      The ID of the Gateway Load Balancer endpoint.

    • setGatewayLoadBalancerEndpointId

      @Stability(Stable) public void setGatewayLoadBalancerEndpointId(@Nullable String value)
      The ID of the Gateway Load Balancer endpoint.

    • getNetworkInterfaceId

      @Stability(Stable) @Nullable public String getNetworkInterfaceId()
      The network interface ID that is associated with the target.

    • setNetworkInterfaceId

      @Stability(Stable) public void setNetworkInterfaceId(@Nullable String value)
      The network interface ID that is associated with the target.

    • getNetworkLoadBalancerArn

      @Stability(Stable) @Nullable public String getNetworkLoadBalancerArn()
      The Amazon Resource Name (ARN) of the Network Load Balancer that is associated with the target.

    • setNetworkLoadBalancerArn

      @Stability(Stable) public void setNetworkLoadBalancerArn(@Nullable String value)
      The Amazon Resource Name (ARN) of the Network Load Balancer that is associated with the target.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      The tags to assign to the Traffic Mirror target.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      The tags to assign to the Traffic Mirror target.