AWS::IAM::AccessKey - AWS CloudFormation
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 AWS 服务入门

AWS::IAM::AccessKey

为指定用户创建新的 AWS 秘密访问密钥和对应的 AWS 访问密钥 ID。新密钥的默认状态为 Active

如果不指定用户名,则 IAM 会根据对请求进行签名的 AWS 访问密钥 ID 隐式确定用户名。此操作适用于 AWS 账户下的访问密钥。因此,您可以使用此操作来管理 AWS 账户根用户凭证。即使 AWS 账户没有关联的用户也是如此。

有关可创建的密钥数的信息,请参阅 IAM 用户指南 中的 IAM 实体的限制

重要

为确保您的 AWS 账户的安全,仅在创建密钥和创建用户期间可访问私密访问密钥。若您希望能够再次访问密钥,则必须予以保存(例如,将其存入文本文件)。若私有密匙丢失,则可删除相关用户的访问密钥,然后创建新的密钥。

语法

要在 AWS CloudFormation 模板中声明此实体,请使用以下语法:

JSON

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

YAML

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

属性

Serial

此值特定于 CloudFormation 并且只能递增。增加此值会告知 CloudFormation 您要轮换访问密钥。当您更新堆栈时,CloudFormation 会以新的密钥替换现有访问密钥。

必需:否

类型:整数

Update requires: Replacement

Status

访问密钥的状态。Active 表示该密钥对 API 调用有效,而 Inactive 表示无效。

必需:否

类型:字符串

允许的值Active | Inactive

Update requires: No interruption

UserName

新密钥所属 IAM 用户的名称。

该参数允许(通过其正则表达式模式)使用由大小写字母数字字符组成的字符串(不包含空格)。此外,还可以包含以下任何字符:_+=,.@-

必需:是

类型:字符串

最低1

最高128

模式[\w+=,.@-]+

Update requires: Replacement

返回值

Ref

在将此资源的逻辑 ID 传递给内部 Ref 函数时,Ref 返回 AccessKeyId。例如:AKIAIOSFODNN7EXAMPLE

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

Fn::GetAtt

Fn::GetAtt 内部函数返回此类型的一个指定属性的值。以下为可用属性和示例返回值。

有关使用 Fn::GetAtt 内部函数的更多信息,请参阅 Fn::GetAtt

SecretAccessKey

返回指定 AWS::IAM::AccessKey 资源的私密访问密钥。例如:wJalrXUtnFEMI/K7MDENG/bPxRfiCYzEXAMPLEKEY。

示例

访问密钥

在该示例中,为名为“MyUser”的用户创建访问密钥。

JSON

{ "AWSTemplateFormatVersion": "2010-09-09", "Resources": { "CFNKeys" : { "Type" : "AWS::IAM::AccessKey", "Properties" : { "UserName" : { "Ref": "MyUser" } } } } }

YAML

AWSTemplateFormatVersion: '2010-09-09' Resources: CFNKeys: Type: AWS::IAM::AccessKey Properties: UserName: Ref: MyUser

另请参阅