AWS::Config::ConfigurationRecorder

AWS::Config::ConfigurationRecorder リソースは、AWS Config がリソースの設定変更を記録する AWS リソースタイプを記述します。設定レコーダーは、サポートされるリソースの設定を設定項目としてアカウントに保存します。

注記

AWS Config を有効にするには、設定レコーダーと配信チャネルを作成する必要があります。AWS Config は配信チャネルを使用して、Amazon S3 バケットまたは Amazon SNS トピック に設定変更を配信します詳細については、「AWS::Config::DeliveryChannel」を参照してください。

AWS CloudFormation は、配信チャネルが利用可能になるとすぐにレコーダーを起動します。レコーダーを停止するには、スタックから設定レコーダーを削除します。詳細については、AWS Config 開発者ガイドの「設定レコーダー」を参照してください。

構文

AWS CloudFormation テンプレートでこのエンティティを宣言するには、次の構文を使用します。

JSON

{
  "Type" : "AWS::Config::ConfigurationRecorder",
  "Properties" : {
      "Name" : String,
      "RecordingGroup" : RecordingGroup,
      "RoleARN" : String
    }
}

YAML

Type: AWS::Config::ConfigurationRecorder
Properties: 
  Name: String
  RecordingGroup: 
    RecordingGroup
  RoleARN: String

プロパティ

Name

設定レコーダーの名前。名前を指定しない場合、AWS CloudFormation は一意の物理 ID を生成し、その ID を設定レコーダー名として使用します。詳細については、「Name タイプ」を参照してください。

注記

設定レコーダーを作成すると、その名前を変更することはできません。AWS CloudFormation により生成された名前を使用しない場合、このプロパティの値を指定します。

アップデートはサポートされていません。

必須: いいえ

タイプ: 文字列

最小: 1

最大: 256

Update requires: Replacement

RecordingGroup

サポートされるすべてのリソースまたはリソースタイプのリストの設定を記録するかどうかを示します。リストするリソースタイプは、AWS Config によりサポートされている必要があります。

必須: いいえ

タイプ: RecordingGroup

Update requires: No interruption

RoleARN

AWS Identity and Access Management (IAM) ロールの Amazon リソースネーム (ARN)。指定した配信チャネルに読み取りまたは書き込みリクエストを行い、サポートされている AWS リソースの設定の詳細を取得するために使用されます。詳細については、AWS Config 開発者ガイドの「割り当てられた IAM ロールのアクセス許可」を参照してください。

必須: はい

タイプ: 文字列

Update requires: No interruption

戻り値

参照番号

デフォルトなどの設定レコーダー名このリソースの論理 ID を組み込みの Ref 関数に渡すと、Ref は次を返します: 。

For more information about using the Ref function, see Ref.

例

設定レコーダー

次の例では、EC2 ボリュームの設定レコーダーを作成します。

JSON

"ConfigRecorder": {
  "Type": "AWS::Config::ConfigurationRecorder",
  "Properties": {
    "Name": "default",
    "RecordingGroup": {
      "ResourceTypes": ["AWS::EC2::Volume"]
    },
    "RoleARN": {"Fn::GetAtt": ["ConfigRole", "Arn"]}
  }
}

YAML

ConfigRecorder: 
  Type: AWS::Config::ConfigurationRecorder
  Properties: 
    Name: default
    RecordingGroup: 
      ResourceTypes: 
        - "AWS::EC2::Volume"
    RoleARN: 
      Fn::GetAtt: 
        - ConfigRole
        - Arn