登录控制台
AWS CloudFormation
User Guide (API 版本 2010-05-15)
AWS 文档 » AWS CloudFormation » User Guide » 模板参考 » AWS 资源类型参考 » AWS::IAM::AccessKey
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异，请参阅中国的 AWS 服务入门。

AWS::IAM::AccessKey

AWS::IAM::AccessKey 资源类型用于生成秘密访问密钥，并将其分配到 IAM 用户或 AWS 账户。

此类型支持更新。有关更新堆栈的详细信息，请参阅 AWS CloudFormation 堆栈更新。

语法

要在 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

该值与 AWS CloudFormation 是一一对应的，并且只能递增。增加此值会告知 AWS CloudFormation 您要更换访问密钥。当您更新堆栈时，AWS CloudFormation 会以新的密钥替换现有访问密钥。

必需：否

类型：整数

更新要求：替换

Status

访问密钥的状态。默认情况下，AWS CloudFormation 将此属性值设置为 Active。

必需：否

类型：字符串

有效值：Active 或 Inactive

更新要求：无需中断

UserName

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

必需：是

类型：字符串

更新要求：替换

返回值

Ref

将此资源 ID 指定到内部 Ref 函数将返回 AccessKeyId。例如：AKIAIOSFODNN7EXAMPLE。

有关使用 Ref 功能的更多信息，请参阅参考。

Fn::GetAtt

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

SecretAccessKey

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

有关使用 Fn::GetAtt 的更多信息，请参见 Fn::GetAtt。

模板示例

要查看 AWS::IAM::AccessKey 代码段，请参阅 声明 IAM 访问密钥资源。