register-default-patch-baseline¶
Description¶
Defines the default patch baseline for the relevant operating system.
To reset the Amazon Web Services-predefined patch baseline as the default, specify the full patch baseline Amazon Resource Name (ARN) as the baseline ID value. For example, for CentOS, specify arn:aws:ssm:us-east-2:733109147000:patchbaseline/pb-0574b43a65ea646ed instead of pb-0574b43a65ea646ed .
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
register-default-patch-baseline
--baseline-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--baseline-id (string)
The ID of the patch baseline that should be the default patch baseline.
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
See ‘aws help’ for descriptions of global parameters.
Examples¶
Note
To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.
Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .
To set the default patch baseline
The following register-default-patch-baseline example registers the specified custom patch baseline as the default patch baseline for the operating system type that it supports.
aws ssm register-default-patch-baseline \
--baseline-id "pb-abc123cf9bEXAMPLE"
Output:
{
"BaselineId":"pb-abc123cf9bEXAMPLE"
}
The following register-default-patch-baseline example registers the default patch baseline provided by AWS for CentOS as the default patch baseline.
aws ssm register-default-patch-baseline \
--baseline-id "arn:aws:ssm:us-east-2:733109147000:patchbaseline/pb-0574b43a65ea646ed"
Output:
{
"BaselineId":"pb-abc123cf9bEXAMPLE"
}
For more information, see About Predefined and Custom Patch Baselines in the AWS Systems Manager User Guide.