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

AWS::IAM::AccessKey

AWS::IAM::AccessKey リソースタイプは、シークレットアクセスキーを生成して IAM ユーザーまたは AWS アカウントに割り当てます。

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

構文

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

JSON

Copy
{ "Type": "AWS::IAM::AccessKey", "Properties": { "Serial": Integer, "Status": String, "UserName": String } }

YAML

Copy
Type: "AWS::IAM::AccessKey" Properties: Serial: Integer Status: String UserName: String

プロパティ

Serial

これは AWS CloudFormation に固有の値であり、増分のみ可能となっています。この値をインクリメントすると、アクセスキーをローテーションする要望が AWS CloudFormation に通知されます。スタックを更新すると、AWS CloudFormation によって既存のアクセスキーが新しいキーに置き換えられます。

必須: いいえ

タイプ: 整数

更新に伴う要件: 置換

Status

アクセス キーのステータス。デフォルトでは、AWS CloudFormation はこのプロパティ値を Active に設定します。

必須: いいえ

タイプ: 文字列

有効な値: Active または Inactive

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

UserName

新しいキーが属するユーザーの名前。

必須: はい

タイプ: 文字列

更新に伴う要件: 置換

戻り値

参照番号

組み込み Ref 関数にこのリソース ID を指定すると、AccessKeyId が返されます。例: AKIAIOSFODNN7EXAMPLE

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

Fn::GetAtt

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

SecretAccessKey

指定された AWS::IAM::AccessKey リソースのシークレットアクセスキーを返します。例: wJalrXUtnFEMI/K7MDENG/bPxRfiCYzEXAMPLEKEY

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

テンプレートの例

AWS::IAM::AccessKey のスニペットについては、「IAM アクセスキーリソースの宣言」を参照してください。