1. Packages
  2. Control Plane (cpln)
  3. API Docs
  4. getImages
Control Plane v0.0.56 published on Wednesday, Apr 9, 2025 by pulumiverse

cpln.getImages

Explore with Pulumi AI

Use this data source to access information about all Images within Control Plane.

Optional

  • query (Block List, Max: 1) (see below).

query

Optional:

  • fetch (String) Type of fetch. Specify either: links or items. Default: items.
  • spec (Block List, Max: 1) (see below).

query.spec

Optional:

  • match (String) Type of match. Available values: all, any, none. Default: all.
  • terms (Block List) (see below).

query.spec.terms

Terms can only contain one of the following attributes: property, rel, tag.

Optional:

  • op (String) Type of query operation. Available values: =, >, >=, <, <=, !=, exists, !exists. Default: =.

  • property (String) Property to use for query evaluation.

  • rel (String) Rel to use use for query evaluation.

  • tag (String) Tag key to use for query evaluation.

  • value (String) Testing value for query evaluation.

Outputs

The following attributes are exported:

  • images (Block List) (see below).

images

  • cpln_id (String) The ID, in GUID format, of the Image.
  • name (String) Name of the Image.
  • tags (Map of String) Key-value map of resource tags.
  • self_link (String) Full link to this resource. Can be referenced by other resources.
  • tag (String) Tag of the image.
  • repository (String) Respository name of the image.
  • digest (String) A unique SHA256 hash used to identify a specific image version within the image registry.
  • manifest (Block List, Max: 1) (see below)

manifest

The manifest provides configuration and layers information about the image. It plays a crucial role in the Docker image distribution system, enabling image creation, verification, and replication in a consistent and secure manner.

  • config (Block List, Max: 1) (see below).
  • layers (Block List) (see below).
  • media_type (String) Specifies the type of the content represented in the manifest, allowing Docker clients and registries to understand how to handle the document correctly.
  • schema_version (Number) The version of the Docker Image Manifest format.

config and layers

The config is a JSON blob that contains the image configuration data which includes environment variables, default command to run, and other settings necessary to run the container based on this image.

Layers lists the digests of the image’s layers. These layers are filesystem changes or additions made in each step of the Docker image’s creation process. The layers are stored separately and pulled as needed, which allows for efficient storage and transfer of images. Each layer is represented by a SHA256 digest, ensuring the integrity and authenticity of the image.

  • size (Number) The size of the image or layer in bytes. This helps in estimating the space required and the download time.
  • digest (String) A unique SHA256 hash used to identify a specific image version within the image registry.
  • media_type (String) Specifies the type of the content represented in the manifest, allowing Docker clients and registries to understand how to handle the document correctly.

Using getImages

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 getImages(args: GetImagesArgs, opts?: InvokeOptions): Promise<GetImagesResult>
function getImagesOutput(args: GetImagesOutputArgs, opts?: InvokeOptions): Output<GetImagesResult>
Copy
def get_images(query: Optional[GetImagesQuery] = None,
               opts: Optional[InvokeOptions] = None) -> GetImagesResult
def get_images_output(query: Optional[pulumi.Input[GetImagesQueryArgs]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetImagesResult]
Copy
func GetImages(ctx *Context, args *GetImagesArgs, opts ...InvokeOption) (*GetImagesResult, error)
func GetImagesOutput(ctx *Context, args *GetImagesOutputArgs, opts ...InvokeOption) GetImagesResultOutput
Copy

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

public static class GetImages 
{
    public static Task<GetImagesResult> InvokeAsync(GetImagesArgs args, InvokeOptions? opts = null)
    public static Output<GetImagesResult> Invoke(GetImagesInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetImagesResult> getImages(GetImagesArgs args, InvokeOptions options)
public static Output<GetImagesResult> getImages(GetImagesArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: cpln:index/getImages:getImages
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

getImages Result

The following output properties are available:

Id string
The provider-assigned unique ID for this managed resource.
Images List<Pulumiverse.Cpln.Outputs.GetImagesImage>
Query Pulumiverse.Cpln.Outputs.GetImagesQuery
Id string
The provider-assigned unique ID for this managed resource.
Images []GetImagesImage
Query GetImagesQuery
id String
The provider-assigned unique ID for this managed resource.
images List<GetImagesImage>
query GetImagesQuery
id string
The provider-assigned unique ID for this managed resource.
images GetImagesImage[]
query GetImagesQuery
id str
The provider-assigned unique ID for this managed resource.
images Sequence[GetImagesImage]
query GetImagesQuery
id String
The provider-assigned unique ID for this managed resource.
images List<Property Map>
query Property Map

Supporting Types

GetImagesImage

CplnId This property is required. string
The ID, in GUID format, of the Image.
Digest This property is required. string
A unique SHA256 hash used to identify a specific image version within the image registry.
Manifests This property is required. List<Pulumiverse.Cpln.Inputs.GetImagesImageManifest>
The manifest provides configuration and layers information about the image. It plays a crucial role in the Docker image distribution system, enabling image creation, verification, and replication in a consistent and secure manner.
Name This property is required. string
Name of the Image.
Repository This property is required. string
Respository name of the image.
SelfLink This property is required. string
Full link to this resource. Can be referenced by other resources.
Tag This property is required. string
Tag of the image.
Tags This property is required. Dictionary<string, string>
Key-value map of resource tags.
CplnId This property is required. string
The ID, in GUID format, of the Image.
Digest This property is required. string
A unique SHA256 hash used to identify a specific image version within the image registry.
Manifests This property is required. []GetImagesImageManifest
The manifest provides configuration and layers information about the image. It plays a crucial role in the Docker image distribution system, enabling image creation, verification, and replication in a consistent and secure manner.
Name This property is required. string
Name of the Image.
Repository This property is required. string
Respository name of the image.
SelfLink This property is required. string
Full link to this resource. Can be referenced by other resources.
Tag This property is required. string
Tag of the image.
Tags This property is required. map[string]string
Key-value map of resource tags.
cplnId This property is required. String
The ID, in GUID format, of the Image.
digest This property is required. String
A unique SHA256 hash used to identify a specific image version within the image registry.
manifests This property is required. List<GetImagesImageManifest>
The manifest provides configuration and layers information about the image. It plays a crucial role in the Docker image distribution system, enabling image creation, verification, and replication in a consistent and secure manner.
name This property is required. String
Name of the Image.
repository This property is required. String
Respository name of the image.
selfLink This property is required. String
Full link to this resource. Can be referenced by other resources.
tag This property is required. String
Tag of the image.
tags This property is required. Map<String,String>
Key-value map of resource tags.
cplnId This property is required. string
The ID, in GUID format, of the Image.
digest This property is required. string
A unique SHA256 hash used to identify a specific image version within the image registry.
manifests This property is required. GetImagesImageManifest[]
The manifest provides configuration and layers information about the image. It plays a crucial role in the Docker image distribution system, enabling image creation, verification, and replication in a consistent and secure manner.
name This property is required. string
Name of the Image.
repository This property is required. string
Respository name of the image.
selfLink This property is required. string
Full link to this resource. Can be referenced by other resources.
tag This property is required. string
Tag of the image.
tags This property is required. {[key: string]: string}
Key-value map of resource tags.
cpln_id This property is required. str
The ID, in GUID format, of the Image.
digest This property is required. str
A unique SHA256 hash used to identify a specific image version within the image registry.
manifests This property is required. Sequence[GetImagesImageManifest]
The manifest provides configuration and layers information about the image. It plays a crucial role in the Docker image distribution system, enabling image creation, verification, and replication in a consistent and secure manner.
name This property is required. str
Name of the Image.
repository This property is required. str
Respository name of the image.
self_link This property is required. str
Full link to this resource. Can be referenced by other resources.
tag This property is required. str
Tag of the image.
tags This property is required. Mapping[str, str]
Key-value map of resource tags.
cplnId This property is required. String
The ID, in GUID format, of the Image.
digest This property is required. String
A unique SHA256 hash used to identify a specific image version within the image registry.
manifests This property is required. List<Property Map>
The manifest provides configuration and layers information about the image. It plays a crucial role in the Docker image distribution system, enabling image creation, verification, and replication in a consistent and secure manner.
name This property is required. String
Name of the Image.
repository This property is required. String
Respository name of the image.
selfLink This property is required. String
Full link to this resource. Can be referenced by other resources.
tag This property is required. String
Tag of the image.
tags This property is required. Map<String>
Key-value map of resource tags.

GetImagesImageManifest

Configs This property is required. List<Pulumiverse.Cpln.Inputs.GetImagesImageManifestConfig>
The config is a JSON blob that contains the image configuration data which includes environment variables, default command to run, and other settings necessary to run the container based on this image.
Layers This property is required. List<Pulumiverse.Cpln.Inputs.GetImagesImageManifestLayer>
Layers lists the digests of the image's layers. These layers are filesystem changes or additions made in each step of the Docker image's creation process. The layers are stored separately and pulled as needed, which allows for efficient storage and transfer of images. Each layer is represented by a SHA256 digest, ensuring the integrity and authenticity of the image.
MediaType This property is required. string
Specifies the type of the content represented in the manifest, allowing Docker clients and registries to understand how to handle the document correctly.
SchemaVersion This property is required. int
The version of the Docker Image Manifest format.
Configs This property is required. []GetImagesImageManifestConfig
The config is a JSON blob that contains the image configuration data which includes environment variables, default command to run, and other settings necessary to run the container based on this image.
Layers This property is required. []GetImagesImageManifestLayer
Layers lists the digests of the image's layers. These layers are filesystem changes or additions made in each step of the Docker image's creation process. The layers are stored separately and pulled as needed, which allows for efficient storage and transfer of images. Each layer is represented by a SHA256 digest, ensuring the integrity and authenticity of the image.
MediaType This property is required. string
Specifies the type of the content represented in the manifest, allowing Docker clients and registries to understand how to handle the document correctly.
SchemaVersion This property is required. int
The version of the Docker Image Manifest format.
configs This property is required. List<GetImagesImageManifestConfig>
The config is a JSON blob that contains the image configuration data which includes environment variables, default command to run, and other settings necessary to run the container based on this image.
layers This property is required. List<GetImagesImageManifestLayer>
Layers lists the digests of the image's layers. These layers are filesystem changes or additions made in each step of the Docker image's creation process. The layers are stored separately and pulled as needed, which allows for efficient storage and transfer of images. Each layer is represented by a SHA256 digest, ensuring the integrity and authenticity of the image.
mediaType This property is required. String
Specifies the type of the content represented in the manifest, allowing Docker clients and registries to understand how to handle the document correctly.
schemaVersion This property is required. Integer
The version of the Docker Image Manifest format.
configs This property is required. GetImagesImageManifestConfig[]
The config is a JSON blob that contains the image configuration data which includes environment variables, default command to run, and other settings necessary to run the container based on this image.
layers This property is required. GetImagesImageManifestLayer[]
Layers lists the digests of the image's layers. These layers are filesystem changes or additions made in each step of the Docker image's creation process. The layers are stored separately and pulled as needed, which allows for efficient storage and transfer of images. Each layer is represented by a SHA256 digest, ensuring the integrity and authenticity of the image.
mediaType This property is required. string
Specifies the type of the content represented in the manifest, allowing Docker clients and registries to understand how to handle the document correctly.
schemaVersion This property is required. number
The version of the Docker Image Manifest format.
configs This property is required. Sequence[GetImagesImageManifestConfig]
The config is a JSON blob that contains the image configuration data which includes environment variables, default command to run, and other settings necessary to run the container based on this image.
layers This property is required. Sequence[GetImagesImageManifestLayer]
Layers lists the digests of the image's layers. These layers are filesystem changes or additions made in each step of the Docker image's creation process. The layers are stored separately and pulled as needed, which allows for efficient storage and transfer of images. Each layer is represented by a SHA256 digest, ensuring the integrity and authenticity of the image.
media_type This property is required. str
Specifies the type of the content represented in the manifest, allowing Docker clients and registries to understand how to handle the document correctly.
schema_version This property is required. int
The version of the Docker Image Manifest format.
configs This property is required. List<Property Map>
The config is a JSON blob that contains the image configuration data which includes environment variables, default command to run, and other settings necessary to run the container based on this image.
layers This property is required. List<Property Map>
Layers lists the digests of the image's layers. These layers are filesystem changes or additions made in each step of the Docker image's creation process. The layers are stored separately and pulled as needed, which allows for efficient storage and transfer of images. Each layer is represented by a SHA256 digest, ensuring the integrity and authenticity of the image.
mediaType This property is required. String
Specifies the type of the content represented in the manifest, allowing Docker clients and registries to understand how to handle the document correctly.
schemaVersion This property is required. Number
The version of the Docker Image Manifest format.

GetImagesImageManifestConfig

Digest This property is required. string
A unique SHA256 hash used to identify a specific image version within the image registry.
MediaType This property is required. string
Specifies the type of the content represented in the manifest, allowing Docker clients and registries to understand how to handle the document correctly.
Size This property is required. int
The size of the image or layer in bytes. This helps in estimating the space required and the download time.
Digest This property is required. string
A unique SHA256 hash used to identify a specific image version within the image registry.
MediaType This property is required. string
Specifies the type of the content represented in the manifest, allowing Docker clients and registries to understand how to handle the document correctly.
Size This property is required. int
The size of the image or layer in bytes. This helps in estimating the space required and the download time.
digest This property is required. String
A unique SHA256 hash used to identify a specific image version within the image registry.
mediaType This property is required. String
Specifies the type of the content represented in the manifest, allowing Docker clients and registries to understand how to handle the document correctly.
size This property is required. Integer
The size of the image or layer in bytes. This helps in estimating the space required and the download time.
digest This property is required. string
A unique SHA256 hash used to identify a specific image version within the image registry.
mediaType This property is required. string
Specifies the type of the content represented in the manifest, allowing Docker clients and registries to understand how to handle the document correctly.
size This property is required. number
The size of the image or layer in bytes. This helps in estimating the space required and the download time.
digest This property is required. str
A unique SHA256 hash used to identify a specific image version within the image registry.
media_type This property is required. str
Specifies the type of the content represented in the manifest, allowing Docker clients and registries to understand how to handle the document correctly.
size This property is required. int
The size of the image or layer in bytes. This helps in estimating the space required and the download time.
digest This property is required. String
A unique SHA256 hash used to identify a specific image version within the image registry.
mediaType This property is required. String
Specifies the type of the content represented in the manifest, allowing Docker clients and registries to understand how to handle the document correctly.
size This property is required. Number
The size of the image or layer in bytes. This helps in estimating the space required and the download time.

GetImagesImageManifestLayer

Digest This property is required. string
A unique SHA256 hash used to identify a specific image version within the image registry.
MediaType This property is required. string
Specifies the type of the content represented in the manifest, allowing Docker clients and registries to understand how to handle the document correctly.
Size This property is required. int
The size of the image or layer in bytes. This helps in estimating the space required and the download time.
Digest This property is required. string
A unique SHA256 hash used to identify a specific image version within the image registry.
MediaType This property is required. string
Specifies the type of the content represented in the manifest, allowing Docker clients and registries to understand how to handle the document correctly.
Size This property is required. int
The size of the image or layer in bytes. This helps in estimating the space required and the download time.
digest This property is required. String
A unique SHA256 hash used to identify a specific image version within the image registry.
mediaType This property is required. String
Specifies the type of the content represented in the manifest, allowing Docker clients and registries to understand how to handle the document correctly.
size This property is required. Integer
The size of the image or layer in bytes. This helps in estimating the space required and the download time.
digest This property is required. string
A unique SHA256 hash used to identify a specific image version within the image registry.
mediaType This property is required. string
Specifies the type of the content represented in the manifest, allowing Docker clients and registries to understand how to handle the document correctly.
size This property is required. number
The size of the image or layer in bytes. This helps in estimating the space required and the download time.
digest This property is required. str
A unique SHA256 hash used to identify a specific image version within the image registry.
media_type This property is required. str
Specifies the type of the content represented in the manifest, allowing Docker clients and registries to understand how to handle the document correctly.
size This property is required. int
The size of the image or layer in bytes. This helps in estimating the space required and the download time.
digest This property is required. String
A unique SHA256 hash used to identify a specific image version within the image registry.
mediaType This property is required. String
Specifies the type of the content represented in the manifest, allowing Docker clients and registries to understand how to handle the document correctly.
size This property is required. Number
The size of the image or layer in bytes. This helps in estimating the space required and the download time.

GetImagesQuery

Fetch string
Type of fetch. Specify either: links or items. Default: items.
Spec Pulumiverse.Cpln.Inputs.GetImagesQuerySpec
Fetch string
Type of fetch. Specify either: links or items. Default: items.
Spec GetImagesQuerySpec
fetch String
Type of fetch. Specify either: links or items. Default: items.
spec GetImagesQuerySpec
fetch string
Type of fetch. Specify either: links or items. Default: items.
spec GetImagesQuerySpec
fetch str
Type of fetch. Specify either: links or items. Default: items.
spec GetImagesQuerySpec
fetch String
Type of fetch. Specify either: links or items. Default: items.
spec Property Map

GetImagesQuerySpec

Match string
Type of match. Available values: all, any, none. Default: all.
Terms List<Pulumiverse.Cpln.Inputs.GetImagesQuerySpecTerm>
Terms can only contain one of the following attributes: property, rel, tag.
Match string
Type of match. Available values: all, any, none. Default: all.
Terms []GetImagesQuerySpecTerm
Terms can only contain one of the following attributes: property, rel, tag.
match String
Type of match. Available values: all, any, none. Default: all.
terms List<GetImagesQuerySpecTerm>
Terms can only contain one of the following attributes: property, rel, tag.
match string
Type of match. Available values: all, any, none. Default: all.
terms GetImagesQuerySpecTerm[]
Terms can only contain one of the following attributes: property, rel, tag.
match str
Type of match. Available values: all, any, none. Default: all.
terms Sequence[GetImagesQuerySpecTerm]
Terms can only contain one of the following attributes: property, rel, tag.
match String
Type of match. Available values: all, any, none. Default: all.
terms List<Property Map>
Terms can only contain one of the following attributes: property, rel, tag.

GetImagesQuerySpecTerm

Op string
Type of query operation. Available values: =, >, >=, <, <=, !=, exists, !exists. Default: =.
Property string
Property to use for query evaluation.
Rel string
Tag string
Tag key to use for query evaluation.
Value string
Testing value for query evaluation.
Op string
Type of query operation. Available values: =, >, >=, <, <=, !=, exists, !exists. Default: =.
Property string
Property to use for query evaluation.
Rel string
Tag string
Tag key to use for query evaluation.
Value string
Testing value for query evaluation.
op String
Type of query operation. Available values: =, >, >=, <, <=, !=, exists, !exists. Default: =.
property String
Property to use for query evaluation.
rel String
tag String
Tag key to use for query evaluation.
value String
Testing value for query evaluation.
op string
Type of query operation. Available values: =, >, >=, <, <=, !=, exists, !exists. Default: =.
property string
Property to use for query evaluation.
rel string
tag string
Tag key to use for query evaluation.
value string
Testing value for query evaluation.
op str
Type of query operation. Available values: =, >, >=, <, <=, !=, exists, !exists. Default: =.
property str
Property to use for query evaluation.
rel str
tag str
Tag key to use for query evaluation.
value str
Testing value for query evaluation.
op String
Type of query operation. Available values: =, >, >=, <, <=, !=, exists, !exists. Default: =.
property String
Property to use for query evaluation.
rel String
tag String
Tag key to use for query evaluation.
value String
Testing value for query evaluation.

Package Details

Repository
cpln pulumiverse/pulumi-cpln
License
Apache-2.0
Notes
This Pulumi package is based on the cpln Terraform Provider.