class ServerApplication (construct)

Language	Type name
.NET	Amazon.CDK.AWS.CodeDeploy.ServerApplication
Go	github.com/aws/aws-cdk-go/awscdk/v2/awscodedeploy#ServerApplication
Java	software.amazon.awscdk.services.codedeploy.ServerApplication
Python	aws_cdk.aws_codedeploy.ServerApplication
TypeScript (source)	aws-cdk-lib » aws_codedeploy » ServerApplication

Implements IConstruct, IDependable, IResource, IServerApplication

A CodeDeploy Application that deploys to EC2/on-premise instances.

Example

const application = new codedeploy.ServerApplication(this, 'CodeDeployApplication', {
  applicationName: 'MyApplication', // optional property
});

Initializer

new ServerApplication(scope: Construct, id: string, props?: ServerApplicationProps)

Parameters

• scope Construct
• id string
• props ServerApplicationProps

Construct Props

Name	Type	Description
applicationName?	string	The physical, human-readable name of the CodeDeploy Application.

---

applicationName?

Type: string (optional, default: an auto-generated name will be used)

The physical, human-readable name of the CodeDeploy Application.

Properties

Name	Type	Description
applicationArn	string
applicationName	string
env	ResourceEnvironment	The environment this resource belongs to.
node	Node	The tree node.
stack	Stack	The stack in which this resource is defined.

---

applicationArn

Type: string

---

applicationName

Type: string

---

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

---

node

Type: Node

The tree node.

---

stack

Type: Stack

The stack in which this resource is defined.

Methods

Name	Description
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.
toString()	Returns a string representation of this construct.
static fromServerApplicationArn(scope, id, serverApplicationArn)	Import an Application defined either outside the CDK, or in a different CDK Stack, by ARN.
static fromServerApplicationName(scope, id, serverApplicationName)	Import an Application defined either outside the CDK app, or in a different region.

---

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

---

toString()

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

static fromServerApplicationArn(scope, id, serverApplicationArn)

public static fromServerApplicationArn(scope: Construct, id: string, serverApplicationArn: string): IServerApplication

Parameters

• scope Construct — the parent Construct for this new Construct.
• id string — the logical ID of this new Construct.
• serverApplicationArn string — the ARN of the application to import.

Returns

• IServerApplication

Import an Application defined either outside the CDK, or in a different CDK Stack, by ARN.

---

static fromServerApplicationName(scope, id, serverApplicationName)

public static fromServerApplicationName(scope: Construct, id: string, serverApplicationName: string): IServerApplication

Parameters

• scope Construct — the parent Construct for this new Construct.
• id string — the logical ID of this new Construct.
• serverApplicationName string — the name of the application to import.

Returns

• IServerApplication

Import an Application defined either outside the CDK app, or in a different region.

The Application's account and region are assumed to be the same as the stack it is being imported into. If not, use fromServerApplicationArn.