docker.RemoteImage
Explore with Pulumi AI
Create RemoteImage Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new RemoteImage(name: string, args: RemoteImageArgs, opts?: CustomResourceOptions);
@overload
def RemoteImage(resource_name: str,
args: RemoteImageArgs,
opts: Optional[ResourceOptions] = None)
@overload
def RemoteImage(resource_name: str,
opts: Optional[ResourceOptions] = None,
name: Optional[str] = None,
build: Optional[RemoteImageBuildArgs] = None,
force_remove: Optional[bool] = None,
keep_locally: Optional[bool] = None,
platform: Optional[str] = None,
pull_triggers: Optional[Sequence[str]] = None,
triggers: Optional[Mapping[str, str]] = None)
func NewRemoteImage(ctx *Context, name string, args RemoteImageArgs, opts ...ResourceOption) (*RemoteImage, error)
public RemoteImage(string name, RemoteImageArgs args, CustomResourceOptions? opts = null)
public RemoteImage(String name, RemoteImageArgs args)
public RemoteImage(String name, RemoteImageArgs args, CustomResourceOptions options)
type: docker:RemoteImage
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args RemoteImageArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args RemoteImageArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args RemoteImageArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args RemoteImageArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args RemoteImageArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var remoteImageResource = new Docker.RemoteImage("remoteImageResource", new()
{
Name = "string",
Build = new Docker.Inputs.RemoteImageBuildArgs
{
Context = "string",
Labels =
{
{ "string", "string" },
},
BuildId = "string",
BuildLogFile = "string",
Builder = "string",
CacheFroms = new[]
{
"string",
},
CgroupParent = "string",
BuildArgs =
{
{ "string", "string" },
},
CpuPeriod = 0,
CpuQuota = 0,
CpuSetCpus = "string",
CpuSetMems = "string",
CpuShares = 0,
Dockerfile = "string",
ExtraHosts = new[]
{
"string",
},
ForceRemove = false,
Isolation = "string",
AuthConfigs = new[]
{
new Docker.Inputs.RemoteImageBuildAuthConfigArgs
{
HostName = "string",
Auth = "string",
Email = "string",
IdentityToken = "string",
Password = "string",
RegistryToken = "string",
ServerAddress = "string",
UserName = "string",
},
},
Label =
{
{ "string", "string" },
},
SessionId = "string",
MemorySwap = 0,
NetworkMode = "string",
NoCache = false,
Platform = "string",
PullParent = false,
RemoteContext = "string",
Remove = false,
Secrets = new[]
{
new Docker.Inputs.RemoteImageBuildSecretArgs
{
Id = "string",
Env = "string",
Src = "string",
},
},
SecurityOpts = new[]
{
"string",
},
Memory = 0,
ShmSize = 0,
Squash = false,
SuppressOutput = false,
Tags = new[]
{
"string",
},
Target = "string",
Ulimits = new[]
{
new Docker.Inputs.RemoteImageBuildUlimitArgs
{
Hard = 0,
Name = "string",
Soft = 0,
},
},
Version = "string",
},
ForceRemove = false,
KeepLocally = false,
Platform = "string",
PullTriggers = new[]
{
"string",
},
Triggers =
{
{ "string", "string" },
},
});
example, err := docker.NewRemoteImage(ctx, "remoteImageResource", &docker.RemoteImageArgs{
Name: pulumi.String("string"),
Build: &docker.RemoteImageBuildArgs{
Context: pulumi.String("string"),
Labels: pulumi.StringMap{
"string": pulumi.String("string"),
},
BuildId: pulumi.String("string"),
BuildLogFile: pulumi.String("string"),
Builder: pulumi.String("string"),
CacheFroms: pulumi.StringArray{
pulumi.String("string"),
},
CgroupParent: pulumi.String("string"),
BuildArgs: pulumi.StringMap{
"string": pulumi.String("string"),
},
CpuPeriod: pulumi.Int(0),
CpuQuota: pulumi.Int(0),
CpuSetCpus: pulumi.String("string"),
CpuSetMems: pulumi.String("string"),
CpuShares: pulumi.Int(0),
Dockerfile: pulumi.String("string"),
ExtraHosts: pulumi.StringArray{
pulumi.String("string"),
},
ForceRemove: pulumi.Bool(false),
Isolation: pulumi.String("string"),
AuthConfigs: docker.RemoteImageBuildAuthConfigArray{
&docker.RemoteImageBuildAuthConfigArgs{
HostName: pulumi.String("string"),
Auth: pulumi.String("string"),
Email: pulumi.String("string"),
IdentityToken: pulumi.String("string"),
Password: pulumi.String("string"),
RegistryToken: pulumi.String("string"),
ServerAddress: pulumi.String("string"),
UserName: pulumi.String("string"),
},
},
Label: pulumi.StringMap{
"string": pulumi.String("string"),
},
SessionId: pulumi.String("string"),
MemorySwap: pulumi.Int(0),
NetworkMode: pulumi.String("string"),
NoCache: pulumi.Bool(false),
Platform: pulumi.String("string"),
PullParent: pulumi.Bool(false),
RemoteContext: pulumi.String("string"),
Remove: pulumi.Bool(false),
Secrets: docker.RemoteImageBuildSecretArray{
&docker.RemoteImageBuildSecretArgs{
Id: pulumi.String("string"),
Env: pulumi.String("string"),
Src: pulumi.String("string"),
},
},
SecurityOpts: pulumi.StringArray{
pulumi.String("string"),
},
Memory: pulumi.Int(0),
ShmSize: pulumi.Int(0),
Squash: pulumi.Bool(false),
SuppressOutput: pulumi.Bool(false),
Tags: pulumi.StringArray{
pulumi.String("string"),
},
Target: pulumi.String("string"),
Ulimits: docker.RemoteImageBuildUlimitArray{
&docker.RemoteImageBuildUlimitArgs{
Hard: pulumi.Int(0),
Name: pulumi.String("string"),
Soft: pulumi.Int(0),
},
},
Version: pulumi.String("string"),
},
ForceRemove: pulumi.Bool(false),
KeepLocally: pulumi.Bool(false),
Platform: pulumi.String("string"),
PullTriggers: pulumi.StringArray{
pulumi.String("string"),
},
Triggers: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
var remoteImageResource = new RemoteImage("remoteImageResource", RemoteImageArgs.builder()
.name("string")
.build(RemoteImageBuildArgs.builder()
.context("string")
.labels(Map.of("string", "string"))
.buildId("string")
.buildLogFile("string")
.builder("string")
.cacheFroms("string")
.cgroupParent("string")
.buildArgs(Map.of("string", "string"))
.cpuPeriod(0)
.cpuQuota(0)
.cpuSetCpus("string")
.cpuSetMems("string")
.cpuShares(0)
.dockerfile("string")
.extraHosts("string")
.forceRemove(false)
.isolation("string")
.authConfigs(RemoteImageBuildAuthConfigArgs.builder()
.hostName("string")
.auth("string")
.email("string")
.identityToken("string")
.password("string")
.registryToken("string")
.serverAddress("string")
.userName("string")
.build())
.label(Map.of("string", "string"))
.sessionId("string")
.memorySwap(0)
.networkMode("string")
.noCache(false)
.platform("string")
.pullParent(false)
.remoteContext("string")
.remove(false)
.secrets(RemoteImageBuildSecretArgs.builder()
.id("string")
.env("string")
.src("string")
.build())
.securityOpts("string")
.memory(0)
.shmSize(0)
.squash(false)
.suppressOutput(false)
.tags("string")
.target("string")
.ulimits(RemoteImageBuildUlimitArgs.builder()
.hard(0)
.name("string")
.soft(0)
.build())
.version("string")
.build())
.forceRemove(false)
.keepLocally(false)
.platform("string")
.pullTriggers("string")
.triggers(Map.of("string", "string"))
.build());
remote_image_resource = docker.RemoteImage("remoteImageResource",
name="string",
build={
"context": "string",
"labels": {
"string": "string",
},
"build_id": "string",
"build_log_file": "string",
"builder": "string",
"cache_froms": ["string"],
"cgroup_parent": "string",
"build_args": {
"string": "string",
},
"cpu_period": 0,
"cpu_quota": 0,
"cpu_set_cpus": "string",
"cpu_set_mems": "string",
"cpu_shares": 0,
"dockerfile": "string",
"extra_hosts": ["string"],
"force_remove": False,
"isolation": "string",
"auth_configs": [{
"host_name": "string",
"auth": "string",
"email": "string",
"identity_token": "string",
"password": "string",
"registry_token": "string",
"server_address": "string",
"user_name": "string",
}],
"label": {
"string": "string",
},
"session_id": "string",
"memory_swap": 0,
"network_mode": "string",
"no_cache": False,
"platform": "string",
"pull_parent": False,
"remote_context": "string",
"remove": False,
"secrets": [{
"id": "string",
"env": "string",
"src": "string",
}],
"security_opts": ["string"],
"memory": 0,
"shm_size": 0,
"squash": False,
"suppress_output": False,
"tags": ["string"],
"target": "string",
"ulimits": [{
"hard": 0,
"name": "string",
"soft": 0,
}],
"version": "string",
},
force_remove=False,
keep_locally=False,
platform="string",
pull_triggers=["string"],
triggers={
"string": "string",
})
const remoteImageResource = new docker.RemoteImage("remoteImageResource", {
name: "string",
build: {
context: "string",
labels: {
string: "string",
},
buildId: "string",
buildLogFile: "string",
builder: "string",
cacheFroms: ["string"],
cgroupParent: "string",
buildArgs: {
string: "string",
},
cpuPeriod: 0,
cpuQuota: 0,
cpuSetCpus: "string",
cpuSetMems: "string",
cpuShares: 0,
dockerfile: "string",
extraHosts: ["string"],
forceRemove: false,
isolation: "string",
authConfigs: [{
hostName: "string",
auth: "string",
email: "string",
identityToken: "string",
password: "string",
registryToken: "string",
serverAddress: "string",
userName: "string",
}],
label: {
string: "string",
},
sessionId: "string",
memorySwap: 0,
networkMode: "string",
noCache: false,
platform: "string",
pullParent: false,
remoteContext: "string",
remove: false,
secrets: [{
id: "string",
env: "string",
src: "string",
}],
securityOpts: ["string"],
memory: 0,
shmSize: 0,
squash: false,
suppressOutput: false,
tags: ["string"],
target: "string",
ulimits: [{
hard: 0,
name: "string",
soft: 0,
}],
version: "string",
},
forceRemove: false,
keepLocally: false,
platform: "string",
pullTriggers: ["string"],
triggers: {
string: "string",
},
});
type: docker:RemoteImage
properties:
build:
authConfigs:
- auth: string
email: string
hostName: string
identityToken: string
password: string
registryToken: string
serverAddress: string
userName: string
buildArgs:
string: string
buildId: string
buildLogFile: string
builder: string
cacheFroms:
- string
cgroupParent: string
context: string
cpuPeriod: 0
cpuQuota: 0
cpuSetCpus: string
cpuSetMems: string
cpuShares: 0
dockerfile: string
extraHosts:
- string
forceRemove: false
isolation: string
label:
string: string
labels:
string: string
memory: 0
memorySwap: 0
networkMode: string
noCache: false
platform: string
pullParent: false
remoteContext: string
remove: false
secrets:
- env: string
id: string
src: string
securityOpts:
- string
sessionId: string
shmSize: 0
squash: false
suppressOutput: false
tags:
- string
target: string
ulimits:
- hard: 0
name: string
soft: 0
version: string
forceRemove: false
keepLocally: false
name: string
platform: string
pullTriggers:
- string
triggers:
string: string
RemoteImage Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The RemoteImage resource accepts the following input properties:
- Name string
- The name of the Docker image, including any tags or SHA256 repo digests.
- Build
Remote
Image Build - Force
Remove bool - If true, then the image is removed forcibly when the resource is destroyed.
- Keep
Locally bool - If true, then the Docker image won't be deleted on destroy operation. If this is false, it will delete the image from the docker local storage on destroy operation.
- Platform string
- The platform to use when pulling the image. Defaults to the platform of the current machine.
- Pull
Triggers List<string> - List of values which cause an image pull when changed. This is used to store the image digest from the registry when using the dockerregistryimage.
- Triggers Dictionary<string, string>
- A map of arbitrary strings that, when changed, will force the
docker.RemoteImage
resource to be replaced. This can be used to rebuild an image when contents of source code folders change
- Name string
- The name of the Docker image, including any tags or SHA256 repo digests.
- Build
Remote
Image Build Args - Force
Remove bool - If true, then the image is removed forcibly when the resource is destroyed.
- Keep
Locally bool - If true, then the Docker image won't be deleted on destroy operation. If this is false, it will delete the image from the docker local storage on destroy operation.
- Platform string
- The platform to use when pulling the image. Defaults to the platform of the current machine.
- Pull
Triggers []string - List of values which cause an image pull when changed. This is used to store the image digest from the registry when using the dockerregistryimage.
- Triggers map[string]string
- A map of arbitrary strings that, when changed, will force the
docker.RemoteImage
resource to be replaced. This can be used to rebuild an image when contents of source code folders change
- name String
- The name of the Docker image, including any tags or SHA256 repo digests.
- build
Remote
Image Build - force
Remove Boolean - If true, then the image is removed forcibly when the resource is destroyed.
- keep
Locally Boolean - If true, then the Docker image won't be deleted on destroy operation. If this is false, it will delete the image from the docker local storage on destroy operation.
- platform String
- The platform to use when pulling the image. Defaults to the platform of the current machine.
- pull
Triggers List<String> - List of values which cause an image pull when changed. This is used to store the image digest from the registry when using the dockerregistryimage.
- triggers Map<String,String>
- A map of arbitrary strings that, when changed, will force the
docker.RemoteImage
resource to be replaced. This can be used to rebuild an image when contents of source code folders change
- name string
- The name of the Docker image, including any tags or SHA256 repo digests.
- build
Remote
Image Build - force
Remove boolean - If true, then the image is removed forcibly when the resource is destroyed.
- keep
Locally boolean - If true, then the Docker image won't be deleted on destroy operation. If this is false, it will delete the image from the docker local storage on destroy operation.
- platform string
- The platform to use when pulling the image. Defaults to the platform of the current machine.
- pull
Triggers string[] - List of values which cause an image pull when changed. This is used to store the image digest from the registry when using the dockerregistryimage.
- triggers {[key: string]: string}
- A map of arbitrary strings that, when changed, will force the
docker.RemoteImage
resource to be replaced. This can be used to rebuild an image when contents of source code folders change
- name str
- The name of the Docker image, including any tags or SHA256 repo digests.
- build
Remote
Image Build Args - force_
remove bool - If true, then the image is removed forcibly when the resource is destroyed.
- keep_
locally bool - If true, then the Docker image won't be deleted on destroy operation. If this is false, it will delete the image from the docker local storage on destroy operation.
- platform str
- The platform to use when pulling the image. Defaults to the platform of the current machine.
- pull_
triggers Sequence[str] - List of values which cause an image pull when changed. This is used to store the image digest from the registry when using the dockerregistryimage.
- triggers Mapping[str, str]
- A map of arbitrary strings that, when changed, will force the
docker.RemoteImage
resource to be replaced. This can be used to rebuild an image when contents of source code folders change
- name String
- The name of the Docker image, including any tags or SHA256 repo digests.
- build Property Map
- force
Remove Boolean - If true, then the image is removed forcibly when the resource is destroyed.
- keep
Locally Boolean - If true, then the Docker image won't be deleted on destroy operation. If this is false, it will delete the image from the docker local storage on destroy operation.
- platform String
- The platform to use when pulling the image. Defaults to the platform of the current machine.
- pull
Triggers List<String> - List of values which cause an image pull when changed. This is used to store the image digest from the registry when using the dockerregistryimage.
- triggers Map<String>
- A map of arbitrary strings that, when changed, will force the
docker.RemoteImage
resource to be replaced. This can be used to rebuild an image when contents of source code folders change
Outputs
All input properties are implicitly available as output properties. Additionally, the RemoteImage resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Image
Id string - The ID of the image (as seen when executing
docker inspect
on the image). Can be used to reference the image via its ID in other resources. - Repo
Digest string - The image sha256 digest in the form of
repo[:tag]@sha256:<hash>
. This may not be populated when building an image, because it is read from the local Docker client and so may be available only when the image was either pulled from the repo or pushed to the repo (perhaps usingdocker.RegistryImage
) in a previous run.
- Id string
- The provider-assigned unique ID for this managed resource.
- Image
Id string - The ID of the image (as seen when executing
docker inspect
on the image). Can be used to reference the image via its ID in other resources. - Repo
Digest string - The image sha256 digest in the form of
repo[:tag]@sha256:<hash>
. This may not be populated when building an image, because it is read from the local Docker client and so may be available only when the image was either pulled from the repo or pushed to the repo (perhaps usingdocker.RegistryImage
) in a previous run.
- id String
- The provider-assigned unique ID for this managed resource.
- image
Id String - The ID of the image (as seen when executing
docker inspect
on the image). Can be used to reference the image via its ID in other resources. - repo
Digest String - The image sha256 digest in the form of
repo[:tag]@sha256:<hash>
. This may not be populated when building an image, because it is read from the local Docker client and so may be available only when the image was either pulled from the repo or pushed to the repo (perhaps usingdocker.RegistryImage
) in a previous run.
- id string
- The provider-assigned unique ID for this managed resource.
- image
Id string - The ID of the image (as seen when executing
docker inspect
on the image). Can be used to reference the image via its ID in other resources. - repo
Digest string - The image sha256 digest in the form of
repo[:tag]@sha256:<hash>
. This may not be populated when building an image, because it is read from the local Docker client and so may be available only when the image was either pulled from the repo or pushed to the repo (perhaps usingdocker.RegistryImage
) in a previous run.
- id str
- The provider-assigned unique ID for this managed resource.
- image_
id str - The ID of the image (as seen when executing
docker inspect
on the image). Can be used to reference the image via its ID in other resources. - repo_
digest str - The image sha256 digest in the form of
repo[:tag]@sha256:<hash>
. This may not be populated when building an image, because it is read from the local Docker client and so may be available only when the image was either pulled from the repo or pushed to the repo (perhaps usingdocker.RegistryImage
) in a previous run.
- id String
- The provider-assigned unique ID for this managed resource.
- image
Id String - The ID of the image (as seen when executing
docker inspect
on the image). Can be used to reference the image via its ID in other resources. - repo
Digest String - The image sha256 digest in the form of
repo[:tag]@sha256:<hash>
. This may not be populated when building an image, because it is read from the local Docker client and so may be available only when the image was either pulled from the repo or pushed to the repo (perhaps usingdocker.RegistryImage
) in a previous run.
Look up Existing RemoteImage Resource
Get an existing RemoteImage resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: RemoteImageState, opts?: CustomResourceOptions): RemoteImage
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
build: Optional[RemoteImageBuildArgs] = None,
force_remove: Optional[bool] = None,
image_id: Optional[str] = None,
keep_locally: Optional[bool] = None,
name: Optional[str] = None,
platform: Optional[str] = None,
pull_triggers: Optional[Sequence[str]] = None,
repo_digest: Optional[str] = None,
triggers: Optional[Mapping[str, str]] = None) -> RemoteImage
func GetRemoteImage(ctx *Context, name string, id IDInput, state *RemoteImageState, opts ...ResourceOption) (*RemoteImage, error)
public static RemoteImage Get(string name, Input<string> id, RemoteImageState? state, CustomResourceOptions? opts = null)
public static RemoteImage get(String name, Output<String> id, RemoteImageState state, CustomResourceOptions options)
resources: _: type: docker:RemoteImage get: id: ${id}
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Build
Remote
Image Build - Force
Remove bool - If true, then the image is removed forcibly when the resource is destroyed.
- Image
Id string - The ID of the image (as seen when executing
docker inspect
on the image). Can be used to reference the image via its ID in other resources. - Keep
Locally bool - If true, then the Docker image won't be deleted on destroy operation. If this is false, it will delete the image from the docker local storage on destroy operation.
- Name string
- The name of the Docker image, including any tags or SHA256 repo digests.
- Platform string
- The platform to use when pulling the image. Defaults to the platform of the current machine.
- Pull
Triggers List<string> - List of values which cause an image pull when changed. This is used to store the image digest from the registry when using the dockerregistryimage.
- Repo
Digest string - The image sha256 digest in the form of
repo[:tag]@sha256:<hash>
. This may not be populated when building an image, because it is read from the local Docker client and so may be available only when the image was either pulled from the repo or pushed to the repo (perhaps usingdocker.RegistryImage
) in a previous run. - Triggers Dictionary<string, string>
- A map of arbitrary strings that, when changed, will force the
docker.RemoteImage
resource to be replaced. This can be used to rebuild an image when contents of source code folders change
- Build
Remote
Image Build Args - Force
Remove bool - If true, then the image is removed forcibly when the resource is destroyed.
- Image
Id string - The ID of the image (as seen when executing
docker inspect
on the image). Can be used to reference the image via its ID in other resources. - Keep
Locally bool - If true, then the Docker image won't be deleted on destroy operation. If this is false, it will delete the image from the docker local storage on destroy operation.
- Name string
- The name of the Docker image, including any tags or SHA256 repo digests.
- Platform string
- The platform to use when pulling the image. Defaults to the platform of the current machine.
- Pull
Triggers []string - List of values which cause an image pull when changed. This is used to store the image digest from the registry when using the dockerregistryimage.
- Repo
Digest string - The image sha256 digest in the form of
repo[:tag]@sha256:<hash>
. This may not be populated when building an image, because it is read from the local Docker client and so may be available only when the image was either pulled from the repo or pushed to the repo (perhaps usingdocker.RegistryImage
) in a previous run. - Triggers map[string]string
- A map of arbitrary strings that, when changed, will force the
docker.RemoteImage
resource to be replaced. This can be used to rebuild an image when contents of source code folders change
- build
Remote
Image Build - force
Remove Boolean - If true, then the image is removed forcibly when the resource is destroyed.
- image
Id String - The ID of the image (as seen when executing
docker inspect
on the image). Can be used to reference the image via its ID in other resources. - keep
Locally Boolean - If true, then the Docker image won't be deleted on destroy operation. If this is false, it will delete the image from the docker local storage on destroy operation.
- name String
- The name of the Docker image, including any tags or SHA256 repo digests.
- platform String
- The platform to use when pulling the image. Defaults to the platform of the current machine.
- pull
Triggers List<String> - List of values which cause an image pull when changed. This is used to store the image digest from the registry when using the dockerregistryimage.
- repo
Digest String - The image sha256 digest in the form of
repo[:tag]@sha256:<hash>
. This may not be populated when building an image, because it is read from the local Docker client and so may be available only when the image was either pulled from the repo or pushed to the repo (perhaps usingdocker.RegistryImage
) in a previous run. - triggers Map<String,String>
- A map of arbitrary strings that, when changed, will force the
docker.RemoteImage
resource to be replaced. This can be used to rebuild an image when contents of source code folders change
- build
Remote
Image Build - force
Remove boolean - If true, then the image is removed forcibly when the resource is destroyed.
- image
Id string - The ID of the image (as seen when executing
docker inspect
on the image). Can be used to reference the image via its ID in other resources. - keep
Locally boolean - If true, then the Docker image won't be deleted on destroy operation. If this is false, it will delete the image from the docker local storage on destroy operation.
- name string
- The name of the Docker image, including any tags or SHA256 repo digests.
- platform string
- The platform to use when pulling the image. Defaults to the platform of the current machine.
- pull
Triggers string[] - List of values which cause an image pull when changed. This is used to store the image digest from the registry when using the dockerregistryimage.
- repo
Digest string - The image sha256 digest in the form of
repo[:tag]@sha256:<hash>
. This may not be populated when building an image, because it is read from the local Docker client and so may be available only when the image was either pulled from the repo or pushed to the repo (perhaps usingdocker.RegistryImage
) in a previous run. - triggers {[key: string]: string}
- A map of arbitrary strings that, when changed, will force the
docker.RemoteImage
resource to be replaced. This can be used to rebuild an image when contents of source code folders change
- build
Remote
Image Build Args - force_
remove bool - If true, then the image is removed forcibly when the resource is destroyed.
- image_
id str - The ID of the image (as seen when executing
docker inspect
on the image). Can be used to reference the image via its ID in other resources. - keep_
locally bool - If true, then the Docker image won't be deleted on destroy operation. If this is false, it will delete the image from the docker local storage on destroy operation.
- name str
- The name of the Docker image, including any tags or SHA256 repo digests.
- platform str
- The platform to use when pulling the image. Defaults to the platform of the current machine.
- pull_
triggers Sequence[str] - List of values which cause an image pull when changed. This is used to store the image digest from the registry when using the dockerregistryimage.
- repo_
digest str - The image sha256 digest in the form of
repo[:tag]@sha256:<hash>
. This may not be populated when building an image, because it is read from the local Docker client and so may be available only when the image was either pulled from the repo or pushed to the repo (perhaps usingdocker.RegistryImage
) in a previous run. - triggers Mapping[str, str]
- A map of arbitrary strings that, when changed, will force the
docker.RemoteImage
resource to be replaced. This can be used to rebuild an image when contents of source code folders change
- build Property Map
- force
Remove Boolean - If true, then the image is removed forcibly when the resource is destroyed.
- image
Id String - The ID of the image (as seen when executing
docker inspect
on the image). Can be used to reference the image via its ID in other resources. - keep
Locally Boolean - If true, then the Docker image won't be deleted on destroy operation. If this is false, it will delete the image from the docker local storage on destroy operation.
- name String
- The name of the Docker image, including any tags or SHA256 repo digests.
- platform String
- The platform to use when pulling the image. Defaults to the platform of the current machine.
- pull
Triggers List<String> - List of values which cause an image pull when changed. This is used to store the image digest from the registry when using the dockerregistryimage.
- repo
Digest String - The image sha256 digest in the form of
repo[:tag]@sha256:<hash>
. This may not be populated when building an image, because it is read from the local Docker client and so may be available only when the image was either pulled from the repo or pushed to the repo (perhaps usingdocker.RegistryImage
) in a previous run. - triggers Map<String>
- A map of arbitrary strings that, when changed, will force the
docker.RemoteImage
resource to be replaced. This can be used to rebuild an image when contents of source code folders change
Supporting Types
RemoteImageBuild, RemoteImageBuildArgs
- Context string
- Value to specify the build context. Currently, only a
PATH
context is supported. You can use the helper function '${path.cwd}/context-dir'. This always refers to the local working directory, even when building images on remote hosts. Please see https://docs.docker.com/build/building/context/ for more information about build contexts. - Auth
Configs List<RemoteImage Build Auth Config> - The configuration for the authentication
- Build
Args Dictionary<string, string> - Pairs for build-time variables in the form of
ENDPOINT : "https://example.com"
- Build
Id string - BuildID is an optional identifier that can be passed together with the build request. The same identifier can be used to gracefully cancel the build with the cancel request.
- Build
Log stringFile - Path to a file where the buildx log are written to. Only available when
builder
is set. If not set, no logs are available. The path is taken as is, so make sure to use a path that is available. - Builder string
- Set the name of the buildx builder to use. If not set or empty, the legacy builder will be used.
- Cache
Froms List<string> - Images to consider as cache sources
- Cgroup
Parent string - Optional parent cgroup for the container
- Cpu
Period int - The length of a CPU period in microseconds
- Cpu
Quota int - Microseconds of CPU time that the container can get in a CPU period
- Cpu
Set stringCpus - CPUs in which to allow execution (e.g.,
0-3
,0
,1
) - Cpu
Set stringMems - MEMs in which to allow execution (
0-3
,0
,1
) - int
- CPU shares (relative weight)
- Dockerfile string
- Name of the Dockerfile. Defaults to
Dockerfile
. - Extra
Hosts List<string> - A list of hostnames/IP mappings to add to the container’s /etc/hosts file. Specified in the form ["hostname:IP"]
- Force
Remove bool - Always remove intermediate containers
- Isolation string
- Isolation represents the isolation technology of a container. The supported values are
- Label Dictionary<string, string>
- Set metadata for an image
- Labels Dictionary<string, string>
- User-defined key/value metadata
- Memory int
- Set memory limit for build
- Memory
Swap int - Total memory (memory + swap), -1 to enable unlimited swap
- Network
Mode string - Set the networking mode for the RUN instructions during build
- No
Cache bool - Do not use the cache when building the image
- Platform string
- Set platform if server is multi-platform capable
- Pull
Parent bool - Attempt to pull the image even if an older image exists locally
- Remote
Context string - A Git repository URI or HTTP/HTTPS context URI. Will be ignored if
builder
is set. - Remove bool
- Remove intermediate containers after a successful build. Defaults to
true
. - Secrets
List<Remote
Image Build Secret> - Set build-time secrets. Only available when you use a buildx builder.
- Security
Opts List<string> - The security options
- Session
Id string - Set an ID for the build session
- Shm
Size int - Size of /dev/shm in bytes. The size must be greater than 0
- Squash bool
- If true the new layers are squashed into a new image with a single new layer
- Suppress
Output bool - Suppress the build output and print image ID on success
- List<string>
- Name and optionally a tag in the 'name:tag' format
- Target string
- Set the target build stage to build
- Ulimits
List<Remote
Image Build Ulimit> - Configuration for ulimits
- Version string
- Version of the underlying builder to use
- Context string
- Value to specify the build context. Currently, only a
PATH
context is supported. You can use the helper function '${path.cwd}/context-dir'. This always refers to the local working directory, even when building images on remote hosts. Please see https://docs.docker.com/build/building/context/ for more information about build contexts. - Auth
Configs []RemoteImage Build Auth Config - The configuration for the authentication
- Build
Args map[string]string - Pairs for build-time variables in the form of
ENDPOINT : "https://example.com"
- Build
Id string - BuildID is an optional identifier that can be passed together with the build request. The same identifier can be used to gracefully cancel the build with the cancel request.
- Build
Log stringFile - Path to a file where the buildx log are written to. Only available when
builder
is set. If not set, no logs are available. The path is taken as is, so make sure to use a path that is available. - Builder string
- Set the name of the buildx builder to use. If not set or empty, the legacy builder will be used.
- Cache
Froms []string - Images to consider as cache sources
- Cgroup
Parent string - Optional parent cgroup for the container
- Cpu
Period int - The length of a CPU period in microseconds
- Cpu
Quota int - Microseconds of CPU time that the container can get in a CPU period
- Cpu
Set stringCpus - CPUs in which to allow execution (e.g.,
0-3
,0
,1
) - Cpu
Set stringMems - MEMs in which to allow execution (
0-3
,0
,1
) - int
- CPU shares (relative weight)
- Dockerfile string
- Name of the Dockerfile. Defaults to
Dockerfile
. - Extra
Hosts []string - A list of hostnames/IP mappings to add to the container’s /etc/hosts file. Specified in the form ["hostname:IP"]
- Force
Remove bool - Always remove intermediate containers
- Isolation string
- Isolation represents the isolation technology of a container. The supported values are
- Label map[string]string
- Set metadata for an image
- Labels map[string]string
- User-defined key/value metadata
- Memory int
- Set memory limit for build
- Memory
Swap int - Total memory (memory + swap), -1 to enable unlimited swap
- Network
Mode string - Set the networking mode for the RUN instructions during build
- No
Cache bool - Do not use the cache when building the image
- Platform string
- Set platform if server is multi-platform capable
- Pull
Parent bool - Attempt to pull the image even if an older image exists locally
- Remote
Context string - A Git repository URI or HTTP/HTTPS context URI. Will be ignored if
builder
is set. - Remove bool
- Remove intermediate containers after a successful build. Defaults to
true
. - Secrets
[]Remote
Image Build Secret - Set build-time secrets. Only available when you use a buildx builder.
- Security
Opts []string - The security options
- Session
Id string - Set an ID for the build session
- Shm
Size int - Size of /dev/shm in bytes. The size must be greater than 0
- Squash bool
- If true the new layers are squashed into a new image with a single new layer
- Suppress
Output bool - Suppress the build output and print image ID on success
- []string
- Name and optionally a tag in the 'name:tag' format
- Target string
- Set the target build stage to build
- Ulimits
[]Remote
Image Build Ulimit - Configuration for ulimits
- Version string
- Version of the underlying builder to use
- context String
- Value to specify the build context. Currently, only a
PATH
context is supported. You can use the helper function '${path.cwd}/context-dir'. This always refers to the local working directory, even when building images on remote hosts. Please see https://docs.docker.com/build/building/context/ for more information about build contexts. - auth
Configs List<RemoteImage Build Auth Config> - The configuration for the authentication
- build
Args Map<String,String> - Pairs for build-time variables in the form of
ENDPOINT : "https://example.com"
- build
Id String - BuildID is an optional identifier that can be passed together with the build request. The same identifier can be used to gracefully cancel the build with the cancel request.
- build
Log StringFile - Path to a file where the buildx log are written to. Only available when
builder
is set. If not set, no logs are available. The path is taken as is, so make sure to use a path that is available. - builder_ String
- Set the name of the buildx builder to use. If not set or empty, the legacy builder will be used.
- cache
Froms List<String> - Images to consider as cache sources
- cgroup
Parent String - Optional parent cgroup for the container
- cpu
Period Integer - The length of a CPU period in microseconds
- cpu
Quota Integer - Microseconds of CPU time that the container can get in a CPU period
- cpu
Set StringCpus - CPUs in which to allow execution (e.g.,
0-3
,0
,1
) - cpu
Set StringMems - MEMs in which to allow execution (
0-3
,0
,1
) - Integer
- CPU shares (relative weight)
- dockerfile String
- Name of the Dockerfile. Defaults to
Dockerfile
. - extra
Hosts List<String> - A list of hostnames/IP mappings to add to the container’s /etc/hosts file. Specified in the form ["hostname:IP"]
- force
Remove Boolean - Always remove intermediate containers
- isolation String
- Isolation represents the isolation technology of a container. The supported values are
- label Map<String,String>
- Set metadata for an image
- labels Map<String,String>
- User-defined key/value metadata
- memory Integer
- Set memory limit for build
- memory
Swap Integer - Total memory (memory + swap), -1 to enable unlimited swap
- network
Mode String - Set the networking mode for the RUN instructions during build
- no
Cache Boolean - Do not use the cache when building the image
- platform String
- Set platform if server is multi-platform capable
- pull
Parent Boolean - Attempt to pull the image even if an older image exists locally
- remote
Context String - A Git repository URI or HTTP/HTTPS context URI. Will be ignored if
builder
is set. - remove Boolean
- Remove intermediate containers after a successful build. Defaults to
true
. - secrets
List<Remote
Image Build Secret> - Set build-time secrets. Only available when you use a buildx builder.
- security
Opts List<String> - The security options
- session
Id String - Set an ID for the build session
- shm
Size Integer - Size of /dev/shm in bytes. The size must be greater than 0
- squash Boolean
- If true the new layers are squashed into a new image with a single new layer
- suppress
Output Boolean - Suppress the build output and print image ID on success
- List<String>
- Name and optionally a tag in the 'name:tag' format
- target String
- Set the target build stage to build
- ulimits
List<Remote
Image Build Ulimit> - Configuration for ulimits
- version String
- Version of the underlying builder to use
- context string
- Value to specify the build context. Currently, only a
PATH
context is supported. You can use the helper function '${path.cwd}/context-dir'. This always refers to the local working directory, even when building images on remote hosts. Please see https://docs.docker.com/build/building/context/ for more information about build contexts. - auth
Configs RemoteImage Build Auth Config[] - The configuration for the authentication
- build
Args {[key: string]: string} - Pairs for build-time variables in the form of
ENDPOINT : "https://example.com"
- build
Id string - BuildID is an optional identifier that can be passed together with the build request. The same identifier can be used to gracefully cancel the build with the cancel request.
- build
Log stringFile - Path to a file where the buildx log are written to. Only available when
builder
is set. If not set, no logs are available. The path is taken as is, so make sure to use a path that is available. - builder string
- Set the name of the buildx builder to use. If not set or empty, the legacy builder will be used.
- cache
Froms string[] - Images to consider as cache sources
- cgroup
Parent string - Optional parent cgroup for the container
- cpu
Period number - The length of a CPU period in microseconds
- cpu
Quota number - Microseconds of CPU time that the container can get in a CPU period
- cpu
Set stringCpus - CPUs in which to allow execution (e.g.,
0-3
,0
,1
) - cpu
Set stringMems - MEMs in which to allow execution (
0-3
,0
,1
) - number
- CPU shares (relative weight)
- dockerfile string
- Name of the Dockerfile. Defaults to
Dockerfile
. - extra
Hosts string[] - A list of hostnames/IP mappings to add to the container’s /etc/hosts file. Specified in the form ["hostname:IP"]
- force
Remove boolean - Always remove intermediate containers
- isolation string
- Isolation represents the isolation technology of a container. The supported values are
- label {[key: string]: string}
- Set metadata for an image
- labels {[key: string]: string}
- User-defined key/value metadata
- memory number
- Set memory limit for build
- memory
Swap number - Total memory (memory + swap), -1 to enable unlimited swap
- network
Mode string - Set the networking mode for the RUN instructions during build
- no
Cache boolean - Do not use the cache when building the image
- platform string
- Set platform if server is multi-platform capable
- pull
Parent boolean - Attempt to pull the image even if an older image exists locally
- remote
Context string - A Git repository URI or HTTP/HTTPS context URI. Will be ignored if
builder
is set. - remove boolean
- Remove intermediate containers after a successful build. Defaults to
true
. - secrets
Remote
Image Build Secret[] - Set build-time secrets. Only available when you use a buildx builder.
- security
Opts string[] - The security options
- session
Id string - Set an ID for the build session
- shm
Size number - Size of /dev/shm in bytes. The size must be greater than 0
- squash boolean
- If true the new layers are squashed into a new image with a single new layer
- suppress
Output boolean - Suppress the build output and print image ID on success
- string[]
- Name and optionally a tag in the 'name:tag' format
- target string
- Set the target build stage to build
- ulimits
Remote
Image Build Ulimit[] - Configuration for ulimits
- version string
- Version of the underlying builder to use
- context str
- Value to specify the build context. Currently, only a
PATH
context is supported. You can use the helper function '${path.cwd}/context-dir'. This always refers to the local working directory, even when building images on remote hosts. Please see https://docs.docker.com/build/building/context/ for more information about build contexts. - auth_
configs Sequence[RemoteImage Build Auth Config] - The configuration for the authentication
- build_
args Mapping[str, str] - Pairs for build-time variables in the form of
ENDPOINT : "https://example.com"
- build_
id str - BuildID is an optional identifier that can be passed together with the build request. The same identifier can be used to gracefully cancel the build with the cancel request.
- build_
log_ strfile - Path to a file where the buildx log are written to. Only available when
builder
is set. If not set, no logs are available. The path is taken as is, so make sure to use a path that is available. - builder str
- Set the name of the buildx builder to use. If not set or empty, the legacy builder will be used.
- cache_
froms Sequence[str] - Images to consider as cache sources
- cgroup_
parent str - Optional parent cgroup for the container
- cpu_
period int - The length of a CPU period in microseconds
- cpu_
quota int - Microseconds of CPU time that the container can get in a CPU period
- cpu_
set_ strcpus - CPUs in which to allow execution (e.g.,
0-3
,0
,1
) - cpu_
set_ strmems - MEMs in which to allow execution (
0-3
,0
,1
) - int
- CPU shares (relative weight)
- dockerfile str
- Name of the Dockerfile. Defaults to
Dockerfile
. - extra_
hosts Sequence[str] - A list of hostnames/IP mappings to add to the container’s /etc/hosts file. Specified in the form ["hostname:IP"]
- force_
remove bool - Always remove intermediate containers
- isolation str
- Isolation represents the isolation technology of a container. The supported values are
- label Mapping[str, str]
- Set metadata for an image
- labels Mapping[str, str]
- User-defined key/value metadata
- memory int
- Set memory limit for build
- memory_
swap int - Total memory (memory + swap), -1 to enable unlimited swap
- network_
mode str - Set the networking mode for the RUN instructions during build
- no_
cache bool - Do not use the cache when building the image
- platform str
- Set platform if server is multi-platform capable
- pull_
parent bool - Attempt to pull the image even if an older image exists locally
- remote_
context str - A Git repository URI or HTTP/HTTPS context URI. Will be ignored if
builder
is set. - remove bool
- Remove intermediate containers after a successful build. Defaults to
true
. - secrets
Sequence[Remote
Image Build Secret] - Set build-time secrets. Only available when you use a buildx builder.
- security_
opts Sequence[str] - The security options
- session_
id str - Set an ID for the build session
- shm_
size int - Size of /dev/shm in bytes. The size must be greater than 0
- squash bool
- If true the new layers are squashed into a new image with a single new layer
- suppress_
output bool - Suppress the build output and print image ID on success
- Sequence[str]
- Name and optionally a tag in the 'name:tag' format
- target str
- Set the target build stage to build
- ulimits
Sequence[Remote
Image Build Ulimit] - Configuration for ulimits
- version str
- Version of the underlying builder to use
- context String
- Value to specify the build context. Currently, only a
PATH
context is supported. You can use the helper function '${path.cwd}/context-dir'. This always refers to the local working directory, even when building images on remote hosts. Please see https://docs.docker.com/build/building/context/ for more information about build contexts. - auth
Configs List<Property Map> - The configuration for the authentication
- build
Args Map<String> - Pairs for build-time variables in the form of
ENDPOINT : "https://example.com"
- build
Id String - BuildID is an optional identifier that can be passed together with the build request. The same identifier can be used to gracefully cancel the build with the cancel request.
- build
Log StringFile - Path to a file where the buildx log are written to. Only available when
builder
is set. If not set, no logs are available. The path is taken as is, so make sure to use a path that is available. - builder String
- Set the name of the buildx builder to use. If not set or empty, the legacy builder will be used.
- cache
Froms List<String> - Images to consider as cache sources
- cgroup
Parent String - Optional parent cgroup for the container
- cpu
Period Number - The length of a CPU period in microseconds
- cpu
Quota Number - Microseconds of CPU time that the container can get in a CPU period
- cpu
Set StringCpus - CPUs in which to allow execution (e.g.,
0-3
,0
,1
) - cpu
Set StringMems - MEMs in which to allow execution (
0-3
,0
,1
) - Number
- CPU shares (relative weight)
- dockerfile String
- Name of the Dockerfile. Defaults to
Dockerfile
. - extra
Hosts List<String> - A list of hostnames/IP mappings to add to the container’s /etc/hosts file. Specified in the form ["hostname:IP"]
- force
Remove Boolean - Always remove intermediate containers
- isolation String
- Isolation represents the isolation technology of a container. The supported values are
- label Map<String>
- Set metadata for an image
- labels Map<String>
- User-defined key/value metadata
- memory Number
- Set memory limit for build
- memory
Swap Number - Total memory (memory + swap), -1 to enable unlimited swap
- network
Mode String - Set the networking mode for the RUN instructions during build
- no
Cache Boolean - Do not use the cache when building the image
- platform String
- Set platform if server is multi-platform capable
- pull
Parent Boolean - Attempt to pull the image even if an older image exists locally
- remote
Context String - A Git repository URI or HTTP/HTTPS context URI. Will be ignored if
builder
is set. - remove Boolean
- Remove intermediate containers after a successful build. Defaults to
true
. - secrets List<Property Map>
- Set build-time secrets. Only available when you use a buildx builder.
- security
Opts List<String> - The security options
- session
Id String - Set an ID for the build session
- shm
Size Number - Size of /dev/shm in bytes. The size must be greater than 0
- squash Boolean
- If true the new layers are squashed into a new image with a single new layer
- suppress
Output Boolean - Suppress the build output and print image ID on success
- List<String>
- Name and optionally a tag in the 'name:tag' format
- target String
- Set the target build stage to build
- ulimits List<Property Map>
- Configuration for ulimits
- version String
- Version of the underlying builder to use
RemoteImageBuildAuthConfig, RemoteImageBuildAuthConfigArgs
- Host
Name string - hostname of the registry
- Auth string
- the auth token
- Email string
- the user emal
- Identity
Token string - the identity token
- Password string
- the registry password
- Registry
Token string - the registry token
- Server
Address string - the server address
- User
Name string - the registry user name
- Host
Name string - hostname of the registry
- Auth string
- the auth token
- Email string
- the user emal
- Identity
Token string - the identity token
- Password string
- the registry password
- Registry
Token string - the registry token
- Server
Address string - the server address
- User
Name string - the registry user name
- host
Name String - hostname of the registry
- auth String
- the auth token
- email String
- the user emal
- identity
Token String - the identity token
- password String
- the registry password
- registry
Token String - the registry token
- server
Address String - the server address
- user
Name String - the registry user name
- host
Name string - hostname of the registry
- auth string
- the auth token
- email string
- the user emal
- identity
Token string - the identity token
- password string
- the registry password
- registry
Token string - the registry token
- server
Address string - the server address
- user
Name string - the registry user name
- host_
name str - hostname of the registry
- auth str
- the auth token
- email str
- the user emal
- identity_
token str - the identity token
- password str
- the registry password
- registry_
token str - the registry token
- server_
address str - the server address
- user_
name str - the registry user name
- host
Name String - hostname of the registry
- auth String
- the auth token
- email String
- the user emal
- identity
Token String - the identity token
- password String
- the registry password
- registry
Token String - the registry token
- server
Address String - the server address
- user
Name String - the registry user name
RemoteImageBuildSecret, RemoteImageBuildSecretArgs
RemoteImageBuildUlimit, RemoteImageBuildUlimitArgs
Package Details
- Repository
- Docker pulumi/pulumi-docker
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
docker
Terraform Provider.