← All packages

AWS Classic

Pulumi Official

Package maintained by Pulumi

v5.4.0 published on Wednesday, May 4, 2022 by Pulumi

Source code

getImage

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

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var serviceImage = Output.Create(Aws.Ecr.GetImage.InvokeAsync(new Aws.Ecr.GetImageArgs
        {
            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 java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

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

    public static void stack(Context ctx) {
        final var serviceImage = Output.of(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: The name of the ECR Repository.
ImageDigest string: The sha256 digest of the image manifest. At least one of image_digest or image_tag must be specified.
ImageTag string: The tag associated with this image. At least one of image_digest or image_tag must be specified.
RegistryId string: The ID of the Registry where the repository resides.

RepositoryName string: The name of the ECR Repository.
ImageDigest string: The sha256 digest of the image manifest. At least one of image_digest or image_tag must be specified.
ImageTag string: The tag associated with this image. At least one of image_digest or image_tag must be specified.
RegistryId string: The ID of the Registry where the repository resides.

repositoryName String: The name of the ECR Repository.
imageDigest String: The sha256 digest of the image manifest. At least one of image_digest or image_tag must be specified.
imageTag String: The tag associated with this image. At least one of image_digest or image_tag must be specified.
registryId String: The ID of the Registry where the repository resides.

repositoryName string: The name of the ECR Repository.
imageDigest string: The sha256 digest of the image manifest. At least one of image_digest or image_tag must be specified.
imageTag string: The tag associated with this image. At least one of image_digest or image_tag must be specified.
registryId string: The ID of the Registry where the repository resides.

repository_name str: The name of the ECR Repository.
image_digest str: The sha256 digest of the image manifest. At least one of image_digest or image_tag must be specified.
image_tag str: The tag associated with this image. At least one of image_digest or image_tag must be specified.
registry_id str: The ID of the Registry where the repository resides.

repositoryName String: The name of the ECR Repository.
imageDigest String: The sha256 digest of the image manifest. At least one of image_digest or image_tag must be specified.
imageTag String: The tag associated with this image. At least one of image_digest or image_tag must be specified.
registryId String: The 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: The date and time, expressed as a unix timestamp, at which the current image was pushed to the repository.
ImageSizeInBytes int: The size, in bytes, of the image in the repository.
ImageTags List<string>: The 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: The date and time, expressed as a unix timestamp, at which the current image was pushed to the repository.
ImageSizeInBytes int: The size, in bytes, of the image in the repository.
ImageTags []string: The 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: The date and time, expressed as a unix timestamp, at which the current image was pushed to the repository.
imageSizeInBytes Integer: The size, in bytes, of the image in the repository.
imageTags List: The 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: The date and time, expressed as a unix timestamp, at which the current image was pushed to the repository.
imageSizeInBytes number: The size, in bytes, of the image in the repository.
imageTags string[]: The 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: The date and time, expressed as a unix timestamp, at which the current image was pushed to the repository.
image_size_in_bytes int: The size, in bytes, of the image in the repository.
image_tags Sequence[str]: The 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: The date and time, expressed as a unix timestamp, at which the current image was pushed to the repository.
imageSizeInBytes Number: The size, in bytes, of the image in the repository.
imageTags List: The 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.