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

AWS::ServiceCatalog::CloudFormationProvisionedProduct

预配置指定的产品。

预配置的产品是产品的资源实例。例如,预配置基于 CloudFormation 模板的产品会启动 CloudFormation 堆栈及其底层资源。您可以使用 DescribeRecord 查看此请求的状态。

如果请求包含一个带空值列表的标签键,则该键存在标签冲突。请不要包含冲突键作为标签,否则会导致出现错误“Parameter validation failed: Missing required parameter in Tags[N]:Value (参数验证失败: Tags[N]:Value 中缺少所需参数 )”。

语法

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

JSON

{ "Type" : "AWS::ServiceCatalog::CloudFormationProvisionedProduct", "Properties" : { "AcceptLanguage" : String, "NotificationArns" : [ String, ... ], "PathId" : String, "PathName" : String, "ProductId" : String, "ProductName" : String, "ProvisionedProductName" : String, "ProvisioningArtifactId" : String, "ProvisioningArtifactName" : String, "ProvisioningParameters" : [ ProvisioningParameter, ... ], "ProvisioningPreferences" : ProvisioningPreferences, "Tags" : [ Tag, ... ] } }

YAML

Type: AWS::ServiceCatalog::CloudFormationProvisionedProduct Properties: AcceptLanguage: String NotificationArns: - String PathId: String PathName: String ProductId: String ProductName: String ProvisionedProductName: String ProvisioningArtifactId: String ProvisioningArtifactName: String ProvisioningParameters: - ProvisioningParameter ProvisioningPreferences: ProvisioningPreferences Tags: - Tag

属性

AcceptLanguage

语言代码。

  • en - 英语(默认值)

  • jp - 日语

  • zh - 中文

必需:否

类型:字符串

最高100

Update requires: No interruption

NotificationArns

已传递到 CloudFormation。要将与堆栈相关的事件发布到的 SNS 主题 ARN。

必需:否

类型:字符串列表

最高5

Update requires: Replacement

PathId

产品的路径标识符。如果产品具有默认路径,则此值是可选的;如果产品具有多个路径,则此值是必需的。要列出产品的路径,请使用 ListLaunchPaths

注意

您必须提供名称或 ID,但不是同时提供两者。

必需:否

类型:字符串

最低1

最高100

模式^[a-zA-Z0-9_\-]*

Update requires: No interruption

PathName

路径的名称。如果产品具有默认路径,则此值是可选的;如果产品具有多个路径,则此值是必需的。要列出产品的路径,请使用 ListLaunchPaths

注意

您必须提供名称或 ID,但不是同时提供两者。

必需:否

类型:字符串

最低1

最高100

Update requires: No interruption

ProductId

产品标识符。

注意

您必须指定产品的 ID 或名称,但不能同时指定两者。

必需:条件

类型:字符串

最低1

最高100

模式^[a-zA-Z0-9_\-]*

Update requires: No interruption

ProductName

已配置产品的用户易记名称。此值在 AWS 账户中必须是唯一的,并且无法在预配置产品后进行更新。

每次创建或更新堆栈时,如果提供了 ProductName,则它会成功解析为 ProductId,只要该账户/区域中只存在一个具有该 ProductName 的产品。

注意

您必须指定产品的名称或 ID,但不能同时指定两者。

必需:条件

类型:字符串

最低1

最高128

模式[a-zA-Z0-9][a-zA-Z0-9._-]*

Update requires: No interruption

ProvisionedProductName

已配置产品的用户易记名称。此值在 AWS 账户中必须是唯一的,并且无法在预配置产品后进行更新。

必需:否

类型:字符串

最低1

最高128

模式[a-zA-Z0-9][a-zA-Z0-9._-]*

Update requires: Replacement

ProvisioningArtifactId

预配置的构件(也称为版本)的标识符。

注意

您必须指定预置构件的 ID 或名称,但不能同时指定两者。

必需:条件

类型:字符串

最低1

最高100

模式^[a-zA-Z0-9_\-]*

Update requires: No interruption

ProvisioningArtifactName

产品的预置构件(也称为版本)的名称。此名称对于产品来说必须是唯一的。

注意

您必须指定预置构件的名称或 ID,但不能同时指定两者。

必需:条件

类型:字符串

最高8192

Update requires: No interruption

ProvisioningParameters

配置产品所需的由管理员指定的参数。

必需:否

类型ProvisioningParameter 的列表

Update requires: No interruption

ProvisioningPreferences

预配置产品或更新预配置的产品所需的 StackSet 首选项。

必需:否

类型ProvisioningPreferences

Update requires: No interruption

Tags

一个或多个标签。

注意

要求预配置产品具有 ResourceUpdateConstraint 资源且 TagUpdatesOnProvisionedProduct 设置为 ALLOWED 以允许标签更新。如果 RESOURCE_UPDATE 约束不存在,则将忽略标签更新。

必需:否

类型Tag 的列表

最高50

Update requires: No interruption

返回值

Ref

在将此资源的逻辑 ID 传递给内部 Ref 函数时,Ref 返回预配置产品 ID,例如 pp-hfyszaotincww

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

Fn::GetAtt

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

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

CloudformationStackArn

CloudFormation 堆栈的 Amazon 资源名称 (ARN),例如 arn:aws:cloudformation:eu-west-1:123456789012:stack/SC-499278721343-pp-hfyszaotincww/8f3df460-346a-11e8-9444-503abe701c29

Outputs

要预置的产品的输出。例如,EC2 实例的 DNS。

ProvisionedProductId

预置产品的 ID。

RecordId

记录的 ID,例如 rec-rjeatvy434trk

示例

GetAtt 示例

YAML

AWSTemplateFormatVersion: '2010-09-09' Description: Serverless Stack Resources: SimpleLambda: Type: AWS::ServiceCatalog::CloudFormationProvisionedProduct Properties: ProductName: Basic Lambda ProvisioningArtifactName: '1.0' SimpleApiGateway: Type: AWS::ServiceCatalog::CloudFormationProvisionedProduct Properties: ProductName: API Gateway ProvisioningArtifactName: '1.0' ProvisioningParameters: - Key: LambdaArn Value: !GetAtt [SimpleLambda, Outputs.SCLambdaArn]

另请参阅