O recurso ALIYUN::Config::AggregateCompliancePack cria um pacote de conformidade para um grupo de contas.
Sintaxe
{
"Type": "ALIYUN::Config::AggregateCompliancePack",
"Properties": {
"TagKeyScope": String,
"TagValueScope": String,
"Description": String,
"CompliancePackName": String,
"ExcludeResourceIdsScope": List,
"RegionIdsScope": List,
"ResourceGroupIdsScope": List,
"ConfigRules": List,
"CompliancePackTemplateId": String,
"RiskLevel": Integer,
"DefaultEnable": Boolean,
"AggregatorId": String,
"ResourceIdsScope": String,
"ExcludeRegionIdsScope": String,
"TemplateContent": String,
"ExcludeResourceGroupIdsScope": String
}
}Propriedades
Propriedade | Tipo | Obrigatório | Editável | Descrição | Restrição |
AggregatorId | String | Sim | Sim | ID do grupo de contas. | Nenhuma. |
CompliancePackName | String | Sim | Sim | Nome do pacote de conformidade. | Nenhuma. |
ConfigRules | List | Não | Sim | Regras do pacote de conformidade. | Para mais informações, consulte Propriedades de ConfigRules. |
Description | String | Sim | Sim | Descrição do pacote de conformidade. | Nenhuma. |
RiskLevel | Integer | Sim | Sim | Nível de risco do pacote de conformidade. | Valores válidos:
|
CompliancePackTemplateId | String | Não | Não | ID do modelo de pacote de conformidade. | Nenhuma. |
DefaultEnable | Boolean | Não | Sim | Indica se as regras devem ser ativadas junto com o pacote de conformidade. | Valores válidos:
|
ExcludeResourceIdsScope | List | Não | Sim | IDs dos recursos excluídos da avaliação pelo pacote de conformidade. | Separe vários IDs de recursos com vírgulas (,). |
RegionIdsScope | List | Não | Sim | IDs das regiões que contêm os recursos a serem avaliados pelo pacote de conformidade. | Separe vários IDs de região com vírgulas (,). |
ResourceGroupIdsScope | List | Não | Sim | IDs dos grupos de recursos cujos recursos serão avaliados pelo pacote de conformidade. | Separe vários IDs de grupo de recursos com vírgulas (,). |
TagKeyScope | String | Não | Sim | Chave da tag dos recursos a serem avaliados pelo pacote de conformidade. | Nenhuma. |
TagValueScope | String | Não | Sim | Valor da tag dos recursos a serem avaliados pelo pacote de conformidade. | Especifique TagValueScope em conjunto com TagKeyScope. |
ResourceIdsScope | String | Não | Não | IDs dos recursos aos quais a regra se aplica. | Separe vários IDs de recursos com vírgulas (,). |
ExcludeRegionIdsScope | String | Não | Não | IDs das regiões excluídas das avaliações de conformidade da regra. | Separe vários IDs de região com vírgulas (,). |
TemplateContent | String | Não | Não | Informações sobre o modelo usado para criar o pacote de conformidade. | Nenhuma. |
ExcludeResourceGroupIdsScope | String | Não | Não | IDs dos grupos de recursos excluídos das avaliações de conformidade da regra. | Separe vários IDs de grupo de recursos com vírgulas (,). |
Sintaxe de ConfigRules
"ConfigRules": [
{
"ConfigRuleId": String,
"Description": String,
"ConfigRuleName": String,
"ManagedRuleIdentifier": String,
"RiskLevel": Integer,
"ConfigRuleParameters": List
}
]Propriedades de ConfigRules
Propriedade | Tipo | Obrigatório | Editável | Descrição | Restrição |
RiskLevel | Integer | Sim | Sim | Nível de risco dos recursos em não conformidade com a regra. | Valores válidos:
|
ConfigRuleId | String | Não | Sim | IDs das regras. | Se você especificar esta propriedade, o Cloud Config adicionará a regra com o ID indicado ao pacote de conformidade. Especifique apenas uma das propriedades |
ConfigRuleName | String | Não | Sim | Nome da regra. | Nenhuma. |
ConfigRuleParameters | List | Não | Sim | Parâmetros de entrada da regra. | Para mais informações, consulte Propriedades de ConfigRuleParameters. |
Description | String | Não | Sim | Descrição da regra. | Nenhuma. |
ManagedRuleIdentifier | String | Não | Sim | Identificador da regra gerenciada. | O Cloud Config cria automaticamente uma regra gerenciada com base no identificador especificado e a adiciona ao pacote de conformidade. Especifique apenas uma das propriedades |
Sintaxe de ConfigRuleParameters
"ConfigRuleParameters": [
{
"ParameterValue": String,
"ParameterName": String
}
]Propriedades de ConfigRuleParameters
|
Propriedade |
Tipo |
Obrigatório |
Editável |
Descrição |
Restrição |
|
ParameterValue |
String |
Sim |
Sim |
Valor do parâmetro de entrada. |
Especifique as propriedades |
|
ParameterName |
String |
Sim |
Sim |
Nome do parâmetro de entrada. |
Especifique as propriedades |
Valores de retorno
Fn::GetAtt
CompliancePackId: ID do pacote de conformidade.
Exemplos
Formato YAML
ROSTemplateFormatVersion: '2015-09-01'
Parameters:
AggregatorId:
Description:
en: Aggregator id.
Required: true
Type: String
CompliancePackName:
Description:
en: Compliance package name.
Required: true
Type: String
CompliancePackTemplateId:
Description:
en: Compliance package template ID.
Required: false
Type: String
ConfigRules:
AssociationProperty: List[Parameter]
AssociationPropertyMetadata:
Parameter:
AssociationPropertyMetadata:
Parameters:
ConfigRuleId:
Description:
en: Rule ID. Configure auditing to add existing rules to the current
compliance package.Choose one of ManagedRuleIdentifier and ConfigRuleId.
When both parameters are set, ConfigRuleId is the correct one.
Required: false
Type: String
ConfigRuleName:
Description:
en: The name of config rule.
Required: false
Type: String
ConfigRuleParameters:
AssociationProperty: List[Parameters]
AssociationPropertyMetadata:
Parameters:
ParameterName:
Description:
en: The name of parameter.
Required: true
Type: String
ParameterValue:
Description:
en: The value of parameter.
Required: true
Type: String
Required: false
Type: Json
Description:
AssociationProperty: TextArea
Description:
en: The description of config rule.
Required: false
Type: String
ManagedRuleIdentifier:
Description:
en: Managed rule ID. Configure auditing to automatically create a
rule based on the managed rule ID and add the rule to the current
compliance package.Choose one of ManagedRuleIdentifier and ConfigRuleId.
When both parameters are set, ConfigRuleId is the correct one.
Required: false
Type: String
RiskLevel:
AllowedValues:
- 1
- 2
- 3
Description:
en: 'Rule risk level. Value:
1: High risk.
2: Medium risk.
3: Low risk.'
Required: true
Type: Number
Required: false
Type: Json
Description:
en: List of rules in the compliance package.
MinLength: 1
Required: true
Type: Json
DefaultEnable:
Description:
en: 'Whether the rule supports quick activation. Value:
true: This rule will be enabled when the compliance package is quickly enabled.
false (default): disable'
Required: false
Type: Boolean
Description:
AssociationProperty: TextArea
Description:
en: The description of compliance pack.
Required: true
Type: String
ExcludeResourceIdsScope:
AssociationProperty: List[Parameter]
AssociationPropertyMetadata:
Parameter:
Description:
en: The resource id.
Required: false
Type: String
Description:
en: The compliance package is invalid for the specified resource ID, that is,
no evaluation is performed on the resource.
Required: false
Type: Json
RegionIdsScope:
AssociationProperty: List[Parameter]
AssociationPropertyMetadata:
Parameter:
Description:
en: The region id.
Required: false
Type: String
Description:
en: The compliance package only takes effect for resources in the specified
region ID.
Required: false
Type: Json
ResourceGroupIdsScope:
AssociationProperty: List[Parameter]
AssociationPropertyMetadata:
Parameter:
Description:
en: Resource group id.
Required: false
Type: String
Description:
en: The compliance package only takes effect on resources in the specified resource
group ID.
Required: false
Type: Json
RiskLevel:
AllowedValues:
- 1
- 2
- 3
Description:
en: 'Compliance package risk level. Value:
1: High risk.
2: Medium risk.
3: Low risk.'
Required: true
Type: Number
TagKeyScope:
Description:
en: Compliance packages only take effect on resources bound to the specified
tag key.
Required: false
Type: String
TagValueScope:
Description:
en: Compliance packages only take effect on resources bound to specified tag
key-value pairs.TagValueScope needs to be used in conjunction with TagKeyScope.
Required: false
Type: String
Resources:
AggregateCompliancePack:
Properties:
AggregatorId:
Ref: AggregatorId
CompliancePackName:
Ref: CompliancePackName
CompliancePackTemplateId:
Ref: CompliancePackTemplateId
ConfigRules:
Ref: ConfigRules
DefaultEnable:
Ref: DefaultEnable
Description:
Ref: Description
ExcludeResourceIdsScope:
Ref: ExcludeResourceIdsScope
RegionIdsScope:
Ref: RegionIdsScope
ResourceGroupIdsScope:
Ref: ResourceGroupIdsScope
RiskLevel:
Ref: RiskLevel
TagKeyScope:
Ref: TagKeyScope
TagValueScope:
Ref: TagValueScope
Type: ALIYUN::Config::AggregateCompliancePack
Outputs:
CompliancePackId:
Description: 'The ID of the compliance pack id. '
Value:
Fn::GetAtt:
- AggregateCompliancePack
- CompliancePackId
Formato JSON
{
"ROSTemplateFormatVersion": "2015-09-01",
"Parameters": {
"TagKeyScope": {
"Type": "String",
"Description": {
"en": "Compliance packages only take effect on resources bound to the specified tag key."
},
"Required": false
},
"TagValueScope": {
"Type": "String",
"Description": {
"en": "Compliance packages only take effect on resources bound to specified tag key-value pairs.TagValueScope needs to be used in conjunction with TagKeyScope."
},
"Required": false
},
"Description": {
"AssociationProperty": "TextArea",
"Type": "String",
"Description": {
"en": "The description of compliance pack."
},
"Required": true
},
"CompliancePackName": {
"Type": "String",
"Description": {
"en": "Compliance package name."
},
"Required": true
},
"ExcludeResourceIdsScope": {
"AssociationPropertyMetadata": {
"Parameter": {
"Type": "String",
"Description": {
"en": "The resource id."
},
"Required": false
}
},
"AssociationProperty": "List[Parameter]",
"Type": "Json",
"Description": {
"en": "The compliance package is invalid for the specified resource ID, that is, no evaluation is performed on the resource."
},
"Required": false
},
"RegionIdsScope": {
"AssociationPropertyMetadata": {
"Parameter": {
"Type": "String",
"Description": {
"en": "The region id."
},
"Required": false
}
},
"AssociationProperty": "List[Parameter]",
"Type": "Json",
"Description": {
"en": "The compliance package only takes effect for resources in the specified region ID."
},
"Required": false
},
"ResourceGroupIdsScope": {
"AssociationPropertyMetadata": {
"Parameter": {
"Type": "String",
"Description": {
"en": "Resource group id."
},
"Required": false
}
},
"AssociationProperty": "List[Parameter]",
"Type": "Json",
"Description": {
"en": "The compliance package only takes effect on resources in the specified resource group ID."
},
"Required": false
},
"ConfigRules": {
"AssociationPropertyMetadata": {
"Parameter": {
"AssociationPropertyMetadata": {
"Parameters": {
"ConfigRuleId": {
"Type": "String",
"Description": {
"en": "Rule ID. Configure auditing to add existing rules to the current compliance package.Choose one of ManagedRuleIdentifier and ConfigRuleId. When both parameters are set, ConfigRuleId is the correct one."
},
"Required": false
},
"Description": {
"AssociationProperty": "TextArea",
"Type": "String",
"Description": {
"en": "The description of config rule."
},
"Required": false
},
"ConfigRuleName": {
"Type": "String",
"Description": {
"en": "The name of config rule."
},
"Required": false
},
"ManagedRuleIdentifier": {
"Type": "String",
"Description": {
"en": "Managed rule ID. Configure auditing to automatically create a rule based on the managed rule ID and add the rule to the current compliance package.Choose one of ManagedRuleIdentifier and ConfigRuleId. When both parameters are set, ConfigRuleId is the correct one."
},
"Required": false
},
"RiskLevel": {
"Type": "Number",
"Description": {
"en": "Rule risk level. Value:\n1: High risk.\n2: Medium risk.\n3: Low risk."
},
"AllowedValues": [
1,
2,
3
],
"Required": true
},
"ConfigRuleParameters": {
"AssociationPropertyMetadata": {
"Parameters": {
"ParameterValue": {
"Type": "String",
"Description": {
"en": "The value of parameter."
},
"Required": true
},
"ParameterName": {
"Type": "String",
"Description": {
"en": "The name of parameter."
},
"Required": true
}
}
},
"AssociationProperty": "List[Parameters]",
"Type": "Json",
"Required": false
}
}
},
"Type": "Json",
"Required": false
}
},
"AssociationProperty": "List[Parameter]",
"Type": "Json",
"Description": {
"en": "List of rules in the compliance package."
},
"Required": true,
"MinLength": 1
},
"CompliancePackTemplateId": {
"Type": "String",
"Description": {
"en": "Compliance package template ID."
},
"Required": false
},
"RiskLevel": {
"Type": "Number",
"Description": {
"en": "Compliance package risk level. Value:\n1: High risk.\n2: Medium risk.\n3: Low risk."
},
"AllowedValues": [
1,
2,
3
],
"Required": true
},
"DefaultEnable": {
"Type": "Boolean",
"Description": {
"en": "Whether the rule supports quick activation. Value:\ntrue: This rule will be enabled when the compliance package is quickly enabled.\nfalse (default): disable"
},
"Required": false
},
"AggregatorId": {
"Type": "String",
"Description": {
"en": "Aggregator id."
},
"Required": true
}
},
"Resources": {
"AggregateCompliancePack": {
"Type": "ALIYUN::Config::AggregateCompliancePack",
"Properties": {
"TagKeyScope": {
"Ref": "TagKeyScope"
},
"TagValueScope": {
"Ref": "TagValueScope"
},
"Description": {
"Ref": "Description"
},
"CompliancePackName": {
"Ref": "CompliancePackName"
},
"ExcludeResourceIdsScope": {
"Ref": "ExcludeResourceIdsScope"
},
"RegionIdsScope": {
"Ref": "RegionIdsScope"
},
"ResourceGroupIdsScope": {
"Ref": "ResourceGroupIdsScope"
},
"ConfigRules": {
"Ref": "ConfigRules"
},
"CompliancePackTemplateId": {
"Ref": "CompliancePackTemplateId"
},
"RiskLevel": {
"Ref": "RiskLevel"
},
"DefaultEnable": {
"Ref": "DefaultEnable"
},
"AggregatorId": {
"Ref": "AggregatorId"
}
}
}
},
"Outputs": {
"CompliancePackId": {
"Description": "The ID of the compliance pack id. ",
"Value": {
"Fn::GetAtt": [
"AggregateCompliancePack",
"CompliancePackId"
]
}
}
}
}