AWS::IAM::User - AWS CloudFormation

AWS::IAM::User

AWS アカウント用に新しい IAM ユーザーを作成します。

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

構文

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

JSON

{ "Type" : "AWS::IAM::User", "Properties" : { "Groups" : [ String, ... ], "LoginProfile" : LoginProfile, "ManagedPolicyArns" : [ String, ... ], "Path" : String, "PermissionsBoundary" : String, "Policies" : [ Policy, ... ], "Tags" : [ Tag, ... ], "UserName" : String } }

YAML

Type: AWS::IAM::User Properties: Groups: - String LoginProfile: LoginProfile ManagedPolicyArns: - String Path: String PermissionsBoundary: String Policies: - Policy Tags: - Tag UserName: String

プロパティ

Groups

ユーザーを追加するグループのリスト。

必須: いいえ

タイプ: 文字列のリスト

Update requires: No interruption

LoginProfile

指定されたユーザーのパスワードを作成し、そのユーザーが AWS マネジメントコンソールを使用して AWS のサービスにアクセスできるようにします。パスワードの管理の詳細については、IAM ユーザーガイドの「パスワードの管理」を参照してください。

必須: いいえ

タイプ: LoginProfile

Update requires: No interruption

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

PermissionsBoundary

ユーザーのアクセス許可の境界を設定するために使用するポリシーの ARN。

必須: いいえ

タイプ: 文字列

Update requires: No interruption

Policies

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

重要

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

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

必須: いいえ

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

Update requires: No interruption

Tags

新しく作成されたユーザーにアタッチするタグのリスト。各タグは、キー名と関連する値で構成されます。タグ付けの詳細については、「IAM ユーザーガイド 」の「IAM アイデンティティのタグ付け」を参照してください。

注記

タグのいずれかが無効である場合、またはユーザーあたりのタグの許容数を超える場合、リクエスト全体が失敗し、ユーザーは作成されません。

必須: いいえ

タイプ: Tag のリスト

最大: 50

Update requires: No interruption

UserName

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

このパラメータは、(正規表現パターンに従い) スペースを含まない大文字と小文字の英数字からなる文字列を使用できます。以下の _+=,.@- の文字を含めることもできます。ユーザー名はアカウント内で一意である必要があります。ユーザー名は大文字と小文字が区別されません。たとえば、「John」と「john」の両方の名前のユーザーを作成することはできません。

名前を指定しない場合、AWS CloudFormation は一意の物理 ID を生成し、その ID をユーザー名として使用します。

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

重要

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

必須: いいえ

タイプ: 文字列

Update requires: Replacement

戻り値

参照番号

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

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

Fn::GetAtt

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

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

Arn

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

User

この例では、「MyUser」という名前のユーザーを作成します。

JSON

{ "AWSTemplateFormatVersion": "2010-09-09", "Resources" : { "MyUser" : { "Type" : "AWS::IAM::User", "Properties" : { "LoginProfile": { "Password": { "Ref" : "MyPassword" } } } } } }

YAML

AWSTemplateFormatVersion: '2010-09-09' Resources: MyUser: Type: AWS::IAM::User Properties: LoginProfile: Password: Ref: MyPassword

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