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

AWS::AppSync::ApiKey

AWS::AppSync::ApiKey 资源创建一个唯一键,您可将该键分发给使用 AWS AppSync 并且需要 API 键来执行 GraphQL 操作的客户。

语法

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

JSON

{ "Type" : "AWS::AppSync::ApiKey", "Properties" : { "ApiId" : String, "Description" : String, "Expires" : Double } }

YAML

Type: AWS::AppSync::ApiKey Properties: ApiId: String Description: String Expires: Double

属性

ApiId

此 API 键的唯一 AWS AppSync GraphQL API ID。

必需:是

类型:字符串

Update requires: Replacement

Description

您的 API 键的唯一描述。

必需:否

类型:字符串

Update requires: No interruption

Expires

API 键的过期时间(以秒为单位且使用 Unix 纪元时间),最小值为 1 天,最大值为 365 天。默认值为 7 天。

必需:否

类型:双精度

Update requires: No interruption

返回值

Ref

如果将 AWS::AppSync::ApiKey 资源的逻辑 ID 传递给内部 Ref 函数,则该函数将返回 API 键的 ARN,如 arn:aws:appsync:us-east-1:123456789012:apis/graphqlapiid/apikey/apikeya1bzhi

有关使用 Ref 函数的更多信息,请参阅 Ref

Fn::GetAtt

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

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

ApiKey

API 键。

Arn

API 键的 Amazon 资源名称 (ARN),如 arn:aws:appsync:us-east-1:123456789012:apis/graphqlapiid/apikey/apikeya1bzhi

示例

API 键创建示例

以下示例创建一个 API 键并通过将 GraphQL API ID 作为参数传递来将该键与现有 GraphQL API 关联。

YAML

Parameters: graphQlApiId: Type: String apiKeyDescription: Type: String apiKeyExpires: Type: Number Resources: ApiKey: Type: AWS::AppSync::ApiKey Properties: ApiId: Ref: graphQlApiId Description: Ref: apiKeyDescription Expires: Ref: apiKeyExpires

JSON

{ "Parameters": { "graphQlApiId": { "Type": "String" }, "apiKeyDescription": { "Type": "String" }, "apiKeyExpires": { "Type": "Number" } }, "Resources": { "ApiKey": { "Type": "AWS::AppSync::ApiKey", "Properties": { "ApiId": { "Ref": "graphQlApiId" }, "Description": { "Ref": "apiKeyDescription" }, "Expires": { "Ref": "apiKeyExpires" } } } } }

另请参阅