应用程序 applicationId 变更集 - AWS Serverless Application Repository

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

应用程序 applicationId 变更集

URI

/applications/applicationId/changesets

HTTP方法

POST

操作 ID:CreateCloudFormationChangeSet

为给定的应用程序创建 AWS CloudFormation 更改集。

路径参数
名称Type必需描述
applicationIdStringTrue

应用程序的 Amazon 资源名称 (ARN)。

响应
状态代码响应模型描述
201ChangeSetDetails

成功

400BadRequestException

请求中的参数之一无效。

403ForbiddenException

客户端未通过身份验证。

429TooManyRequestsException

客户端每单位时间发送的请求数超过了允许的请求数。

500InternalServerErrorException

该 AWS Serverless Application Repository 服务遇到了内部错误。

OPTIONS

路径参数
名称Type必需描述
applicationIdStringTrue

应用程序的 Amazon 资源名称 (ARN)。

响应
状态代码响应模型描述
200

200 条回复

架构

请求正文

{ "stackName": "string", "semanticVersion": "string", "templateId": "string", "parameterOverrides": [ { "name": "string", "value": "string" } ], "capabilities": [ "string" ], "changeSetName": "string", "clientToken": "string", "description": "string", "notificationArns": [ "string" ], "resourceTypes": [ "string" ], "rollbackConfiguration": { "rollbackTriggers": [ { "arn": "string", "type": "string" } ], "monitoringTimeInMinutes": integer }, "tags": [ { "key": "string", "value": "string" } ] }

响应正文

{ "applicationId": "string", "semanticVersion": "string", "changeSetId": "string", "stackId": "string" }
{ "message": "string", "errorCode": "string" }
{ "message": "string", "errorCode": "string" }
{ "message": "string", "errorCode": "string" }
{ "message": "string", "errorCode": "string" }

属性

BadRequestException

请求中的参数之一无效。

属性类型必需描述
errorCode

字符串

False

400

message

字符串

False

请求中的参数之一无效。

ChangeSetDetails

变更集的详细信息。

属性类型必需描述
applicationId

字符串

True

应用程序 Amazon 资源名称 (ARN)。

changeSetId

字符串

True

变更集的 Amazon 资源名称 (ARN)。

长度限制:最小长度为 1。

图案:ARN: [-a-za-z0-9:/] *

semanticVersion

字符串

True

应用程序的语义版本:

https://semver.org/

stackId

字符串

True

堆栈的唯一 ID。

CreateCloudFormationChangeSetInput

创建应用程序更改集请求。

属性类型必需描述
capabilities

类型的数组 string

False

在部署某些应用程序之前必须指定的值列表。某些应用程序可能包含可能影响您 AWS 账户权限的资源,例如,通过创建新 AWS Identity and Access Management (IAM) 用户。对于这些应用程序,必须通过指定此参数来明确确认其功能。

唯一有效的值是CAPABILITY_IAMCAPABILITY_NAMED_IAMCAPABILITY_RESOURCE_POLICY、和CAPABILITY_AUTO_EXPAND

以下资源要求您指定CAPABILITY_IAMCAPABILITY_NAMED_IAM::: AWS::IAM::Group:、:IAM: InstanceProfile、AWS:AWS::IAM:Policy:IAM: Rol e。如果应用程序包含IAM资源,则可以指定CAPABILITY_IAMCAPABILITY_NAMED_IAM。如果应用程序包含具有自定义名称的IAM资源,则必须指定CAPABILITY_NAMED_IAM

以下资源要求您指定CAPABILITY_RESOURCE_POLICY::: LambdaAWS:: Permission、AWS:: Policy IAM、::: Pol icy、AWS:ApplicationAutoScaling::、ScalingPolicy:AWS::S3::BucketPolicy、BucketPolicy:和AWS::SQS:。AWS::SQS::QueuePolicy

包含一个或多个嵌套应用程序的应用程序要求您指定 CAPABILITY_AUTO_EXPAND

如果您的应用程序模板包含上述任何资源,我们建议您在部署之前查看与该应用程序关联的所有权限。如果您没有为需要功能的应用程序指定此参数,则调用将失败。

changeSetName

字符串

False

此属性对应于的同名参数AWS CloudFormation CreateChangeSetAPI。

clientToken

字符串

False

此属性对应于的同名参数AWS CloudFormation CreateChangeSetAPI。

description

字符串

False

此属性对应于的同名参数AWS CloudFormation CreateChangeSetAPI。

notificationArns

类型的数组 string

False

此属性对应于的同名参数AWS CloudFormation CreateChangeSetAPI。

parameterOverrides

类型的数组 ParameterValue

False

应用程序参数的参数值列表。

resourceTypes

类型的数组 string

False

此属性对应于的同名参数AWS CloudFormation CreateChangeSetAPI。

rollbackConfiguration

RollbackConfiguration

False

此属性对应于的同名参数AWS CloudFormation CreateChangeSetAPI。

semanticVersion

字符串

False

应用程序的语义版本:

https://semver.org/

stackName

字符串

True

此属性对应于的同名参数AWS CloudFormation CreateChangeSetAPI。

tags

类型的数组 标签

False

此属性对应于的同名参数AWS CloudFormation CreateChangeSetAPI。

templateId

字符串

False

由UUID... 返回的 CreateCloudFormationTemplate。

模式:[0-9a-fa-f] {8}\-[0-9a-fa-f] {4}\-[0-9a-fa-f] {4}\-[0-9a-fa-f] {4}\-[0-9a-fa-f] {12}

ForbiddenException

客户端未通过身份验证。

属性类型必需描述
errorCode

字符串

False

403

message

字符串

False

客户端未通过身份验证。

InternalServerErrorException

该 AWS Serverless Application Repository 服务遇到了内部错误。

属性类型必需描述
errorCode

字符串

False

500

message

字符串

False

该 AWS Serverless Application Repository 服务遇到了内部错误。

ParameterValue

应用程序的参数值。

属性类型必需描述
name

字符串

True

与参数关联的键。如果您没有为特定参数指定键和值,则 AWS CloudFormation 使用模板中指定的默认值。

value

字符串

True

与参数关联的输入值。

RollbackConfiguration

此属性对应于AWS CloudFormation RollbackConfiguration数据类型。

属性类型必需描述
monitoringTimeInMinutes

整数

False

此属性对应于AWS CloudFormation RollbackConfiguration数据类型的同名内容。

rollbackTriggers

类型的数组 RollbackTrigger

False

此属性对应于AWS CloudFormation RollbackConfiguration数据类型的同名内容。

RollbackTrigger

此属性对应于AWS CloudFormation RollbackTrigger数据类型。

属性类型必需描述
arn

字符串

True

此属性对应于AWS CloudFormation RollbackTrigger数据类型的同名内容。

type

字符串

True

此属性对应于AWS CloudFormation RollbackTrigger数据类型的同名内容。

Tag

此属性对应于AWS CloudFormation 标签数据类型。

属性类型必需描述
key

字符串

True

此属性对应于AWS CloudFormation 标签数据类型的同名内容。

value

字符串

True

此属性对应于AWS CloudFormation 标签数据类型的同名内容。

TooManyRequestsException

客户端每单位时间发送的请求数超过了允许的请求数。

属性类型必需描述
errorCode

字符串

False

429

message

字符串

False

客户端每单位时间发送的请求数超过了允许的请求数。

另请参阅

有关在特定语言 AWS SDKs和参考文献API中使用它的更多信息,请参阅以下内容:

CreateCloudFormationChangeSet