ALIYUN::ThreatDetection::HoneypotProbe - Resource Orchestration Service

Syntax

{
  "Type": "ALIYUN::ThreatDetection::HoneypotProbe",
  "Properties": {
    "ControlNodeId": String,
    "DisplayName": String,
    "ProbeType": String,
    "Arp": Boolean,
    "BusinessGroupId": String,
    "HoneypotBindList": List,
    "ProbeVersion": String,
    "Ping": Boolean,
    "ProxyIp": String,
    "ServiceIpList": List,
    "Uuid": String,
    "VpcId": String
  }
}

Properties

Parameter	Type	Required	Update Allowed	Description	Constraints
ControlNodeId	String	Yes	No	The ID of the management node.	None
DisplayName	String	Yes	Yes	The name of the probe.	None
ProbeType	String	Yes	No	The type of the probe.	Valid values: host_probe: A host probe. vpc_black_hole_probe: A VPC black hole probe.
Arp	Boolean	No	Yes	Specifies whether to enable ARP spoofing.	Valid values: true: Enables ARP spoofing. false: Disables ARP spoofing.
BusinessGroupId	String	No	No	The ID of the business group.	None
HoneypotBindList	List	No	No	A list of honeypots to bind to the probe.	The list can contain 0 to 20 items. For more information, see HoneypotBindList properties.
Ping	Boolean	No	Yes	Specifies whether to enable ping scan.	Valid values: true: Enables ping scan. false: Disables ping scan.
ProbeVersion	String	No	No	The probe version.	None
ProxyIp	String	No	No	The proxy IP address.	None
ServiceIpList	List	No	Yes	A list of listening IP addresses.	The list can contain 0 to 20 items.
Uuid	String	Conditional	No	The UUID of the instance.	This property is required when `ProbeType` is set to `host_probe`.
VpcId	String	Conditional	No	The VPC ID.	This property is required when `ProbeType` is set to `vpc_black_hole_probe`.

HoneypotBindList syntax

"HoneypotBindList": [
  {
    "HoneypotId": String,
    "BindPortList": List
  }
]

HoneypotBindList properties

Parameter	Type	Required	Update Allowed	Description	Constraints
BindPortList	List	No	No	The port binding configurations for the honeypot.	The list can contain 0 to 20 items. For more information, see BindPortList properties.
HoneypotId	String	No	No	The ID of the honeypot.	None

BindPortList syntax

"BindPortList": [
  {
    "TargetPort": Integer,
    "BindPort": Boolean,
    "StartPort": Integer,
    "EndPort": Integer,
    "Fixed": Boolean
  }
]

BindPortList properties

Parameter	Type	Required	Update Allowed	Description	Constraints
BindPort	Boolean	No	No	Specifies whether to bind the port.	Valid values: true: Binds the port. false: Does not bind the port.
EndPort	Integer	No	No	The end port of the listening range.	None
Fixed	Boolean	No	No	Specifies whether the port is a fixed port.	Valid values: true: The port is a fixed port. false: The port is not a fixed port.
StartPort	Integer	No	No	The start port of the listening range.	None
TargetPort	Integer	Conditional	No	The destination port.	This property is required if `HoneypotId` is specified.

Return values

Fn::GetAtt

ProbeVersion: The probe version.
Uuid: The UUID of the instance.
VpcId: The VPC ID.
ProbeType: The type of the probe.
ServiceIpList: A list of listening IP addresses.
ControlNodeId: The ID of the management node.
HoneypotProbeId: The probe ID.
Ping: Indicates whether ping scan is enabled (true or false).
DisplayName: The name of the probe.
HoneypotBindList: The list of honeypots bound to the probe.
Arp: Indicates whether ARP spoofing is enabled (true or false).

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  Arp:
    Type: Boolean
    Description:
      en: |-
        Specifies whether to enable ARP spoofing. Valid values:
        *   true: Enables ARP spoofing.
        *   false: Disables ARP spoofing.
    Default: Null
    Required: false
  VpcId:
    Type: String
    Description:
      en: |-
        The VPC ID.
        > This parameter is required if ProbeType is set to vpc_black_hole_probe. You can call the [DescribeVpcHoneyPotList](DescribeVpcHoneyPotList) operation to obtain the ID.
    AssociationProperty: ALIYUN::ECS::VPC::VPCId
    Default: Null
    Required: false
  DisplayName:
    Type: String
    Description:
      en: The name of the probe.
    Required: true
  Uuid:
    Type: String
    Description:
      en: |-
        The UUID of the instance.
        > This parameter is required if ProbeType is set to host_probe.
    Default: Null
    Required: false
  ProbeType:
    Type: String
    Description:
      en: |-
        The probe type. Valid values:
        *   host_probe: A host probe.
        *   vpc_black_hole_probe: A VPC black hole probe.
    AllowedValues:
      - host_probe
      - vpc_black_hole_probe
    Required: true
  HoneypotBindList:
    Description:
      en: A list of honeypots to bind to the probe.
    Required: false
    Default: Null
    Type: Json
    MinLength: 0
    MaxLength: 20
    AssociationProperty: List[Parameter]
    AssociationPropertyMetadata:
      Parameter:
        Description:
          en: The binding configuration for a honeypot.
        Required: false
        Default: Null
        Type: Json
        AssociationPropertyMetadata:
          Parameters:
            HoneypotId:
              Type: String
              Description:
                en: |-
                  The ID of the honeypot.
                  > You can call the [ListHoneypot](ListHoneypot) operation to query the IDs of honeypots.
              Default: Null
              Required: false
            BindPortList:
              Description:
                en: The port binding configurations for the honeypot.
              Required: false
              Default: Null
              Type: Json
              MinLength: 0
              MaxLength: 20
              AssociationProperty: List[Parameters]
              AssociationPropertyMetadata:
                Parameters:
                  BindPort:
                    Type: Boolean
                    Description:
                      en: |-
                        Specifies whether to bind a port. Valid values:
                        *   true: Binds the port.
                        *   false: Does not bind the port.
                    Default: Null
                    Required: false
                  StartPort:
                    Type: Number
                    Description:
                      en: The start port of the listening range.
                    Default: Null
                    Required: false
                  Fixed:
                    Type: Boolean
                    Description:
                      en: |-
                        Specifies whether the port is a fixed port. Valid values:
                        *   true: The port is a fixed port.
                        *   false: The port is not a fixed port.
                    Default: Null
                    Required: false
                  TargetPort:
                    Type: Number
                    Description:
                      en: |-
                        The destination port.
                        > This parameter is required if HoneypotId is specified.
                    Default: Null
                    Required: false
                  EndPort:
                    Type: Number
                    Description:
                      en: The end port of the listening range.
                    Default: Null
                    Required: false
  Ping:
    Type: Boolean
    Description:
      en: |-
        Specifies whether to enable ping scan. Valid values:
        *   true: Enables ping scan.
        *   false: Disables ping scan.
    Default: Null
    Required: false
  ProbeVersion:
    Type: String
    Description:
      en: The probe version.
    Default: Null
    Required: false
  ControlNodeId:
    Type: String
    Description:
      en: |-
        The ID of the management node.
        > You can call the [ListHoneypotNode](ListHoneypotNode) operation to query the IDs of management nodes.
    Required: true
  BusinessGroupId:
    Type: String
    Description:
      en: The ID of the business group.
    Default: Null
    Required: false
  ProxyIp:
    Type: String
    Description:
      en: The proxy IP address.
    Default: Null
    Required: false
  ServiceIpList:
    Description:
      en: A list of listening IP addresses.
    Required: false
    Default: Null
    Type: Json
    MinLength: 0
    MaxLength: 20
    AssociationProperty: List[Parameter]
    AssociationPropertyMetadata:
      Parameter:
        Type: String
        Description:
          en: A listening IP address.
        Default: Null
        Required: false
Resources:
  ExtensionResource:
    Type: ALIYUN::ThreatDetection::HoneypotProbe
    Properties:
      Arp:
        Ref: Arp
      VpcId:
        Ref: VpcId
      DisplayName:
        Ref: DisplayName
      Uuid:
        Ref: Uuid
      ProbeType:
        Ref: ProbeType
      HoneypotBindList:
        Ref: HoneypotBindList
      Ping:
        Ref: Ping
      ProbeVersion:
        Ref: ProbeVersion
      ControlNodeId:
        Ref: ControlNodeId
      BusinessGroupId:
        Ref: BusinessGroupId
      ProxyIp:
        Ref: ProxyIp
      ServiceIpList:
        Ref: ServiceIpList
Outputs:
  Arp:
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Arp
    Description: Indicates whether ARP spoofing is enabled (true or false).
  VpcId:
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - VpcId
    Description: The VPC ID.
  DisplayName:
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - DisplayName
    Description: The name of the probe.
  Uuid:
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Uuid
    Description: The UUID of the instance.
  ProbeType:
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - ProbeType
    Description: The type of the probe.
  HoneypotBindList:
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - HoneypotBindList
    Description: The list of honeypots bound to the probe.
  Ping:
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Ping
    Description: Indicates whether ping scan is enabled (true or false).
  ProbeVersion:
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - ProbeVersion
    Description: The probe version.
  ControlNodeId:
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - ControlNodeId
    Description: The ID of the management node.
  HoneypotProbeId:
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - HoneypotProbeId
    Description: The probe ID.
  ServiceIpList:
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - ServiceIpList
    Description: A list of listening IP addresses.

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "Arp": {
      "Type": "Boolean",
      "Description": {
        "en": "Specifies whether to enable ARP spoofing. Valid values:\n*   true: Enables ARP spoofing.\n*   false: Disables ARP spoofing."
      },
      "Default": null,
      "Required": false
    },
    "VpcId": {
      "Type": "String",
      "Description": {
        "en": "The VPC ID.\n> This parameter is required if ProbeType is set to vpc_black_hole_probe. You can call the [DescribeVpcHoneyPotList](DescribeVpcHoneyPotList) operation to obtain the ID."
      },
      "AssociationProperty": "ALIYUN::ECS::VPC::VPCId",
      "Default": null,
      "Required": false
    },
    "DisplayName": {
      "Type": "String",
      "Description": {
        "en": "The name of the probe."
      },
      "Required": true
    },
    "Uuid": {
      "Type": "String",
      "Description": {
        "en": "The UUID of the instance.\n> This parameter is required if ProbeType is set to host_probe."
      },
      "Default": null,
      "Required": false
    },
    "ProbeType": {
      "Type": "String",
      "Description": {
        "en": "The probe type. Valid values:\n*   host_probe: A host probe.\n*   vpc_black_hole_probe: A VPC black hole probe."
      },
      "AllowedValues": [
        "host_probe",
        "vpc_black_hole_probe"
      ],
      "Required": true
    },
    "HoneypotBindList": {
      "Description": {
        "en": "A list of honeypots to bind to the probe."
      },
      "Required": false,
      "Default": null,
      "Type": "Json",
      "MinLength": 0,
      "MaxLength": 20,
      "AssociationProperty": "List[Parameter]",
      "AssociationPropertyMetadata": {
        "Parameter": {
          "Description": {
            "en": "The binding configuration for a honeypot."
          },
          "Required": false,
          "Default": null,
          "Type": "Json",
          "AssociationPropertyMetadata": {
            "Parameters": {
              "HoneypotId": {
                "Type": "String",
                "Description": {
                  "en": "The ID of the honeypot.\n> You can call the [ListHoneypot](ListHoneypot) operation to query the IDs of honeypots."
                },
                "Default": null,
                "Required": false
              },
              "BindPortList": {
                "Description": {
                  "en": "The port binding configurations for the honeypot."
                },
                "Required": false,
                "Default": null,
                "Type": "Json",
                "MinLength": 0,
                "MaxLength": 20,
                "AssociationProperty": "List[Parameters]",
                "AssociationPropertyMetadata": {
                  "Parameters": {
                    "BindPort": {
                      "Type": "Boolean",
                      "Description": {
                        "en": "Specifies whether to bind a port. Valid values:\n*   true: Binds the port.\n*   false: Does not bind the port."
                      },
                      "Default": null,
                      "Required": false
                    },
                    "StartPort": {
                      "Type": "Number",
                      "Description": {
                        "en": "The start port of the listening range."
                      },
                      "Default": null,
                      "Required": false
                    },
                    "Fixed": {
                      "Type": "Boolean",
                      "Description": {
                        "en": "Specifies whether the port is a fixed port. Valid values:\n*   true: The port is a fixed port.\n*   false: The port is not a fixed port."
                      },
                      "Default": null,
                      "Required": false
                    },
                    "TargetPort": {
                      "Type": "Number",
                      "Description": {
                        "en": "The destination port.\n> This parameter is required if HoneypotId is specified."
                      },
                      "Default": null,
                      "Required": false
                    },
                    "EndPort": {
                      "Type": "Number",
                      "Description": {
                        "en": "The end port of the listening range."
                      },
                      "Default": null,
                      "Required": false
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "Ping": {
      "Type": "Boolean",
      "Description": {
        "en": "Specifies whether to enable ping scan. Valid values:\n*   true: Enables ping scan.\n*   false: Disables ping scan."
      },
      "Default": null,
      "Required": false
    },
    "ProbeVersion": {
      "Type": "String",
      "Description": {
        "en": "The probe version."
      },
      "Default": null,
      "Required": false
    },
    "ControlNodeId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the management node.\n> You can call the [ListHoneypotNode](ListHoneypotNode) operation to query the IDs of management nodes."
      },
      "Required": true
    },
    "BusinessGroupId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the business group."
      },
      "Default": null,
      "Required": false
    },
    "ProxyIp": {
      "Type": "String",
      "Description": {
        "en": "The proxy IP address."
      },
      "Default": null,
      "Required": false
    },
    "ServiceIpList": {
      "Description": {
        "en": "A list of listening IP addresses."
      },
      "Required": false,
      "Default": null,
      "Type": "Json",
      "MinLength": 0,
      "MaxLength": 20,
      "AssociationProperty": "List[Parameter]",
      "AssociationPropertyMetadata": {
        "Parameter": {
          "Type": "String",
          "Description": {
            "en": "A listening IP address."
          },
          "Default": null,
          "Required": false
        }
      }
    }
  },
  "Resources": {
    "ExtensionResource": {
      "Type": "ALIYUN::ThreatDetection::HoneypotProbe",
      "Properties": {
        "Arp": {
          "Ref": "Arp"
        },
        "VpcId": {
          "Ref": "VpcId"
        },
        "DisplayName": {
          "Ref": "DisplayName"
        },
        "Uuid": {
          "Ref": "Uuid"
        },
        "ProbeType": {
          "Ref": "ProbeType"
        },
        "HoneypotBindList": {
          "Ref": "HoneypotBindList"
        },
        "Ping": {
          "Ref": "Ping"
        },
        "ProbeVersion": {
          "Ref": "ProbeVersion"
        },
        "ControlNodeId": {
          "Ref": "ControlNodeId"
        },
        "BusinessGroupId": {
          "Ref": "BusinessGroupId"
        },
        "ProxyIp": {
          "Ref": "ProxyIp"
        },
        "ServiceIpList": {
          "Ref": "ServiceIpList"
        }
      }
    }
  },
  "Outputs": {
    "Arp": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Arp"
        ]
      },
      "Description": "Indicates whether ARP spoofing is enabled (true or false)."
    },
    "VpcId": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "VpcId"
        ]
      },
      "Description": "The VPC ID."
    },
    "DisplayName": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "DisplayName"
        ]
      },
      "Description": "The name of the probe."
    },
    "Uuid": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Uuid"
        ]
      },
      "Description": "The UUID of the instance."
    },
    "ProbeType": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "ProbeType"
        ]
      },
      "Description": "The type of the probe."
    },
    "HoneypotBindList": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "HoneypotBindList"
        ]
      },
      "Description": "The list of honeypots bound to the probe."
    },
    "Ping": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Ping"
        ]
      },
      "Description": "Indicates whether ping scan is enabled (true or false)."
    },
    "ProbeVersion": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "ProbeVersion"
        ]
      },
      "Description": "The probe version."
    },
    "ControlNodeId": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "ControlNodeId"
        ]
      },
      "Description": "The ID of the management node."
    },
    "HoneypotProbeId": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "HoneypotProbeId"
        ]
      },
      "Description": "The probe ID."
    },
    "ServiceIpList": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "ServiceIpList"
        ]
      },
      "Description": "A list of listening IP addresses."
    }
  }
}