aws_sdk_ssm/client/create_patch_baseline.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3 /// Constructs a fluent builder for the [`CreatePatchBaseline`](crate::operation::create_patch_baseline::builders::CreatePatchBaselineFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`operating_system(OperatingSystem)`](crate::operation::create_patch_baseline::builders::CreatePatchBaselineFluentBuilder::operating_system) / [`set_operating_system(Option<OperatingSystem>)`](crate::operation::create_patch_baseline::builders::CreatePatchBaselineFluentBuilder::set_operating_system):<br>required: **false**<br><p>Defines the operating system the patch baseline applies to. The default value is <code>WINDOWS</code>.</p><br>
7 /// - [`name(impl Into<String>)`](crate::operation::create_patch_baseline::builders::CreatePatchBaselineFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::create_patch_baseline::builders::CreatePatchBaselineFluentBuilder::set_name):<br>required: **true**<br><p>The name of the patch baseline.</p><br>
8 /// - [`global_filters(PatchFilterGroup)`](crate::operation::create_patch_baseline::builders::CreatePatchBaselineFluentBuilder::global_filters) / [`set_global_filters(Option<PatchFilterGroup>)`](crate::operation::create_patch_baseline::builders::CreatePatchBaselineFluentBuilder::set_global_filters):<br>required: **false**<br><p>A set of global filters used to include patches in the baseline.</p><important> <p>The <code>GlobalFilters</code> parameter can be configured only by using the CLI or an Amazon Web Services SDK. It can't be configured from the Patch Manager console, and its value isn't displayed in the console.</p> </important><br>
9 /// - [`approval_rules(PatchRuleGroup)`](crate::operation::create_patch_baseline::builders::CreatePatchBaselineFluentBuilder::approval_rules) / [`set_approval_rules(Option<PatchRuleGroup>)`](crate::operation::create_patch_baseline::builders::CreatePatchBaselineFluentBuilder::set_approval_rules):<br>required: **false**<br><p>A set of rules used to include patches in the baseline.</p><br>
10 /// - [`approved_patches(impl Into<String>)`](crate::operation::create_patch_baseline::builders::CreatePatchBaselineFluentBuilder::approved_patches) / [`set_approved_patches(Option<Vec::<String>>)`](crate::operation::create_patch_baseline::builders::CreatePatchBaselineFluentBuilder::set_approved_patches):<br>required: **false**<br><p>A list of explicitly approved patches for the baseline.</p> <p>For information about accepted formats for lists of approved patches and rejected patches, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-approved-rejected-package-name-formats.html">Package name formats for approved and rejected patch lists</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p><br>
11 /// - [`approved_patches_compliance_level(PatchComplianceLevel)`](crate::operation::create_patch_baseline::builders::CreatePatchBaselineFluentBuilder::approved_patches_compliance_level) / [`set_approved_patches_compliance_level(Option<PatchComplianceLevel>)`](crate::operation::create_patch_baseline::builders::CreatePatchBaselineFluentBuilder::set_approved_patches_compliance_level):<br>required: **false**<br><p>Defines the compliance level for approved patches. When an approved patch is reported as missing, this value describes the severity of the compliance violation. The default value is <code>UNSPECIFIED</code>.</p><br>
12 /// - [`approved_patches_enable_non_security(bool)`](crate::operation::create_patch_baseline::builders::CreatePatchBaselineFluentBuilder::approved_patches_enable_non_security) / [`set_approved_patches_enable_non_security(Option<bool>)`](crate::operation::create_patch_baseline::builders::CreatePatchBaselineFluentBuilder::set_approved_patches_enable_non_security):<br>required: **false**<br><p>Indicates whether the list of approved patches includes non-security updates that should be applied to the managed nodes. The default value is <code>false</code>. Applies to Linux managed nodes only.</p><br>
13 /// - [`rejected_patches(impl Into<String>)`](crate::operation::create_patch_baseline::builders::CreatePatchBaselineFluentBuilder::rejected_patches) / [`set_rejected_patches(Option<Vec::<String>>)`](crate::operation::create_patch_baseline::builders::CreatePatchBaselineFluentBuilder::set_rejected_patches):<br>required: **false**<br><p>A list of explicitly rejected patches for the baseline.</p> <p>For information about accepted formats for lists of approved patches and rejected patches, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-approved-rejected-package-name-formats.html">Package name formats for approved and rejected patch lists</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p><br>
14 /// - [`rejected_patches_action(PatchAction)`](crate::operation::create_patch_baseline::builders::CreatePatchBaselineFluentBuilder::rejected_patches_action) / [`set_rejected_patches_action(Option<PatchAction>)`](crate::operation::create_patch_baseline::builders::CreatePatchBaselineFluentBuilder::set_rejected_patches_action):<br>required: **false**<br><p>The action for Patch Manager to take on patches included in the <code>RejectedPackages</code> list.</p> <dl> <dt> ALLOW_AS_DEPENDENCY </dt> <dd> <p><b>Linux and macOS</b>: A package in the rejected patches list is installed only if it is a dependency of another package. It is considered compliant with the patch baseline, and its status is reported as <code>INSTALLED_OTHER</code>. This is the default action if no option is specified.</p> <p><b>Windows Server</b>: Windows Server doesn't support the concept of package dependencies. If a package in the rejected patches list and already installed on the node, its status is reported as <code>INSTALLED_OTHER</code>. Any package not already installed on the node is skipped. This is the default action if no option is specified.</p> </dd> <dt> BLOCK </dt> <dd> <p><b>All OSs</b>: Packages in the rejected patches list, and packages that include them as dependencies, aren't installed by Patch Manager under any circumstances.</p> <p>State value assignment for patch compliance:</p> <ul> <li> <p>If a package was installed before it was added to the rejected patches list, or is installed outside of Patch Manager afterward, it's considered noncompliant with the patch baseline and its status is reported as <code>INSTALLED_REJECTED</code>.</p></li> <li> <p>If an update attempts to install a dependency package that is now rejected by the baseline, when previous versions of the package were not rejected, the package being updated is reported as <code>MISSING</code> for <code>SCAN</code> operations and as <code>FAILED</code> for <code>INSTALL</code> operations.</p></li> </ul> </dd> </dl><br>
15 /// - [`description(impl Into<String>)`](crate::operation::create_patch_baseline::builders::CreatePatchBaselineFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::create_patch_baseline::builders::CreatePatchBaselineFluentBuilder::set_description):<br>required: **false**<br><p>A description of the patch baseline.</p><br>
16 /// - [`sources(PatchSource)`](crate::operation::create_patch_baseline::builders::CreatePatchBaselineFluentBuilder::sources) / [`set_sources(Option<Vec::<PatchSource>>)`](crate::operation::create_patch_baseline::builders::CreatePatchBaselineFluentBuilder::set_sources):<br>required: **false**<br><p>Information about the patches to use to update the managed nodes, including target operating systems and source repositories. Applies to Linux managed nodes only.</p><br>
17 /// - [`available_security_updates_compliance_status(PatchComplianceStatus)`](crate::operation::create_patch_baseline::builders::CreatePatchBaselineFluentBuilder::available_security_updates_compliance_status) / [`set_available_security_updates_compliance_status(Option<PatchComplianceStatus>)`](crate::operation::create_patch_baseline::builders::CreatePatchBaselineFluentBuilder::set_available_security_updates_compliance_status):<br>required: **false**<br><p>Indicates the status you want to assign to security patches that are available but not approved because they don't meet the installation criteria specified in the patch baseline.</p> <p>Example scenario: Security patches that you might want installed can be skipped if you have specified a long period to wait after a patch is released before installation. If an update to the patch is released during your specified waiting period, the waiting period for installing the patch starts over. If the waiting period is too long, multiple versions of the patch could be released but never installed.</p> <p>Supported for Windows Server managed nodes only.</p><br>
18 /// - [`client_token(impl Into<String>)`](crate::operation::create_patch_baseline::builders::CreatePatchBaselineFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::create_patch_baseline::builders::CreatePatchBaselineFluentBuilder::set_client_token):<br>required: **false**<br><p>User-provided idempotency token.</p><br>
19 /// - [`tags(Tag)`](crate::operation::create_patch_baseline::builders::CreatePatchBaselineFluentBuilder::tags) / [`set_tags(Option<Vec::<Tag>>)`](crate::operation::create_patch_baseline::builders::CreatePatchBaselineFluentBuilder::set_tags):<br>required: **false**<br><p>Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a patch baseline to identify the severity level of patches it specifies and the operating system family it applies to. In this case, you could specify the following key-value pairs:</p> <ul> <li> <p><code>Key=PatchSeverity,Value=Critical</code></p></li> <li> <p><code>Key=OS,Value=Windows</code></p></li> </ul><note> <p>To add tags to an existing patch baseline, use the <code>AddTagsToResource</code> operation.</p> </note><br>
20 /// - On success, responds with [`CreatePatchBaselineOutput`](crate::operation::create_patch_baseline::CreatePatchBaselineOutput) with field(s):
21 /// - [`baseline_id(Option<String>)`](crate::operation::create_patch_baseline::CreatePatchBaselineOutput::baseline_id): <p>The ID of the created patch baseline.</p>
22 /// - On failure, responds with [`SdkError<CreatePatchBaselineError>`](crate::operation::create_patch_baseline::CreatePatchBaselineError)
23 pub fn create_patch_baseline(&self) -> crate::operation::create_patch_baseline::builders::CreatePatchBaselineFluentBuilder {
24 crate::operation::create_patch_baseline::builders::CreatePatchBaselineFluentBuilder::new(self.handle.clone())
25 }
26}