Sign In to the Console
AWS CloudFormation
User Guide (API Version 2010-05-15)

AWS Documentation » AWS CloudFormation » User Guide » Template Reference » AWS Resource and Property Types Reference » AWS CodeDeploy Resource Types Reference » AWS::CodeDeploy::Application

AWS::CodeDeploy::Application

The AWS::CodeDeploy::Application resource creates an AWS CodeDeploy application. In AWS CodeDeploy, an application is a name that functions as a container to ensure that the correct combination of revision, deployment configuration, and deployment group are referenced during a deployment. You can use the AWS::CodeDeploy::DeploymentGroup resource to associate the application with an AWS CodeDeploy deployment group. For more information, see AWS CodeDeploy Deployments in the AWS CodeDeploy User Guide.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::CodeDeploy::Application",
  "Properties" : {
    "ApplicationName" : String,
    "ComputePlatform" : String
  }
}

YAML

Type: AWS::CodeDeploy::Application
Properties:
  ApplicationName: String	    
  ComputePlatform: String

Properties

ApplicationName

A name for the application. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the application name. For more information, see Name Type.

Required: No

Type: String

Update requires: Updates are not supported.

ComputePlatform

The compute platform that AWS CodeDeploy deploys the application to. For valid values see CreateApplication in the AWS CodeDeploy API Reference.

Required: No

Type: String

Update requires: Replacement

Return Value

Ref

When you pass the logical ID of an AWS::CodeDeploy::Application resource to the intrinsic Ref function, the function returns the application name, such as myapplication-a123d0d1.

For more information about using the Ref function, see Ref.

Examples

The following example creates an AWS CodeDeploy application with a Lambda compute platform.

JSON

"CodeDeployApplication": {
  "Type": "AWS::CodeDeploy::Application",
  "Properties": {
    "ComputePlatform": "Lambda"
  }
}

YAML

CodeDeployApplication:
  Type: AWS::CodeDeploy::Application
  Properties:
    ComputePlatform: Lambda

The following example creates an AWS CodeDeploy application with a Server compute platform.

JSON

"CodeDeployApplication": {
  "Type": "AWS::CodeDeploy::Application",
  "Properties": {
    "ComputePlatform": "Server"
  }
}

YAML

CodeDeployApplication:
  Type: AWS::CodeDeploy::Application
  Properties:
    ComputePlatform: Server

Related Resources

For configuring your deployment and specifying your application revisions, see AWS::CodeDeploy::DeploymentConfig and AWS::CodeDeploy::DeploymentGroup.