メニュー
AWS CloudFormation
ユーザーガイド (API Version 2010-05-15)

AWS::IAM::Group

AWS::IAM::Group リソースは、AWS Identity and Access Management (IAM) グループを作成します。

このタイプは更新をサポートしています。スタックの更新の詳細については、「AWS CloudFormation スタックの更新」を参照してください。

構文

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

JSON

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

YAML

Copy
Type: "AWS::IAM::Group" Properties: GroupName: String ManagedPolicyArns: [ String, ... ] Path: String Policies: - Policies

プロパティ

GroupName

IAM グループの名前。有効な値については、IAM API リファレンスCreateGroup アクションの GroupName パラメーターを参照してください。名前を指定しない場合、AWS CloudFormation は一意の物理 ID を生成し、その ID をグループ名として使用します。

重要

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

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

警告

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

必須: いいえ

Type: String

更新に伴う要件: 置換

ManagedPolicyArns

このグループにアタッチする 1 つ以上の管理ポリシー。

Required: No

Type: List of String values

更新に伴う要件: 中断はありません。

Path

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

Required: No

Type: String

更新に伴う要件: 中断はありません。

Policies

このグループに関連付けるポリシーです。ポリシーの詳細については、IAM ユーザーガイド の「IAM ポリシーの概要」を参照してください。

Required: No

: IAM ポリシー のリスト

更新に伴う要件: 中断はありません。

戻り値

参照番号

組み込み Ref 関数にこのリソース ID を指定すると、GroupName が返されます。例: mystack-mygroup-1DZETITOWEKVO

Ref 関数の使用方法の詳細については、「Ref」を参照してください。

Fn::GetAtt

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

Arn

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

Fn::GetAtt の使用の詳細については、「Fn::GetAtt」を参照してください。

テンプレートの例

AWS::IAM::Group のスニペットについては、「IAM グループ リソースの宣言」を参照してください。