# ContainerImage

Constructs for types of container images.

Superclass of: [AssetImage](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.AssetImage.html), [EcrImage](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.EcrImage.html), [RepositoryImage](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.RepositoryImage.html), [TagParameterContainerImage](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.TagParameterContainerImage.html)
Obtainable from: ContainerImage.fromDockerImageAsset, ContainerImage.fromTarball

- Source: [`aws-ecs/lib/container-image.ts`](https://github.com/aws/aws-cdk/blob/v2.278.0/packages/aws-cdk-lib/aws-ecs/lib/container-image.ts#L12)
- Type last changed: v2.96.1 · 14 Sep 2023

## Example

TypeScript:

```ts
declare const myFileSystem: efs.IFileSystem;
declare const myJobRole: iam.Role;
myFileSystem.grantRead(myJobRole);

const jobDefn = new batch.EcsJobDefinition(this, 'JobDefn', {
  container: new batch.EcsEc2ContainerDefinition(this, 'containerDefn', {
    image: ecs.ContainerImage.fromRegistry('public.ecr.aws/amazonlinux/amazonlinux:latest'),
    memory: cdk.Size.mebibytes(2048),
    cpu: 256,
    volumes: [batch.EcsVolume.efs({
      name: 'myVolume',
      fileSystem: myFileSystem,
      containerPath: '/Volumes/myVolume',
      useJobRole: true,
    })],
    jobRole: myJobRole,
  }),
});
```

Python:

```python
# my_file_system: efs.IFileSystem
# my_job_role: iam.Role

my_file_system.grant_read(my_job_role)

job_defn = batch.EcsJobDefinition(self, "JobDefn",
    container=batch.EcsEc2ContainerDefinition(self, "containerDefn",
        image=ecs.ContainerImage.from_registry("public.ecr.aws/amazonlinux/amazonlinux:latest"),
        memory=cdk.Size.mebibytes(2048),
        cpu=256,
        volumes=[batch.EcsVolume.efs(
            name="myVolume",
            file_system=my_file_system,
            container_path="/Volumes/myVolume",
            use_job_role=True
        )],
        job_role=my_job_role
    )
)
```

Java:

```java
IFileSystem myFileSystem;
Role myJobRole;

myFileSystem.grantRead(myJobRole);

EcsJobDefinition jobDefn = EcsJobDefinition.Builder.create(this, "JobDefn")
        .container(EcsEc2ContainerDefinition.Builder.create(this, "containerDefn")
                .image(ContainerImage.fromRegistry("public.ecr.aws/amazonlinux/amazonlinux:latest"))
                .memory(Size.mebibytes(2048))
                .cpu(256)
                .volumes(List.of(EcsVolume.efs(EfsVolumeOptions.builder()
                        .name("myVolume")
                        .fileSystem(myFileSystem)
                        .containerPath("/Volumes/myVolume")
                        .useJobRole(true)
                        .build())))
                .jobRole(myJobRole)
                .build())
        .build();
```

C# / .NET:

```csharp
// Install: dotnet add package Amazon.CDK.Lib
IFileSystem myFileSystem;
Role myJobRole;

myFileSystem.GrantRead(myJobRole);

var jobDefn = new EcsJobDefinition(this, "JobDefn", new EcsJobDefinitionProps {
    Container = new EcsEc2ContainerDefinition(this, "containerDefn", new EcsEc2ContainerDefinitionProps {
        Image = ContainerImage.FromRegistry("public.ecr.aws/amazonlinux/amazonlinux:latest"),
        Memory = Size.Mebibytes(2048),
        Cpu = 256,
        Volumes = new [] { EcsVolume.Efs(new EfsVolumeOptions {
            Name = "myVolume",
            FileSystem = myFileSystem,
            ContainerPath = "/Volumes/myVolume",
            UseJobRole = true
        }) },
        JobRole = myJobRole
    })
});
```

Golang:

```go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
var myFileSystem IFileSystem
var myJobRole Role

myFileSystem.GrantRead(myJobRole)

jobDefn := batch.NewEcsJobDefinition(this, jsii.String("JobDefn"), &EcsJobDefinitionProps{
	Container: batch.NewEcsEc2ContainerDefinition(this, jsii.String("containerDefn"), &EcsEc2ContainerDefinitionProps{
		Image: ecs.ContainerImage_FromRegistry(jsii.String("public.ecr.aws/amazonlinux/amazonlinux:latest")),
		Memory: cdk.Size_Mebibytes(jsii.Number(2048)),
		Cpu: jsii.Number(256),
		Volumes: []EcsVolume{
			batch.EcsVolume_Efs(&EfsVolumeOptions{
				Name: jsii.String("myVolume"),
				FileSystem: myFileSystem,
				ContainerPath: jsii.String("/Volumes/myVolume"),
				UseJobRole: jsii.Boolean(true),
			}),
		},
		JobRole: myJobRole,
	}),
})
```

## Initializer

TypeScript:

```ts
new ContainerImage()
```

Python:

```python
ContainerImage()
```

Java:

```java
new ContainerImage()
```

C# / .NET:

```csharp
new ContainerImage()
```

Golang:

```go
NewContainerImage()
```

## Methods

- `bind(scope: Construct, containerDefinition: ContainerDefinition): ContainerImageConfig` — Called when the image is used by a ContainerDefinition.

- `fromAsset(directory: string, props?: AssetImageProps): AssetImage` (static) — Reference an image that's constructed directly from sources on disk.

  If you already have a `DockerImageAsset` instance, you can use the
  `ContainerImage.fromDockerImageAsset` method instead.

  **Parameters**

  - `directory` — The directory containing the Dockerfile.

- `fromDockerImageAsset(asset: DockerImageAsset): ContainerImage // chainable` (static) — Use an existing `DockerImageAsset` for this container image.

  **Parameters**

  - `asset` — The `DockerImageAsset` to use for this container definition.

- `fromEcrRepository(repository: IRepository, tag?: string): EcrImage` (static) — Reference an image in an ECR repository.

  **Parameters**

  - `tag` — If you don't specify this parameter, `latest` is used as default.

- `fromRegistry(name: string, props?: RepositoryImageProps): RepositoryImage` (static) — Reference an image on DockerHub or another online registry.

- `fromTarball(tarballFile: string): ContainerImage // chainable` (static) — Use an existing tarball for this container image.

  Use this method if the container image has already been created by another process (e.g. jib)
  and you want to add it as a container image asset.

  **Parameters**

  - `tarballFile` — Absolute path to the tarball.
