ALIYUN::KAFKA::Acl による Kafka トピックアクセス制御の強制 - ROS

ALIYUN::KAFKA::Acl は、アクセス制御リスト (ACL) を作成するために使用されます。

構文

{
  "Type": "ALIYUN::KAFKA::Acl",
  "Properties": {
    "AclResourceName": String,
    "AclOperationTypes": List,
    "AclResourceType": String,
    "AclResourcePatternType": String,
    "InstanceId": String,
    "Username": String,
    "AclPermissionType": String,
    "Host": String
  }
}

プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
AclResourceName	String	はい	いいえ	リソース名。	値には、トピック名、グループ ID、クラスタ名、またはトランザクション ID を指定できます。アスタリスク () を使用して、指定したタイプのすべてのリソースを指定できます。説明すべてのリソースに必要な権限を付与した後でのみ、アスタリスク () を使用して承認されたリソースをクエリできます。
AclOperationTypes	List	はい	いいえ	許可される操作。	複数の操作はカンマ (,) で区切ります。有効な値: Write: 書き込み。 Read: 読み取り。 Describe: トランザクション ID の読み取り。 IdempotentWrite: クラスタへの冪等データ書き込み。 IDEMPOTENT_WRITE: クラスタへの冪等データ書き込み。この値は、ApsaraMQ for Kafka V3 インスタンスでのみ使用できます。 DESCRIBE_CONFIGS: 構成のクエリ。この値は、ApsaraMQ for Kafka V3 インスタンスでのみ使用できます。説明このプロパティは、サーバーレス ApsaraMQ for Kafka V3 インスタンスでのみ使用できます。
AclResourceType	String	はい	いいえ	リソースタイプ。	有効な値: Topic: トピック Group: コンシューマーグループ Cluster: クラスタ TransactionalId: トランザクション ID
AclResourcePatternType	String	はい	いいえ	マッチングモード。	有効な値: LITERAL: 完全一致 PREFIXED: プレフィックス一致
InstanceId	String	はい	いいえ	インスタンス ID。	なし。
Username	String	はい	いいえ	ユーザー名。	アスタリスク () を使用して、すべてのユーザー名を指定できます。説明すべてのユーザーに必要な権限を付与した後でのみ、アスタリスク () を使用して承認済みユーザーをクエリできます。
AclPermissionType	String	いいえ	いいえ	認証タイプ。	有効な値: DENY ALLOW 説明このプロパティは、サーバーレス ApsaraMQ for Kafka V3 インスタンスでのみ使用できます。
Host	String	いいえ	いいえ	ソース IP アドレス。	説明特定の IP アドレスのみを指定するか、アスタリスク (*) を使用してすべての IP アドレスを指定できます。CIDR ブロックはサポートされていません。このプロパティは、サーバーレス ApsaraMQ for Kafka V3 インスタンスでのみ使用できます。

戻り値

Fn::GetAtt

InstanceId: インスタンス ID。
Username: ユーザー名。
AclResourceType: リソースタイプ。

例

YAML フォーマット

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  AclResourceName:
    Type: String
    Description:
      ja: |-
        リソース名。
        値には、トピック名、グループID、クラスタ名、またはトランザクションIDを指定できます。
        アスタリスク (*) を使用して、指定したタイプのすべてのリソースの名前を指定できます。
        注:  すべてのリソースに必要な権限をユーザーに付与した後でのみ、アスタリスク (*) を使用して権限が付与されているリソースをクエリできます。
    Required: true
    MinLength: 1
    MaxLength: 256
  AclOperationTypes:
    AssociationPropertyMetadata:
      Parameter:
        Type: String
        Description:
          ja: |-
            アクセス制御リスト (ACL) で許可される操作のタイプ。有効な値:
            Write
            Read
            Describe: トランザクションIDの読み取り。
            IdempotentWrite: クラスタへの冪等データ書き込み。
            IDEMPOTENT_WRITE: クラスタへの冪等データ書き込み。この値は、ApsaraMQ for Kafka V3 インスタンスでのみ使用できます。
        AllowedValues:
          - Write
          - Read
          - Describe
          - IdempotentWrite
          - IDEMPOTENT_WRITE
          - DESCRIBE_CONFIGS
        Required: true
    AssociationProperty: List[Parameter]
    Type: Json
    Description:
      ja: ACL で許可される操作のタイプ。
    Required: true
    MinLength: 1
    MaxLength: 10
  Username:
    Type: String
    Description:
      ja: |-
        ユーザー名。
        アスタリスク (*) を使用して、すべてのユーザー名を指定できます。
        注: すべてのユーザーに必要な権限を付与した後でのみ、アスタリスク (*) を使用して承認済みユーザーをクエリできます。
    AllowedPattern: ^[a-zA-Z][a-zA-Z0-9_]{2,63}$
    Required: true
  InstanceId:
    Type: String
    Description:
      ja: インスタンスID。
    Required: true
    MinLength: 1
    MaxLength: 64
  AclResourceType:
    Type: String
    Description:
      ja: |-
        リソースタイプ。有効な値:
        Topic
        Group
        Cluster
        TransactionalId: トランザクションID
    AllowedValues:
      - Cluster
      - Group
      - Topic
      - TransactionalId
    Required: true
  AclResourcePatternType:
    Type: String
    Description:
      ja: |-
        マッチングモード。有効な値:
        LITERAL: 完全一致
        PREFIXED: プレフィックス一致
    AllowedValues:
      - LITERAL
      - PREFIXED
    Required: true
Resources:
  Acl:
    Type: ALIYUN::KAFKA::Acl
    Properties:
      AclResourceName:
        Ref: AclResourceName
      AclOperationTypes:
        Ref: AclOperationTypes
      Username:
        Ref: Username
      InstanceId:
        Ref: InstanceId
      AclResourceType:
        Ref: AclResourceType
      AclResourcePatternType:
        Ref: AclResourcePatternType
Outputs:
  InstanceId:
    Description: インスタンス ID。
    Value:
      Fn::GetAtt:
        - Acl
        - InstanceId
  Username:
    Description: ユーザー名。
    Value:
      Fn::GetAtt:
        - Acl
        - Username
  AclResourceType:
    Description: リソースタイプ。
    Value:
      Fn::GetAtt:
        - Acl
        - AclResourceType

JSON フォーマット

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "AclResourceName": {
      "Type": "String",
      "Description": {
        "ja": "リソース名。\n値には、トピック名、グループ ID、クラスタ名、またはトランザクション ID を指定できます。\nアスタリスク (*) を使用して、指定したタイプのすべてのリソースの名前を指定できます。\n注: すべてのリソースに必要な権限をユーザーに付与した後でのみ、アスタリスク (*) を使用して権限が付与されているリソースをクエリできます。"
      },
      "Required": true,
      "MinLength": 1,
      "MaxLength": 256
    },
    "AclOperationTypes": {
      "AssociationPropertyMetadata": {
        "Parameter": {
          "Type": "String",
          "Description": {
            "ja": "アクセス制御リスト (ACL) で許可される操作のタイプ。有効な値:\nWrite\nRead\nDescribe: トランザクション ID の読み取り。\nIdempotentWrite: クラスタへの冪等データ書き込み。\nIDEMPOTENT_WRITE: クラスタへの冪等データ書き込み。この値は、ApsaraMQ for Kafka V3 インスタンスでのみ使用できます。"
          },
          "AllowedValues": [
            "Write",
            "Read",
            "Describe",
            "IdempotentWrite",
            "IDEMPOTENT_WRITE",
            "DESCRIBE_CONFIGS"
          ],
          "Required": true
        }
      },
      "AssociationProperty": "List[Parameter]",
      "Type": "Json",
      "Description": {
        "ja": "ACL で許可される操作のタイプ。"
      },
      "Required": true,
      "MinLength": 1,
      "MaxLength": 10
    },
    "Username": {
      "Type": "String",
      "Description": {
        "ja": "ユーザー名。\nアスタリスク (*) を使用して、すべてのユーザー名を指定できます。\n注: すべてのユーザーに必要な権限を付与した後でのみ、アスタリスク (*) を使用して承認済みユーザーをクエリできます。"
      },
      "AllowedPattern": "^[a-zA-Z][a-zA-Z0-9_]{2,63}$",
      "Required": true
    },
    "InstanceId": {
      "Type": "String",
      "Description": {
        "ja": "インスタンス ID。"
      },
      "Required": true,
      "MinLength": 1,
      "MaxLength": 64
    },
    "AclResourceType": {
      "Type": "String",
      "Description": {
        "ja": "リソースタイプ。有効な値:\nTopic\nGroup\nCluster\nTransactionalId: トランザクション ID"
      },
      "AllowedValues": [
        "Cluster",
        "Group",
        "Topic",
        "TransactionalId"
      ],
      "Required": true
    },
    "AclResourcePatternType": {
      "Type": "String",
      "Description": {
        "ja": "マッチングモード。有効な値:\nLITERAL: 完全一致\nPREFIXED: プレフィックス一致"
      },
      "AllowedValues": [
        "LITERAL",
        "PREFIXED"
      ],
      "Required": true
    }
  },
  "Resources": {
    "Acl": {
      "Type": "ALIYUN::KAFKA::Acl",
      "Properties": {
        "AclResourceName": {
          "Ref": "AclResourceName"
        },
        "AclOperationTypes": {
          "Ref": "AclOperationTypes"
        },
        "Username": {
          "Ref": "Username"
        },
        "InstanceId": {
          "Ref": "InstanceId"
        },
        "AclResourceType": {
          "Ref": "AclResourceType"
        },
        "AclResourcePatternType": {
          "Ref": "AclResourcePatternType"
        }
      }
    }
  },
  "Outputs": {
    "InstanceId": {
      "Description": "インスタンス ID。",
      "Value": {
        "Fn::GetAtt": [
          "Acl",
          "InstanceId"
        ]
      }
    },
    "Username": {
      "Description": "ユーザー名。",
      "Value": {
        "Fn::GetAtt": [
          "Acl",
          "Username"
        ]
      }
    },
    "AclResourceType": {
      "Description": "リソースタイプ。",
      "Value": {
        "Fn::GetAtt": [
          "Acl",
          "AclResourceType"
        ]
      }
    }
  }
}