pulumi-docker 4.6.2a1741997713__py3-none-any.whl → 4.7.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of pulumi-docker might be problematic. Click here for more details.

@@ -2,6 +2,7 @@
2
2
  # *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
3
3
  # *** Do not edit by hand unless you're certain you know what you are doing! ***
4
4
 
5
+ import builtins
5
6
  import copy
6
7
  import warnings
7
8
  import sys
@@ -39,7 +40,7 @@ class GetRemoteImageResult:
39
40
 
40
41
  @property
41
42
  @pulumi.getter
42
- def id(self) -> str:
43
+ def id(self) -> builtins.str:
43
44
  """
44
45
  The provider-assigned unique ID for this managed resource.
45
46
  """
@@ -47,7 +48,7 @@ class GetRemoteImageResult:
47
48
 
48
49
  @property
49
50
  @pulumi.getter
50
- def name(self) -> str:
51
+ def name(self) -> builtins.str:
51
52
  """
52
53
  The name of the Docker image, including any tags or SHA256 repo digests.
53
54
  """
@@ -55,7 +56,7 @@ class GetRemoteImageResult:
55
56
 
56
57
  @property
57
58
  @pulumi.getter(name="repoDigest")
58
- def repo_digest(self) -> str:
59
+ def repo_digest(self) -> builtins.str:
59
60
  """
60
61
  The image sha256 digest in the form of `repo[:tag]@sha256:<hash>`. It may be empty in the edge case where the local image was pulled from a repo, tagged locally, and then referred to in the data source by that local name/tag.
61
62
  """
@@ -73,7 +74,7 @@ class AwaitableGetRemoteImageResult(GetRemoteImageResult):
73
74
  repo_digest=self.repo_digest)
74
75
 
75
76
 
76
- def get_remote_image(name: Optional[str] = None,
77
+ def get_remote_image(name: Optional[builtins.str] = None,
77
78
  opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetRemoteImageResult:
78
79
  """
79
80
  `RemoteImage` provides details about a specific Docker Image which needs to be present on the Docker Host
@@ -95,7 +96,7 @@ def get_remote_image(name: Optional[str] = None,
95
96
  ```
96
97
 
97
98
 
98
- :param str name: The name of the Docker image, including any tags or SHA256 repo digests.
99
+ :param builtins.str name: The name of the Docker image, including any tags or SHA256 repo digests.
99
100
  """
100
101
  __args__ = dict()
101
102
  __args__['name'] = name
@@ -106,7 +107,7 @@ def get_remote_image(name: Optional[str] = None,
106
107
  id=pulumi.get(__ret__, 'id'),
107
108
  name=pulumi.get(__ret__, 'name'),
108
109
  repo_digest=pulumi.get(__ret__, 'repo_digest'))
109
- def get_remote_image_output(name: Optional[pulumi.Input[str]] = None,
110
+ def get_remote_image_output(name: Optional[pulumi.Input[builtins.str]] = None,
110
111
  opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetRemoteImageResult]:
111
112
  """
112
113
  `RemoteImage` provides details about a specific Docker Image which needs to be present on the Docker Host
@@ -128,7 +129,7 @@ def get_remote_image_output(name: Optional[pulumi.Input[str]] = None,
128
129
  ```
129
130
 
130
131
 
131
- :param str name: The name of the Docker image, including any tags or SHA256 repo digests.
132
+ :param builtins.str name: The name of the Docker image, including any tags or SHA256 repo digests.
132
133
  """
133
134
  __args__ = dict()
134
135
  __args__['name'] = name
pulumi_docker/image.py CHANGED
@@ -2,6 +2,7 @@
2
2
  # *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
3
3
  # *** Do not edit by hand unless you're certain you know what you are doing! ***
4
4
 
5
+ import builtins
5
6
  import copy
6
7
  import warnings
7
8
  import sys
@@ -21,19 +22,19 @@ __all__ = ['ImageArgs', 'Image']
21
22
  @pulumi.input_type
22
23
  class ImageArgs:
23
24
  def __init__(__self__, *,
24
- image_name: pulumi.Input[str],
25
+ image_name: pulumi.Input[builtins.str],
25
26
  build: Optional[pulumi.Input['DockerBuildArgs']] = None,
26
- build_on_preview: Optional[pulumi.Input[bool]] = None,
27
+ build_on_preview: Optional[pulumi.Input[builtins.bool]] = None,
27
28
  registry: Optional[pulumi.Input['RegistryArgs']] = None,
28
- skip_push: Optional[pulumi.Input[bool]] = None):
29
+ skip_push: Optional[pulumi.Input[builtins.bool]] = None):
29
30
  """
30
31
  The set of arguments for constructing a Image resource.
31
- :param pulumi.Input[str] image_name: The image name, of the format repository[:tag], e.g. `docker.io/username/demo-image:v1`.
32
+ :param pulumi.Input[builtins.str] image_name: The image name, of the format repository[:tag], e.g. `docker.io/username/demo-image:v1`.
32
33
  This reference is not unique to each build and push.For the unique manifest SHA of a pushed docker image, or the local image ID, please use `repoDigest`.
33
34
  :param pulumi.Input['DockerBuildArgs'] build: The Docker build context
34
- :param pulumi.Input[bool] build_on_preview: A flag to build an image on preview
35
+ :param pulumi.Input[builtins.bool] build_on_preview: A flag to build an image on preview
35
36
  :param pulumi.Input['RegistryArgs'] registry: The registry to push the image to
36
- :param pulumi.Input[bool] skip_push: A flag to skip a registry push.
37
+ :param pulumi.Input[builtins.bool] skip_push: A flag to skip a registry push.
37
38
  """
38
39
  pulumi.set(__self__, "image_name", image_name)
39
40
  if build is not None:
@@ -51,7 +52,7 @@ class ImageArgs:
51
52
 
52
53
  @property
53
54
  @pulumi.getter(name="imageName")
54
- def image_name(self) -> pulumi.Input[str]:
55
+ def image_name(self) -> pulumi.Input[builtins.str]:
55
56
  """
56
57
  The image name, of the format repository[:tag], e.g. `docker.io/username/demo-image:v1`.
57
58
  This reference is not unique to each build and push.For the unique manifest SHA of a pushed docker image, or the local image ID, please use `repoDigest`.
@@ -59,7 +60,7 @@ class ImageArgs:
59
60
  return pulumi.get(self, "image_name")
60
61
 
61
62
  @image_name.setter
62
- def image_name(self, value: pulumi.Input[str]):
63
+ def image_name(self, value: pulumi.Input[builtins.str]):
63
64
  pulumi.set(self, "image_name", value)
64
65
 
65
66
  @property
@@ -76,14 +77,14 @@ class ImageArgs:
76
77
 
77
78
  @property
78
79
  @pulumi.getter(name="buildOnPreview")
79
- def build_on_preview(self) -> Optional[pulumi.Input[bool]]:
80
+ def build_on_preview(self) -> Optional[pulumi.Input[builtins.bool]]:
80
81
  """
81
82
  A flag to build an image on preview
82
83
  """
83
84
  return pulumi.get(self, "build_on_preview")
84
85
 
85
86
  @build_on_preview.setter
86
- def build_on_preview(self, value: Optional[pulumi.Input[bool]]):
87
+ def build_on_preview(self, value: Optional[pulumi.Input[builtins.bool]]):
87
88
  pulumi.set(self, "build_on_preview", value)
88
89
 
89
90
  @property
@@ -100,27 +101,28 @@ class ImageArgs:
100
101
 
101
102
  @property
102
103
  @pulumi.getter(name="skipPush")
103
- def skip_push(self) -> Optional[pulumi.Input[bool]]:
104
+ def skip_push(self) -> Optional[pulumi.Input[builtins.bool]]:
104
105
  """
105
106
  A flag to skip a registry push.
106
107
  """
107
108
  return pulumi.get(self, "skip_push")
108
109
 
109
110
  @skip_push.setter
110
- def skip_push(self, value: Optional[pulumi.Input[bool]]):
111
+ def skip_push(self, value: Optional[pulumi.Input[builtins.bool]]):
111
112
  pulumi.set(self, "skip_push", value)
112
113
 
113
114
 
115
+ @pulumi.type_token("docker:index/image:Image")
114
116
  class Image(pulumi.CustomResource):
115
117
  @overload
116
118
  def __init__(__self__,
117
119
  resource_name: str,
118
120
  opts: Optional[pulumi.ResourceOptions] = None,
119
121
  build: Optional[pulumi.Input[Union['DockerBuildArgs', 'DockerBuildArgsDict']]] = None,
120
- build_on_preview: Optional[pulumi.Input[bool]] = None,
121
- image_name: Optional[pulumi.Input[str]] = None,
122
+ build_on_preview: Optional[pulumi.Input[builtins.bool]] = None,
123
+ image_name: Optional[pulumi.Input[builtins.str]] = None,
122
124
  registry: Optional[pulumi.Input[Union['RegistryArgs', 'RegistryArgsDict']]] = None,
123
- skip_push: Optional[pulumi.Input[bool]] = None,
125
+ skip_push: Optional[pulumi.Input[builtins.bool]] = None,
124
126
  __props__=None):
125
127
  """
126
128
  `Image` builds a Docker image and pushes it Docker and OCI compatible registries.
@@ -214,11 +216,11 @@ class Image(pulumi.CustomResource):
214
216
  :param str resource_name: The name of the resource.
215
217
  :param pulumi.ResourceOptions opts: Options for the resource.
216
218
  :param pulumi.Input[Union['DockerBuildArgs', 'DockerBuildArgsDict']] build: The Docker build context
217
- :param pulumi.Input[bool] build_on_preview: A flag to build an image on preview
218
- :param pulumi.Input[str] image_name: The image name, of the format repository[:tag], e.g. `docker.io/username/demo-image:v1`.
219
+ :param pulumi.Input[builtins.bool] build_on_preview: A flag to build an image on preview
220
+ :param pulumi.Input[builtins.str] image_name: The image name, of the format repository[:tag], e.g. `docker.io/username/demo-image:v1`.
219
221
  This reference is not unique to each build and push.For the unique manifest SHA of a pushed docker image, or the local image ID, please use `repoDigest`.
220
222
  :param pulumi.Input[Union['RegistryArgs', 'RegistryArgsDict']] registry: The registry to push the image to
221
- :param pulumi.Input[bool] skip_push: A flag to skip a registry push.
223
+ :param pulumi.Input[builtins.bool] skip_push: A flag to skip a registry push.
222
224
  """
223
225
  ...
224
226
  @overload
@@ -331,10 +333,10 @@ class Image(pulumi.CustomResource):
331
333
  resource_name: str,
332
334
  opts: Optional[pulumi.ResourceOptions] = None,
333
335
  build: Optional[pulumi.Input[Union['DockerBuildArgs', 'DockerBuildArgsDict']]] = None,
334
- build_on_preview: Optional[pulumi.Input[bool]] = None,
335
- image_name: Optional[pulumi.Input[str]] = None,
336
+ build_on_preview: Optional[pulumi.Input[builtins.bool]] = None,
337
+ image_name: Optional[pulumi.Input[builtins.str]] = None,
336
338
  registry: Optional[pulumi.Input[Union['RegistryArgs', 'RegistryArgsDict']]] = None,
337
- skip_push: Optional[pulumi.Input[bool]] = None,
339
+ skip_push: Optional[pulumi.Input[builtins.bool]] = None,
338
340
  __props__=None):
339
341
  opts = pulumi.ResourceOptions.merge(_utilities.get_resource_opts_defaults(), opts)
340
342
  if not isinstance(opts, pulumi.ResourceOptions):
@@ -396,7 +398,7 @@ class Image(pulumi.CustomResource):
396
398
 
397
399
  @property
398
400
  @pulumi.getter(name="baseImageName")
399
- def base_image_name(self) -> pulumi.Output[str]:
401
+ def base_image_name(self) -> pulumi.Output[builtins.str]:
400
402
  """
401
403
  The fully qualified image name that was pushed to the registry.
402
404
  """
@@ -404,7 +406,7 @@ class Image(pulumi.CustomResource):
404
406
 
405
407
  @property
406
408
  @pulumi.getter
407
- def context(self) -> pulumi.Output[str]:
409
+ def context(self) -> pulumi.Output[builtins.str]:
408
410
  """
409
411
  The path to the build context to use.
410
412
  """
@@ -412,7 +414,7 @@ class Image(pulumi.CustomResource):
412
414
 
413
415
  @property
414
416
  @pulumi.getter
415
- def dockerfile(self) -> pulumi.Output[str]:
417
+ def dockerfile(self) -> pulumi.Output[builtins.str]:
416
418
  """
417
419
  The location of the Dockerfile relative to the docker build context.
418
420
  """
@@ -420,7 +422,7 @@ class Image(pulumi.CustomResource):
420
422
 
421
423
  @property
422
424
  @pulumi.getter(name="imageName")
423
- def image_name(self) -> pulumi.Output[str]:
425
+ def image_name(self) -> pulumi.Output[builtins.str]:
424
426
  """
425
427
  The fully qualified image name
426
428
  """
@@ -428,7 +430,7 @@ class Image(pulumi.CustomResource):
428
430
 
429
431
  @property
430
432
  @pulumi.getter
431
- def platform(self) -> pulumi.Output[Optional[str]]:
433
+ def platform(self) -> pulumi.Output[Optional[builtins.str]]:
432
434
  """
433
435
  The image's architecture and OS
434
436
  """
@@ -436,7 +438,7 @@ class Image(pulumi.CustomResource):
436
438
 
437
439
  @property
438
440
  @pulumi.getter(name="registryServer")
439
- def registry_server(self) -> pulumi.Output[str]:
441
+ def registry_server(self) -> pulumi.Output[builtins.str]:
440
442
  """
441
443
  The name of the registry server hosting the image.
442
444
  """
@@ -444,7 +446,7 @@ class Image(pulumi.CustomResource):
444
446
 
445
447
  @property
446
448
  @pulumi.getter(name="repoDigest")
447
- def repo_digest(self) -> pulumi.Output[str]:
449
+ def repo_digest(self) -> pulumi.Output[builtins.str]:
448
450
  """
449
451
  **For pushed images:**
450
452
  The manifest digest of an image pushed to a registry, of the format repository@<algorithm>:<hash>, e.g. `username/demo-image@sha256:a6ae6dd8d39c5bb02320e41abf00cd4cb35905fec540e37d306c878be8d38bd3`.