Deploys the specified AWS CloudFormation template by creating and then executing
a change set. The command terminates after AWS CloudFormation executes the
change set. If you want to view the change set before AWS CloudFormation
executes it, use the ``--no-execute-changeset`` flag.
To update a stack, specify the name of an existing stack. To create a new stack,
specify a new stack name.
Subcommands
| Name | Description |
|---|
push | Bundles and uploads to Amazon Simple Storage Service (Amazon S3) an application revision, which is a zip archive file that contains deployable content and an accompanying Application Specification file (AppSpec file). If the upload is successful, a message is returned that describes how to call the create-deployment command to deploy the application revision from Amazon S3 to target Amazon Elastic Compute Cloud (Amazon EC2) instances |
register | Creates an IAM user for the on-premises instance, if not provided, and saves the user's credentials to an on-premises instance configuration file; registers the on-premises instance with AWS CodeDeploy; and optionally adds tags to the on-premises instance |
deregister | Removes any tags from the on-premises instance; deregisters the on-premises instance from AWS CodeDeploy; and, unless requested otherwise, deletes the IAM user for the on-premises instance |
install | Configures and installs the AWS CodeDeploy Agent on the on-premises instance |
uninstall | Uninstalls the AWS CodeDeploy Agent from the on-premises instance |
Options
| Name | Description |
|---|
--template-file <string> | The path where your AWS CloudFormation template is located |
--stack-name <string> | The name of the AWS CloudFormation stack you're deploying to. If you specify an existing stack, the command updates the stack. If you specify a new stack, the command creates it |
--s3-bucket <string> | The name of the S3 bucket where this command uploads your CloudFormation template. This is required the deployments of templates sized greater than 51,200 bytes |
--force-upload | Indicates whether to override existing files in the S3 bucket. Specify this flag to upload artifacts even if they match existing artifacts in the S3 bucket |
--s3-prefix <string> | A prefix name that the command adds to the artifacts' name when it uploads them to the S3 bucket. The prefix name is a path name (folder name) for the S3 bucket |
--kms-key-id <string> | The ID of an AWS KMS key that the command uses to encrypt artifacts that are at rest in the S3 bucket |
--parameter-overrides <list...> | A list of parameter structures that specify input parameters for your stack template. If you're updating a stack and you don't specify a parameter, the command uses the stack's existing value. For new stacks, you must specify parameters that don't have a default value. Syntax: ParameterKey1=ParameterValue1 ParameterKey2=ParameterValue2 |
--capabilities <list...> | A list of capabilities that you must specify before AWS Cloudformation can create certain stacks. Some stack templates 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 stacks, you must explicitly acknowledge their capabilities by specifying this parameter. The only valid values are CAPABILITY_IAM and CAPABILITY_NAMED_IAM. If you have IAM resources, you can specify either capability. If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM. If you don't specify this parameter, this action returns an InsufficientCapabilities error |
--no-execute-changeset | Indicates whether to execute the change set. Specify this flag if you want to view your stack changes before executing the change set. The command creates an AWS CloudFormation change set and then exits without executing the change set. After you view the change set, execute it to implement your changes |
--role-arn <string> | The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes when executing the change set |
--notification-arns <list...> | Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that AWS CloudFormation associates with the stack |
--fail-on-empty-changeset | Specify if the CLI should return a non-zero exit code if there are no changes to be made to the stack. The default behavior is to return a non-zero exit code |
--no-fail-on-empty-changeset | Causes the CLI to return an exit code of 0 if there are no changes to be made to the stack |
--tags <list...> | A list of tags to associate with the stack that is created or updated. AWS CloudFormation also propagates these tags to resources in the stack if the resource supports it. Syntax: TagKey1=TagValue1 TagKey2=TagValue2 |