AWS CodeDeploy

Create deployment

このページは日本語には対応しておりません。随時翻訳に取り組んでいます。翻訳に関してご質問やご意見ございましたら、お気軽にご連絡ください。

Deploy an application revision through the specified deployment group.

Inputs

Expand All

フィールド

種類

説明

region [required]

enum

default: us-east-1

applicationName [required]

string

The name of an AWS CodeDeploy application associated with the IAM user or AWS account.

autoRollbackConfiguration

object

Configuration information for an automatic rollback that is added when a deployment is created.

enabled

boolean

Indicates whether a defined automatic rollback configuration is currently enabled.

events

[string]

The event type or types that trigger a rollback.

deploymentConfigName

string

The name of a deployment configuration associated with the IAM user or AWS account.

deploymentGroupName

string

The name of the deployment group.

fileExistsBehavior

enum

Information about how AWS CodeDeploy handles files that already exist in a deployment target location but weren't part of the previous successful deployment. Defaults to DISALLOW. Allowed enum values: DISALLOW,OVERWRITE,RETAIN

ignoreApplicationStopFailures

boolean

If true, then if an ApplicationStop, BeforeBlockTraffic, or AfterBlockTraffic deployment lifecycle event to an instance fails, the deployment continues to the next deployment lifecycle event.

revision

object

The type and location of the revision to deploy.

revisionType

string

The type of application revision:
S3: An application revision stored in Amazon S3.
GitHub: An application revision stored in GitHub (EC2/On-premises deployments only).
String: A YAML-formatted or JSON-formatted string (AWS Lambda deployments only).
AppSpecContent: An AppSpecContent object that contains the contents of an AppSpec file for an AWS Lambda or Amazon ECS deployment. The content is formatted as JSON or YAML stored as a RawString.

s3Location

object

Information about the location of a revision stored in Amazon S3.

bucket

string

The name of the Amazon S3 bucket where the application revision is stored.

key

string

The name of the Amazon S3 object that represents the bundled artifacts for the application revision.

bundleType

string

The file type of the application revision. Must be one of the following:
tar: A tar archive file.
tgz: A compressed tar archive file.
zip: A zip archive file.

version

string

A specific version of the Amazon S3 object that represents the bundled artifacts for the application revision. If the version is not specified, the system uses the most recent version by default.

eTag

string

The ETag of the Amazon S3 object that represents the bundled artifacts for the application revision. If the ETag is not specified as an input parameter, ETag validation of the object is skipped.

gitHubLocation

object

Information about the location of application artifacts stored in GitHub.

repository

string

The GitHub account and repository pair that stores a reference to the commit that represents the bundled artifacts for the application revision. Specified as account/repository.

commitId

string

The SHA1 commit ID of the GitHub commit that represents the bundled artifacts for the application revision.

string

object

Information about the location of an Lambda deployment revision stored as a RawString.

content

string

The YAML-formatted or JSON-formatted revision string. It includes information about which Lambda function to update and optional Lambda functions that validate deployment lifecycle events.

sha256

string

The SHA256 hash value of the revision content.

appSpecContent

object

The content of an AppSpec file for an Lambda or Amazon ECS deployment. The content is formatted as JSON or YAML and stored as a RawString.

content

string

The YAML-formatted or JSON-formatted revision string. For an Lambda deployment, the content includes a Lambda function name, the alias for its original version, and the alias for its replacement version. The deployment shifts traffic from the original version of the Lambda function to the replacement version. For an Amazon ECS deployment, the content includes the task name, information about the load balancer that serves traffic to the container, and more. For both types of deployments, the content can specify Lambda functions that run at specified hooks, such as BeforeInstall, during a deployment.

sha256

string

The SHA256 hash value of the revision content.

targetInstances

object

Information about the instances that belong to the replacement environment in a blue/green deployment.

tagFilters

[object]

The tag filter key, type, and value used to identify Amazon EC2 instances in a replacement environment for a blue/green deployment. Cannot be used in the same call as ec2TagSet.

Key

string

The tag filter key.

Value

string

The tag filter value.

Type

string

The tag filter type: KEY_ONLY: Key only. VALUE_ONLY: Value only. KEY_AND_VALUE: Key and value.

autoScalingGroups

[string]

The names of one or more Auto Scaling groups to identify a replacement environment for a blue/green deployment.

ec2TagSet

object

Information about the groups of Amazon EC2 instance tags that an instance must be identified by in order for it to be included in the replacement environment for a blue/green deployment. Cannot be used in the same call as tagFilters.

ec2TagSetList

[array]

A list that contains other lists of Amazon EC2 instance tag groups. For an instance to be included in the deployment group, it must be identified by all of the tag groups in the list.

updateOutdatedInstancesOnly

boolean

Indicates whether to deploy to all instances or only to instances that are not running the latest application revision.

Outputs

フィールド

種類

説明

deploymentId [required]

string

amzRequestId [required]

string