應用程式 applicationId 變更集 - AWS Serverless Application Repository

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

應用程式 applicationId 變更集

URI

/applications/applicationId/changesets

HTTP 方法

POST

操作 ID:CreateCloudFormationChangeSet

為指定的應用程式建立 AWS CloudFormation 變更集。

路徑參數
名稱Type必要描述
applicationId字串True

應用程式的 Amazon Resource Name (ARN)。

回應
狀態碼回應模型描述
201ChangeSetDetails

Success (成功)

400BadRequestException

請求中的其中一個參數無效。

403ForbiddenException

用戶端未經過身分驗證。

429TooManyRequestsException

用戶端傳送的請求數目超過每單位時間允許的數目。

500InternalServerErrorException

AWS Serverless Application Repository 服務遇到內部錯誤。

OPTIONS

路徑參數
名稱Type必要描述
applicationId字串True

應用程式的 Amazon Resource Name (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

請求中的其中一個參數無效。

屬性Type必要描述
errorCode

string

False

400

message

string

False

請求中的其中一個參數無效。

ChangeSetDetails

變更集的詳細資訊。

屬性Type必要描述
applicationId

string

True

應用程式 Amazon Resource Name (ARN)。

changeSetId

string

True

變更集的 Amazon Resource Name (ARN)。

長度限制:長度下限為 1。

模式:ARN:【-a-zA-Z0-9:/】*

semanticVersion

string

True

應用程式語意版本:

https://semver.org/

stackId

string

True

堆疊的唯一 ID。

CreateCloudFormationChangeSetInput

建立應用程式變更集請求。

屬性Type必要描述
capabilities

類型的陣列 string

False

您必須先指定的值清單,才能部署特定應用程式。某些應用程式可能包含可能會影響您 AWS 帳戶中許可的資源,例如,建立新的 AWS Identity and Access Management (IAM) 使用者。對於這些應用程式,您必須指定此參數來明確認可其功能。

唯一有效的值是 CAPABILITY_IAMCAPABILITY_RESOURCE_POLICYCAPABILITY_NAMED_IAMCAPABILITY_AUTO_EXPAND

下列資源需要您指定 CAPABILITY_IAMCAPABILITY_NAMED_IAMAWS:IAM:GroupAWS:IAM::InstanceProfileAWS::IAM:PolicyAWS:IAM:::Role。如果應用程式包含 IAM 資源,您可以指定 CAPABILITY_IAMCAPABILITY_NAMED_IAM。如果應用程式包含具有自訂名稱IAM的資源,您必須指定 CAPABILITY_NAMED_IAM

下列資源需要您指定 CAPABILITY_RESOURCE_POLICYAWS:Lambda::PermissionAWS:IAM:PolicyAWS:ApplicationAutoScaling::ScalingPolicy:、AWS:S3::BucketPolicyAWS::SQS::QueuePolicyAWS::SNS::TopicPolicy

包含一個或多個巢狀應用程式的應用程式需要由您指定 CAPABILITY_AUTO_EXPAND

如果您的應用程式範本包含上述任何資源,建議您在部署之前檢閱與應用程式相關聯的所有許可。如果您未為需要 功能的應用程式指定此參數,呼叫將會失敗。

changeSetName

string

False

此屬性對應至 AWS CloudFormation CreateChangeSet 相同名稱的 參數API。

clientToken

string

False

此屬性對應至 AWS CloudFormation CreateChangeSet 相同名稱的 參數API。

description

string

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

string

False

應用程式語意版本:

https://semver.org/

stackName

string

True

此屬性對應至 相同名稱的 參數AWS CloudFormation CreateChangeSetAPI。

tags

類型的陣列 Tag

False

此屬性對應至 相同名稱的 參數AWS CloudFormation CreateChangeSetAPI。

templateId

string

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

用戶端未驗證。

屬性Type必要描述
errorCode

string

False

403

message

string

False

用戶端未驗證。

InternalServerErrorException

AWS Serverless Application Repository 服務遇到內部錯誤。

屬性Type必要描述
errorCode

string

False

500

message

string

False

AWS Serverless Application Repository 服務遇到內部錯誤。

ParameterValue

應用程式參數值。

屬性Type必要描述
name

string

True

與參數相關聯的金鑰。如果您未指定特定參數的金鑰和值, AWS CloudFormation 會使用範本中指定的預設值。

value

string

True

與參數關聯的輸入值。

RollbackConfiguration

此屬性對應至 AWS CloudFormation RollbackConfiguration 資料類型。

屬性Type必要描述
monitoringTimeInMinutes

integer

False

此屬性對應至AWS CloudFormation RollbackConfiguration資料類型的相同名稱內容。

rollbackTriggers

類型的陣列 RollbackTrigger

False

此屬性對應至AWS CloudFormation RollbackConfiguration資料類型相同名稱的內容。

RollbackTrigger

此屬性對應至 AWS CloudFormation RollbackTrigger 資料類型。

屬性Type必要描述
arn

string

True

此屬性對應至AWS CloudFormation RollbackTrigger資料類型的相同名稱內容。

type

string

True

此屬性對應至AWS CloudFormation RollbackTrigger資料類型相同名稱的內容。

Tag

此屬性對應至AWS CloudFormation 標籤資料類型。

屬性Type必要描述
key

string

True

此屬性對應至AWS CloudFormation 標籤資料類型的相同名稱內容。

value

string

True

此屬性對應至AWS CloudFormation 標籤資料類型的相同名稱內容。

TooManyRequestsException

用戶端傳送的請求數目超過每單位時間允許的數目。

屬性Type必要描述
errorCode

string

False

429

message

string

False

用戶端傳送的請求數目超過每單位時間允許的數目。

另請參閱

如需在其中一種語言特定 AWS SDKs和參考API中使用此功能的詳細資訊,請參閱以下內容:

CreateCloudFormationChangeSet