ServerlessApplicationRepository / Client / create_cloud_formation_change_set

create_cloud_formation_change_set#

ServerlessApplicationRepository.Client.create_cloud_formation_change_set(**kwargs)#

Creates an AWS CloudFormation change set for the given application.

See also: AWS API Documentation

Request Syntax

response = client.create_cloud_formation_change_set(
    ApplicationId='string',
    Capabilities=[
        'string',
    ],
    ChangeSetName='string',
    ClientToken='string',
    Description='string',
    NotificationArns=[
        'string',
    ],
    ParameterOverrides=[
        {
            'Name': 'string',
            'Value': 'string'
        },
    ],
    ResourceTypes=[
        'string',
    ],
    RollbackConfiguration={
        'MonitoringTimeInMinutes': 123,
        'RollbackTriggers': [
            {
                'Arn': 'string',
                'Type': 'string'
            },
        ]
    },
    SemanticVersion='string',
    StackName='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    TemplateId='string'
)
type ApplicationId:

string

param ApplicationId:

[REQUIRED]

The Amazon Resource Name (ARN) of the application.

type Capabilities:

list

param Capabilities:

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.

  • (string) –

type ChangeSetName:

string

param ChangeSetName:

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

type ClientToken:

string

param ClientToken:

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

type Description:

string

param Description:

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

type NotificationArns:

list

param NotificationArns:

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

  • (string) –

type ParameterOverrides:

list

param ParameterOverrides:

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

  • (dict) –

    Parameter value of the application.

    • Name (string) – [REQUIRED]

      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) – [REQUIRED]

      The input value associated with the parameter.

type ResourceTypes:

list

param ResourceTypes:

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

  • (string) –

type RollbackConfiguration:

dict

param RollbackConfiguration:

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

  • MonitoringTimeInMinutes (integer) –

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

  • RollbackTriggers (list) –

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

    • (dict) –

      This property corresponds to the AWS CloudFormation RollbackTrigger Data Type.

      • Arn (string) – [REQUIRED]

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

      • Type (string) – [REQUIRED]

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

type SemanticVersion:

string

param SemanticVersion:

The semantic version of the application:

https://semver.org/

type StackName:

string

param StackName:

[REQUIRED]

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

type Tags:

list

param Tags:

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

  • (dict) –

    This property corresponds to the AWS CloudFormation Tag Data Type.

    • Key (string) – [REQUIRED]

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

    • Value (string) – [REQUIRED]

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

Data Type.

type TemplateId:

string

param TemplateId:

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}

rtype:

dict

returns:

Response Syntax

{
    'ApplicationId': 'string',
    'ChangeSetId': 'string',
    'SemanticVersion': 'string',
    'StackId': 'string'
}

Response Structure

  • (dict) –

    Success

    • ApplicationId (string) –

      The application Amazon Resource Name (ARN).

    • ChangeSetId (string) –

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

      Length constraints: Minimum length of 1.

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

    • SemanticVersion (string) –

      The semantic version of the application:

      https://semver.org/

    • StackId (string) –

      The unique ID of the stack.

Exceptions