ALIYUN::CMS2::AddonRelease installs an addon.
Syntax
{
"Type": "ALIYUN::CMS2::AddonRelease",
"Properties": {
"AddonVersion": String,
"AddonName": String,
"PolicyId": String,
"EntityRules": Map,
"EnvType": String,
"Lang": String,
"ParentAddonReleaseId": String,
"ReleaseName": String,
"Values": Map,
"Workspace": String
}
}Properties
Parameter | Type | Required | Update allowed | Description | Constraints |
AddonName | String | Yes | No | The name of the addon. | None |
AddonVersion | String | Yes | Yes | The version of the addon. | None |
PolicyId | String | Yes | No | The ID of the integration policy. | None |
EntityRules | Map | No | Yes | The entity discovery rule model. | |
EnvType | String | No | Yes | The environment type. | Valid values:
|
Lang | String | No | Yes | The language of the addon. | None |
ParentAddonReleaseId | String | No | No | The ID of the parent addon release. | None |
ReleaseName | String | No | No | The name of the addon release. | None |
Values | Map | No | Yes | The configuration settings for the addon release. | None |
Workspace | String | No | Yes | The workspace of the addon release. | None |
EntityRules syntax
"EntityRules": {
"FieldRules": List,
"EntityTypes": List,
"Annotations": List,
"ResourceGroupId": String,
"RegionIds": List,
"IpMatchRule": List,
"Labels": List,
"InstanceIds": List,
"Tags": List
}EntityRules properties
Parameter | Type | Required | Update allowed | Description | Constraints |
Annotations | List | No | Yes | A collection of annotation matching rules. | See the Annotations properties. |
EntityTypes | List | No | Yes | A collection of entity types. | None |
FieldRules | List | No | Yes | A collection of property matching rules. | See the FieldRules properties. |
InstanceIds | List | No | Yes | A collection of instance IDs. | None |
IpMatchRule | List | No | Yes | A collection of IP matching rules. | See the IpMatchRule properties. |
Labels | List | No | Yes | A collection of label matching rules. | See the Labels properties. |
RegionIds | List | No | Yes | A collection of region IDs. | None |
ResourceGroupId | String | No | Yes | The resource group ID. | None |
Tags | List | No | Yes | Tags for service discovery. | See the Tags properties. |
FieldRules syntax
"FieldRules": [
{
"Op": String,
"FieldValues": List,
"FieldKey": String
}
]FieldRules properties
Parameter | Type | Required | Updatable | Description | Constraints |
FieldKey | String | true | true | The key of the attribute to match. | None |
FieldValues | List | true | true | A list of attribute values for the rule. | None |
Op | String | true | true | The operator to use for the matching rule. | None |
Annotations syntax
"Annotations": [
{
"Op": String,
"TagKey": String,
"TagValues": List
}
]Annotations properties
Parameter | Type | Required | Updatable | Description | Constraint |
Op | String | Yes | Yes | Specifies the operation. | None |
TagKey | String | Yes | Yes | The annotation key. | None |
TagValues | List | Yes | Yes | A list of annotation values. | None |
IpMatchRule syntax
"IpMatchRule": [
{
"IpFieldKey": String,
"IpCIDR": String
}
]IpMatchRule properties
Parameter | Type | Required | Updatable | Description | Constraints |
IpCIDR | String | No | Yes | The CIDR block for the IP address. | None |
IpFieldKey | String | No | Yes | The IP field key. | None |
Labels syntax
"Labels": [
{
"Op": String,
"TagKey": String,
"TagValues": List
}
]Labels properties
Parameter | Type | Required | Updatable | Description | Constraints |
Op | String | Yes | Yes | Specifies the operation. | None |
TagKey | String | Yes | Yes | Specifies the tag key. | None |
TagValues | List | Yes | Yes | The list of tag values. | None |
Tags syntax
"Tags": [
{
"Op": String,
"TagKey": String,
"TagValues": List
}
]Tags properties
Parameter | Type | Required | Updatable | Description | Constraint |
Op | String | Yes | Yes | Specifies the operation. | None |
TagKey | String | Yes | Yes | The key of the tag. | None |
TagValues | List | Yes | Yes | The list of tag values. | None |
Return values
Fn::GetAtt
ReleaseName: The name of the plugin release.
Examples
ROSTemplateFormatVersion: '2015-09-01'
Parameters:
AddonName:
Description:
en: The name of the add-on.
Required: true
Type: String
AddonVersion:
Description:
en: The version of the add-on.
Required: true
Type: String
EntityRules:
AssociationPropertyMetadata:
Parameters:
Annotations:
AssociationProperty: List[Parameter]
AssociationPropertyMetadata:
Parameter:
AssociationPropertyMetadata:
Parameters:
Op:
Description:
en: Operation.
Required: true
Type: String
TagKey:
Description:
en: The key of the annotation.
Required: true
Type: String
TagValues:
AssociationProperty: List[Parameter]
AssociationPropertyMetadata:
Parameter:
Description:
en: The value of the annotation.
Required: false
Type: String
Description:
en: The values of the annotation.
Required: true
Type: Json
Description:
en: Annotation details.
Required: false
Type: Json
Description:
en: The annotation matching rules.
Required: false
Type: Json
EntityTypes:
AssociationProperty: List[Parameter]
AssociationPropertyMetadata:
Parameter:
Description:
en: Entity type.
Required: false
Type: String
Description:
en: The entity types.
Required: false
Type: Json
FieldRules:
AssociationProperty: List[Parameter]
AssociationPropertyMetadata:
Parameter:
AssociationPropertyMetadata:
Parameters:
FieldKey:
Description:
en: The key of the field.
Required: true
Type: String
FieldValues:
AssociationProperty: List[Parameter]
AssociationPropertyMetadata:
Parameter:
Description:
en: The value of the field.
Required: false
Type: String
Description:
en: The values of the field.
Required: true
Type: Json
Op:
Description:
en: Operation.
Required: true
Type: String
Description:
en: Field details.
Required: false
Type: Json
Description:
en: Field matching rules.
Required: false
Type: Json
InstanceIds:
AssociationProperty: List[Parameter]
AssociationPropertyMetadata:
Parameter:
Description:
en: The instance ID.
Required: false
Type: String
Description:
en: The instance IDs.
Required: false
Type: Json
IpMatchRule:
AssociationProperty: List[Parameters]
AssociationPropertyMetadata:
Parameters:
IpCIDR:
Description:
en: The CIDR block of the IP address.
Required: false
Type: String
IpFieldKey:
Description:
en: The key of the IP field.
Required: false
Type: String
Description:
en: The IP matching rules.
Required: false
Type: Json
Labels:
AssociationProperty: List[Parameter]
AssociationPropertyMetadata:
Parameter:
AssociationPropertyMetadata:
Parameters:
Op:
Description:
en: Operation.
Required: true
Type: String
TagKey:
Description:
en: The key of the label.
Required: true
Type: String
TagValues:
AssociationProperty: List[Parameter]
AssociationPropertyMetadata:
Parameter:
Description:
en: The value of the label.
Required: false
Type: String
Description:
en: The values of the label.
Required: true
Type: Json
Description:
en: Label details.
Required: false
Type: Json
Description:
en: The label matching rules.
Required: false
Type: Json
RegionIds:
AssociationProperty: List[Parameter]
AssociationPropertyMetadata:
Parameter:
Description:
en: The region ID.
Required: false
Type: String
Description:
en: The region IDs.
Required: false
Type: Json
ResourceGroupId:
AssociationProperty: ALIYUN::ECS::ResourceGroup::ResourceGroupId
Description:
en: The resource group ID.
Required: false
Type: String
Tags:
AssociationProperty: List[Parameter]
AssociationPropertyMetadata:
ListMetadata:
Order:
- Key
- Value
Parameter:
AssociationPropertyMetadata:
Parameters:
Op:
Description:
en: Operation.
Required: true
Type: String
TagKey:
Description:
en: The key of the tag.
Required: true
Type: String
TagValues:
AssociationProperty: List[Parameter]
AssociationPropertyMetadata:
Parameter:
Description:
en: The value of the tag.
Required: false
Type: String
Description:
en: The values of the tag.
Required: true
Type: Json
Description:
en: Tag details.
Required: false
Type: Json
Description:
en: Tag matching rules.
Required: false
Type: Json
Description:
en: The entity discovery rules.
Required: false
Type: Json
EnvType:
AllowedValues:
- CS
- ECS
- Cloud
Description:
en: The environment type.
Required: false
Type: String
Lang:
Description:
en: The language of the add-on.
Required: false
Type: String
ParentAddonReleaseId:
Description:
en: The ID of the parent add-on release.
Required: false
Type: String
PolicyId:
Description:
en: The ID of the integration policy.
Required: true
Type: String
ReleaseName:
Description:
en: The name of the add-on release.
Required: false
Type: String
Values:
Description:
en: The values of the add-on release.
Required: false
Type: Json
Workspace:
Description:
en: The workspace of the add-on release.
Required: false
Type: String
Resources:
AddonRelease:
Properties:
AddonName:
Ref: AddonName
AddonVersion:
Ref: AddonVersion
EntityRules:
Ref: EntityRules
EnvType:
Ref: EnvType
Lang:
Ref: Lang
ParentAddonReleaseId:
Ref: ParentAddonReleaseId
PolicyId:
Ref: PolicyId
ReleaseName:
Ref: ReleaseName
Values:
Ref: Values
Workspace:
Ref: Workspace
Type: ALIYUN::CMS2::AddonRelease
Outputs:
ReleaseName:
Description: The name of the add-on release.
Value:
Fn::GetAtt:
- AddonRelease
- ReleaseName
{
"ROSTemplateFormatVersion": "2015-09-01",
"Parameters": {
"AddonVersion": {
"Type": "String",
"Description": {
"en": "The version of the add-on."
},
"Required": true
},
"ParentAddonReleaseId": {
"Type": "String",
"Description": {
"en": "The ID of the parent add-on release."
},
"Required": false
},
"Values": {
"Type": "Json",
"Description": {
"en": "The values of the add-on release."
},
"Required": false
},
"AddonName": {
"Type": "String",
"Description": {
"en": "The name of the add-on."
},
"Required": true
},
"Lang": {
"Type": "String",
"Description": {
"en": "The language of the add-on."
},
"Required": false
},
"ReleaseName": {
"Type": "String",
"Description": {
"en": "The name of the add-on release."
},
"Required": false
},
"EntityRules": {
"AssociationPropertyMetadata": {
"Parameters": {
"FieldRules": {
"AssociationPropertyMetadata": {
"Parameter": {
"AssociationPropertyMetadata": {
"Parameters": {
"Op": {
"Type": "String",
"Description": {
"en": "Operation."
},
"Required": true
},
"FieldValues": {
"AssociationPropertyMetadata": {
"Parameter": {
"Type": "String",
"Description": {
"en": "The value of the field."
},
"Required": false
}
},
"Type": "Json",
"AssociationProperty": "List[Parameter]",
"Description": {
"en": "The values of the field."
},
"Required": true
},
"FieldKey": {
"Type": "String",
"Description": {
"en": "The key of the field."
},
"Required": true
}
}
},
"Type": "Json",
"Description": {
"en": "Field details."
},
"Required": false
}
},
"Type": "Json",
"AssociationProperty": "List[Parameter]",
"Description": {
"en": "Field matching rules."
},
"Required": false
},
"EntityTypes": {
"AssociationPropertyMetadata": {
"Parameter": {
"Type": "String",
"Description": {
"en": "Entity type."
},
"Required": false
}
},
"Type": "Json",
"AssociationProperty": "List[Parameter]",
"Description": {
"en": "The entity types."
},
"Required": false
},
"Annotations": {
"AssociationPropertyMetadata": {
"Parameter": {
"AssociationPropertyMetadata": {
"Parameters": {
"Op": {
"Type": "String",
"Description": {
"en": "Operation."
},
"Required": true
},
"TagKey": {
"Type": "String",
"Description": {
"en": "The key of the annotation."
},
"Required": true
},
"TagValues": {
"AssociationPropertyMetadata": {
"Parameter": {
"Type": "String",
"Description": {
"en": "The value of the annotation."
},
"Required": false
}
},
"Type": "Json",
"AssociationProperty": "List[Parameter]",
"Description": {
"en": "The values of the annotation."
},
"Required": true
}
}
},
"Type": "Json",
"Description": {
"en": "Annotation details."
},
"Required": false
}
},
"Type": "Json",
"AssociationProperty": "List[Parameter]",
"Description": {
"en": "The annotation matching rules."
},
"Required": false
},
"ResourceGroupId": {
"Type": "String",
"AssociationProperty": "ALIYUN::ECS::ResourceGroup::ResourceGroupId",
"Description": {
"en": "The resource group ID."
},
"Required": false
},
"RegionIds": {
"AssociationPropertyMetadata": {
"Parameter": {
"Type": "String",
"Description": {
"en": "The region ID."
},
"Required": false
}
},
"Type": "Json",
"AssociationProperty": "List[Parameter]",
"Description": {
"en": "The region IDs."
},
"Required": false
},
"IpMatchRule": {
"AssociationPropertyMetadata": {
"Parameters": {
"IpFieldKey": {
"Type": "String",
"Description": {
"en": "The key of the IP field."
},
"Required": false
},
"IpCIDR": {
"Type": "String",
"Description": {
"en": "The CIDR block of the IP address."
},
"Required": false
}
}
},
"Type": "Json",
"AssociationProperty": "List[Parameters]",
"Description": {
"en": "The IP matching rules."
},
"Required": false
},
"Labels": {
"AssociationPropertyMetadata": {
"Parameter": {
"AssociationPropertyMetadata": {
"Parameters": {
"Op": {
"Type": "String",
"Description": {
"en": "Operation."
},
"Required": true
},
"TagKey": {
"Type": "String",
"Description": {
"en": "The key of the label."
},
"Required": true
},
"TagValues": {
"AssociationPropertyMetadata": {
"Parameter": {
"Type": "String",
"Description": {
"en": "The value of the label."
},
"Required": false
}
},
"Type": "Json",
"AssociationProperty": "List[Parameter]",
"Description": {
"en": "The values of the label."
},
"Required": true
}
}
},
"Type": "Json",
"Description": {
"en": "Label details."
},
"Required": false
}
},
"Type": "Json",
"AssociationProperty": "List[Parameter]",
"Description": {
"en": "The label matching rules."
},
"Required": false
},
"InstanceIds": {
"AssociationPropertyMetadata": {
"Parameter": {
"Type": "String",
"Description": {
"en": "The instance ID."
},
"Required": false
}
},
"Type": "Json",
"AssociationProperty": "List[Parameter]",
"Description": {
"en": "The instance IDs."
},
"Required": false
},
"Tags": {
"AssociationPropertyMetadata": {
"Parameter": {
"AssociationPropertyMetadata": {
"Parameters": {
"Op": {
"Type": "String",
"Description": {
"en": "Operation."
},
"Required": true
},
"TagKey": {
"Type": "String",
"Description": {
"en": "The key of the tag."
},
"Required": true
},
"TagValues": {
"AssociationPropertyMetadata": {
"Parameter": {
"Type": "String",
"Description": {
"en": "The value of the tag."
},
"Required": false
}
},
"Type": "Json",
"AssociationProperty": "List[Parameter]",
"Description": {
"en": "The values of the tag."
},
"Required": true
}
}
},
"Type": "Json",
"Description": {
"en": "Tag details."
},
"Required": false
},
"ListMetadata": {
"Order": [
"Key",
"Value"
]
}
},
"Type": "Json",
"AssociationProperty": "List[Parameter]",
"Description": {
"en": "Tag matching rules."
},
"Required": false
}
}
},
"Type": "Json",
"Description": {
"en": "The entity discovery rules."
},
"Required": false
},
"PolicyId": {
"Type": "String",
"Description": {
"en": "The ID of the integration policy."
},
"Required": true
},
"EnvType": {
"Type": "String",
"Description": {
"en": "The environment type."
},
"AllowedValues": [
"CS",
"ECS",
"Cloud"
],
"Required": false
},
"Workspace": {
"Type": "String",
"Description": {
"en": "The workspace of the add-on release."
},
"Required": false
}
},
"Resources": {
"AddonRelease": {
"Type": "ALIYUN::CMS2::AddonRelease",
"Properties": {
"AddonVersion": {
"Ref": "AddonVersion"
},
"ParentAddonReleaseId": {
"Ref": "ParentAddonReleaseId"
},
"Values": {
"Ref": "Values"
},
"AddonName": {
"Ref": "AddonName"
},
"Lang": {
"Ref": "Lang"
},
"ReleaseName": {
"Ref": "ReleaseName"
},
"EntityRules": {
"Ref": "EntityRules"
},
"PolicyId": {
"Ref": "PolicyId"
},
"EnvType": {
"Ref": "EnvType"
},
"Workspace": {
"Ref": "Workspace"
}
}
}
},
"Outputs": {
"ReleaseName": {
"Description": "The name of the add-on release.",
"Value": {
"Fn::GetAtt": [
"AddonRelease",
"ReleaseName"
]
}
}
}
}
该文章对您有帮助吗？