Add-UserData
Add-UserData
SYNOPSIS
Adds UserData to a resource on the template. For single values (i.e. in AutoScaling Launch Configurations), it adds the single For multiple values, it automatically adds it as {“Fn::Base64”: {“Fn::Join”: [””,[VALUES…] ] } } to reduce the amount of scripting needed.
SYNTAX
String (Default)
Add-UserData [-String] <Object> [-Replace <Hashtable>] [-Persist] [-UseJoin] [<CommonParameters>]
File
Add-UserData [-File] <String> [-Replace <Hashtable>] [-Persist] [-UseJoin] [<CommonParameters>]
DESCRIPTION
PARAMETERS
-String
An array of strings and/or Instrinsic Functions.
IMPORTANT: You must specify new lines in Powershell syntax so it identifies it as a new line when converting to JSON via Export-Vaporshell. This will convert `n [backtick n] into \n [backslash n] in the resulting JSON template.
Type: Object
Parameter Sets: String
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-File
The path of the script file to convert to UserData. This cannot contain any Intrinsic functions such as Ref in it. Use the String parameter if you’d like to include functions in the array.
Type: String
Parameter Sets: File
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Replace
A hashtable of keys to replace in your UserData file with the corresponding values.
Type: Hashtable
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Persist
If true and the UserData file does not already include it, adds the <persist>true</persist> tag to the end of the UserData file.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-UseJoin
If true, uses Fn::Join to add the UserData contents as an array of strings. If false or excluded, content is
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.