The ALIYUN::ThreatDetection::CustomCheckItem resource type creates a custom check item.
Syntax
{
"Type": "ALIYUN::ThreatDetection::CustomCheckItem",
"Properties": {
"CheckShowName": String,
"CheckRule": Map,
"InstanceSubType": String,
"InstanceType": String,
"RiskLevel": String,
"Status": String,
"SectionIds": List,
"Vendor": String,
"AssistInfo": Map,
"Description": Map,
"Remark": String,
"Solution": Map
}
}Properties
Parameter | Type | Required | Editable | Description | Constraints |
CheckRule | Map | Yes | Yes | The rules for the check item. | None |
CheckShowName | String | Yes | Yes | The display name of the check item. | None |
InstanceSubType | String | Yes | Yes | The asset subtype of the check item. | None |
InstanceType | String | Yes | Yes | The asset type of the check item. | None |
RiskLevel | String | Yes | Yes | The risk level of the check item. | Valid values:
|
SectionIds | List | Yes | Yes | The check sections for the check item. | Length: 0 to 100. |
Status | String | Yes | No | The status of the check item. | Valid values:
|
Vendor | String | Yes | Yes | The vendor of the check item. | None |
AssistInfo | Map | No | Yes | Supplementary information for the check item. | For more information, see AssistInfo properties. |
Description | Map | No | Yes | The description of the check item. | For more information, see Description properties. |
Remark | String | No | Yes | The remark for the check item. | None |
Solution | Map | No | Yes | The solution for the check item. | For more information, see Solution properties. |
Description syntax
"Description": {
"Type": String,
"Value": String
}Description properties
Parameter | Type | Required | Editable | Description | Constraints |
Type | String | No | Yes | The format of the check item description. | Valid value:
|
Value | String | No | Yes | The content of the check item description. | None |
AssistInfo syntax
"AssistInfo": {
"Type": String,
"Value": String
}AssistInfo properties
Parameter | Type | Required | Editable | Description | Constraints |
Type | String | No | Yes | The format of the supplementary information. | Valid value:
|
Value | String | No | Yes | The content of the supplementary information. | None |
Solution syntax
"Solution": {
"Type": String,
"Value": String
}Solution properties
Parameter | Type | Required | Editable | Description | Constraints |
Type | String | No | Yes | The format of the solution. | Valid value:
|
Value | String | No | Yes | The content of the solution. | None |
Return values
Fn::GetAtt
InstanceSubType: The asset subtype of the check item.
SectionIds: The check sections for the check item.
Description: The description of the check item.
CheckId: The resource ID of the custom check item.
CheckShowName: The display name of the check item.
CheckRule: The rules for the check item.
Vendor: The vendor of the check item.
AssistInfo: Supplementary information for the check item.
InstanceType: The asset type of the check item.
RiskLevel: The risk level of the check item.
Solution: The solution for the check item.
Remark: The remark for the check item.
Examples
ROSTemplateFormatVersion: '2015-09-01'
Parameters:
InstanceSubType:
Type: String
Description:
en: The asset subtype of the check item.
Required: true
Status:
Type: String
Description:
en: |-
The status of the check item. Valid values:
EDIT: The check item is being edited.
RELEASE: The check item is published.
AllowedValues:
- EDIT
- RELEASE
Required: true
AssistInfo:
Description:
en: Supplementary information for the check item.
Required: false
Default: Null
Type: Json
AssociationPropertyMetadata:
Parameters:
Type:
Type: String
Description:
en: The format of the supplementary information.
AllowedValues:
- text
Default: Null
Required: false
Value:
Type: String
Description:
en: The content of the supplementary information.
Default: Null
Required: false
Vendor:
Type: String
Description:
en: The vendor of the check item.
Required: true
Description:
Description:
en: The description of the check item.
Required: false
Default: Null
Type: Json
AssociationPropertyMetadata:
Parameters:
Type:
Type: String
Description:
en: The format of the check item description.
AllowedValues:
- text
Default: Null
Required: false
Value:
Type: String
Description:
en: The content of the check item description.
Default: Null
Required: false
RiskLevel:
Type: String
Description:
en: The risk level of the check item.
AllowedValues:
- HIGH
- MEDIUM
- LOW
Required: true
SectionIds:
Description:
en: The check sections for the check item.
Required: true
Type: Json
MinLength: 0
MaxLength: 100
AssociationProperty: List[Parameter]
AssociationPropertyMetadata:
Parameter:
Type: Number
Description:
en: The ID of the check section.
Default: Null
Required: false
Remark:
Type: String
Description:
en: The remark for the check item.
Default: Null
Required: false
Solution:
Description:
en: The solution for the check item.
Required: false
Default: Null
Type: Json
AssociationPropertyMetadata:
Parameters:
Type:
Type: String
Description:
en: The format of the solution.
AllowedValues:
- text
Default: Null
Required: false
Value:
Type: String
Description:
en: The content of the solution.
Default: Null
Required: false
CheckShowName:
Type: String
Description:
en: The display name of the check item.
Required: true
CheckRule:
Description:
en: The rules for the check item.
Required: true
Type: Json
InstanceType:
Type: String
Description:
en: The asset type of the check item.
Required: true
Resources:
ExtensionResource:
Type: ALIYUN::ThreatDetection::CustomCheckItem
Properties:
InstanceSubType:
Ref: InstanceSubType
Status:
Ref: Status
AssistInfo:
Ref: AssistInfo
Vendor:
Ref: Vendor
Description:
Ref: Description
RiskLevel:
Ref: RiskLevel
SectionIds:
Ref: SectionIds
Remark:
Ref: Remark
Solution:
Ref: Solution
CheckShowName:
Ref: CheckShowName
CheckRule:
Ref: CheckRule
InstanceType:
Ref: InstanceType
Outputs:
CheckId:
Value:
Fn::GetAtt:
- ExtensionResource
- CheckId
Description: The resource ID of the custom check item.
InstanceSubType:
Value:
Fn::GetAtt:
- ExtensionResource
- InstanceSubType
Description: The asset subtype of the check item.
AssistInfo:
Value:
Fn::GetAtt:
- ExtensionResource
- AssistInfo
Description: Supplementary information for the check item.
Vendor:
Value:
Fn::GetAtt:
- ExtensionResource
- Vendor
Description: The vendor of the check item.
Description:
Value:
Fn::GetAtt:
- ExtensionResource
- Description
Description: The description of the check item.
RiskLevel:
Value:
Fn::GetAtt:
- ExtensionResource
- RiskLevel
Description: The risk level of the check item.
SectionIds:
Value:
Fn::GetAtt:
- ExtensionResource
- SectionIds
Description: The check sections for the check item.
Remark:
Value:
Fn::GetAtt:
- ExtensionResource
- Remark
Description: The remark for the check item.
Solution:
Value:
Fn::GetAtt:
- ExtensionResource
- Solution
Description: The solution for the check item.
CheckShowName:
Value:
Fn::GetAtt:
- ExtensionResource
- CheckShowName
Description: The display name of the check item.
CheckRule:
Value:
Fn::GetAtt:
- ExtensionResource
- CheckRule
Description: The rules for the check item.
InstanceType:
Value:
Fn::GetAtt:
- ExtensionResource
- InstanceType
Description: The asset type of the check item.
{
"ROSTemplateFormatVersion": "2015-09-01",
"Parameters": {
"InstanceSubType": {
"Type": "String",
"Description": {
"en": "The asset subtype of the check item."
},
"Required": true
},
"Status": {
"Type": "String",
"Description": {
"en": "The status of the check item. Valid values:\nEDIT: The check item is being edited.\nRELEASE: The check item is published."
},
"AllowedValues": [
"EDIT",
"RELEASE"
],
"Required": true
},
"AssistInfo": {
"Description": {
"en": "Supplementary information for the check item."
},
"Required": false,
"Default": null,
"Type": "Json",
"AssociationPropertyMetadata": {
"Parameters": {
"Type": {
"Type": "String",
"Description": {
"en": "The format of the supplementary information."
},
"AllowedValues": [
"text"
],
"Default": null,
"Required": false
},
"Value": {
"Type": "String",
"Description": {
"en": "The content of the supplementary information."
},
"Default": null,
"Required": false
}
}
}
},
"Vendor": {
"Type": "String",
"Description": {
"en": "The vendor of the check item."
},
"Required": true
},
"Description": {
"Description": {
"en": "The description of the check item."
},
"Required": false,
"Default": null,
"Type": "Json",
"AssociationPropertyMetadata": {
"Parameters": {
"Type": {
"Type": "String",
"Description": {
"en": "The format of the check item description."
},
"AllowedValues": [
"text"
],
"Default": null,
"Required": false
},
"Value": {
"Type": "String",
"Description": {
"en": "The content of the check item description."
},
"Default": null,
"Required": false
}
}
}
},
"RiskLevel": {
"Type": "String",
"Description": {
"en": "The risk level of the check item."
},
"AllowedValues": [
"HIGH",
"MEDIUM",
"LOW"
],
"Required": true
},
"SectionIds": {
"Description": {
"en": "The check sections for the check item."
},
"Required": true,
"Type": "Json",
"MinLength": 0,
"MaxLength": 100,
"AssociationProperty": "List[Parameter]",
"AssociationPropertyMetadata": {
"Parameter": {
"Type": "Number",
"Description": {
"en": "The ID of the check section."
},
"Default": null,
"Required": false
}
}
},
"Remark": {
"Type": "String",
"Description": {
"en": "The remark for the check item."
},
"Default": null,
"Required": false
},
"Solution": {
"Description": {
"en": "The solution for the check item."
},
"Required": false,
"Default": null,
"Type": "Json",
"AssociationPropertyMetadata": {
"Parameters": {
"Type": {
"Type": "String",
"Description": {
"en": "The format of the solution."
},
"AllowedValues": [
"text"
],
"Default": null,
"Required": false
},
"Value": {
"Type": "String",
"Description": {
"en": "The content of the solution."
},
"Default": null,
"Required": false
}
}
}
},
"CheckShowName": {
"Type": "String",
"Description": {
"en": "The display name of the check item."
},
"Required": true
},
"CheckRule": {
"Description": {
"en": "The rules for the check item."
},
"Required": true,
"Type": "Json"
},
"InstanceType": {
"Type": "String",
"Description": {
"en": "The asset type of the check item."
},
"Required": true
}
},
"Resources": {
"ExtensionResource": {
"Type": "ALIYUN::ThreatDetection::CustomCheckItem",
"Properties": {
"InstanceSubType": {
"Ref": "InstanceSubType"
},
"Status": {
"Ref": "Status"
},
"AssistInfo": {
"Ref": "AssistInfo"
},
"Vendor": {
"Ref": "Vendor"
},
"Description": {
"Ref": "Description"
},
"RiskLevel": {
"Ref": "RiskLevel"
},
"SectionIds": {
"Ref": "SectionIds"
},
"Remark": {
"Ref": "Remark"
},
"Solution": {
"Ref": "Solution"
},
"CheckShowName": {
"Ref": "CheckShowName"
},
"CheckRule": {
"Ref": "CheckRule"
},
"InstanceType": {
"Ref": "InstanceType"
}
}
}
},
"Outputs": {
"CheckId": {
"Value": {
"Fn::GetAtt": [
"ExtensionResource",
"CheckId"
]
},
"Description": "The resource ID of the custom check item."
},
"InstanceSubType": {
"Value": {
"Fn::GetAtt": [
"ExtensionResource",
"InstanceSubType"
]
},
"Description": "The asset subtype of the check item."
},
"AssistInfo": {
"Value": {
"Fn::GetAtt": [
"ExtensionResource",
"AssistInfo"
]
},
"Description": "Supplementary information for the check item."
},
"Vendor": {
"Value": {
"Fn::GetAtt": [
"ExtensionResource",
"Vendor"
]
},
"Description": "The vendor of the check item."
},
"Description": {
"Value": {
"Fn::GetAtt": [
"ExtensionResource",
"Description"
]
},
"Description": "The description of the check item."
},
"RiskLevel": {
"Value": {
"Fn::GetAtt": [
"ExtensionResource",
"RiskLevel"
]
},
"Description": "The risk level of the check item."
},
"SectionIds": {
"Value": {
"Fn::GetAtt": [
"ExtensionResource",
"SectionIds"
]
},
"Description": "The check sections for the check item."
},
"Remark": {
"Value": {
"Fn::GetAtt": [
"ExtensionResource",
"Remark"
]
},
"Description": "The remark for the check item."
},
"Solution": {
"Value": {
"Fn::GetAtt": [
"ExtensionResource",
"Solution"
]
},
"Description": "The solution for the check item."
},
"CheckShowName": {
"Value": {
"Fn::GetAtt": [
"ExtensionResource",
"CheckShowName"
]
},
"Description": "The display name of the check item."
},
"CheckRule": {
"Value": {
"Fn::GetAtt": [
"ExtensionResource",
"CheckRule"
]
},
"Description": "The rules for the check item."
},
"InstanceType": {
"Value": {
"Fn::GetAtt": [
"ExtensionResource",
"InstanceType"
]
},
"Description": "The asset type of the check item."
}
}
}