From e720ac304bac47da50125f028505aaaeafc2aa51 Mon Sep 17 00:00:00 2001 From: Kazuho CryerShinozuka Date: Mon, 12 Aug 2024 00:33:04 +0900 Subject: [PATCH] docs: update API.md --- API.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/API.md b/API.md index 548155d..a6dc138 100644 --- a/API.md +++ b/API.md @@ -138,6 +138,7 @@ const codeServerProps: CodeServerProps = { ... } | cpuType | aws-cdk-lib.aws_ec2.AmazonLinuxCpuType | The CPU type. | | instanceType | aws-cdk-lib.aws_ec2.InstanceType | The instance type. | | policy | aws-cdk-lib.aws_iam.PolicyStatement | The IAM policy to attach to the instance role. | +| userData | string[] | User data to run when launching the instance. | | volumeSize | number | The size of the root volume in GiB. | | vpc | aws-cdk-lib.aws_ec2.IVpc | The VPC where the instance will be deployed. | @@ -182,6 +183,19 @@ The IAM policy to attach to the instance role. --- +##### `userData`Optional + +```typescript +public readonly userData: string[]; +``` + +- *Type:* string[] +- *Default:* No additional user data + +User data to run when launching the instance. + +--- + ##### `volumeSize`Optional ```typescript