baiji v0.6.5 Baiji.CodeDeploy

AWS CodeDeploy

AWS CodeDeploy is a deployment service that automates application deployments to Amazon EC2 instances or on-premises instances running in your own facility.

You can deploy a nearly unlimited variety of application content, such as code, web and configuration files, executables, packages, scripts, multimedia files, and so on. AWS CodeDeploy can deploy application content stored in Amazon S3 buckets, GitHub repositories, or Bitbucket repositories. You do not need to make changes to your existing code before you can use AWS CodeDeploy.

AWS CodeDeploy makes it easier for you to rapidly release new features, helps you avoid downtime during application deployment, and handles the complexity of updating your applications, without many of the risks associated with error-prone manual deployments.

AWS CodeDeploy Components

Use the information in this guide to help you work with the following AWS CodeDeploy components:

  • **Application**: A name that uniquely identifies the application you want to deploy. AWS CodeDeploy uses this name, which functions as a container, to ensure the correct combination of revision, deployment configuration, and deployment group are referenced during a deployment.
  • **Deployment group**: A set of individual instances. A deployment group contains individually tagged instances, Amazon EC2 instances in Auto Scaling groups, or both.
  • **Deployment configuration**: A set of deployment rules and deployment success and failure conditions used by AWS CodeDeploy during a deployment.
  • **Deployment**: The process, and the components involved in the process, of installing content on one or more instances.
  • **Application revisions**: An archive file containing source content—source code, web pages, executable files, and deployment scripts—along with an application specification file (AppSpec file). Revisions are stored in Amazon S3 buckets or GitHub repositories. For Amazon S3, a revision is uniquely identified by its Amazon S3 object key and its ETag, version, or both. For GitHub, a revision is uniquely identified by its commit ID.
This guide also contains information to help you get details about the instances in your deployments and to make on-premises instances available for AWS CodeDeploy deployments. **AWS CodeDeploy Information Resources**
  • [AWS CodeDeploy User Guide](http://docs.aws.amazon.com/codedeploy/latest/userguide)
  • [AWS CodeDeploy API Reference Guide](http://docs.aws.amazon.com/codedeploy/latest/APIReference/)
  • [AWS CLI Reference for AWS CodeDeploy](http://docs.aws.amazon.com/cli/latest/reference/deploy/index.html)
  • [AWS CodeDeploy Developer Forum](https://forums.aws.amazon.com/forum.jspa?forumID=179)

Link to this section Summary

Functions

Returns a map containing the input/output shapes for this endpoint

Outputs values common to all actions

Gets information about one or more application revisions

Gets information about one or more applications

Gets information about one or more deployment groups

Gets information about one or more instance that are part of a deployment group

Gets information about one or more deployments

Gets information about one or more on-premises instances

For a blue/green deployment, starts the process of rerouting traffic from instances in the original environment to instances in the replacement environment without waiting for a specified wait time to elapse. (Traffic rerouting, which is achieved by registering instances in the replacement environment with the load balancer, can start as soon as all instances have a status of Ready.)

Deploys an application revision through the specified deployment group

Creates a deployment configuration

Creates a deployment group to which application revisions will be deployed

Deletes a deployment configuration

Gets information about an application

Gets information about an application revision

Gets information about a deployment

Gets information about a deployment configuration

Gets information about a deployment group

Gets information about an instance as part of a deployment

Gets information about an on-premises instance

Lists information about revisions for an application

Lists the applications registered with the applicable IAM user or AWS account

Lists the deployment configurations with the applicable IAM user or AWS account

Lists the deployment groups for an application registered with the applicable IAM user or AWS account

Lists the instance for a deployment associated with the applicable IAM user or AWS account

Lists the deployments in a deployment group for an application registered with the applicable IAM user or AWS account

Lists the names of stored connections to GitHub accounts

Gets a list of names for one or more on-premises instances

Registers with AWS CodeDeploy a revision for the specified application

Removes one or more tags from one or more on-premises instances

In a blue/green deployment, overrides any specified wait time and starts terminating instances immediately after the traffic routing is completed

Attempts to stop an ongoing deployment

Changes the name of an application

Changes information about a deployment group

Link to this section Functions

Returns a map containing the input/output shapes for this endpoint

Outputs values common to all actions

Link to this function add_tags_to_on_premises_instances(input \\ %{}, options \\ [])

Adds tags to on-premises instances.

Link to this function batch_get_application_revisions(input \\ %{}, options \\ [])

Gets information about one or more application revisions.

Link to this function batch_get_applications(input \\ %{}, options \\ [])

Gets information about one or more applications.

Link to this function batch_get_deployment_groups(input \\ %{}, options \\ [])

Gets information about one or more deployment groups.

Link to this function batch_get_deployment_instances(input \\ %{}, options \\ [])

Gets information about one or more instance that are part of a deployment group.

Link to this function batch_get_deployments(input \\ %{}, options \\ [])

Gets information about one or more deployments.

Link to this function batch_get_on_premises_instances(input \\ %{}, options \\ [])

Gets information about one or more on-premises instances.

Link to this function continue_deployment(input \\ %{}, options \\ [])

For a blue/green deployment, starts the process of rerouting traffic from instances in the original environment to instances in the replacement environment without waiting for a specified wait time to elapse. (Traffic rerouting, which is achieved by registering instances in the replacement environment with the load balancer, can start as soon as all instances have a status of Ready.)

Link to this function create_application(input \\ %{}, options \\ [])

Creates an application.

Link to this function create_deployment(input \\ %{}, options \\ [])

Deploys an application revision through the specified deployment group.

Link to this function create_deployment_config(input \\ %{}, options \\ [])

Creates a deployment configuration.

Link to this function create_deployment_group(input \\ %{}, options \\ [])

Creates a deployment group to which application revisions will be deployed.

Link to this function delete_application(input \\ %{}, options \\ [])

Deletes an application.

Link to this function delete_deployment_config(input \\ %{}, options \\ [])

Deletes a deployment configuration.

A deployment configuration cannot be deleted if it is currently in use. Predefined configurations cannot be deleted.
Link to this function delete_deployment_group(input \\ %{}, options \\ [])

Deletes a deployment group.

Link to this function deregister_on_premises_instance(input \\ %{}, options \\ [])

Deregisters an on-premises instance.

Link to this function get_application(input \\ %{}, options \\ [])

Gets information about an application.

Link to this function get_application_revision(input \\ %{}, options \\ [])

Gets information about an application revision.

Link to this function get_deployment(input \\ %{}, options \\ [])

Gets information about a deployment.

Link to this function get_deployment_config(input \\ %{}, options \\ [])

Gets information about a deployment configuration.

Link to this function get_deployment_group(input \\ %{}, options \\ [])

Gets information about a deployment group.

Link to this function get_deployment_instance(input \\ %{}, options \\ [])

Gets information about an instance as part of a deployment.

Link to this function get_on_premises_instance(input \\ %{}, options \\ [])

Gets information about an on-premises instance.

Link to this function list_application_revisions(input \\ %{}, options \\ [])

Lists information about revisions for an application.

Link to this function list_applications(input \\ %{}, options \\ [])

Lists the applications registered with the applicable IAM user or AWS account.

Link to this function list_deployment_configs(input \\ %{}, options \\ [])

Lists the deployment configurations with the applicable IAM user or AWS account.

Link to this function list_deployment_groups(input \\ %{}, options \\ [])

Lists the deployment groups for an application registered with the applicable IAM user or AWS account.

Link to this function list_deployment_instances(input \\ %{}, options \\ [])

Lists the instance for a deployment associated with the applicable IAM user or AWS account.

Link to this function list_deployments(input \\ %{}, options \\ [])

Lists the deployments in a deployment group for an application registered with the applicable IAM user or AWS account.

Link to this function list_git_hub_account_token_names(input \\ %{}, options \\ [])

Lists the names of stored connections to GitHub accounts.

Link to this function list_on_premises_instances(input \\ %{}, options \\ [])

Gets a list of names for one or more on-premises instances.

Unless otherwise specified, both registered and deregistered on-premises instance names will be listed. To list only registered or deregistered on-premises instance names, use the registration status parameter.

Link to this function register_application_revision(input \\ %{}, options \\ [])

Registers with AWS CodeDeploy a revision for the specified application.

Link to this function register_on_premises_instance(input \\ %{}, options \\ [])

Registers an on-premises instance.

Only one IAM ARN (an IAM session ARN or IAM user ARN) is supported in the request. You cannot use both.
Link to this function remove_tags_from_on_premises_instances(input \\ %{}, options \\ [])

Removes one or more tags from one or more on-premises instances.

Link to this function skip_wait_time_for_instance_termination(input \\ %{}, options \\ [])

In a blue/green deployment, overrides any specified wait time and starts terminating instances immediately after the traffic routing is completed.

Link to this function stop_deployment(input \\ %{}, options \\ [])

Attempts to stop an ongoing deployment.

Link to this function update_application(input \\ %{}, options \\ [])

Changes the name of an application.

Link to this function update_deployment_group(input \\ %{}, options \\ [])

Changes information about a deployment group.