Make auth.conf contents Sensitive

[puppet-modules/puppetlabs-apt.git] / manifests / conf.pp

diff --git a/manifests/conf.pp b/manifests/conf.pp
index 364cae383ce346a86d00524763a5a09c1caa35b0..9c1a59e81cffbfae1e64772853b0872f6da6a262 100644 (file)
--- a/manifests/conf.pp
+++ b/manifests/conf.pp
@@ -1,13 +1,28 @@
+# @summary Specifies a custom Apt configuration file.
+#
+# @param content
+#   Required unless `ensure` is set to 'absent'. Directly supplies content for the configuration file.
+#
+# @param ensure
+#    Specifies whether the configuration file should exist. Valid options: 'present' and 'absent'. 
+#
+# @param priority
+#   Determines the order in which Apt processes the configuration file. Files with lower priority numbers are loaded first. 
+#   Valid options: a string containing an integer or an integer.
+#
+# @param notify_update
+#   Specifies whether to trigger an `apt-get update` run.
+#
 define apt::conf (
-  Optional[Variant[String, Stdlib::Compat::String]] $content                          = undef,
-  Enum['present', 'absent'] $ensure                                                   = present,
-  Variant[String, Stdlib::Compat::String, Integer, Stdlib::Compat::Integer] $priority = 50,
-  Optional[Boolean] $notify_update                                                    = undef,
+  Optional[String] $content          = undef,
+  Enum['present', 'absent'] $ensure  = present,
+  Variant[String, Integer] $priority = 50,
+  Optional[Boolean] $notify_update   = undef,
 ) {
 
   unless $ensure == 'absent' {
     unless $content {
-      fail('Need to pass in content parameter')
+      fail(translate('Need to pass in content parameter'))
     }
   }