ALIYUN::VPC::TrafficMirrorSession

Syntax

{
  "Type": "ALIYUN::VPC::TrafficMirrorSession",
  "Properties": {
    "TrafficMirrorTargetId": String,
    "ResourceGroupId": String,
    "VirtualNetworkId": Integer,
    "TrafficMirrorSourceIds": List,
    "Priority": Integer,
    "PacketLength": Integer,
    "Enabled": Boolean,
    "TrafficMirrorSessionDescription": String,
    "Tag": List,
    "TrafficMirrorSessionName": String,
    "TrafficMirrorFilterId": String,
    "TrafficMirrorTargetType": String
  }
}

Properties

Tag syntax

"Tag": [
  {
    "Value": String,
    "Key": String
  }
]

Tag properties

Return values

Fn::GetAtt

TrafficMirrorSessionId: the ID of the traffic mirror session.

Examples

• YAML format

  ROSTemplateFormatVersion: '2015-09-01'
  Parameters:
    Priority:
      Description: 'The priority of the traffic mirror session. Valid values: **1 to 32766**.
          A smaller value indicates a higher priority. You cannot specify identical
          priorities for traffic mirror sessions that are created in the same region
          by using the same account.'
      MaxValue: 32766
      MinValue: 1
      Type: Number
      Default: 1
    TrafficMirrorFilterId:
      Description: The ID of the filter.
      Type: String
      Default: tmf-j6cmls82xnc86vtpe****
    TrafficMirrorSourceIds:
      AssociationProperty: List[Parameter]
      AssociationPropertyMetadata:
        Parameter:
          Description: The ID of the traffic mirror source. You can specify only an ENI as
              the traffic mirror source. The default value of N is 1, which means that
              you can add only one traffic mirror source to a traffic mirror session.
          Type: String
      Type: Json
      Default: [eni-j6c2fp57q8rr47rp****]
    TrafficMirrorTargetId:
      Description: The ID of the traffic mirror destination. You can specify only an elastic
          network interface (ENI) or a Server Load Balancer (SLB) instance as a traffic
          mirror destination.
      Type: String
      Default: eni-j6c8znm5l1yt4sox****
    TrafficMirrorTargetType:
      Description: 'The type of the traffic mirror destination. Valid values:
          - **NetworkInterface**: an ENI
          - **SLB**: an SLB instance'
      Type: String
      Default: NetworkInterface
  Resources:
    TrafficMirrorSession:
      Properties:
        Priority:
          Ref: Priority
        TrafficMirrorFilterId:
          Ref: TrafficMirrorFilterId
        TrafficMirrorSourceIds:
          Ref: TrafficMirrorSourceIds
        TrafficMirrorTargetId:
          Ref: TrafficMirrorTargetId
        TrafficMirrorTargetType:
          Ref: TrafficMirrorTargetType
      Type: ALIYUN::VPC::TrafficMirrorSession
  Outputs:
    TrafficMirrorSessionId:
      Description: The ID of the traffic mirror session.
      Value:
        Fn::GetAtt:
        - TrafficMirrorSession
        - TrafficMirrorSessionId

• JSON format

  {
    "ROSTemplateFormatVersion": "2015-09-01",
    "Parameters": {
      "Priority": {
        "Description": "The priority of the traffic mirror session. Valid values: **1 to 32766**.\nA smaller value indicates a higher priority. You cannot specify identical priorities for traffic mirror sessions that are created in the same region by using the same account.",
        "MaxValue": 32766,
        "MinValue": 1,
        "Type": "Number",
        "Default": 1
      },
      "TrafficMirrorFilterId": {
        "Description": "The ID of the filter.",
        "Type": "String",
        "Default": "tmf-j6cmls82xnc86vtpe****"
      },
      "TrafficMirrorSourceIds": {
        "AssociationProperty": "List[Parameter]",
        "AssociationPropertyMetadata": {
          "Parameter": {
            "Description": "The ID of the traffic mirror source. You can specify only an ENI as the traffic mirror source. The default value of N is 1, which means that you can add only one traffic mirror source to a traffic mirror session.",
            "Type": "String"
          }
        },
        "Type": "Json",
        "Default": [
          "eni-j6c2fp57q8rr47rp****"
        ]
      },
      "TrafficMirrorTargetId": {
        "Description": "The ID of the traffic mirror destination. You can specify only an elastic network interface (ENI) or a Server Load Balancer (SLB) instance as a traffic mirror destination.",
        "Type": "String",
        "Default": "eni-j6c8znm5l1yt4sox****"
      },
      "TrafficMirrorTargetType": {
        "Description": "The type of the traffic mirror destination. Valid values: - **NetworkInterface**: an ENI - **SLB**: an SLB instance",
        "Type": "String",
        "Default": "NetworkInterface"
      }
    },
    "Resources": {
      "TrafficMirrorSession": {
        "Properties": {
          "Priority": {
            "Ref": "Priority"
          },
          "TrafficMirrorFilterId": {
            "Ref": "TrafficMirrorFilterId"
          },
          "TrafficMirrorSourceIds": {
            "Ref": "TrafficMirrorSourceIds"
          },
          "TrafficMirrorTargetId": {
            "Ref": "TrafficMirrorTargetId"
          },
          "TrafficMirrorTargetType": {
            "Ref": "TrafficMirrorTargetType"
          }
        },
        "Type": "ALIYUN::VPC::TrafficMirrorSession"
      }
    },
    "Outputs": {
      "TrafficMirrorSessionId": {
        "Description": "The ID of the traffic mirror session.",
        "Value": {
          "Fn::GetAtt": [
            "TrafficMirrorSession",
            "TrafficMirrorSessionId"
          ]
        }
      }
    }
  }