AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Invokes the CreatePatchBaseline operation against Amazon Simple Systems Management.

Syntax

New-SSMPatchBaseline
-ApprovedPatch <String[]>
-ApprovedPatchesComplianceLevel <PatchComplianceLevel>
-ClientToken <String>
-Description <String>
-Name <String>
-OperatingSystem <OperatingSystem>
-GlobalFilters_PatchFilter <PatchFilter[]>
-ApprovalRules_PatchRule <PatchRule[]>
-RejectedPatch <String[]>
-Force <SwitchParameter>

Description

Creates a patch baseline.

Parameters

-ApprovalRules_PatchRule <PatchRule[]>
The rules that make up the rule group.
Required?False
Position?Named
Accept pipeline input?False
-ApprovedPatch <String[]>
A list of explicitly approved patches for the baseline.
Required?False
Position?Named
Accept pipeline input?False
-ApprovedPatchesComplianceLevel <PatchComplianceLevel>
Defines the compliance level for approved patches. This means that if an approved patch is reported as missing, this is the severity of the compliance violation. Valid compliance severity levels include the following: CRITICAL, HIGH, MEDIUM, LOW, INFORMATIONAL, UNSPECIFIED. The default value is UNSPECIFIED.
Required?False
Position?Named
Accept pipeline input?False
-ClientToken <String>
User-provided idempotency token.
Required?False
Position?Named
Accept pipeline input?False
-Description <String>
A description of the patch baseline.
Required?False
Position?Named
Accept pipeline input?False
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?False
-GlobalFilters_PatchFilter <PatchFilter[]>
The set of patch filters that make up the group.
Required?False
Position?Named
Accept pipeline input?False
-Name <String>
The name of the patch baseline.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OperatingSystem <OperatingSystem>
Defines the operating system the patch baseline applies to. Supported operating systems include WINDOWS, AMAZON_LINUX, UBUNTU and REDHAT_ENTERPRISE_LINUX. The Default value is WINDOWS.
Required?False
Position?Named
Accept pipeline input?False
-RejectedPatch <String[]>
A list of explicitly rejected patches for the baseline.
Required?False
Position?Named
Accept pipeline input?False

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required? False
Position? Named
Accept pipeline input? False
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required? False
Position? Named
Accept pipeline input? False
-ProfileLocation <String>

Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)

If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials. Note that the encrypted credential file is not supported on all platforms. It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.

If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.

As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.

Required? False
Position? Named
Accept pipeline input? False
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required? False
Position? Named
Accept pipeline input? False
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required? False
Position? Named
Accept pipeline input? False
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required? False
Position? Named
Accept pipeline input? False
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required? False
Position? Named
Accept pipeline input? False
-Region <String>
The system name of the AWS region in which the operation should be invoked. For example, us-east-1, eu-west-1 etc.
Required? False
Position? Named
Accept pipeline input? False
-EndpointUrl <String>

The endpoint to make the call against.

Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.

Required? False
Position? Named
Accept pipeline input? False

Inputs

This cmdlet does not accept pipeline input.

Outputs

This cmdlet returns a String object. The service call response (type Amazon.SimpleSystemsManagement.Model.CreatePatchBaselineResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Examples

Example 1

PS C:\> $rule = New-Object Amazon.SimpleSystemsManagement.Model.PatchRule
PS C:\> $rule.ApproveAfterDays = 7

PS C:\> $ruleFilters = New-Object Amazon.SimpleSystemsManagement.Model.PatchFilterGroup

PS C:\> $patchFilter = New-Object Amazon.SimpleSystemsManagement.Model.PatchFilter

PS C:\> $severityFilter = New-Object Amazon.SimpleSystemsManagement.Model.PatchFilter
PS C:\> $severityFilter.Key="MSRC_SEVERITY"
PS C:\> $severityFilter.Values.Add("Critical")
PS C:\> $severityFilter.Values.Add("Important")
PS C:\> $severityFilter.Values.Add("Moderate")

PS C:\> $classificationFilter = New-Object Amazon.SimpleSystemsManagement.Model.PatchFilter
PS C:\> $classificationFilter.Key = "CLASSIFICATION"
PS C:\> $classificationFilter.Values.Add( "SecurityUpdates" )
PS C:\> $classificationFilter.Values.Add( "Updates" )
PS C:\> $classificationFilter.Values.Add( "UpdateRollups" )
PS C:\> $classificationFilter.Values.Add( "CriticalUpdates" )

PS C:\> $ruleFilters.PatchFilters.Add($severityFilter)
PS C:\> $ruleFilters.PatchFilters.Add($classificationFilter)
PS C:\> $rule.PatchFilterGroup = $ruleFilters

PS C:\> New-SSMPatchBaseline -Name "Production-Baseline" -Description "Baseline containing all updates approved for production systems" -ApprovalRules_PatchRule $rule

pb-03da896ca3b68b639
This example creates a patch baseline that approves patches for a production environment seven days after they are released by Microsoft.

Supported Version

AWS Tools for PowerShell: 2.x.y.z