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

AWS::ImageBuilder::ImagePipeline

映像管道是用于在 AWS 上构建安全的操作系统映像的自动化配置。映像生成器映像管道与一个映像配方相关联,该配方定义映像生成生命周期的生成、验证和测试阶段。映像管道可与定义映像构建位置的基础设施配置相关联。您可以定义一些属性,例如,实例类型、子网、安全组、日志记录以及其他基础设施相关配置。还可以将映像管道与分发配置相关联,以定义您希望如何部署映像。

语法

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

JSON

{ "Type" : "AWS::ImageBuilder::ImagePipeline", "Properties" : { "Description" : String, "DistributionConfigurationArn" : String, "EnhancedImageMetadataEnabled" : Boolean, "ImageRecipeArn" : String, "ImageTestsConfiguration" : ImageTestsConfiguration, "InfrastructureConfigurationArn" : String, "Name" : String, "Schedule" : Schedule, "Status" : String, "Tags" : {Key : Value, ...} } }

YAML

Type: AWS::ImageBuilder::ImagePipeline Properties: Description: String DistributionConfigurationArn: String EnhancedImageMetadataEnabled: Boolean ImageRecipeArn: String ImageTestsConfiguration: ImageTestsConfiguration InfrastructureConfigurationArn: String Name: String Schedule: Schedule Status: String Tags: Key : Value

属性

Description

此映像管道的描述。

必需:否

类型:字符串

最低1

最高1024

Update requires: No interruption

DistributionConfigurationArn

与此映像管道关联的分发配置的 Amazon 资源名称 (ARN)。

必需:否

类型:字符串

Update requires: No interruption

EnhancedImageMetadataEnabled

收集有关正在创建的映像的其他信息,包括操作系统 (OS) 版本和程序包列表。此信息用于增强使用 EC2 映像生成器的整体体验。默认情况下启用。

必需:否

类型:布尔值

Update requires: No interruption

ImageRecipeArn

与此映像管道关联的映像配方的 Amazon 资源名称 (ARN)。

必需:是

类型:字符串

Update requires: No interruption

ImageTestsConfiguration

创建此映像时使用的映像测试的配置。

必需:否

类型ImageTestsConfiguration

Update requires: No interruption

InfrastructureConfigurationArn

与此映像管道关联的基础设施配置的 Amazon 资源名称 (ARN)。

必需:是

类型:字符串

Update requires: No interruption

Name

映像管道的名称。

必需:是

类型:字符串

模式^[-_A-Za-z-0-9][-_A-Za-z0-9 ]{1,126}[-_A-Za-z-0-9]$

Update requires: Replacement

Schedule

映像管道的计划。计划用于配置管道自动创建新映像的频率和时间。

必需:否

类型计划

Update requires: No interruption

Status

映像管道的状态。

必需:否

类型:字符串

允许的值DISABLED | ENABLED

Update requires: No interruption

Tags

此映像管道的标签。

必需:否

类型:字符串的映射

Update requires: No interruption

返回值

Ref

在将此资源的逻辑 ID 传递给内部 Ref 函数时,Ref 返回 资源 ARN,如 arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/mywindows2016pipeline

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

Fn::GetAtt

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

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

Arn

返回映像管道的 Amazon 资源名称 (ARN)。例如:arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/mywindows2016pipeline

示例

创建映像管道

以下示例同时以 YAML 和 JSON 格式显示 ImagePipeline 资源文档的所有参数的架构。

YAML

Resources: ImagePipelineAllParameters: Type: 'AWS::ImageBuilder::ImagePipeline' Properties: Name: 'image-pipeline-name' Description: 'description' ImageRecipeArn: !Ref ImageRecipeArn InfrastructureConfigurationArn: !Ref InfrastructureConfigurationArn DistributionConfigurationArn: !Ref DistributionConfigurationArn ImageTestsConfiguration: ImageTestsEnabled: false TimeoutMinutes: 90 Schedule: ScheduleExpression: 'cron(0 0 * * 0)' PipelineExecutionStartCondition: 'EXPRESSION_MATCH_ONLY' Status: 'DISABLED' Tags: CustomerImagePipelineTagKey1: 'CustomerImagePipelineTagValue1' CustomerImagePipelineTagKey2: 'CustomerImagePipelineTagValue2'

JSON

{ "Resources": { "ImagePipelineAllParameters": { "Type": "AWS::ImageBuilder::ImagePipeline", "Properties": { "Name": "image-pipeline-name", "Description": "description", "ImageRecipeArn": { "Ref": "ImageRecipeArn" }, "InfrastructureConfigurationArn": { "Ref": "InfrastructureConfigurationArn" }, "DistributionConfigurationArn": { "Ref": "DistributionConfigurationArn" }, "ImageTestsConfiguration": { "ImageTestsEnabled": false, "TimeoutMinutes": 90 }, "Schedule": { "ScheduleExpression": "cron(0 0 * * 0)", "PipelineExecutionStartCondition": "EXPRESSION_MATCH_ONLY" }, "Status": "DISABLED", "Tags": { "CustomerImagePipelineTagKey1": "CustomerImagePipelineTagValue1", "CustomerImagePipelineTagKey2": "CustomerImagePipelineTagValue2" } } } } }