pulumi-docker 4.7.0a1705607229__py3-none-any.whl → 4.7.0a1736833147__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.

pulumi_docker/outputs.py CHANGED
@@ -4,9 +4,14 @@
4
4
 
5
5
  import copy
6
6
  import warnings
7
+ import sys
7
8
  import pulumi
8
9
  import pulumi.runtime
9
10
  from typing import Any, Mapping, Optional, Sequence, Union, overload
11
+ if sys.version_info >= (3, 11):
12
+ from typing import NotRequired, TypedDict, TypeAlias
13
+ else:
14
+ from typing_extensions import NotRequired, TypedDict, TypeAlias
10
15
  from . import _utilities
11
16
  from . import outputs
12
17
  from ._enums import *
@@ -630,6 +635,16 @@ class ContainerNetworkData(dict):
630
635
  ipv6_gateway: Optional[str] = None,
631
636
  mac_address: Optional[str] = None,
632
637
  network_name: Optional[str] = None):
638
+ """
639
+ :param str gateway: The network gateway of the container.
640
+ :param str global_ipv6_address: The IPV6 address of the container.
641
+ :param int global_ipv6_prefix_length: The IPV6 prefix length address of the container.
642
+ :param str ip_address: The IP address of the container.
643
+ :param int ip_prefix_length: The IP prefix length of the container.
644
+ :param str ipv6_gateway: The IPV6 gateway of the container.
645
+ :param str mac_address: The MAC address of the container.
646
+ :param str network_name: The name of the network
647
+ """
633
648
  if gateway is not None:
634
649
  pulumi.set(__self__, "gateway", gateway)
635
650
  if global_ipv6_address is not None:
@@ -650,41 +665,65 @@ class ContainerNetworkData(dict):
650
665
  @property
651
666
  @pulumi.getter
652
667
  def gateway(self) -> Optional[str]:
668
+ """
669
+ The network gateway of the container.
670
+ """
653
671
  return pulumi.get(self, "gateway")
654
672
 
655
673
  @property
656
674
  @pulumi.getter(name="globalIpv6Address")
657
675
  def global_ipv6_address(self) -> Optional[str]:
676
+ """
677
+ The IPV6 address of the container.
678
+ """
658
679
  return pulumi.get(self, "global_ipv6_address")
659
680
 
660
681
  @property
661
682
  @pulumi.getter(name="globalIpv6PrefixLength")
662
683
  def global_ipv6_prefix_length(self) -> Optional[int]:
684
+ """
685
+ The IPV6 prefix length address of the container.
686
+ """
663
687
  return pulumi.get(self, "global_ipv6_prefix_length")
664
688
 
665
689
  @property
666
690
  @pulumi.getter(name="ipAddress")
667
691
  def ip_address(self) -> Optional[str]:
692
+ """
693
+ The IP address of the container.
694
+ """
668
695
  return pulumi.get(self, "ip_address")
669
696
 
670
697
  @property
671
698
  @pulumi.getter(name="ipPrefixLength")
672
699
  def ip_prefix_length(self) -> Optional[int]:
700
+ """
701
+ The IP prefix length of the container.
702
+ """
673
703
  return pulumi.get(self, "ip_prefix_length")
674
704
 
675
705
  @property
676
706
  @pulumi.getter(name="ipv6Gateway")
677
707
  def ipv6_gateway(self) -> Optional[str]:
708
+ """
709
+ The IPV6 gateway of the container.
710
+ """
678
711
  return pulumi.get(self, "ipv6_gateway")
679
712
 
680
713
  @property
681
714
  @pulumi.getter(name="macAddress")
682
715
  def mac_address(self) -> Optional[str]:
716
+ """
717
+ The MAC address of the container.
718
+ """
683
719
  return pulumi.get(self, "mac_address")
684
720
 
685
721
  @property
686
722
  @pulumi.getter(name="networkName")
687
723
  def network_name(self) -> Optional[str]:
724
+ """
725
+ The name of the network
726
+ """
688
727
  return pulumi.get(self, "network_name")
689
728
 
690
729
 
@@ -886,6 +925,7 @@ class ContainerUpload(dict):
886
925
  """
887
926
  :param str file: Path to the file in the container where is upload goes to
888
927
  :param str content: Literal string value to use as the object content, which will be uploaded as UTF-8-encoded text. Conflicts with `content_base64` & `source`
928
+ :param str content_base64: Base64-encoded data that will be decoded and uploaded as raw bytes for the object content. This allows safely uploading non-UTF8 binary data, but is recommended only for larger binary content such as the result of the `base64encode` interpolation function. See here for the reason. Conflicts with `content` & `source`
889
929
  :param bool executable: If `true`, the file will be uploaded with user executable permission. Defaults to `false`.
890
930
  :param str source: A filename that references a file which will be uploaded as the object content. This allows for large file uploads that do not get stored in state. Conflicts with `content` & `content_base64`
891
931
  :param str source_hash: If using `source`, this will force an update if the file content has updated but the filename has not.
@@ -921,6 +961,9 @@ class ContainerUpload(dict):
921
961
  @property
922
962
  @pulumi.getter(name="contentBase64")
923
963
  def content_base64(self) -> Optional[str]:
964
+ """
965
+ Base64-encoded data that will be decoded and uploaded as raw bytes for the object content. This allows safely uploading non-UTF8 binary data, but is recommended only for larger binary content such as the result of the `base64encode` interpolation function. See here for the reason. Conflicts with `content` & `source`
966
+ """
924
967
  return pulumi.get(self, "content_base64")
925
968
 
926
969
  @property
@@ -1062,12 +1105,12 @@ class NetworkIpamConfig(dict):
1062
1105
  return super().get(key, default)
1063
1106
 
1064
1107
  def __init__(__self__, *,
1065
- aux_address: Optional[Mapping[str, Any]] = None,
1108
+ aux_address: Optional[Mapping[str, str]] = None,
1066
1109
  gateway: Optional[str] = None,
1067
1110
  ip_range: Optional[str] = None,
1068
1111
  subnet: Optional[str] = None):
1069
1112
  """
1070
- :param Mapping[str, Any] aux_address: Auxiliary IPv4 or IPv6 addresses used by Network driver
1113
+ :param Mapping[str, str] aux_address: Auxiliary IPv4 or IPv6 addresses used by Network driver
1071
1114
  :param str gateway: The IP address of the gateway
1072
1115
  :param str ip_range: The ip range in CIDR form
1073
1116
  :param str subnet: The subnet in CIDR form
@@ -1083,7 +1126,7 @@ class NetworkIpamConfig(dict):
1083
1126
 
1084
1127
  @property
1085
1128
  @pulumi.getter(name="auxAddress")
1086
- def aux_address(self) -> Optional[Mapping[str, Any]]:
1129
+ def aux_address(self) -> Optional[Mapping[str, str]]:
1087
1130
  """
1088
1131
  Auxiliary IPv4 or IPv6 addresses used by Network driver
1089
1132
  """
@@ -2427,7 +2470,7 @@ class ServiceTaskSpecContainerSpec(dict):
2427
2470
  secrets: Optional[Sequence['outputs.ServiceTaskSpecContainerSpecSecret']] = None,
2428
2471
  stop_grace_period: Optional[str] = None,
2429
2472
  stop_signal: Optional[str] = None,
2430
- sysctl: Optional[Mapping[str, Any]] = None,
2473
+ sysctl: Optional[Mapping[str, str]] = None,
2431
2474
  user: Optional[str] = None):
2432
2475
  """
2433
2476
  :param str image: The image name to use for the containers of the service, like `nginx:1.17.6`. Also use the data-source or resource of `RemoteImage` with the `repo_digest` or `RegistryImage` with the `name` attribute for this, as shown in the examples.
@@ -2445,12 +2488,12 @@ class ServiceTaskSpecContainerSpec(dict):
2445
2488
  :param Sequence['ServiceTaskSpecContainerSpecLabelArgs'] labels: User-defined key/value metadata
2446
2489
  :param Sequence['ServiceTaskSpecContainerSpecMountArgs'] mounts: Specification for mounts to be added to containers created as part of the service
2447
2490
  :param 'ServiceTaskSpecContainerSpecPrivilegesArgs' privileges: Security options for the container
2448
- :param bool read_only: Whether the mount should be read-only
2491
+ :param bool read_only: Mount the container's root filesystem as read only
2449
2492
  :param Sequence['ServiceTaskSpecContainerSpecSecretArgs'] secrets: References to zero or more secrets that will be exposed to the service
2450
2493
  :param str stop_grace_period: Amount of time to wait for the container to terminate before forcefully removing it (ms|s|m|h). If not specified or '0s' the destroy will not check if all tasks/containers of the service terminate.
2451
2494
  :param str stop_signal: Signal to stop the container
2452
- :param Mapping[str, Any] sysctl: Sysctls config (Linux only)
2453
- :param str user: SELinux user label
2495
+ :param Mapping[str, str] sysctl: Sysctls config (Linux only)
2496
+ :param str user: The user inside the container
2454
2497
  """
2455
2498
  pulumi.set(__self__, "image", image)
2456
2499
  if args is not None:
@@ -2618,7 +2661,7 @@ class ServiceTaskSpecContainerSpec(dict):
2618
2661
  @pulumi.getter(name="readOnly")
2619
2662
  def read_only(self) -> Optional[bool]:
2620
2663
  """
2621
- Whether the mount should be read-only
2664
+ Mount the container's root filesystem as read only
2622
2665
  """
2623
2666
  return pulumi.get(self, "read_only")
2624
2667
 
@@ -2648,7 +2691,7 @@ class ServiceTaskSpecContainerSpec(dict):
2648
2691
 
2649
2692
  @property
2650
2693
  @pulumi.getter
2651
- def sysctl(self) -> Optional[Mapping[str, Any]]:
2694
+ def sysctl(self) -> Optional[Mapping[str, str]]:
2652
2695
  """
2653
2696
  Sysctls config (Linux only)
2654
2697
  """
@@ -2658,7 +2701,7 @@ class ServiceTaskSpecContainerSpec(dict):
2658
2701
  @pulumi.getter
2659
2702
  def user(self) -> Optional[str]:
2660
2703
  """
2661
- SELinux user label
2704
+ The user inside the container
2662
2705
  """
2663
2706
  return pulumi.get(self, "user")
2664
2707
 
@@ -2839,7 +2882,7 @@ class ServiceTaskSpecContainerSpecHealthcheck(dict):
2839
2882
  :param str interval: Time between running the check (ms|s|m|h). Defaults to `0s`.
2840
2883
  :param int retries: Consecutive failures needed to report unhealthy. Defaults to `0`
2841
2884
  :param str start_period: Start period for the container to initialize before counting retries towards unstable (ms|s|m|h). Defaults to `0s`.
2842
- :param str timeout: The timeout of the service to reach the desired state `(s|m)`. Defaults to `3m`
2885
+ :param str timeout: Maximum time to allow one check to run (ms|s|m|h). Defaults to `0s`.
2843
2886
  """
2844
2887
  pulumi.set(__self__, "tests", tests)
2845
2888
  if interval is not None:
@@ -2887,7 +2930,7 @@ class ServiceTaskSpecContainerSpecHealthcheck(dict):
2887
2930
  @pulumi.getter
2888
2931
  def timeout(self) -> Optional[str]:
2889
2932
  """
2890
- The timeout of the service to reach the desired state `(s|m)`. Defaults to `3m`
2933
+ Maximum time to allow one check to run (ms|s|m|h). Defaults to `0s`.
2891
2934
  """
2892
2935
  return pulumi.get(self, "timeout")
2893
2936
 
@@ -3104,7 +3147,7 @@ class ServiceTaskSpecContainerSpecMountTmpfsOptions(dict):
3104
3147
  mode: Optional[int] = None,
3105
3148
  size_bytes: Optional[int] = None):
3106
3149
  """
3107
- :param int mode: The mode of resolution to use for internal load balancing between tasks
3150
+ :param int mode: The permission mode for the tmpfs mount in an integer
3108
3151
  :param int size_bytes: The size for the tmpfs mount in bytes
3109
3152
  """
3110
3153
  if mode is not None:
@@ -3116,7 +3159,7 @@ class ServiceTaskSpecContainerSpecMountTmpfsOptions(dict):
3116
3159
  @pulumi.getter
3117
3160
  def mode(self) -> Optional[int]:
3118
3161
  """
3119
- The mode of resolution to use for internal load balancing between tasks
3162
+ The permission mode for the tmpfs mount in an integer
3120
3163
  """
3121
3164
  return pulumi.get(self, "mode")
3122
3165
 
@@ -3327,7 +3370,7 @@ class ServiceTaskSpecContainerSpecPrivilegesSeLinuxContext(dict):
3327
3370
  :param bool disable: Disable SELinux
3328
3371
  :param str level: SELinux level label
3329
3372
  :param str role: SELinux role label
3330
- :param str type: The mount type
3373
+ :param str type: SELinux type label
3331
3374
  :param str user: SELinux user label
3332
3375
  """
3333
3376
  if disable is not None:
@@ -3369,7 +3412,7 @@ class ServiceTaskSpecContainerSpecPrivilegesSeLinuxContext(dict):
3369
3412
  @pulumi.getter
3370
3413
  def type(self) -> Optional[str]:
3371
3414
  """
3372
- The mount type
3415
+ SELinux type label
3373
3416
  """
3374
3417
  return pulumi.get(self, "type")
3375
3418
 
@@ -3421,9 +3464,9 @@ class ServiceTaskSpecContainerSpecSecret(dict):
3421
3464
  """
3422
3465
  :param str file_name: Represents the final filename in the filesystem
3423
3466
  :param str secret_id: ID of the specific secret that we're referencing
3424
- :param str file_gid: Represents the file GID. Defaults to `0`.
3425
- :param int file_mode: Represents represents the FileMode of the file. Defaults to `0o444`.
3426
- :param str file_uid: Represents the file UID. Defaults to `0`.
3467
+ :param str file_gid: Represents the file GID. Defaults to `0`
3468
+ :param int file_mode: Represents represents the FileMode of the file. Defaults to `0o444`
3469
+ :param str file_uid: Represents the file UID. Defaults to `0`
3427
3470
  :param str secret_name: Name of the secret that this references, but this is just provided for lookup/display purposes. The config in the reference will be identified by its ID
3428
3471
  """
3429
3472
  pulumi.set(__self__, "file_name", file_name)
@@ -3457,7 +3500,7 @@ class ServiceTaskSpecContainerSpecSecret(dict):
3457
3500
  @pulumi.getter(name="fileGid")
3458
3501
  def file_gid(self) -> Optional[str]:
3459
3502
  """
3460
- Represents the file GID. Defaults to `0`.
3503
+ Represents the file GID. Defaults to `0`
3461
3504
  """
3462
3505
  return pulumi.get(self, "file_gid")
3463
3506
 
@@ -3465,7 +3508,7 @@ class ServiceTaskSpecContainerSpecSecret(dict):
3465
3508
  @pulumi.getter(name="fileMode")
3466
3509
  def file_mode(self) -> Optional[int]:
3467
3510
  """
3468
- Represents represents the FileMode of the file. Defaults to `0o444`.
3511
+ Represents represents the FileMode of the file. Defaults to `0o444`
3469
3512
  """
3470
3513
  return pulumi.get(self, "file_mode")
3471
3514
 
@@ -3473,7 +3516,7 @@ class ServiceTaskSpecContainerSpecSecret(dict):
3473
3516
  @pulumi.getter(name="fileUid")
3474
3517
  def file_uid(self) -> Optional[str]:
3475
3518
  """
3476
- Represents the file UID. Defaults to `0`.
3519
+ Represents the file UID. Defaults to `0`
3477
3520
  """
3478
3521
  return pulumi.get(self, "file_uid")
3479
3522
 
@@ -3492,8 +3535,8 @@ class ServiceTaskSpecLogDriver(dict):
3492
3535
  name: str,
3493
3536
  options: Optional[Mapping[str, str]] = None):
3494
3537
  """
3495
- :param str name: A random name for the port
3496
- :param Mapping[str, str] options: A list of internal resolver variables to be modified (e.g., `debug`, `ndots:3`, etc.)
3538
+ :param str name: The logging driver to use
3539
+ :param Mapping[str, str] options: The options for the logging driver
3497
3540
  """
3498
3541
  pulumi.set(__self__, "name", name)
3499
3542
  if options is not None:
@@ -3503,7 +3546,7 @@ class ServiceTaskSpecLogDriver(dict):
3503
3546
  @pulumi.getter
3504
3547
  def name(self) -> str:
3505
3548
  """
3506
- A random name for the port
3549
+ The logging driver to use
3507
3550
  """
3508
3551
  return pulumi.get(self, "name")
3509
3552
 
@@ -3511,7 +3554,7 @@ class ServiceTaskSpecLogDriver(dict):
3511
3554
  @pulumi.getter
3512
3555
  def options(self) -> Optional[Mapping[str, str]]:
3513
3556
  """
3514
- A list of internal resolver variables to be modified (e.g., `debug`, `ndots:3`, etc.)
3557
+ The options for the logging driver
3515
3558
  """
3516
3559
  return pulumi.get(self, "options")
3517
3560
 
@@ -3540,7 +3583,7 @@ class ServiceTaskSpecNetworksAdvanced(dict):
3540
3583
  aliases: Optional[Sequence[str]] = None,
3541
3584
  driver_opts: Optional[Sequence[str]] = None):
3542
3585
  """
3543
- :param str name: A random name for the port
3586
+ :param str name: The name/id of the network.
3544
3587
  :param Sequence[str] aliases: The network aliases of the container in the specific network.
3545
3588
  :param Sequence[str] driver_opts: An array of driver options for the network, e.g. `opts1=value`
3546
3589
  """
@@ -3554,7 +3597,7 @@ class ServiceTaskSpecNetworksAdvanced(dict):
3554
3597
  @pulumi.getter
3555
3598
  def name(self) -> str:
3556
3599
  """
3557
- A random name for the port
3600
+ The name/id of the network.
3558
3601
  """
3559
3602
  return pulumi.get(self, "name")
3560
3603
 
@@ -3787,7 +3830,7 @@ class ServiceTaskSpecResourcesReservation(dict):
3787
3830
  """
3788
3831
  :param 'ServiceTaskSpecResourcesReservationGenericResourcesArgs' generic_resources: User-defined resources can be either Integer resources (e.g, `SSD=3`) or String resources (e.g, GPU=UUID1)
3789
3832
  :param int memory_bytes: The amounf of memory in bytes the container allocates
3790
- :param int nano_cpus: CPU shares in units of `1/1e9` (or `10^-9`) of the CPU. Should be at least `1000000`
3833
+ :param int nano_cpus: CPU shares in units of 1/1e9 (or 10^-9) of the CPU. Should be at least `1000000`
3791
3834
  """
3792
3835
  if generic_resources is not None:
3793
3836
  pulumi.set(__self__, "generic_resources", generic_resources)
@@ -3816,7 +3859,7 @@ class ServiceTaskSpecResourcesReservation(dict):
3816
3859
  @pulumi.getter(name="nanoCpus")
3817
3860
  def nano_cpus(self) -> Optional[int]:
3818
3861
  """
3819
- CPU shares in units of `1/1e9` (or `10^-9`) of the CPU. Should be at least `1000000`
3862
+ CPU shares in units of 1/1e9 (or 10^-9) of the CPU. Should be at least `1000000`
3820
3863
  """
3821
3864
  return pulumi.get(self, "nano_cpus")
3822
3865
 
@@ -3897,7 +3940,7 @@ class ServiceTaskSpecRestartPolicy(dict):
3897
3940
  window: Optional[str] = None):
3898
3941
  """
3899
3942
  :param str condition: Condition for restart
3900
- :param str delay: The interval to check if the desired state is reached `(ms|s)`. Defaults to `7s`.
3943
+ :param str delay: Delay between restart attempts (ms|s|m|h)
3901
3944
  :param int max_attempts: Maximum attempts to restart a given container before giving up (default value is `0`, which is ignored)
3902
3945
  :param str window: The time window used to evaluate the restart policy (default value is `0`, which is unbounded) (ms|s|m|h)
3903
3946
  """
@@ -3922,7 +3965,7 @@ class ServiceTaskSpecRestartPolicy(dict):
3922
3965
  @pulumi.getter
3923
3966
  def delay(self) -> Optional[str]:
3924
3967
  """
3925
- The interval to check if the desired state is reached `(ms|s)`. Defaults to `7s`.
3968
+ Delay between restart attempts (ms|s|m|h)
3926
3969
  """
3927
3970
  return pulumi.get(self, "delay")
3928
3971
 
@@ -4073,10 +4116,16 @@ class VolumeLabel(dict):
4073
4116
  @pulumi.output_type
4074
4117
  class GetNetworkIpamConfigResult(dict):
4075
4118
  def __init__(__self__, *,
4076
- aux_address: Optional[Mapping[str, Any]] = None,
4119
+ aux_address: Optional[Mapping[str, str]] = None,
4077
4120
  gateway: Optional[str] = None,
4078
4121
  ip_range: Optional[str] = None,
4079
4122
  subnet: Optional[str] = None):
4123
+ """
4124
+ :param Mapping[str, str] aux_address: Auxiliary IPv4 or IPv6 addresses used by Network driver
4125
+ :param str gateway: The IP address of the gateway
4126
+ :param str ip_range: The ip range in CIDR form
4127
+ :param str subnet: The subnet in CIDR form
4128
+ """
4080
4129
  if aux_address is not None:
4081
4130
  pulumi.set(__self__, "aux_address", aux_address)
4082
4131
  if gateway is not None:
@@ -4088,22 +4137,34 @@ class GetNetworkIpamConfigResult(dict):
4088
4137
 
4089
4138
  @property
4090
4139
  @pulumi.getter(name="auxAddress")
4091
- def aux_address(self) -> Optional[Mapping[str, Any]]:
4140
+ def aux_address(self) -> Optional[Mapping[str, str]]:
4141
+ """
4142
+ Auxiliary IPv4 or IPv6 addresses used by Network driver
4143
+ """
4092
4144
  return pulumi.get(self, "aux_address")
4093
4145
 
4094
4146
  @property
4095
4147
  @pulumi.getter
4096
4148
  def gateway(self) -> Optional[str]:
4149
+ """
4150
+ The IP address of the gateway
4151
+ """
4097
4152
  return pulumi.get(self, "gateway")
4098
4153
 
4099
4154
  @property
4100
4155
  @pulumi.getter(name="ipRange")
4101
4156
  def ip_range(self) -> Optional[str]:
4157
+ """
4158
+ The ip range in CIDR form
4159
+ """
4102
4160
  return pulumi.get(self, "ip_range")
4103
4161
 
4104
4162
  @property
4105
4163
  @pulumi.getter
4106
4164
  def subnet(self) -> Optional[str]:
4165
+ """
4166
+ The subnet in CIDR form
4167
+ """
4107
4168
  return pulumi.get(self, "subnet")
4108
4169
 
4109
4170
 
pulumi_docker/plugin.py CHANGED
@@ -4,9 +4,14 @@
4
4
 
5
5
  import copy
6
6
  import warnings
7
+ import sys
7
8
  import pulumi
8
9
  import pulumi.runtime
9
10
  from typing import Any, Mapping, Optional, Sequence, Union, overload
11
+ if sys.version_info >= (3, 11):
12
+ from typing import NotRequired, TypedDict, TypeAlias
13
+ else:
14
+ from typing_extensions import NotRequired, TypedDict, TypeAlias
10
15
  from . import _utilities
11
16
  from . import outputs
12
17
  from ._inputs import *
@@ -35,7 +40,7 @@ class PluginArgs:
35
40
  :param pulumi.Input[bool] force_disable: If true, then the plugin is disabled forcibly
36
41
  :param pulumi.Input[bool] grant_all_permissions: If true, grant all permissions necessary to run the plugin
37
42
  :param pulumi.Input[Sequence[pulumi.Input['PluginGrantPermissionArgs']]] grant_permissions: Grant specific permissions only
38
- :param pulumi.Input[str] name: The name of the permission
43
+ :param pulumi.Input[str] name: Docker Plugin name
39
44
  """
40
45
  if alias is not None:
41
46
  pulumi.set(__self__, "alias", alias)
@@ -156,7 +161,7 @@ class PluginArgs:
156
161
  @pulumi.getter
157
162
  def name(self) -> Optional[pulumi.Input[str]]:
158
163
  """
159
- The name of the permission
164
+ Docker Plugin name
160
165
  """
161
166
  return pulumi.get(self, "name")
162
167
 
@@ -188,7 +193,7 @@ class _PluginState:
188
193
  :param pulumi.Input[bool] force_disable: If true, then the plugin is disabled forcibly
189
194
  :param pulumi.Input[bool] grant_all_permissions: If true, grant all permissions necessary to run the plugin
190
195
  :param pulumi.Input[Sequence[pulumi.Input['PluginGrantPermissionArgs']]] grant_permissions: Grant specific permissions only
191
- :param pulumi.Input[str] name: The name of the permission
196
+ :param pulumi.Input[str] name: Docker Plugin name
192
197
  :param pulumi.Input[str] plugin_reference: Docker Plugin Reference
193
198
  """
194
199
  if alias is not None:
@@ -312,7 +317,7 @@ class _PluginState:
312
317
  @pulumi.getter
313
318
  def name(self) -> Optional[pulumi.Input[str]]:
314
319
  """
315
- The name of the permission
320
+ Docker Plugin name
316
321
  """
317
322
  return pulumi.get(self, "name")
318
323
 
@@ -345,35 +350,19 @@ class Plugin(pulumi.CustomResource):
345
350
  force_destroy: Optional[pulumi.Input[bool]] = None,
346
351
  force_disable: Optional[pulumi.Input[bool]] = None,
347
352
  grant_all_permissions: Optional[pulumi.Input[bool]] = None,
348
- grant_permissions: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['PluginGrantPermissionArgs']]]]] = None,
353
+ grant_permissions: Optional[pulumi.Input[Sequence[pulumi.Input[Union['PluginGrantPermissionArgs', 'PluginGrantPermissionArgsDict']]]]] = None,
349
354
  name: Optional[pulumi.Input[str]] = None,
350
355
  __props__=None):
351
356
  """
352
357
  <!-- Bug: Type and Name are switched -->
353
358
  Manages the lifecycle of a Docker plugin.
354
359
 
355
- ## Example Usage
356
-
357
- ```python
358
- import pulumi
359
- import pulumi_docker as docker
360
-
361
- sample_volume_plugin = docker.Plugin("sample-volume-plugin",
362
- alias="sample-volume-plugin",
363
- enable_timeout=60,
364
- enabled=False,
365
- envs=["DEBUG=1"],
366
- force_destroy=True,
367
- force_disable=True,
368
- grant_all_permissions=True)
369
- ```
370
-
371
360
  ## Import
372
361
 
373
362
  #!/bin/bash
374
363
 
375
364
  ```sh
376
- $ pulumi import docker:index/plugin:Plugin sample-volume-plugin "$(docker plugin inspect -f {{.ID}} tiborvass/sample-volume-plugin:latest)"
365
+ $ pulumi import docker:index/plugin:Plugin sample-volume-plugin "$(docker plugin inspect -f {{.ID}} tiborvass/sample-volume-plugin:latest)"
377
366
  ```
378
367
 
379
368
  :param str resource_name: The name of the resource.
@@ -385,8 +374,8 @@ class Plugin(pulumi.CustomResource):
385
374
  :param pulumi.Input[bool] force_destroy: If true, then the plugin is destroyed forcibly
386
375
  :param pulumi.Input[bool] force_disable: If true, then the plugin is disabled forcibly
387
376
  :param pulumi.Input[bool] grant_all_permissions: If true, grant all permissions necessary to run the plugin
388
- :param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['PluginGrantPermissionArgs']]]] grant_permissions: Grant specific permissions only
389
- :param pulumi.Input[str] name: The name of the permission
377
+ :param pulumi.Input[Sequence[pulumi.Input[Union['PluginGrantPermissionArgs', 'PluginGrantPermissionArgsDict']]]] grant_permissions: Grant specific permissions only
378
+ :param pulumi.Input[str] name: Docker Plugin name
390
379
  """
391
380
  ...
392
381
  @overload
@@ -398,28 +387,12 @@ class Plugin(pulumi.CustomResource):
398
387
  <!-- Bug: Type and Name are switched -->
399
388
  Manages the lifecycle of a Docker plugin.
400
389
 
401
- ## Example Usage
402
-
403
- ```python
404
- import pulumi
405
- import pulumi_docker as docker
406
-
407
- sample_volume_plugin = docker.Plugin("sample-volume-plugin",
408
- alias="sample-volume-plugin",
409
- enable_timeout=60,
410
- enabled=False,
411
- envs=["DEBUG=1"],
412
- force_destroy=True,
413
- force_disable=True,
414
- grant_all_permissions=True)
415
- ```
416
-
417
390
  ## Import
418
391
 
419
392
  #!/bin/bash
420
393
 
421
394
  ```sh
422
- $ pulumi import docker:index/plugin:Plugin sample-volume-plugin "$(docker plugin inspect -f {{.ID}} tiborvass/sample-volume-plugin:latest)"
395
+ $ pulumi import docker:index/plugin:Plugin sample-volume-plugin "$(docker plugin inspect -f {{.ID}} tiborvass/sample-volume-plugin:latest)"
423
396
  ```
424
397
 
425
398
  :param str resource_name: The name of the resource.
@@ -444,7 +417,7 @@ class Plugin(pulumi.CustomResource):
444
417
  force_destroy: Optional[pulumi.Input[bool]] = None,
445
418
  force_disable: Optional[pulumi.Input[bool]] = None,
446
419
  grant_all_permissions: Optional[pulumi.Input[bool]] = None,
447
- grant_permissions: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['PluginGrantPermissionArgs']]]]] = None,
420
+ grant_permissions: Optional[pulumi.Input[Sequence[pulumi.Input[Union['PluginGrantPermissionArgs', 'PluginGrantPermissionArgsDict']]]]] = None,
448
421
  name: Optional[pulumi.Input[str]] = None,
449
422
  __props__=None):
450
423
  opts = pulumi.ResourceOptions.merge(_utilities.get_resource_opts_defaults(), opts)
@@ -482,7 +455,7 @@ class Plugin(pulumi.CustomResource):
482
455
  force_destroy: Optional[pulumi.Input[bool]] = None,
483
456
  force_disable: Optional[pulumi.Input[bool]] = None,
484
457
  grant_all_permissions: Optional[pulumi.Input[bool]] = None,
485
- grant_permissions: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['PluginGrantPermissionArgs']]]]] = None,
458
+ grant_permissions: Optional[pulumi.Input[Sequence[pulumi.Input[Union['PluginGrantPermissionArgs', 'PluginGrantPermissionArgsDict']]]]] = None,
486
459
  name: Optional[pulumi.Input[str]] = None,
487
460
  plugin_reference: Optional[pulumi.Input[str]] = None) -> 'Plugin':
488
461
  """
@@ -499,8 +472,8 @@ class Plugin(pulumi.CustomResource):
499
472
  :param pulumi.Input[bool] force_destroy: If true, then the plugin is destroyed forcibly
500
473
  :param pulumi.Input[bool] force_disable: If true, then the plugin is disabled forcibly
501
474
  :param pulumi.Input[bool] grant_all_permissions: If true, grant all permissions necessary to run the plugin
502
- :param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['PluginGrantPermissionArgs']]]] grant_permissions: Grant specific permissions only
503
- :param pulumi.Input[str] name: The name of the permission
475
+ :param pulumi.Input[Sequence[pulumi.Input[Union['PluginGrantPermissionArgs', 'PluginGrantPermissionArgsDict']]]] grant_permissions: Grant specific permissions only
476
+ :param pulumi.Input[str] name: Docker Plugin name
504
477
  :param pulumi.Input[str] plugin_reference: Docker Plugin Reference
505
478
  """
506
479
  opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
@@ -587,7 +560,7 @@ class Plugin(pulumi.CustomResource):
587
560
  @pulumi.getter
588
561
  def name(self) -> pulumi.Output[str]:
589
562
  """
590
- The name of the permission
563
+ Docker Plugin name
591
564
  """
592
565
  return pulumi.get(self, "name")
593
566
 
pulumi_docker/provider.py CHANGED
@@ -4,9 +4,14 @@
4
4
 
5
5
  import copy
6
6
  import warnings
7
+ import sys
7
8
  import pulumi
8
9
  import pulumi.runtime
9
10
  from typing import Any, Mapping, Optional, Sequence, Union, overload
11
+ if sys.version_info >= (3, 11):
12
+ from typing import NotRequired, TypedDict, TypeAlias
13
+ else:
14
+ from typing_extensions import NotRequired, TypedDict, TypeAlias
10
15
  from . import _utilities
11
16
  from ._inputs import *
12
17
 
@@ -140,7 +145,7 @@ class Provider(pulumi.ProviderResource):
140
145
  cert_path: Optional[pulumi.Input[str]] = None,
141
146
  host: Optional[pulumi.Input[str]] = None,
142
147
  key_material: Optional[pulumi.Input[str]] = None,
143
- registry_auth: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['ProviderRegistryAuthArgs']]]]] = None,
148
+ registry_auth: Optional[pulumi.Input[Sequence[pulumi.Input[Union['ProviderRegistryAuthArgs', 'ProviderRegistryAuthArgsDict']]]]] = None,
144
149
  ssh_opts: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
145
150
  __props__=None):
146
151
  """
@@ -190,7 +195,7 @@ class Provider(pulumi.ProviderResource):
190
195
  cert_path: Optional[pulumi.Input[str]] = None,
191
196
  host: Optional[pulumi.Input[str]] = None,
192
197
  key_material: Optional[pulumi.Input[str]] = None,
193
- registry_auth: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['ProviderRegistryAuthArgs']]]]] = None,
198
+ registry_auth: Optional[pulumi.Input[Sequence[pulumi.Input[Union['ProviderRegistryAuthArgs', 'ProviderRegistryAuthArgsDict']]]]] = None,
194
199
  ssh_opts: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
195
200
  __props__=None):
196
201
  opts = pulumi.ResourceOptions.merge(_utilities.get_resource_opts_defaults(), opts)
@@ -1,4 +1,5 @@
1
1
  {
2
2
  "resource": true,
3
- "name": "docker"
3
+ "name": "docker",
4
+ "version": "4.7.0-alpha.1736833147"
4
5
  }