AWS Classic

v5.16.0 published on Saturday, Sep 24, 2022 by Pulumi

getImage

The ECR Image data source allows the details of an image with a particular tag or digest to be retrieved.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var serviceImage = Aws.Ecr.GetImage.Invoke(new()
    {
        ImageTag = "latest",
        RepositoryName = "my/service",
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/ecr"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ecr.GetImage(ctx, &ecr.GetImageArgs{
			ImageTag:       pulumi.StringRef("latest"),
			RepositoryName: "my/service",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ecr.EcrFunctions;
import com.pulumi.aws.ecr.inputs.GetImageArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var serviceImage = EcrFunctions.getImage(GetImageArgs.builder()
            .imageTag("latest")
            .repositoryName("my/service")
            .build());

    }
}
import pulumi
import pulumi_aws as aws

service_image = aws.ecr.get_image(image_tag="latest",
    repository_name="my/service")
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const serviceImage = pulumi.output(aws.ecr.getImage({
    imageTag: "latest",
    repositoryName: "my/service",
}));
variables:
  serviceImage:
    Fn::Invoke:
      Function: aws:ecr:getImage
      Arguments:
        imageTag: latest
        repositoryName: my/service

Using getImage

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getImage(args: GetImageArgs, opts?: InvokeOptions): Promise<GetImageResult>
function getImageOutput(args: GetImageOutputArgs, opts?: InvokeOptions): Output<GetImageResult>
def get_image(image_digest: Optional[str] = None,
              image_tag: Optional[str] = None,
              registry_id: Optional[str] = None,
              repository_name: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetImageResult
def get_image_output(image_digest: Optional[pulumi.Input[str]] = None,
              image_tag: Optional[pulumi.Input[str]] = None,
              registry_id: Optional[pulumi.Input[str]] = None,
              repository_name: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetImageResult]
func GetImage(ctx *Context, args *GetImageArgs, opts ...InvokeOption) (*GetImageResult, error)
func GetImageOutput(ctx *Context, args *GetImageOutputArgs, opts ...InvokeOption) GetImageResultOutput

> Note: This function is named GetImage in the Go SDK.

public static class GetImage 
{
    public static Task<GetImageResult> InvokeAsync(GetImageArgs args, InvokeOptions? opts = null)
    public static Output<GetImageResult> Invoke(GetImageInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetImageResult> getImage(GetImageArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: aws:ecr/getImage:getImage
  Arguments:
    # Arguments dictionary

The following arguments are supported:

RepositoryName string

Name of the ECR Repository.

ImageDigest string

Sha256 digest of the image manifest. At least one of image_digest or image_tag must be specified.

ImageTag string

Tag associated with this image. At least one of image_digest or image_tag must be specified.

RegistryId string

ID of the Registry where the repository resides.

RepositoryName string

Name of the ECR Repository.

ImageDigest string

Sha256 digest of the image manifest. At least one of image_digest or image_tag must be specified.

ImageTag string

Tag associated with this image. At least one of image_digest or image_tag must be specified.

RegistryId string

ID of the Registry where the repository resides.

repositoryName String

Name of the ECR Repository.

imageDigest String

Sha256 digest of the image manifest. At least one of image_digest or image_tag must be specified.

imageTag String

Tag associated with this image. At least one of image_digest or image_tag must be specified.

registryId String

ID of the Registry where the repository resides.

repositoryName string

Name of the ECR Repository.

imageDigest string

Sha256 digest of the image manifest. At least one of image_digest or image_tag must be specified.

imageTag string

Tag associated with this image. At least one of image_digest or image_tag must be specified.

registryId string

ID of the Registry where the repository resides.

repository_name str

Name of the ECR Repository.

image_digest str

Sha256 digest of the image manifest. At least one of image_digest or image_tag must be specified.

image_tag str

Tag associated with this image. At least one of image_digest or image_tag must be specified.

registry_id str

ID of the Registry where the repository resides.

repositoryName String

Name of the ECR Repository.

imageDigest String

Sha256 digest of the image manifest. At least one of image_digest or image_tag must be specified.

imageTag String

Tag associated with this image. At least one of image_digest or image_tag must be specified.

registryId String

ID of the Registry where the repository resides.

getImage Result

The following output properties are available:

Id string

The provider-assigned unique ID for this managed resource.

ImageDigest string
ImagePushedAt int

Date and time, expressed as a unix timestamp, at which the current image was pushed to the repository.

ImageSizeInBytes int

Size, in bytes, of the image in the repository.

ImageTags List<string>

List of tags associated with this image.

RegistryId string
RepositoryName string
ImageTag string
Id string

The provider-assigned unique ID for this managed resource.

ImageDigest string
ImagePushedAt int

Date and time, expressed as a unix timestamp, at which the current image was pushed to the repository.

ImageSizeInBytes int

Size, in bytes, of the image in the repository.

ImageTags []string

List of tags associated with this image.

RegistryId string
RepositoryName string
ImageTag string
id String

The provider-assigned unique ID for this managed resource.

imageDigest String
imagePushedAt Integer

Date and time, expressed as a unix timestamp, at which the current image was pushed to the repository.

imageSizeInBytes Integer

Size, in bytes, of the image in the repository.

imageTags List<String>

List of tags associated with this image.

registryId String
repositoryName String
imageTag String
id string

The provider-assigned unique ID for this managed resource.

imageDigest string
imagePushedAt number

Date and time, expressed as a unix timestamp, at which the current image was pushed to the repository.

imageSizeInBytes number

Size, in bytes, of the image in the repository.

imageTags string[]

List of tags associated with this image.

registryId string
repositoryName string
imageTag string
id str

The provider-assigned unique ID for this managed resource.

image_digest str
image_pushed_at int

Date and time, expressed as a unix timestamp, at which the current image was pushed to the repository.

image_size_in_bytes int

Size, in bytes, of the image in the repository.

image_tags Sequence[str]

List of tags associated with this image.

registry_id str
repository_name str
image_tag str
id String

The provider-assigned unique ID for this managed resource.

imageDigest String
imagePushedAt Number

Date and time, expressed as a unix timestamp, at which the current image was pushed to the repository.

imageSizeInBytes Number

Size, in bytes, of the image in the repository.

imageTags List<String>

List of tags associated with this image.

registryId String
repositoryName String
imageTag String

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.