automation Submodule

Constructs

BaseDockerProject

• Implements: aws-cdk-lib.IResource

The base for Linux-based Docker build projects.

Initializers

import { automation } from 'shady-island'

new automation.BaseDockerProject(scope: Construct, id: string, props: BaseDockerProjectProps)

Name	Type	Description
scope	constructs.Construct	- The scope in which to define this construct.
id	string	- The scoped construct ID.
props	BaseDockerProjectProps	- Initialization properties for this construct.

---

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

id^Required

• Type: string

The scoped construct ID.

---

props^Required

• Type: BaseDockerProjectProps

Initialization properties for this construct.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
applyRemovalPolicy	Apply the given removal policy to this resource.

---

toString

public toString(): string

Returns a string representation of this construct.

applyRemovalPolicy

public applyRemovalPolicy(policy: RemovalPolicy): void

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).

policy^Required

• Type: aws-cdk-lib.RemovalPolicy

---

Static Functions

Name	Description
isConstruct	Checks if x is a construct.

---

isConstruct

import { automation } from 'shady-island'

automation.BaseDockerProject.isConstruct(x: any)

Checks if x is a construct.

x^Required

• Type: any

Any object.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
buildSpec	aws-cdk-lib.aws_codebuild.BuildSpec	The CodeBuild build spec supplied.
env	aws-cdk-lib.ResourceEnvironment	The environment this resource belongs to.
logGroup	aws-cdk-lib.aws_logs.LogGroup	The log group.
project	aws-cdk-lib.aws_codebuild.PipelineProject	The CodeBuild project.
stack	aws-cdk-lib.Stack	The stack in which this resource is defined.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

buildSpec^Required

public readonly buildSpec: BuildSpec;

• Type: aws-cdk-lib.aws_codebuild.BuildSpec

The CodeBuild build spec supplied.

---

env^Required

public readonly env: ResourceEnvironment;

• Type: aws-cdk-lib.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.

---

logGroup^Required

public readonly logGroup: LogGroup;

• Type: aws-cdk-lib.aws_logs.LogGroup

The log group.

---

project^Required

public readonly project: PipelineProject;

• Type: aws-cdk-lib.aws_codebuild.PipelineProject

The CodeBuild project.

---

stack^Required

public readonly stack: Stack;

• Type: aws-cdk-lib.Stack

The stack in which this resource is defined.

---

ContainerImagePipeline

Allows images pushed to an ECR repo to trigger updates to an ECS service.

This construct produces a CodePipeline pipeline using the “ECR Source” action, an “ECS Deploy” action, and a custom Lambda handler in between that transforms the JSON from the “Source” action into the JSON needed for the “Deploy” action.

Initializers

import { automation } from 'shady-island'

new automation.ContainerImagePipeline(scope: Construct, id: string, props: ContainerImagePipelineProps)

Name	Type	Description
scope	constructs.Construct	- The scope in which to define this construct.
id	string	- The scoped construct ID.
props	ContainerImagePipelineProps	- Initialization properties for this construct.

---

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

id^Required

• Type: string

The scoped construct ID.

---

props^Required

• Type: ContainerImagePipelineProps

Initialization properties for this construct.

---

Methods

Name	Description
toString	Returns a string representation of this construct.

---

toString

public toString(): string

Returns a string representation of this construct.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.

---

isConstruct

import { automation } from 'shady-island'

automation.ContainerImagePipeline.isConstruct(x: any)

Checks if x is a construct.

x^Required

• Type: any

Any object.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
pipeline	aws-cdk-lib.aws_codepipeline.Pipeline	The CodePipeline pipeline.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

pipeline^Required

public readonly pipeline: Pipeline;

• Type: aws-cdk-lib.aws_codepipeline.Pipeline

The CodePipeline pipeline.

---

FunctionCodeUpdater

Automates deployments of Lambda function code.

In order to guarantee the least amount of privilege to the principal sending new code revisions to S3 (e.g. a GitHub Action, a CodeBuild project), you can use this construct to call the UpdateFunctionCode action of the Lambda API any time a new revision is added to a bucket (which must support versioning).

Initializers

import { automation } from 'shady-island'

new automation.FunctionCodeUpdater(scope: Construct, id: string, props: FunctionCodeUpdaterProps)

Name	Type	Description
scope	constructs.Construct	- The scope in which to define this construct.
id	string	- The scoped construct ID.
props	FunctionCodeUpdaterProps	- Initialization properties for this construct.

---

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

id^Required

• Type: string

The scoped construct ID.

---

props^Required

• Type: FunctionCodeUpdaterProps

Initialization properties for this construct.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
grantPutCode	Grants s3:PutObject* and s3:AbortObject* permissions for the S3 object key of the Lambda function code.

---

toString

public toString(): string

Returns a string representation of this construct.

grantPutCode

public grantPutCode(identity: IGrantable): Grant

Grants s3:PutObject* and s3:AbortObject* permissions for the S3 object key of the Lambda function code.

If encryption is used, permission to use the key to encrypt uploaded files will also be granted to the same principal.

identity^Required

• Type: aws-cdk-lib.aws_iam.IGrantable

The principal.

---

Static Functions

Name	Description
isConstruct	Checks if x is a construct.

---

isConstruct

import { automation } from 'shady-island'

automation.FunctionCodeUpdater.isConstruct(x: any)

Checks if x is a construct.

x^Required

• Type: any

Any object.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

LinuxDockerBuildProject

Sets up a standardized Docker build project.

This project accepts the following optional environment variables:

• IMAGE_LABELS: JSON-formatted object of container labels and their values.
• BUILD_ARGS: JSON-formatted object of build arguments and their values.
• IMAGE_TAG: Optional. The image tag (e.g. Git commit ID) (default: build number).

Initializers

import { automation } from 'shady-island'

new automation.LinuxDockerBuildProject(scope: Construct, id: string, props: LinuxDockerBuildProjectProps)

Name	Type	Description
scope	constructs.Construct	- The scope in which to define this construct.
id	string	- The scoped construct ID.
props	LinuxDockerBuildProjectProps	- Initialization properties for this construct.

---

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

id^Required

• Type: string

The scoped construct ID.

---

props^Required

• Type: LinuxDockerBuildProjectProps

Initialization properties for this construct.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
applyRemovalPolicy	Apply the given removal policy to this resource.

---

toString

public toString(): string

Returns a string representation of this construct.

applyRemovalPolicy

public applyRemovalPolicy(policy: RemovalPolicy): void

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).

policy^Required

• Type: aws-cdk-lib.RemovalPolicy

---

Static Functions

Name	Description
isConstruct	Checks if x is a construct.

---

isConstruct

import { automation } from 'shady-island'

automation.LinuxDockerBuildProject.isConstruct(x: any)

Checks if x is a construct.

x^Required

• Type: any

Any object.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
buildSpec	aws-cdk-lib.aws_codebuild.BuildSpec	The CodeBuild build spec supplied.
env	aws-cdk-lib.ResourceEnvironment	The environment this resource belongs to.
logGroup	aws-cdk-lib.aws_logs.LogGroup	The log group.
project	aws-cdk-lib.aws_codebuild.PipelineProject	The CodeBuild project.
stack	aws-cdk-lib.Stack	The stack in which this resource is defined.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

buildSpec^Required

public readonly buildSpec: BuildSpec;

• Type: aws-cdk-lib.aws_codebuild.BuildSpec

The CodeBuild build spec supplied.

---

env^Required

public readonly env: ResourceEnvironment;

• Type: aws-cdk-lib.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.

---

logGroup^Required

public readonly logGroup: LogGroup;

• Type: aws-cdk-lib.aws_logs.LogGroup

The log group.

---

project^Required

public readonly project: PipelineProject;

• Type: aws-cdk-lib.aws_codebuild.PipelineProject

The CodeBuild project.

---

stack^Required

public readonly stack: Stack;

• Type: aws-cdk-lib.Stack

The stack in which this resource is defined.

---

LinuxDockerManifestProject

Sets up a standardized Docker manifest build project.

This project accepts the following variables:

• LATEST_TAG: Optional. The tag to push (default: “latest”).
• MANIFEST_CUSTOM_TAG: Optional. The tag to push, in addition to $LATEST_TAG.

Initializers

import { automation } from 'shady-island'

new automation.LinuxDockerManifestProject(scope: Construct, id: string, props: LinuxDockerManifestProjectProps)

Name	Type	Description
scope	constructs.Construct	- The scope in which to define this construct.
id	string	- The scoped construct ID.
props	LinuxDockerManifestProjectProps	- Initialization properties for this construct.

---

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

id^Required

• Type: string

The scoped construct ID.

---

props^Required

• Type: LinuxDockerManifestProjectProps

Initialization properties for this construct.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
applyRemovalPolicy	Apply the given removal policy to this resource.

---

toString

public toString(): string

Returns a string representation of this construct.

applyRemovalPolicy

public applyRemovalPolicy(policy: RemovalPolicy): void

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).

policy^Required

• Type: aws-cdk-lib.RemovalPolicy

---

Static Functions

Name	Description
isConstruct	Checks if x is a construct.

---

isConstruct

import { automation } from 'shady-island'

automation.LinuxDockerManifestProject.isConstruct(x: any)

Checks if x is a construct.

x^Required

• Type: any

Any object.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
buildSpec	aws-cdk-lib.aws_codebuild.BuildSpec	The CodeBuild build spec supplied.
env	aws-cdk-lib.ResourceEnvironment	The environment this resource belongs to.
logGroup	aws-cdk-lib.aws_logs.LogGroup	The log group.
project	aws-cdk-lib.aws_codebuild.PipelineProject	The CodeBuild project.
stack	aws-cdk-lib.Stack	The stack in which this resource is defined.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

buildSpec^Required

public readonly buildSpec: BuildSpec;

• Type: aws-cdk-lib.aws_codebuild.BuildSpec

The CodeBuild build spec supplied.

---

env^Required

public readonly env: ResourceEnvironment;

• Type: aws-cdk-lib.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.

---

logGroup^Required

public readonly logGroup: LogGroup;

• Type: aws-cdk-lib.aws_logs.LogGroup

The log group.

---

project^Required

public readonly project: PipelineProject;

• Type: aws-cdk-lib.aws_codebuild.PipelineProject

The CodeBuild project.

---

stack^Required

public readonly stack: Stack;

• Type: aws-cdk-lib.Stack

The stack in which this resource is defined.

---

Structs

BaseDockerProjectProps

Constructor properties for BaseDockerProject.

Initializer

import { automation } from 'shady-island'

const baseDockerProjectProps: automation.BaseDockerProjectProps = { ... }

Properties

Name	Type	Description
repository	aws-cdk-lib.aws_ecr.IRepository	The ECR repository where images are pushed.
description	string	A description of this CodeBuild project.
logRetention	aws-cdk-lib.aws_logs.RetentionDays	The duration to retain log entries.
removalPolicy	aws-cdk-lib.RemovalPolicy	The removal policy for this project and its logs.
securityGroups	aws-cdk-lib.aws_ec2.ISecurityGroup[]	Security groups to associate with the project’s network interfaces.
subnetSelection	aws-cdk-lib.aws_ec2.SubnetSelection	Where to place the network interfaces within the VPC.
vpc	aws-cdk-lib.aws_ec2.IVpc	VPC network to place CodeBuild network interfaces.
buildEnvironment	aws-cdk-lib.aws_codebuild.BuildEnvironment	Build environment to use for the build.
buildSpec	aws-cdk-lib.aws_codebuild.BuildSpec	Filename or contents of buildspec in JSON format.

---

repository^Required

public readonly repository: IRepository;

• Type: aws-cdk-lib.aws_ecr.IRepository

The ECR repository where images are pushed.

---

description^Optional

public readonly description: string;

• Type: string

A description of this CodeBuild project.

---

logRetention^Optional

public readonly logRetention: RetentionDays;

• Type: aws-cdk-lib.aws_logs.RetentionDays
• Default: RetentionDays.THREE_MONTHS

The duration to retain log entries.

---

removalPolicy^Optional

public readonly removalPolicy: RemovalPolicy;

• Type: aws-cdk-lib.RemovalPolicy

The removal policy for this project and its logs.

---

securityGroups^Optional

public readonly securityGroups: ISecurityGroup[];

• Type: aws-cdk-lib.aws_ec2.ISecurityGroup[]

Security groups to associate with the project’s network interfaces.

---

subnetSelection^Optional

public readonly subnetSelection: SubnetSelection;

• Type: aws-cdk-lib.aws_ec2.SubnetSelection

Where to place the network interfaces within the VPC.

---

vpc^Optional

public readonly vpc: IVpc;

• Type: aws-cdk-lib.aws_ec2.IVpc

VPC network to place CodeBuild network interfaces.

---

buildEnvironment^Required

public readonly buildEnvironment: BuildEnvironment;

• Type: aws-cdk-lib.aws_codebuild.BuildEnvironment

Build environment to use for the build.

---

buildSpec^Required

public readonly buildSpec: BuildSpec;

• Type: aws-cdk-lib.aws_codebuild.BuildSpec

Filename or contents of buildspec in JSON format.

---

CommonDockerProps

Common Docker build properties.

Initializer

import { automation } from 'shady-island'

const commonDockerProps: automation.CommonDockerProps = { ... }

Properties

Name	Type	Description
repository	aws-cdk-lib.aws_ecr.IRepository	The ECR repository where images are pushed.
description	string	A description of this CodeBuild project.
logRetention	aws-cdk-lib.aws_logs.RetentionDays	The duration to retain log entries.
removalPolicy	aws-cdk-lib.RemovalPolicy	The removal policy for this project and its logs.
securityGroups	aws-cdk-lib.aws_ec2.ISecurityGroup[]	Security groups to associate with the project’s network interfaces.
subnetSelection	aws-cdk-lib.aws_ec2.SubnetSelection	Where to place the network interfaces within the VPC.
vpc	aws-cdk-lib.aws_ec2.IVpc	VPC network to place CodeBuild network interfaces.

---

repository^Required

public readonly repository: IRepository;

• Type: aws-cdk-lib.aws_ecr.IRepository

The ECR repository where images are pushed.

---

description^Optional

public readonly description: string;

• Type: string

A description of this CodeBuild project.

---

logRetention^Optional

public readonly logRetention: RetentionDays;

• Type: aws-cdk-lib.aws_logs.RetentionDays
• Default: RetentionDays.THREE_MONTHS

The duration to retain log entries.

---

removalPolicy^Optional

public readonly removalPolicy: RemovalPolicy;

• Type: aws-cdk-lib.RemovalPolicy

The removal policy for this project and its logs.

---

securityGroups^Optional

public readonly securityGroups: ISecurityGroup[];

• Type: aws-cdk-lib.aws_ec2.ISecurityGroup[]

Security groups to associate with the project’s network interfaces.

---

subnetSelection^Optional

public readonly subnetSelection: SubnetSelection;

• Type: aws-cdk-lib.aws_ec2.SubnetSelection

Where to place the network interfaces within the VPC.

---

vpc^Optional

public readonly vpc: IVpc;

• Type: aws-cdk-lib.aws_ec2.IVpc

VPC network to place CodeBuild network interfaces.

---

ContainerImagePipelineProps

Properties for the ContainerImagePipeline constructor.

Initializer

import { automation } from 'shady-island'

const containerImagePipelineProps: automation.ContainerImagePipelineProps = { ... }

Properties

Name	Type	Description
container	string	The name of the container in the task definition to update.
repository	aws-cdk-lib.aws_ecr.IRepository	The ECR repository where images will be pushed.
service	aws-cdk-lib.aws_ecs.IBaseService	The ECS service to update when an image is pushed to the ECR repository.
artifactBucket	aws-cdk-lib.aws_s3.IBucket	A custom bucket for artifacts.
pipelineType	aws-cdk-lib.aws_codepipeline.PipelineType	The pipeline type (V1 or V2).
tag	string	The container image tag to observe for changes in the ECR repository.

---

container^Required

public readonly container: string;

• Type: string

The name of the container in the task definition to update.

---

repository^Required

public readonly repository: IRepository;

• Type: aws-cdk-lib.aws_ecr.IRepository

The ECR repository where images will be pushed.

---

service^Required

public readonly service: IBaseService;

• Type: aws-cdk-lib.aws_ecs.IBaseService

The ECS service to update when an image is pushed to the ECR repository.

---

artifactBucket^Optional

public readonly artifactBucket: IBucket;

• Type: aws-cdk-lib.aws_s3.IBucket
• Default: A new bucket will be created

A custom bucket for artifacts.

---

pipelineType^Optional

public readonly pipelineType: PipelineType;

• Type: aws-cdk-lib.aws_codepipeline.PipelineType
• Default: V1

The pipeline type (V1 or V2).

---

tag^Optional

public readonly tag: string;

• Type: string
• Default: “latest”

The container image tag to observe for changes in the ECR repository.

---

FunctionCodeUpdaterProps

Constructor properties for FunctionCodeUpdater.

Initializer

import { automation } from 'shady-island'

const functionCodeUpdaterProps: automation.FunctionCodeUpdaterProps = { ... }

Properties

Name	Type	Description
bucket	aws-cdk-lib.aws_s3.IBucket	The bucket to monitor for changes.
objectKey	string	The object within the bucket to monitor (e.g. my-application/code.zip).
target	aws-cdk-lib.aws_lambda.IFunction	The Lambda function to update.

---

bucket^Required

public readonly bucket: IBucket;

• Type: aws-cdk-lib.aws_s3.IBucket

The bucket to monitor for changes.

---

objectKey^Required

public readonly objectKey: string;

• Type: string

The object within the bucket to monitor (e.g. my-application/code.zip).

---

target^Required

public readonly target: IFunction;

• Type: aws-cdk-lib.aws_lambda.IFunction

The Lambda function to update.

---

LinuxDockerBuildProjectProps

Constructor properties for LinuxDockerBuildProject.

Initializer

import { automation } from 'shady-island'

const linuxDockerBuildProjectProps: automation.LinuxDockerBuildProjectProps = { ... }

Properties

Name	Type	Description
repository	aws-cdk-lib.aws_ecr.IRepository	The ECR repository where images are pushed.
description	string	A description of this CodeBuild project.
logRetention	aws-cdk-lib.aws_logs.RetentionDays	The duration to retain log entries.
removalPolicy	aws-cdk-lib.RemovalPolicy	The removal policy for this project and its logs.
securityGroups	aws-cdk-lib.aws_ec2.ISecurityGroup[]	Security groups to associate with the project’s network interfaces.
subnetSelection	aws-cdk-lib.aws_ec2.SubnetSelection	Where to place the network interfaces within the VPC.
vpc	aws-cdk-lib.aws_ec2.IVpc	VPC network to place CodeBuild network interfaces.
buildDirectory	string	The build context directory.
buildImage	aws-cdk-lib.aws_codebuild.IBuildImage	The CodeBuild build image to use.
computeType	aws-cdk-lib.aws_codebuild.ComputeType	The type of compute to use for this build.
dockerfile	string	The filename of the Dockerfile.
enableCache	boolean	Whether to enable build caching.
pushLatest	boolean	Whether to push a “latest” tag.
testCommands	string[]	Commands used to test the image once built.

---

repository^Required

public readonly repository: IRepository;

• Type: aws-cdk-lib.aws_ecr.IRepository

The ECR repository where images are pushed.

---

description^Optional

public readonly description: string;

• Type: string

A description of this CodeBuild project.

---

logRetention^Optional

public readonly logRetention: RetentionDays;

• Type: aws-cdk-lib.aws_logs.RetentionDays
• Default: RetentionDays.THREE_MONTHS

The duration to retain log entries.

---

removalPolicy^Optional

public readonly removalPolicy: RemovalPolicy;

• Type: aws-cdk-lib.RemovalPolicy

The removal policy for this project and its logs.

---

securityGroups^Optional

public readonly securityGroups: ISecurityGroup[];

• Type: aws-cdk-lib.aws_ec2.ISecurityGroup[]

Security groups to associate with the project’s network interfaces.

---

subnetSelection^Optional

public readonly subnetSelection: SubnetSelection;

• Type: aws-cdk-lib.aws_ec2.SubnetSelection

Where to place the network interfaces within the VPC.

---

vpc^Optional

public readonly vpc: IVpc;

• Type: aws-cdk-lib.aws_ec2.IVpc

VPC network to place CodeBuild network interfaces.

---

buildDirectory^Optional

public readonly buildDirectory: string;

• Type: string
• Default: The current directory (.)

The build context directory.

---

buildImage^Optional

public readonly buildImage: IBuildImage;

• Type: aws-cdk-lib.aws_codebuild.IBuildImage
• Default: LinuxBuildImage.STANDARD_7_0

The CodeBuild build image to use.

---

computeType^Optional

public readonly computeType: ComputeType;

• Type: aws-cdk-lib.aws_codebuild.ComputeType
• Default: ComputeType.SMALL

The type of compute to use for this build.

---

dockerfile^Optional

public readonly dockerfile: string;

• Type: string
• Default: Dockerfile

The filename of the Dockerfile.

---

enableCache^Optional

public readonly enableCache: boolean;

• Type: boolean
• Default: false

Whether to enable build caching.

---

pushLatest^Optional

public readonly pushLatest: boolean;

• Type: boolean
• Default: true

Whether to push a “latest” tag.

---

testCommands^Optional

public readonly testCommands: string[];

• Type: string[]

Commands used to test the image once built.

---

LinuxDockerManifestProjectProps

Constructor properties for LinuxDockerManifestProject.

Initializer

import { automation } from 'shady-island'

const linuxDockerManifestProjectProps: automation.LinuxDockerManifestProjectProps = { ... }

Properties

Name	Type	Description
repository	aws-cdk-lib.aws_ecr.IRepository	The ECR repository where images are pushed.
description	string	A description of this CodeBuild project.
logRetention	aws-cdk-lib.aws_logs.RetentionDays	The duration to retain log entries.
removalPolicy	aws-cdk-lib.RemovalPolicy	The removal policy for this project and its logs.
securityGroups	aws-cdk-lib.aws_ec2.ISecurityGroup[]	Security groups to associate with the project’s network interfaces.
subnetSelection	aws-cdk-lib.aws_ec2.SubnetSelection	Where to place the network interfaces within the VPC.
vpc	aws-cdk-lib.aws_ec2.IVpc	VPC network to place CodeBuild network interfaces.
tagVariableNames	string[]	The names of environment variables that contain the image hashes to add.
buildImage	aws-cdk-lib.aws_codebuild.IBuildImage	The CodeBuild build image to use.
computeType	aws-cdk-lib.aws_codebuild.ComputeType	The type of compute to use for this build.

---

repository^Required

public readonly repository: IRepository;

• Type: aws-cdk-lib.aws_ecr.IRepository

The ECR repository where images are pushed.

---

description^Optional

public readonly description: string;

• Type: string

A description of this CodeBuild project.

---

logRetention^Optional

public readonly logRetention: RetentionDays;

• Type: aws-cdk-lib.aws_logs.RetentionDays
• Default: RetentionDays.THREE_MONTHS

The duration to retain log entries.

---

removalPolicy^Optional

public readonly removalPolicy: RemovalPolicy;

• Type: aws-cdk-lib.RemovalPolicy

The removal policy for this project and its logs.

---

securityGroups^Optional

public readonly securityGroups: ISecurityGroup[];

• Type: aws-cdk-lib.aws_ec2.ISecurityGroup[]

Security groups to associate with the project’s network interfaces.

---

subnetSelection^Optional

public readonly subnetSelection: SubnetSelection;

• Type: aws-cdk-lib.aws_ec2.SubnetSelection

Where to place the network interfaces within the VPC.

---

vpc^Optional

public readonly vpc: IVpc;

• Type: aws-cdk-lib.aws_ec2.IVpc

VPC network to place CodeBuild network interfaces.

---

tagVariableNames^Required

public readonly tagVariableNames: string[];

• Type: string[]

The names of environment variables that contain the image hashes to add.

---

buildImage^Optional

public readonly buildImage: IBuildImage;

• Type: aws-cdk-lib.aws_codebuild.IBuildImage
• Default: LinuxBuildImage.STANDARD_7_0

The CodeBuild build image to use.

---

computeType^Optional

public readonly computeType: ComputeType;

• Type: aws-cdk-lib.aws_codebuild.ComputeType
• Default: ComputeType.SMALL

The type of compute to use for this build.

---