Applications applicationId Changesets - AWS Serverless Application Repository

Applications applicationId Changesets

URI

/applications/applicationId/changesets

HTTP methods

POST

Operation ID: CreateCloudFormationChangeSet

Creates an AWS CloudFormation change set for the given application.

Path parameters
NameTypeRequiredDescription
applicationIdStringTrue

The Amazon Resource Name (ARN) of the application.

Responses
Status codeResponse modelDescription
201ChangeSetDetails

Success

400BadRequestException

One of the parameters in the request is invalid.

403ForbiddenException

The client is not authenticated.

429TooManyRequestsException

The client is sending more than the allowed number of requests per unit of time.

500InternalServerErrorException

The AWS Serverless Application Repository service encountered an internal error.

Schemas

Request bodies

{ "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" } ] }

Response bodies

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

Properties

BadRequestException

One of the parameters in the request is invalid.

PropertyTypeRequiredDescription
errorCode

string

False

400

message

string

False

One of the parameters in the request is invalid.

ChangeSetDetails

Details of the change set.

PropertyTypeRequiredDescription
applicationId

string

True

The application Amazon Resource Name (ARN).

changeSetId

string

True

The Amazon Resource Name (ARN) of the change set.

Length constraints: Minimum length of 1.

Pattern: ARN:[-a-zA-Z0-9:/]*

semanticVersion

string

True

The semantic version of the application:

https://semver.org/

stackId

string

True

The unique ID of the stack.

CreateCloudFormationChangeSetInput

Create an application change set request.

PropertyTypeRequiredDescription
capabilities

Array of type string

False

A list of values that you must specify before you can deploy certain applications. Some applications might include resources that can affect permissions in your AWS account, for example, by creating new AWS Identity and Access Management (IAM) users. For those applications, you must explicitly acknowledge their capabilities by specifying this parameter.

The only valid values are CAPABILITY_IAM, CAPABILITY_NAMED_IAM, CAPABILITY_RESOURCE_POLICY, and CAPABILITY_AUTO_EXPAND.

The following resources require you to specify CAPABILITY_IAM or CAPABILITY_NAMED_IAM: AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, and AWS::IAM::Role. If the application contains IAM resources, you can specify either CAPABILITY_IAM or CAPABILITY_NAMED_IAM. If the application contains IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.

The following resources require you to specify CAPABILITY_RESOURCE_POLICY: AWS::Lambda::Permission, AWS::IAM:Policy, AWS::ApplicationAutoScaling::ScalingPolicy, AWS::S3::BucketPolicy, AWS::SQS::QueuePolicy, and AWS::SNS:TopicPolicy.

Applications that contain one or more nested applications require you to specify CAPABILITY_AUTO_EXPAND.

If your application template contains any of the above resources, we recommend that you review all permissions associated with the application before deploying. If you don't specify this parameter for an application that requires capabilities, the call will fail.

changeSetName

string

False

This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.

clientToken

string

False

This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.

description

string

False

This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.

notificationArns

Array of type string

False

This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.

parameterOverrides

Array of type ParameterValue

False

A list of parameter values for the parameters of the application.

resourceTypes

Array of type string

False

This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.

rollbackConfiguration

RollbackConfiguration

False

This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.

semanticVersion

string

False

The semantic version of the application:

https://semver.org/

stackName

string

True

This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.

tags

Array of type Tag

False

This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.

templateId

string

False

The UUID returned by CreateCloudFormationTemplate.

Pattern: [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

The client is not authenticated.

PropertyTypeRequiredDescription
errorCode

string

False

403

message

string

False

The client is not authenticated.

InternalServerErrorException

The AWS Serverless Application Repository service encountered an internal error.

PropertyTypeRequiredDescription
errorCode

string

False

500

message

string

False

The AWS Serverless Application Repository service encountered an internal error.

ParameterValue

Parameter value of the application.

PropertyTypeRequiredDescription
name

string

True

The key associated with the parameter. If you don't specify a key and value for a particular parameter, AWS CloudFormation uses the default value that is specified in your template.

value

string

True

The input value associated with the parameter.

RollbackConfiguration

This property corresponds to the AWS CloudFormation RollbackConfiguration Data Type.

PropertyTypeRequiredDescription
monitoringTimeInMinutes

integer

False

This property corresponds to the content of the same name for the AWS CloudFormation RollbackConfiguration Data Type.

rollbackTriggers

Array of type RollbackTrigger

False

This property corresponds to the content of the same name for the AWS CloudFormation RollbackConfiguration Data Type.

RollbackTrigger

This property corresponds to the AWS CloudFormation RollbackTrigger Data Type.

PropertyTypeRequiredDescription
arn

string

True

This property corresponds to the content of the same name for the AWS CloudFormation RollbackTrigger Data Type.

type

string

True

This property corresponds to the content of the same name for the AWS CloudFormation RollbackTrigger Data Type.

Tag

This property corresponds to the AWS CloudFormation Tag Data Type.

PropertyTypeRequiredDescription
key

string

True

This property corresponds to the content of the same name for the AWS CloudFormation Tag Data Type.

value

string

True

This property corresponds to the content of the same name for the AWS CloudFormation Tag Data Type.

TooManyRequestsException

The client is sending more than the allowed number of requests per unit of time.

PropertyTypeRequiredDescription
errorCode

string

False

429

message

string

False

The client is sending more than the allowed number of requests per unit of time.

See also

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

CreateCloudFormationChangeSet