AWS::IAM::Group - AWS CloudFormation

AWS::IAM::Group

新しいグループを作成します。

作成できるグループ数については、IAM ユーザーガイドの「IAM エンティティに関する制限事項」を参照してください。

構文

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

JSON

{ "Type" : "AWS::IAM::Group", "Properties" : { "GroupName" : String, "ManagedPolicyArns" : [ String, ... ], "Path" : String, "Policies" : [ Policy, ... ] } }

YAML

Type: AWS::IAM::Group Properties: GroupName: String ManagedPolicyArns: - String Path: String Policies: - Policy

プロパティ

GroupName

作成するグループの名前。この値にパスを含めないでください。

グループ名はアカウント内で一意である必要があります。グループ名は大文字と小文字が区別されません。たとえば、「ADMINS」と「admins」の両方の名前のグループを作成することはできません。名前を指定しない場合、AWS CloudFormation は一意の物理 ID を生成し、その ID をグループ名として使用します。

重要

名前を指定すると、このリソースの置換が必要な更新はできません。中断が不要であるか、一定の中断が必要な更新であれば、行うことができます。リソースを置き換える必要がある場合は、新しい名前を指定します。

名前を指定した場合、テンプレートの機能を承認するために CAPABILITY_NAMED_IAM 値を指定する必要があります。詳細については、「AWS CloudFormation テンプレートの IAM リソースの承認」を参照してください。

重要

IAM リソースに名前を付けると、複数のリージョンで同じテンプレートを再利用した場合に、回復不能なエラーが発生する場合があります。これを防止するために、Fn::JoinAWS::Region を使用して、次の例のように地域固有の名前を作成することをお勧めします (例 {"Fn::Join": ["", [{"Ref": "AWS::Region"}, {"Ref": "MyResourceName"}]]})。

必須: いいえ

タイプ: 文字列

Update requires: Replacement

ManagedPolicyArns

アタッチする IAM ポリシーの Amazon リソースネーム (ARN)。

ARN の詳細については、AWS 全般のリファレンスの「Amazon リソースネーム (ARN) および AWS のサービスの名前空間」を参照してください。

必須: いいえ

タイプ: 文字列のリスト

Update requires: No interruption

Path

グループへのパス。パスの詳細については、IAM ユーザーガイドの「IAM Identifiers」を参照してください。

このパラメータはオプションです。含まれていない場合は、デフォルトのスラッシュ (/) になります。

このパラメータは、(正規表現パターンを通して) でスラッシュ (/) 単独からなる文字列か、あるいはスラッシュで始めてスラッシュで終わりでなければならない文字列のいずれか可能です。さらに、ほとんどの句読文字、数字、大文字および小文字を含む、! (\u0021) から DEL 文字 (\u007F) までの ASCII 文字を使用できます。

必須: いいえ

タイプ: 文字列

最小: 1

最大: 512

パターン: (\u002F)|(\u002F[\u0021-\u007F]+\u002F)

Update requires: No interruption

Policies

指定の IAM グループに埋め込まれたインラインポリシードキュメントを追加または更新します。AWS::IAM::Group のスニペットを表示するには、「IAM グループリソースの宣言」を参照してください。

重要

ロール、ユーザー、またはグループの各インラインポリシー名は一意である必要があります。一意の名前を選択しない場合、IAM ID の更新は失敗します。

グループに埋め込むことができるインラインポリシー数の制限については、IAM ユーザーガイドの「IAM エンティティに関する制限事項」を参照してください。

必須: いいえ

タイプ: ポリシーのリスト

Update requires: No interruption

戻り値

参照番号

このリソースの論理 ID を組み込みの Ref 関数に渡すと、Ref は次を返します: GroupName。例: mystack-mygroup-1DZETITOWEKVO

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

Fn::GetAtt

Fn::GetAtt 組み込み関数は、このタイプの指定された属性の値を返します。以下には、利用可能な属性とサンプル戻り値のリストが示されます。

Fn::GetAtt 組み込み関数の使用方法の詳細については、「Fn::GetAtt」を参照してください。

Arn

指定された AWS::IAM::Group リソースの Amazon リソースネーム (ARN) を返します。例: arn:aws:iam::123456789012:group/mystack-mygroup-1DZETITOWEKVO

グループ

この例では、「MyGroup」という名前のグループを作成します。

JSON

{ "AWSTemplateFormatVersion": "2010-09-09", "Resources": { "MyGroup" : { "Type" : "AWS::IAM::Group" } } }

YAML

AWSTemplateFormatVersion: '2010-09-09' Resources: MyGroup: Type: AWS::IAM::Group

以下の資料も参照してください。