AWS CDK Reference

Appearance

v2.276.0

DockerImageCode Class ​

Code property for the DockerImageFunction construct.

Source
aws-lambda/lib/image-function.ts

Example ​

ts
new lambda.DockerImageFunction(this, 'AssetFunction', {
  code: lambda.DockerImageCode.fromImageAsset(path.join(__dirname, 'docker-arm64-handler')),
  architecture: lambda.Architecture.ARM_64,
});
python
lambda_.DockerImageFunction(self, "AssetFunction",
    code=lambda_.DockerImageCode.from_image_asset(path.join(__dirname, "docker-arm64-handler")),
    architecture=lambda_.Architecture.ARM_64
)
java
DockerImageFunction.Builder.create(this, "AssetFunction")
        .code(DockerImageCode.fromImageAsset(join(__dirname, "docker-arm64-handler")))
        .architecture(Architecture.ARM_64)
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
new DockerImageFunction(this, "AssetFunction", new DockerImageFunctionProps {
    Code = DockerImageCode.FromImageAsset(Join(__dirname, "docker-arm64-handler")),
    Architecture = Architecture.ARM_64
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
lambda.NewDockerImageFunction(this, jsii.String("AssetFunction"), &DockerImageFunctionProps{
	Code: lambda.DockerImageCode_FromImageAsset(path.join(__dirname, jsii.String("docker-arm64-handler"))),
	Architecture: lambda.Architecture_ARM_64(),
})

Initializer ​

ts
new DockerImageCode()
python
DockerImageCode()
java
new DockerImageCode()
csharp
new DockerImageCode()
go
NewDockerImageCode()

Methods ​

fromEcr(repository: IRepository, props?: EcrImageCodeProps): DockerImageCode // chainable@staticmethod def from_ecr(repository: IRepository, props: typing.Optional[EcrImageCodeProps] = None) -> DockerImageCodepublic static DockerImageCode fromEcr(IRepository repository, EcrImageCodeProps props)public static DockerImageCode FromEcr(IRepository repository, EcrImageCodeProps? props = null)func FromEcr(Repository IRepository, Props EcrImageCodeProps) DockerImageCodestatic#
Use an existing ECR image as the Lambda code.
2 parameters

Parameters

  • repositoryrepositoryrepositoryrepositoryRepository — the ECR repository that the image is in.
  • propspropspropspropsProps — properties to further configure the selected image.
fromImageAsset(directory: string, props?: AssetImageCodeProps): DockerImageCode // chainable@staticmethod def from_image_asset(directory: str, props: typing.Optional[AssetImageCodeProps] = None) -> DockerImageCodepublic static DockerImageCode fromImageAsset(String directory, AssetImageCodeProps props)public static DockerImageCode FromImageAsset(string directory, AssetImageCodeProps? props = null)func FromImageAsset(Directory *string, Props AssetImageCodeProps) DockerImageCodestatic#
Create an ECR image from the specified asset and bind it as the Lambda code.
2 parameters

Parameters

  • directorydirectorydirectorydirectoryDirectory — the directory from which the asset must be created.
  • propspropspropspropsProps — properties to further configure the selected image.