How to use DATASOURCE::VPC::TrafficMirrorFilters to query filters for traffic mirroring. - Resource Orchestration Service

DATASOURCE::VPC::TrafficMirrorFilters is used to query filters for traffic mirroring.

Syntax

{
  "Type": "DATASOURCE::VPC::TrafficMirrorFilters",
  "Properties": {
    "TrafficMirrorFilterName": String,
    "RefreshOptions": String
  }
}

Properties

Property

Type

Required

Editable

Description

Constraint

TrafficMirrorFilterName

String

Yes

The filter name.

None.

RefreshOptions

String

Yes

The refresh policy for data source resources when the stack is updated.

Valid values:

Never (default): does not refresh data source resources when the stack is updated.
Always: refreshes data source resources when the stack is updated.

Return values

Fn::GetAtt

TrafficMirrorFilters: details of the filters.
TrafficMirrorFilterIds: the IDs of the filters.

Property	Type	Description	Constraint
TrafficMirrorFilterIds	List	The IDs of the filters.	None.
TrafficMirrorFilters	List	Details of the filters.	None.
Status	String	The filter status.	Valid values: Creating: The filter is being created. Created: The filter is created. Modifying: The filter is being modified. Deleting: The filter is being deleted.
TrafficMirrorFilterDescription	String	The filter description.	None.
TrafficMirrorFilterName	String	The filter name.	None.
IngressRules	List	Details of the inbound rules in the filter.	Example: `[ { "TrafficMirrorFilterRuleStatus" : "Created", "Action" : "accept", "SourceCidrBlock" : "0.0.0.0/0", "TrafficDirection" : "ingress", "Protocol" : "ALL", "DestinationPortRange" : "-1/-1", "TrafficMirrorFilterRuleId" : "tmr-j6cezu8e68rnpepet**", "DestinationCidrBlock" : "0.0.0.0/0", "Priority" : 1, "TrafficMirrorFilterId" : "tmf-j6cmls82xnc86vtpe**", "SourcePortRange" : "-1/-1" } ]`
EgressRules	List	Details of the outbound rules in the filter.	Example: `[ { "TrafficMirrorFilterRuleStatus" : "Created", "Action" : "accept", "SourceCidrBlock" : "10.0.0.0/24", "TrafficDirection" : "egress", "Protocol" : "TCP", "DestinationPortRange" : "22/40", "TrafficMirrorFilterRuleId" : "tmr-j6c89rzmtd3hhdugq**", "DestinationCidrBlock" : "10.0.0.0/24", "Priority" : 1, "TrafficMirrorFilterId" : "tmf-j6cmls82xnc86vtpe**", "SourcePortRange" : "22/40" } ]`
TrafficMirrorFilterId	String	The filter ID.	None.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
Resources:
  ExtensionDataSource:
    Properties:
      TrafficMirrorFilterName: Demo
    Type: DATASOURCE::VPC::TrafficMirrorFilters
Outputs:
  TrafficMirrorFilterIds:
    Description: The list of traffic mirror filter IDs.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - TrafficMirrorFilterIds
  TrafficMirrorFilters:
    Description: The list of traffic mirror filters.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - TrafficMirrorFilters

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::VPC::TrafficMirrorFilters",
      "Properties": {
        "TrafficMirrorFilterName": "Demo"
      }
    }
  },
  "Outputs": {
    "TrafficMirrorFilters": {
      "Description": "The list of traffic mirror filters.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "TrafficMirrorFilters"
        ]
      }
    },
    "TrafficMirrorFilterIds": {
      "Description": "The list of traffic mirror filter IDs.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "TrafficMirrorFilterIds"
        ]
      }
    }
  }
}