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

AWS::EventSchemas::Schema

可以使用 AWS::EventSchemas::Schema 资源指定事件架构。

语法

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

JSON

{ "Type" : "AWS::EventSchemas::Schema", "Properties" : { "Content" : String, "Description" : String, "RegistryName" : String, "SchemaName" : String, "Tags" : [ TagsEntry, ... ], "Type" : String } }

YAML

Type: AWS::EventSchemas::Schema Properties: Content: String Description: String RegistryName: String SchemaName: String Tags: - TagsEntry Type: String

属性

Content

架构定义源。

必需:是

类型:字符串

Update requires: No interruption

Description

架构描述。

必需:否

类型:字符串

Update requires: No interruption

RegistryName

注册表的名称。

必需:是

类型:字符串

Update requires: Replacement

SchemaName

架构的名称。

必需:否

类型:字符串

Update requires: Replacement

Tags

与架构关联的标签。

必需:否

类型TagsEntry 列表

Update requires: No interruption

Type

架构的类型。

必需:是

类型:字符串

Update requires: No interruption

返回值

Ref

在向 Ref 内部函数提供该资源的逻辑 ID 时,Ref 返回架构的 ARN。例如:

{ "Ref": "MySchema" }

返回与以下值类似的值:

arn:aws:schemas:us-east-1:012345678901:schema/MyRegistry/MySchema

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

Fn::GetAtt

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

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

SchemaArn

架构的 ARN。

SchemaName

架构的名称。

SchemaVersion

架构的版本号。

示例

YAML

Resources: ExecutionStatusChangeSchema: Type: AWS::EventSchemas::Schema Properties:Ref Registry: 'aws.events' Name: ExecutionStatusChange Description: 'event emitted when the status of a state machine execution change' Type: OpenApi3 Content: > { "openapi": "3.0.0", "info": { "version": "1.0.0", "title": "StepFunctionsExecutionStatusChange" }, "components": { "schemas": { "StepFunctionsExecutionStatusChange": { "type": "object", "required": [ "output", "input", "executionArn", "name", "stateMachineArn", "startDate", "stopDate", "status" ], "properties": { "output": {"type": "string","nullable": true}, "input": {"type": "string"}, "executionArn": {"type": "string"}, "name": {"type": "string"}, "stateMachineArn": {"type": "string"}, "startDate": {"type": "integer","format": "int64"}, "stopDate": {"type": "integer","format": "int64","nullable": true}, "status": {"type": "string","enum": [ "FAILED", "RUNNING", "SUCCEEDED", "ABORTED" ]} } } } } }