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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:38.344Z")
 @Stability(value=Stable)
public class CfnTrafficMirrorTarget
extends CfnResource
implements IInspectable

A CloudFormation `AWS::EC2::TrafficMirrorTarget`.

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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnTrafficMirrorTarget.Builder A fluent builder for CfnTrafficMirrorTarget.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnTrafficMirrorTarget(software.constructs.Construct scope, String id) Create a new `AWS::EC2::TrafficMirrorTarget`.
	CfnTrafficMirrorTarget(software.constructs.Construct scope, String id, CfnTrafficMirrorTargetProps props) Create a new `AWS::EC2::TrafficMirrorTarget`.
protected	CfnTrafficMirrorTarget(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnTrafficMirrorTarget(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
protected Map<String,Object>	getCfnProperties()
String	getDescription() The description of the Traffic Mirror target.
String	getGatewayLoadBalancerEndpointId() The ID of the Gateway Load Balancer endpoint.
String	getNetworkInterfaceId() The network interface ID that is associated with the target.
String	getNetworkLoadBalancerArn() The Amazon Resource Name (ARN) of the Network Load Balancer that is associated with the target.
TagManager	getTags() The tags to assign to the Traffic Mirror target.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDescription(String value) The description of the Traffic Mirror target.
void	setGatewayLoadBalancerEndpointId(String value) The ID of the Gateway Load Balancer endpoint.
void	setNetworkInterfaceId(String value) The network interface ID that is associated with the target.
void	setNetworkLoadBalancerArn(String value) The Amazon Resource Name (ARN) of the Network Load Balancer that is associated with the target.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnTrafficMirrorTarget

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

CfnTrafficMirrorTarget

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

CfnTrafficMirrorTarget

@Stability(value=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 - - scoped id of the resource. This parameter is required.

props - - resource properties.

CfnTrafficMirrorTarget

@Stability(value=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 - - scoped id of the resource. This parameter is required.

Method Detail

inspect

@Stability(value=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(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

The tags to assign to the Traffic Mirror target.

getDescription

@Stability(value=Stable)
 @Nullable
public String getDescription()

The description of the Traffic Mirror target.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

The description of the Traffic Mirror target.

getGatewayLoadBalancerEndpointId

@Stability(value=Stable)
 @Nullable
public String getGatewayLoadBalancerEndpointId()

The ID of the Gateway Load Balancer endpoint.

setGatewayLoadBalancerEndpointId

@Stability(value=Stable)
public void setGatewayLoadBalancerEndpointId(@Nullable
                                                                      String value)

The ID of the Gateway Load Balancer endpoint.

getNetworkInterfaceId

@Stability(value=Stable)
 @Nullable
public String getNetworkInterfaceId()

The network interface ID that is associated with the target.

setNetworkInterfaceId

@Stability(value=Stable)
public void setNetworkInterfaceId(@Nullable
                                                           String value)

The network interface ID that is associated with the target.

getNetworkLoadBalancerArn

@Stability(value=Stable)
 @Nullable
public String getNetworkLoadBalancerArn()

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

setNetworkLoadBalancerArn

@Stability(value=Stable)
public void setNetworkLoadBalancerArn(@Nullable
                                                               String value)

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