software.amazon.awscdk.services.ec2

Class CfnTrafficMirrorFilterRule

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.CfnTrafficMirrorFilterRule

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.341Z")
 @Stability(value=Stable)
public class CfnTrafficMirrorFilterRule
extends CfnResource
implements IInspectable

A CloudFormation `AWS::EC2::TrafficMirrorFilterRule`.

Creates a Traffic Mirror filter rule.

A Traffic Mirror rule defines the Traffic Mirror source traffic to mirror.

You need the Traffic Mirror filter ID when you create the rule.

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.*;
 CfnTrafficMirrorFilterRule cfnTrafficMirrorFilterRule = CfnTrafficMirrorFilterRule.Builder.create(this, "MyCfnTrafficMirrorFilterRule")
         .destinationCidrBlock("destinationCidrBlock")
         .ruleAction("ruleAction")
         .ruleNumber(123)
         .sourceCidrBlock("sourceCidrBlock")
         .trafficDirection("trafficDirection")
         .trafficMirrorFilterId("trafficMirrorFilterId")
         // the properties below are optional
         .description("description")
         .destinationPortRange(TrafficMirrorPortRangeProperty.builder()
                 .fromPort(123)
                 .toPort(123)
                 .build())
         .protocol(123)
         .sourcePortRange(TrafficMirrorPortRangeProperty.builder()
                 .fromPort(123)
                 .toPort(123)
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnTrafficMirrorFilterRule.Builder A fluent builder for CfnTrafficMirrorFilterRule.
static interface	CfnTrafficMirrorFilterRule.TrafficMirrorPortRangeProperty Describes the Traffic Mirror port range.

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
	CfnTrafficMirrorFilterRule(software.constructs.Construct scope, String id, CfnTrafficMirrorFilterRuleProps props) Create a new `AWS::EC2::TrafficMirrorFilterRule`.
protected	CfnTrafficMirrorFilterRule(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnTrafficMirrorFilterRule(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 rule.
String	getDestinationCidrBlock() The destination CIDR block to assign to the Traffic Mirror rule.
Object	getDestinationPortRange() The destination port range.
Number	getProtocol() The protocol, for example UDP, to assign to the Traffic Mirror rule.
String	getRuleAction() The action to take on the filtered traffic.
Number	getRuleNumber() The number of the Traffic Mirror rule.
String	getSourceCidrBlock() The source CIDR block to assign to the Traffic Mirror rule.
Object	getSourcePortRange() The source port range.
String	getTrafficDirection() The type of traffic.
String	getTrafficMirrorFilterId() The ID of the filter that this rule is associated with.
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 rule.
void	setDestinationCidrBlock(String value) The destination CIDR block to assign to the Traffic Mirror rule.
void	setDestinationPortRange(CfnTrafficMirrorFilterRule.TrafficMirrorPortRangeProperty value) The destination port range.
void	setDestinationPortRange(IResolvable value) The destination port range.
void	setProtocol(Number value) The protocol, for example UDP, to assign to the Traffic Mirror rule.
void	setRuleAction(String value) The action to take on the filtered traffic.
void	setRuleNumber(Number value) The number of the Traffic Mirror rule.
void	setSourceCidrBlock(String value) The source CIDR block to assign to the Traffic Mirror rule.
void	setSourcePortRange(CfnTrafficMirrorFilterRule.TrafficMirrorPortRangeProperty value) The source port range.
void	setSourcePortRange(IResolvable value) The source port range.
void	setTrafficDirection(String value) The type of traffic.
void	setTrafficMirrorFilterId(String value) The ID of the filter that this rule is associated with.

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

CfnTrafficMirrorFilterRule

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

CfnTrafficMirrorFilterRule

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

CfnTrafficMirrorFilterRule

@Stability(value=Stable)
public CfnTrafficMirrorFilterRule(@NotNull
                                                           software.constructs.Construct scope,
                                                           @NotNull
                                                           String id,
                                                           @NotNull
                                                           CfnTrafficMirrorFilterRuleProps props)

Create a new `AWS::EC2::TrafficMirrorFilterRule`.

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. 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

getDestinationCidrBlock

@Stability(value=Stable)
 @NotNull
public String getDestinationCidrBlock()

The destination CIDR block to assign to the Traffic Mirror rule.

setDestinationCidrBlock

@Stability(value=Stable)
public void setDestinationCidrBlock(@NotNull
                                                             String value)

The destination CIDR block to assign to the Traffic Mirror rule.

getRuleAction

@Stability(value=Stable)
 @NotNull
public String getRuleAction()

The action to take on the filtered traffic.

setRuleAction

@Stability(value=Stable)
public void setRuleAction(@NotNull
                                                   String value)

The action to take on the filtered traffic.

getRuleNumber

@Stability(value=Stable)
 @NotNull
public Number getRuleNumber()

The number of the Traffic Mirror rule.

This number must be unique for each Traffic Mirror rule in a given direction. The rules are processed in ascending order by rule number.

setRuleNumber

@Stability(value=Stable)
public void setRuleNumber(@NotNull
                                                   Number value)

The number of the Traffic Mirror rule.

This number must be unique for each Traffic Mirror rule in a given direction. The rules are processed in ascending order by rule number.

getSourceCidrBlock

@Stability(value=Stable)
 @NotNull
public String getSourceCidrBlock()

The source CIDR block to assign to the Traffic Mirror rule.

setSourceCidrBlock

@Stability(value=Stable)
public void setSourceCidrBlock(@NotNull
                                                        String value)

The source CIDR block to assign to the Traffic Mirror rule.

getTrafficDirection

@Stability(value=Stable)
 @NotNull
public String getTrafficDirection()

The type of traffic.

setTrafficDirection

@Stability(value=Stable)
public void setTrafficDirection(@NotNull
                                                         String value)

The type of traffic.

getTrafficMirrorFilterId

@Stability(value=Stable)
 @NotNull
public String getTrafficMirrorFilterId()

The ID of the filter that this rule is associated with.

setTrafficMirrorFilterId

@Stability(value=Stable)
public void setTrafficMirrorFilterId(@NotNull
                                                              String value)

The ID of the filter that this rule is associated with.

getDescription

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

The description of the Traffic Mirror rule.

setDescription

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

The description of the Traffic Mirror rule.

getDestinationPortRange

@Stability(value=Stable)
 @Nullable
public Object getDestinationPortRange()

The destination port range.

setDestinationPortRange

@Stability(value=Stable)
public void setDestinationPortRange(@Nullable
                                                             CfnTrafficMirrorFilterRule.TrafficMirrorPortRangeProperty value)

The destination port range.

setDestinationPortRange

@Stability(value=Stable)
public void setDestinationPortRange(@Nullable
                                                             IResolvable value)

The destination port range.

getProtocol

@Stability(value=Stable)
 @Nullable
public Number getProtocol()

The protocol, for example UDP, to assign to the Traffic Mirror rule.

For information about the protocol value, see Protocol Numbers on the Internet Assigned Numbers Authority (IANA) website.

setProtocol

@Stability(value=Stable)
public void setProtocol(@Nullable
                                                 Number value)

The protocol, for example UDP, to assign to the Traffic Mirror rule.

For information about the protocol value, see Protocol Numbers on the Internet Assigned Numbers Authority (IANA) website.

getSourcePortRange

@Stability(value=Stable)
 @Nullable
public Object getSourcePortRange()

The source port range.

setSourcePortRange

@Stability(value=Stable)
public void setSourcePortRange(@Nullable
                                                        CfnTrafficMirrorFilterRule.TrafficMirrorPortRangeProperty value)

The source port range.

setSourcePortRange

@Stability(value=Stable)
public void setSourcePortRange(@Nullable
                                                        IResolvable value)

The source port range.