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