DATASOURCE::VPC::TrafficMirrorFilter - Resource Orchestration Service

DATASOURCE::VPC::TrafficMirrorFilter is used to query a filter for traffic mirroring.

Syntax

{
  "Type": "DATASOURCE::VPC::TrafficMirrorFilter",
  "Properties": {
    "TrafficMirrorFilterId": String,
    "RefreshOptions": String
  }
}

Properties

Property

Type

Required

Editable

Description

Constraint

TrafficMirrorFilterId

String

Yes

The filter ID.

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

TrafficMirrorFilterDescription: the description of the filter.
EgressRules: the details of the outbound rules in the filter.
TrafficMirrorFilterId: the filter ID.
TrafficMirrorFilterName: the filter name.
IngressRules: the details of the inbound rules in the filter.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  TrafficMirrorFilterId:
    Description:
      en: The first ID of the resource.
    Required: true
    Type: String
Resources:
  ExtensionDataSource:
    Properties:
      TrafficMirrorFilterId:
        Ref: TrafficMirrorFilterId
    Type: DATASOURCE::VPC::TrafficMirrorFilter
Outputs:
  EgressRules:
    Description: EgressRules.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - EgressRules
  IngressRules:
    Description: IngressRules.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - IngressRules
  TrafficMirrorFilterDescription:
    Description: The description of the TrafficMirrorFilter.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - TrafficMirrorFilterDescription
  TrafficMirrorFilterId:
    Description: The first ID of the resource.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - TrafficMirrorFilterId
  TrafficMirrorFilterName:
    Description: The name of the TrafficMirrorFilter.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - TrafficMirrorFilterName

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "TrafficMirrorFilterId": {
      "Type": "String",
      "Description": {
        "en": "The first ID of the resource."
      },
      "Required": true
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::VPC::TrafficMirrorFilter",
      "Properties": {
        "TrafficMirrorFilterId": {
          "Ref": "TrafficMirrorFilterId"
        }
      }
    }
  },
  "Outputs": {
    "TrafficMirrorFilterDescription": {
      "Description": "The description of the TrafficMirrorFilter.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "TrafficMirrorFilterDescription"
        ]
      }
    },
    "EgressRules": {
      "Description": "EgressRules.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "EgressRules"
        ]
      }
    },
    "TrafficMirrorFilterId": {
      "Description": "The first ID of the resource.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "TrafficMirrorFilterId"
        ]
      }
    },
    "TrafficMirrorFilterName": {
      "Description": "The name of the TrafficMirrorFilter.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "TrafficMirrorFilterName"
        ]
      }
    },
    "IngressRules": {
      "Description": "IngressRules.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "IngressRules"
        ]
      }
    }
  }
}