# API Reference
## Constructs
### AmpServer
A static EC2 instance with an elastic IP address, running an Amp dedicated server.
#### Initializers
```typescript
import { AmpServer } from 'aws-gameservers'
new AmpServer(scope: Construct, id: string, props: AmpServerProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| scope | constructs.Construct | *No description.* |
| id | string | *No description.* |
| props | AmpServerProps | *No description.* |
---
##### `scope`Required
- *Type:* constructs.Construct
---
##### `id`Required
- *Type:* string
---
##### `props`Required
- *Type:* AmpServerProps
---
### GameServer
- *Implements:* IGameServer
An abstract class representing an EC2 instance with an optional AWS Backup Plan, Elastic IP Address, and new or imported VPC.
The GameServer abstract class is meant to be *extended* via the creation of child classes, e.g. ValheimServer, SatisfactoryServer.
#### Initializers
```typescript
import { GameServer } from 'aws-gameservers'
new GameServer(scope: Construct, id: string, props: GameServerProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| scope | constructs.Construct | *No description.* |
| id | string | *No description.* |
| props | GameServerProps | *No description.* |
---
##### `scope`Required
- *Type:* constructs.Construct
---
##### `id`Required
- *Type:* string
---
##### `props`Required
- *Type:* GameServerProps
---
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| elasticIp | aws-cdk-lib.aws_ec2.CfnEIP | The Elastic IP Address attached to the GameServer. |
| game | string | The name of the game being hosted on this GameServer. |
| server | aws-cdk-lib.aws_ec2.IInstance | The EC2 Instance Object representing the GameServer itself. |
| vpc | aws-cdk-lib.aws_ec2.IVpc | The VPC where the GameServer is deployed. |
| securityGroup | aws-cdk-lib.aws_ec2.ISecurityGroup | The security group attached to the GameServer Instance. |
| serverRole | aws-cdk-lib.aws_iam.IRole | The role associated with the GameServer's instance profile. |
| userData | aws-cdk-lib.aws_ec2.UserData | The modifiable UserData object attached to the GameServer Instance object. |
---
##### `elasticIp`Required
```typescript
public readonly elasticIp: CfnEIP;
```
- *Type:* aws-cdk-lib.aws_ec2.CfnEIP
The Elastic IP Address attached to the GameServer.
---
##### `game`Required
```typescript
public readonly game: string;
```
- *Type:* string
The name of the game being hosted on this GameServer.
---
##### `server`Required
```typescript
public readonly server: IInstance;
```
- *Type:* aws-cdk-lib.aws_ec2.IInstance
The EC2 Instance Object representing the GameServer itself.
---
##### `vpc`Required
```typescript
public readonly vpc: IVpc;
```
- *Type:* aws-cdk-lib.aws_ec2.IVpc
The VPC where the GameServer is deployed.
---
##### `securityGroup`Required
```typescript
public readonly securityGroup: ISecurityGroup;
```
- *Type:* aws-cdk-lib.aws_ec2.ISecurityGroup
The security group attached to the GameServer Instance.
---
##### `serverRole`Required
```typescript
public readonly serverRole: IRole;
```
- *Type:* aws-cdk-lib.aws_iam.IRole
The role associated with the GameServer's instance profile.
---
##### `userData`Required
```typescript
public readonly userData: UserData;
```
- *Type:* aws-cdk-lib.aws_ec2.UserData
The modifiable UserData object attached to the GameServer Instance object.
---
### ValheimServer
A static EC2 instance with an elastic IP address, running a Valheim dedicated server.
#### Initializers
```typescript
import { ValheimServer } from 'aws-gameservers'
new ValheimServer(scope: Construct, id: string, props: ValheimServerProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| scope | constructs.Construct | *No description.* |
| id | string | *No description.* |
| props | ValheimServerProps | *No description.* |
---
##### `scope`Required
- *Type:* constructs.Construct
---
##### `id`Required
- *Type:* string
---
##### `props`Required
- *Type:* ValheimServerProps
---
## Structs
### AmpServerProps
Constructor properties that define the AmpServer object.
#### Initializer
```typescript
import { AmpServerProps } from 'aws-gameservers'
const ampServerProps: AmpServerProps = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| backupGameServer | boolean | Optional: Whether to back up the GameServer. |
| game | string | The name of the game being hosted on this GameServer. |
| instanceType | aws-cdk-lib.aws_ec2.InstanceType | Optional: The GameServer's EC2 Instance type. |
| releaseIPOnDelete | boolean | Optional: Whether to automatically release the GameServer's elastic IP address when the stack is torn down. |
| rootVolumeSize | number | Optional: The desired size of the GameServer's root volume, in GB. |
| vpcId | string | Optional: The VPC ID of the existing VPC in which to deploy the GameServer. |
---
##### `backupGameServer`Optional
```typescript
public readonly backupGameServer: boolean;
```
- *Type:* boolean
- *Default:* true
Optional: Whether to back up the GameServer.
When true, the AWS Backup settings for the GameServer follow the "dailyMonthly1YearRetention" plan.
---
##### `game`Optional
```typescript
public readonly game: string;
```
- *Type:* string
The name of the game being hosted on this GameServer.
This is used for LogicalId sugar throughout the object.
---
##### `instanceType`Optional
```typescript
public readonly instanceType: InstanceType;
```
- *Type:* aws-cdk-lib.aws_ec2.InstanceType
- *Default:* InstanceType("t3.medium")
Optional: The GameServer's EC2 Instance type.
> [https://aws.amazon.com/ec2/instance-types/](https://aws.amazon.com/ec2/instance-types/)
---
##### `releaseIPOnDelete`Optional
```typescript
public readonly releaseIPOnDelete: boolean;
```
- *Type:* boolean
- *Default:* false
Optional: Whether to automatically release the GameServer's elastic IP address when the stack is torn down.
Elastic IPs cost a nominal fee when reserved but unallocated. If you release an elastic IP, there is no way to guarantee that you'll ever get it back.
> [https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html)
---
##### `rootVolumeSize`Optional
```typescript
public readonly rootVolumeSize: number;
```
- *Type:* number
- *Default:* 50
Optional: The desired size of the GameServer's root volume, in GB.
Given value must be >= 15 to prevent the need for future volume expansion.
---
##### `vpcId`Optional
```typescript
public readonly vpcId: string;
```
- *Type:* string
- *Default:* A new VPC is created with 2 public subnets.
Optional: The VPC ID of the existing VPC in which to deploy the GameServer.
---
### GameServerProps
Constructor properties that define the GameServer object.
#### Initializer
```typescript
import { GameServerProps } from 'aws-gameservers'
const gameServerProps: GameServerProps = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| backupGameServer | boolean | Optional: Whether to back up the GameServer. |
| game | string | The name of the game being hosted on this GameServer. |
| instanceType | aws-cdk-lib.aws_ec2.InstanceType | Optional: The GameServer's EC2 Instance type. |
| releaseIPOnDelete | boolean | Optional: Whether to automatically release the GameServer's elastic IP address when the stack is torn down. |
| rootVolumeSize | number | Optional: The desired size of the GameServer's root volume, in GB. |
| vpcId | string | Optional: The VPC ID of the existing VPC in which to deploy the GameServer. |
---
##### `backupGameServer`Optional
```typescript
public readonly backupGameServer: boolean;
```
- *Type:* boolean
- *Default:* true
Optional: Whether to back up the GameServer.
When true, the AWS Backup settings for the GameServer follow the "dailyMonthly1YearRetention" plan.
---
##### `game`Optional
```typescript
public readonly game: string;
```
- *Type:* string
The name of the game being hosted on this GameServer.
This is used for LogicalId sugar throughout the object.
---
##### `instanceType`Optional
```typescript
public readonly instanceType: InstanceType;
```
- *Type:* aws-cdk-lib.aws_ec2.InstanceType
- *Default:* InstanceType("t3.medium")
Optional: The GameServer's EC2 Instance type.
> [https://aws.amazon.com/ec2/instance-types/](https://aws.amazon.com/ec2/instance-types/)
---
##### `releaseIPOnDelete`Optional
```typescript
public readonly releaseIPOnDelete: boolean;
```
- *Type:* boolean
- *Default:* false
Optional: Whether to automatically release the GameServer's elastic IP address when the stack is torn down.
Elastic IPs cost a nominal fee when reserved but unallocated. If you release an elastic IP, there is no way to guarantee that you'll ever get it back.
> [https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html)
---
##### `rootVolumeSize`Optional
```typescript
public readonly rootVolumeSize: number;
```
- *Type:* number
- *Default:* 50
Optional: The desired size of the GameServer's root volume, in GB.
Given value must be >= 15 to prevent the need for future volume expansion.
---
##### `vpcId`Optional
```typescript
public readonly vpcId: string;
```
- *Type:* string
- *Default:* A new VPC is created with 2 public subnets.
Optional: The VPC ID of the existing VPC in which to deploy the GameServer.
---
### ValheimServerProps
Constructor properties that define the ValheimServer object.
#### Initializer
```typescript
import { ValheimServerProps } from 'aws-gameservers'
const valheimServerProps: ValheimServerProps = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| backupGameServer | boolean | Optional: Whether to back up the GameServer. |
| game | string | The name of the game being hosted on this GameServer. |
| instanceType | aws-cdk-lib.aws_ec2.InstanceType | Optional: The GameServer's EC2 Instance type. |
| releaseIPOnDelete | boolean | Optional: Whether to automatically release the GameServer's elastic IP address when the stack is torn down. |
| rootVolumeSize | number | Optional: The desired size of the GameServer's root volume, in GB. |
| vpcId | string | Optional: The VPC ID of the existing VPC in which to deploy the GameServer. |
---
##### `backupGameServer`Optional
```typescript
public readonly backupGameServer: boolean;
```
- *Type:* boolean
- *Default:* true
Optional: Whether to back up the GameServer.
When true, the AWS Backup settings for the GameServer follow the "dailyMonthly1YearRetention" plan.
---
##### `game`Optional
```typescript
public readonly game: string;
```
- *Type:* string
The name of the game being hosted on this GameServer.
This is used for LogicalId sugar throughout the object.
---
##### `instanceType`Optional
```typescript
public readonly instanceType: InstanceType;
```
- *Type:* aws-cdk-lib.aws_ec2.InstanceType
- *Default:* InstanceType("t3.medium")
Optional: The GameServer's EC2 Instance type.
> [https://aws.amazon.com/ec2/instance-types/](https://aws.amazon.com/ec2/instance-types/)
---
##### `releaseIPOnDelete`Optional
```typescript
public readonly releaseIPOnDelete: boolean;
```
- *Type:* boolean
- *Default:* false
Optional: Whether to automatically release the GameServer's elastic IP address when the stack is torn down.
Elastic IPs cost a nominal fee when reserved but unallocated. If you release an elastic IP, there is no way to guarantee that you'll ever get it back.
> [https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html)
---
##### `rootVolumeSize`Optional
```typescript
public readonly rootVolumeSize: number;
```
- *Type:* number
- *Default:* 50
Optional: The desired size of the GameServer's root volume, in GB.
Given value must be >= 15 to prevent the need for future volume expansion.
---
##### `vpcId`Optional
```typescript
public readonly vpcId: string;
```
- *Type:* string
- *Default:* A new VPC is created with 2 public subnets.
Optional: The VPC ID of the existing VPC in which to deploy the GameServer.
---
## Protocols
### IAmpServer
- *Extends:* IGameServer
- *Implemented By:* IAmpServer
Defines the overall expected shape of AmpServer objects.
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| elasticIp | aws-cdk-lib.aws_ec2.CfnEIP | The Elastic IP Address attached to the GameServer. |
| game | string | The name of the game being hosted on this GameServer. |
| server | aws-cdk-lib.aws_ec2.IInstance | The EC2 Instance Object representing the GameServer itself. |
| vpc | aws-cdk-lib.aws_ec2.IVpc | The VPC where the GameServer is deployed. |
| securityGroup | aws-cdk-lib.aws_ec2.ISecurityGroup | The security group attached to the GameServer Instance. |
| serverRole | aws-cdk-lib.aws_iam.IRole | The role associated with the GameServer's instance profile. |
| userData | aws-cdk-lib.aws_ec2.UserData | The modifiable UserData object attached to the GameServer Instance object. |
---
##### `elasticIp`Required
```typescript
public readonly elasticIp: CfnEIP;
```
- *Type:* aws-cdk-lib.aws_ec2.CfnEIP
The Elastic IP Address attached to the GameServer.
---
##### `game`Required
```typescript
public readonly game: string;
```
- *Type:* string
The name of the game being hosted on this GameServer.
---
##### `server`Required
```typescript
public readonly server: IInstance;
```
- *Type:* aws-cdk-lib.aws_ec2.IInstance
The EC2 Instance Object representing the GameServer itself.
---
##### `vpc`Required
```typescript
public readonly vpc: IVpc;
```
- *Type:* aws-cdk-lib.aws_ec2.IVpc
The VPC where the GameServer is deployed.
---
##### `securityGroup`Required
```typescript
public readonly securityGroup: ISecurityGroup;
```
- *Type:* aws-cdk-lib.aws_ec2.ISecurityGroup
The security group attached to the GameServer Instance.
---
##### `serverRole`Required
```typescript
public readonly serverRole: IRole;
```
- *Type:* aws-cdk-lib.aws_iam.IRole
The role associated with the GameServer's instance profile.
---
##### `userData`Required
```typescript
public readonly userData: UserData;
```
- *Type:* aws-cdk-lib.aws_ec2.UserData
The modifiable UserData object attached to the GameServer Instance object.
---
### IGameServer
- *Implemented By:* AmpServer, GameServer, ValheimServer, IAmpServer, IGameServer, IValheimServer
Defines the overall expected shape of GameServer objects.
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| elasticIp | aws-cdk-lib.aws_ec2.CfnEIP | The Elastic IP Address attached to the GameServer. |
| game | string | The name of the game being hosted on this GameServer. |
| server | aws-cdk-lib.aws_ec2.IInstance | The EC2 Instance Object representing the GameServer itself. |
| vpc | aws-cdk-lib.aws_ec2.IVpc | The VPC where the GameServer is deployed. |
| securityGroup | aws-cdk-lib.aws_ec2.ISecurityGroup | The security group attached to the GameServer Instance. |
| serverRole | aws-cdk-lib.aws_iam.IRole | The role associated with the GameServer's instance profile. |
| userData | aws-cdk-lib.aws_ec2.UserData | The modifiable UserData object attached to the GameServer Instance object. |
---
##### `elasticIp`Required
```typescript
public readonly elasticIp: CfnEIP;
```
- *Type:* aws-cdk-lib.aws_ec2.CfnEIP
The Elastic IP Address attached to the GameServer.
---
##### `game`Required
```typescript
public readonly game: string;
```
- *Type:* string
The name of the game being hosted on this GameServer.
---
##### `server`Required
```typescript
public readonly server: IInstance;
```
- *Type:* aws-cdk-lib.aws_ec2.IInstance
The EC2 Instance Object representing the GameServer itself.
---
##### `vpc`Required
```typescript
public readonly vpc: IVpc;
```
- *Type:* aws-cdk-lib.aws_ec2.IVpc
The VPC where the GameServer is deployed.
---
##### `securityGroup`Required
```typescript
public readonly securityGroup: ISecurityGroup;
```
- *Type:* aws-cdk-lib.aws_ec2.ISecurityGroup
The security group attached to the GameServer Instance.
---
##### `serverRole`Required
```typescript
public readonly serverRole: IRole;
```
- *Type:* aws-cdk-lib.aws_iam.IRole
The role associated with the GameServer's instance profile.
---
##### `userData`Required
```typescript
public readonly userData: UserData;
```
- *Type:* aws-cdk-lib.aws_ec2.UserData
The modifiable UserData object attached to the GameServer Instance object.
---
### IValheimServer
- *Extends:* IGameServer
- *Implemented By:* IValheimServer
Defines the overall expected shape of ValheimServer objects.
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| elasticIp | aws-cdk-lib.aws_ec2.CfnEIP | The Elastic IP Address attached to the GameServer. |
| game | string | The name of the game being hosted on this GameServer. |
| server | aws-cdk-lib.aws_ec2.IInstance | The EC2 Instance Object representing the GameServer itself. |
| vpc | aws-cdk-lib.aws_ec2.IVpc | The VPC where the GameServer is deployed. |
| securityGroup | aws-cdk-lib.aws_ec2.ISecurityGroup | The security group attached to the GameServer Instance. |
| serverRole | aws-cdk-lib.aws_iam.IRole | The role associated with the GameServer's instance profile. |
| userData | aws-cdk-lib.aws_ec2.UserData | The modifiable UserData object attached to the GameServer Instance object. |
---
##### `elasticIp`Required
```typescript
public readonly elasticIp: CfnEIP;
```
- *Type:* aws-cdk-lib.aws_ec2.CfnEIP
The Elastic IP Address attached to the GameServer.
---
##### `game`Required
```typescript
public readonly game: string;
```
- *Type:* string
The name of the game being hosted on this GameServer.
---
##### `server`Required
```typescript
public readonly server: IInstance;
```
- *Type:* aws-cdk-lib.aws_ec2.IInstance
The EC2 Instance Object representing the GameServer itself.
---
##### `vpc`Required
```typescript
public readonly vpc: IVpc;
```
- *Type:* aws-cdk-lib.aws_ec2.IVpc
The VPC where the GameServer is deployed.
---
##### `securityGroup`Required
```typescript
public readonly securityGroup: ISecurityGroup;
```
- *Type:* aws-cdk-lib.aws_ec2.ISecurityGroup
The security group attached to the GameServer Instance.
---
##### `serverRole`Required
```typescript
public readonly serverRole: IRole;
```
- *Type:* aws-cdk-lib.aws_iam.IRole
The role associated with the GameServer's instance profile.
---
##### `userData`Required
```typescript
public readonly userData: UserData;
```
- *Type:* aws-cdk-lib.aws_ec2.UserData
The modifiable UserData object attached to the GameServer Instance object.
---