アカウントグループのコンプライアンスパッケージを作成する方法 - Resource Orchestration Service

ALIYUN::Config::AggregateCompliancePack は、アカウントグループのコンプライアンスパッケージを作成するために使用されます。

構文

{
  "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
  }
}

プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
AggregatorId	String	はい	はい	アカウントグループの ID です。	なし。
CompliancePackName	String	はい	はい	コンプライアンスパッケージの名前です。	なし。
ConfigRules	List	はい	はい	コンプライアンスパッケージ内のルールです。	詳細については、「ConfigRules プロパティ」をご参照ください。
Description	String	はい	はい	コンプライアンスパッケージの説明です。	なし。
RiskLevel	Integer	はい	はい	コンプライアンスパッケージのリスクレベルです。	有効な値: 1: 高 2: 中 3: 低
CompliancePackTemplateId	String	いいえ	いいえ	コンプライアンスパッケーテンプレートの ID です。	なし。
DefaultEnable	Boolean	いいえ	はい	コンプライアンスパッケージと一緒にルールを有効にするかどうかを指定します。	有効な値: true false (デフォルト)
ExcludeResourceIdsScope	List	いいえ	はい	コンプライアンスパッケージを使用して評価したくないリソースの ID です。	複数のリソース ID はコンマ (,) で区切ります。
RegionIdsScope	List	いいえ	はい	コンプライアンスパッケージを使用して評価するリソースが存在するリージョンの ID です。	複数のリージョン ID はコンマ (,) で区切ります。
ResourceGroupIdsScope	List	いいえ	はい	コンプライアンスパッケージを使用してリソースを評価するリソースグループの ID です。	複数のリソースグループ ID はコンマ (,) で区切ります。
TagKeyScope	String	いいえ	はい	コンプライアンスパッケージを使用して評価するリソースのタグキーです。	なし。
TagValueScope	String	いいえ	はい	コンプライアンスパッケージを使用して評価するリソースのタグ値です。	TagValueScope は TagKeyScope と一緒に指定する必要があります。
ResourceIdsScope	String	いいえ	いいえ	ルールが適用されるリソースの ID です。	複数のリソース ID はコンマ (,) で区切ります。
ExcludeRegionIdsScope	String	いいえ	いいえ	ルールによって実行されるコンプライアンス評価から除外されるリージョンの ID です。	複数のリージョン ID はコンマ (,) で区切ります。
TemplateContent	String	いいえ	いいえ	コンプライアンスパッケージの作成に使用されるテンプレートに関する情報です。	なし。
ExcludeResourceGroupIdsScope	String	いいえ	いいえ	ルールによって実行されるコンプライアンス評価から除外されるリソースグループの ID です。	複数のリソースグループ ID はコンマ (,) で区切ります。

ConfigRules 構文

"ConfigRules": [
  {
    "ConfigRuleId": String,
    "Description": String,
    "ConfigRuleName": String,
    "ManagedRuleIdentifier": String,
    "RiskLevel": Integer,
    "ConfigRuleParameters": List
  }
]

ConfigRules プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
RiskLevel	Integer	はい	はい	ルールに準拠していないリソースのリスクレベルです。	有効な値: 1: 高 2: 中 3: 低
ConfigRuleId	String	いいえ	はい	ルール ID です。	このプロパティを指定すると、Cloud Config は指定された ID のルールをコンプライアンスパッケージに追加します。 `ManagedRuleIdentifier` プロパティと `ConfigRuleId` プロパティのいずれか 1 つだけを指定する必要があります。両方のプロパティを指定した場合、`ConfigRuleId` プロパティの値が優先されます。
ConfigRuleName	String	いいえ	はい	ルール名です。	なし。
ConfigRuleParameters	List	いいえ	はい	ルールの入力パラメーターです。	詳細については、「ConfigRuleParameters プロパティ」をご参照ください。
Description	String	いいえ	はい	ルールの説明です。	なし。
ManagedRuleIdentifier	String	いいえ	はい	マネージドルールの識別子です。	Cloud Config は、指定された識別子に基づいてマネージドルールを自動的に作成し、そのルールをコンプライアンスパッケージに追加します。 `ManagedRuleIdentifier` プロパティと `ConfigRuleId` プロパティのいずれか 1 つだけを指定する必要があります。両方のプロパティを指定した場合、`ConfigRuleId` プロパティの値が優先されます。

ConfigRuleParameters 構文

"ConfigRuleParameters": [
  {
    "ParameterValue": String,
    "ParameterName": String
  }
]

ConfigRuleParameters プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
ParameterValue	String	はい	はい	入力パラメーターの値です。	`ParameterName` プロパティと `ParameterValue` プロパティを指定するか、両方のプロパティを空のままにする必要があります。管理対象ルールが入力パラメーターで構成されていて、デフォルト値がない場合は、ParameterValue を指定する必要があります。
ParameterName	String	はい	はい	入力パラメーターの名前です。	`ParameterName` プロパティと `ParameterValue` プロパティを指定するか、両方のプロパティを空のままにする必要があります。管理対象ルールが入力パラメーターで構成されていて、デフォルト値が設定されていない場合は、ParameterName を指定する必要があります。

戻り値

Fn::GetAtt

CompliancePackId: コンプライアンスパッケージの ID です。

例

`YAML` 形式

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  AggregatorId:
    Description:
      ja: アグリゲーター ID。
    Required: true
    Type: String
  CompliancePackName:
    Description:
      ja: コンプライアンスパッケージ名。
    Required: true
    Type: String
  CompliancePackTemplateId:
    Description:
      ja: コンプライアンスパッケー テンプレート ID。
    Required: false
    Type: String
  ConfigRules:
    AssociationProperty: List[Parameter]
    AssociationPropertyMetadata:
      Parameter:
        AssociationPropertyMetadata:
          Parameters:
            ConfigRuleId:
              Description:
                ja: ルール ID。既存のルールを現在のコンプライアンスパッケージに追加するには、監査を構成します。ManagedRuleIdentifier と ConfigRuleId のいずれかを選択します。両方のパラメーターが設定されている場合、ConfigRuleId が正しいパラメーターです。
              Required: false
              Type: String
            ConfigRuleName:
              Description:
                ja: 設定ルールの名前。
              Required: false
              Type: String
            ConfigRuleParameters:
              AssociationProperty: List[Parameters]
              AssociationPropertyMetadata:
                Parameters:
                  ParameterName:
                    Description:
                      ja: パラメーターの名前。
                    Required: true
                    Type: String
                  ParameterValue:
                    Description:
                      ja: パラメーターの値。
                    Required: true
                    Type: String
              Required: false
              Type: Json
            Description:
              AssociationProperty: TextArea
              Description:
                ja: 設定ルールの説明。
              Required: false
              Type: String
            ManagedRuleIdentifier:
              Description:
                ja: マネージドルール ID。マネージドルール ID に基づいてルールを自動的に作成し、現在のコンプライアンスパッケージにルールを追加するには、監査を構成します。ManagedRuleIdentifier と ConfigRuleId のいずれかを選択します。両方のパラメーターが設定されている場合、ConfigRuleId が正しいパラメーターです。
              Required: false
              Type: String
            RiskLevel:
              AllowedValues:
              - 1
              - 2
              - 3
              Description:
                ja: ルールリスクレベル。値：\n\n1: 高リスク。\n\n2: 中リスク。\n\n3: 低リスク。
              Required: true
              Type: Number
        Required: false
        Type: Json
    Description:
      ja: コンプライアンスパッケージ内のルールのリスト。
    MinLength: 1
    Required: true
    Type: Json
  DefaultEnable:
    Description:
      ja: ルールがクイックアクティベーションをサポートするかどうか。値：\n\ntrue: コンプライアンスパッケージがすばやく有効になると、このルールが有効になります。\n\nfalse (デフォルト): 無効
    Required: false
    Type: Boolean
  Description:
    AssociationProperty: TextArea
    Description:
      ja: コンプライアンスパックの説明。
    Required: true
    Type: String
  ExcludeResourceIdsScope:
    AssociationProperty: List[Parameter]
    AssociationPropertyMetadata:
      Parameter:
        Description:
          ja: リソース ID。
        Required: false
        Type: String
    Description:
      ja: コンプライアンスパッケージは、指定されたリソース ID では無効です。つまり、リソースに対して評価は実行されません。
    Required: false
    Type: Json
  RegionIdsScope:
    AssociationProperty: List[Parameter]
    AssociationPropertyMetadata:
      Parameter:
        Description:
          ja: リージョン ID。
        Required: false
        Type: String
    Description:
      ja: コンプライアンスパッケージは、指定されたリージョン ID 内のリソースに対してのみ有効です。
    Required: false
    Type: Json
  ResourceGroupIdsScope:
    AssociationProperty: List[Parameter]
    AssociationPropertyMetadata:
      Parameter:
        Description:
          ja: リソースグループ ID。
        Required: false
        Type: String
    Description:
      ja: コンプライアンスパッケージは、指定されたリソースグループ ID 内のリソースに対してのみ有効です。
    Required: false
    Type: Json
  RiskLevel:
    AllowedValues:
    - 1
    - 2
    - 3
    Description:
      ja: コンプライアンスパッケージのリスクレベル。値：\n\n1: 高リスク。\n\n2: 中リスク。\n\n3: 低リスク。
    Required: true
    Type: Number
  TagKeyScope:
    Description:
      ja: コンプライアンスパッケージは、指定されたタグキーにバインドされているリソースに対してのみ有効です。
    Required: false
    Type: String
  TagValueScope:
    Description:
      ja: コンプライアンスパッケージは、指定されたタグキーと値のペアにバインドされているリソースに対してのみ有効です。TagValueScope は 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: 'コンプライアンスパック ID の ID。'
    Value:
      Fn::GetAtt:
      - AggregateCompliancePack
      - CompliancePackId

`JSON` 形式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "TagKeyScope": {
      "Type": "String",
      "Description": {
        "ja": "コンプライアンスパッケージは、指定されたタグキーにバインドされているリソースに対してのみ有効です。"
      },
      "Required": false
    },
    "TagValueScope": {
      "Type": "String",
      "Description": {
        "ja": "コンプライアンスパッケージは、指定されたタグキーと値のペアにバインドされているリソースに対してのみ有効です。TagValueScope は TagKeyScope と組み合わせて使用する必要があります。"
      },
      "Required": false
    },
    "Description": {
      "AssociationProperty": "TextArea",
      "Type": "String",
      "Description": {
        "ja": "コンプライアンスパックの説明。"
      },
      "Required": true
    },
    "CompliancePackName": {
      "Type": "String",
      "Description": {
        "ja": "コンプライアンスパッケージ名。"
      },
      "Required": true
    },
    "ExcludeResourceIdsScope": {
      "AssociationPropertyMetadata": {
        "Parameter": {
          "Type": "String",
          "Description": {
            "ja": "リソース ID。"
          },
          "Required": false
        }
      },
      "AssociationProperty": "List[Parameter]",
      "Type": "Json",
      "Description": {
        "ja": "コンプライアンスパッケージは、指定されたリソース ID では無効です。つまり、リソースに対して評価は実行されません。"
      },
      "Required": false
    },
    "RegionIdsScope": {
      "AssociationPropertyMetadata": {
        "Parameter": {
          "Type": "String",
          "Description": {
            "ja": "リージョン ID。"
          },
          "Required": false
        }
      },
      "AssociationProperty": "List[Parameter]",
      "Type": "Json",
      "Description": {
        "ja": "コンプライアンスパッケージは、指定されたリージョン ID 内のリソースに対してのみ有効です。"
      },
      "Required": false
    },
    "ResourceGroupIdsScope": {
      "AssociationPropertyMetadata": {
        "Parameter": {
          "Type": "String",
          "Description": {
            "ja": "リソースグループ ID。"
          },
          "Required": false
        }
      },
      "AssociationProperty": "List[Parameter]",
      "Type": "Json",
      "Description": {
        "ja": "コンプライアンスパッケージは、指定されたリソースグループ ID 内のリソースに対してのみ有効です。"
      },
      "Required": false
    },
    "ConfigRules": {
      "AssociationPropertyMetadata": {
        "Parameter": {
          "AssociationPropertyMetadata": {
            "Parameters": {
              "ConfigRuleId": {
                "Type": "String",
                "Description": {
                  "ja": "ルール ID。既存のルールを現在のコンプライアンスパッケージに追加するには、監査を構成します。ManagedRuleIdentifier と ConfigRuleId のいずれかを選択します。両方のパラメーターが設定されている場合、ConfigRuleId が正しいパラメーターです。"
                },
                "Required": false
              },
              "Description": {
                "AssociationProperty": "TextArea",
                "Type": "String",
                "Description": {
                  "ja": "設定ルールの説明。"
                },
                "Required": false
              },
              "ConfigRuleName": {
                "Type": "String",
                "Description": {
                  "ja": "設定ルールの名前。"
                },
                "Required": false
              },
              "ManagedRuleIdentifier": {
                "Type": "String",
                "Description": {
                  "ja": "マネージドルール ID。マネージドルール ID に基づいてルールを自動的に作成し、現在のコンプライアンスパッケージにルールを追加するには、監査を構成します。ManagedRuleIdentifier と ConfigRuleId のいずれかを選択します。両方のパラメーターが設定されている場合、ConfigRuleId が正しいパラメーターです。"
                },
                "Required": false
              },
              "RiskLevel": {
                "Type": "Number",
                "Description": {
                  "ja": "ルールリスクレベル。値：\n1: 高リスク。\n2: 中リスク。\n3: 低リスク。"
                },
                "AllowedValues": [
                  1,
                  2,
                  3
                ],
                "Required": true
              },
              "ConfigRuleParameters": {
                "AssociationPropertyMetadata": {
                  "Parameters": {
                    "ParameterValue": {
                      "Type": "String",
                      "Description": {
                        "ja": "パラメーターの値。"
                      },
                      "Required": true
                    },
                    "ParameterName": {
                      "Type": "String",
                      "Description": {
                        "ja": "パラメーターの名前。"
                      },
                      "Required": true
                    }
                  }
                },
                "AssociationProperty": "List[Parameters]",
                "Type": "Json",
                "Required": false
              }
            }
          },
          "Type": "Json",
          "Required": false
        }
      },
      "AssociationProperty": "List[Parameter]",
      "Type": "Json",
      "Description": {
        "ja": "コンプライアンスパッケージ内のルールのリスト。"
      },
      "Required": true,
      "MinLength": 1
    },
    "CompliancePackTemplateId": {
      "Type": "String",
      "Description": {
        "ja": "コンプライアンスパッケー テンプレート ID。"
      },
      "Required": false
    },
    "RiskLevel": {
      "Type": "Number",
      "Description": {
        "ja": "コンプライアンスパッケージのリスクレベル。値：\n1: 高リスク。\n2: 中リスク。\n3: 低リスク。"
      },
      "AllowedValues": [
        1,
        2,
        3
      ],
      "Required": true
    },
    "DefaultEnable": {
      "Type": "Boolean",
      "Description": {
        "ja": "ルールがクイックアクティベーションをサポートするかどうか。値：\ntrue: コンプライアンスパッケージがすばやく有効になると、このルールが有効になります。\nfalse (デフォルト): 無効"
      },
      "Required": false
    },
    "AggregatorId": {
      "Type": "String",
      "Description": {
        "ja": "アグリゲーター 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": "コンプライアンスパック ID の ID。",
      "Value": {
        "Fn::GetAtt": [
          "AggregateCompliancePack",
          "CompliancePackId"
        ]
      }
    }
  }
}

構文

プロパティ

ConfigRules 構文

ConfigRules プロパティ

ConfigRuleParameters 構文

ConfigRuleParameters プロパティ

戻り値

例

YAML 形式

JSON 形式

`YAML` 形式

`JSON` 形式