ALIYUN::ThreatDetection::HoneyPot - Resource Orchestration Service

The ALIYUN::ThreatDetection::HoneyPot resource creates a honeypot instance.

Syntax

{
  "Type": "ALIYUN::ThreatDetection::HoneyPot",
  "Properties": {
    "HoneypotImageName": String,
    "HoneypotImageId": String,
    "HoneypotName": String,
    "NodeId": String,
    "Meta": Map
  }
}

Properties

Parameter	Type	Required	Editable	Description	Constraints
HoneypotImageId	String	Yes	No	The ID of the honeypot image.	None
HoneypotImageName	String	Yes	No	The name of the honeypot image.	None
HoneypotName	String	Yes	Yes	The custom name of the honeypot.	None
NodeId	String	Yes	No	The ID of the management node.	None
Meta	Map	No	No	The custom configuration for the honeypot.	A JSON string that contains the following fields: trojan_git: The Git countermeasure. Valid values: zip: Git source package web: .git directory leak close: Disables the countermeasure. trojan_git_addr: The connection address for the Git countermeasure. trojan_git.zip: The trojan package for the Git countermeasure. burp: The Burp countermeasure. Valid values: open: Enables the countermeasure. close: Disables the countermeasure. portrait_option: The source tracing configuration. Valid values: false: Disabled. true: Enabled.

Return values

Fn::GetAtt

HoneypotImageName: The name of the honeypot image.
State: The status of the honeypot.
HoneypotId: The ID of the honeypot.
NodeId: The ID of the management node.
HoneypotImageId: The ID of the honeypot image.
HoneypotName: The custom name of the honeypot.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  HoneypotImageName:
    Type: String
    Description:
      en: |-
        The name of the honeypot image.
        > You can call the [ListAvailableHoneypot](~~ListAvailableHoneypot~~) operation to obtain the names of images from the **HoneypotImageName** response parameter.
    Required: true
  HoneypotName:
    Type: String
    Description:
      en: The custom name of the honeypot.
    Required: true
  NodeId:
    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
  HoneypotImageId:
    Type: String
    Description:
      en: |-
        The ID of the honeypot image.
        > You can call the [ListAvailableHoneypot](~~ListAvailableHoneypot~~) operation to obtain the IDs of images from the **HoneypotImageId** response parameter.
    Required: true
  Meta:
    Type: Json
    Description:
      en: |-
        Custom configuration for the honeypot. The value is a JSON string that can contain the following fields:
        - **trojan_git**: The Git countermeasure. Valid values: **zip** (Git source package), **web** (.git directory leak), and **close** (disables the countermeasure).
        - **trojan_git_addr**: The connection address for the Git countermeasure.
        - **trojan_git.zip**: The trojan package for the Git countermeasure.
        - **burp**: The Burp countermeasure. Valid values: **open** (enables the countermeasure) and **close** (disables the countermeasure).
        - **portrait_option**: The source tracing configuration. Valid values: **true** (enabled) and **false** (disabled).
    Required: false
    Default: Null
Resources:
  ExtensionResource:
    Type: ALIYUN::ThreatDetection::HoneyPot
    Properties:
      HoneypotImageName:
        Ref: HoneypotImageName
      HoneypotName:
        Ref: HoneypotName
      NodeId:
        Ref: NodeId
      HoneypotImageId:
        Ref: HoneypotImageId
      Meta:
        Ref: Meta
Outputs:
  HoneypotImageName:
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - HoneypotImageName
    Description: The name of the honeypot image.
  HoneypotName:
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - HoneypotName
    Description: The custom name of the honeypot.
  HoneypotImageId:
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - HoneypotImageId
    Description: The ID of the honeypot image.
  NodeId:
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - NodeId
    Description: The ID of the management node.
  State:
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - State
    Description: The status of the honeypot.
  HoneypotId:
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - HoneypotId
    Description: The ID of the honeypot.

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "HoneypotImageName": {
      "Type": "String",
      "Description": {
        "en": "The name of the honeypot image.\n> You can call the [ListAvailableHoneypot](~~ListAvailableHoneypot~~) operation to obtain the names of images from the **HoneypotImageName** response parameter."
      },
      "Required": true
    },
    "HoneypotName": {
      "Type": "String",
      "Description": {
        "en": "The custom name of the honeypot."
      },
      "Required": true
    },
    "NodeId": {
      "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
    },
    "HoneypotImageId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the honeypot image.\n> You can call the [ListAvailableHoneypot](~~ListAvailableHoneypot~~) operation to obtain the IDs of images from the **HoneypotImageId** response parameter."
      },
      "Required": true
    },
    "Meta": {
      "Type": "Json",
      "Description": {
        "en": "Custom configuration for the honeypot. The value is a JSON string that can contain the following fields:\n- **trojan_git**: The Git countermeasure. Valid values: **zip** (Git source package), **web** (.git directory leak), and **close** (disables the countermeasure).\n- **trojan_git_addr**: The connection address for the Git countermeasure.\n- **trojan_git.zip**: The trojan package for the Git countermeasure.\n- **burp**: The Burp countermeasure. Valid values: **open** (enables the countermeasure) and **close** (disables the countermeasure).\n- **portrait_option**: The source tracing configuration. Valid values: **true** (enabled) and **false** (disabled)."
      },
      "Required": false,
      "Default": null
    }
  },
  "Resources": {
    "ExtensionResource": {
      "Type": "ALIYUN::ThreatDetection::HoneyPot",
      "Properties": {
        "HoneypotImageName": {
          "Ref": "HoneypotImageName"
        },
        "HoneypotName": {
          "Ref": "HoneypotName"
        },
        "NodeId": {
          "Ref": "NodeId"
        },
        "HoneypotImageId": {
          "Ref": "HoneypotImageId"
        },
        "Meta": {
          "Ref": "Meta"
        }
      }
    }
  },
  "Outputs": {
    "HoneypotImageName": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "HoneypotImageName"
        ]
      },
      "Description": "The name of the honeypot image."
    },
    "HoneypotName": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "HoneypotName"
        ]
      },
      "Description": "The custom name of the honeypot."
    },
    "HoneypotImageId": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "HoneypotImageId"
        ]
      },
      "Description": "The ID of the honeypot image."
    },
    "NodeId": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "NodeId"
        ]
      },
      "Description": "The ID of the management node."
    },
    "State": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "State"
        ]
      },
      "Description": "The status of the honeypot."
    },
    "HoneypotId": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "HoneypotId"
        ]
      },
      "Description": "The ID of the honeypot."
    }
  }
}