class Amazonite::Ssm::CreatePatchBaselineRequest

Included Modules

Defined in:

ssm/create_patch_baseline_request.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]
def self.new(name : String, operating_system : OperatingSystem | Nil = nil, global_filters : PatchFilterGroup | Nil = nil, approval_rules : PatchRuleGroup | Nil = nil, approved_patches : Array(String) | Nil = nil, approved_patches_compliance_level : PatchComplianceLevel | Nil = nil, approved_patches_enable_non_security : Bool | Nil = nil, rejected_patches : Array(String) | Nil = nil, rejected_patches_action : PatchAction | Nil = nil, description : String | Nil = nil, sources : Array(PatchSource) | Nil = nil, available_security_updates_compliance_status : PatchComplianceStatus | Nil = nil, client_token : String | Nil = nil, tags : Array(Tag) | Nil = nil) #

[View source]
def self.new(*, __pull_for_json_serializable pull : JSON::PullParser) #

[View source]

Instance Method Detail

def ==(other : self) #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def approval_rules : PatchRuleGroup | Nil #

A set of rules used to include patches in the baseline.


[View source]
def approval_rules=(approval_rules : PatchRuleGroup | Nil) #

A set of rules used to include patches in the baseline.


[View source]
def approved_patches : Array(String) | Nil #

A list of explicitly approved patches for the baseline.

For information about accepted formats for lists of approved patches and rejected patches, see Package name formats for approved and rejected patch lists in the Amazon Web Services Systems Manager User Guide.


[View source]
def approved_patches=(approved_patches : Array(String) | Nil) #

A list of explicitly approved patches for the baseline.

For information about accepted formats for lists of approved patches and rejected patches, see Package name formats for approved and rejected patch lists in the Amazon Web Services Systems Manager User Guide.


[View source]
def approved_patches_compliance_level : PatchComplianceLevel | Nil #

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 UNSPECIFIED.


[View source]
def approved_patches_compliance_level=(approved_patches_compliance_level : PatchComplianceLevel | Nil) #

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 UNSPECIFIED.


[View source]
def approved_patches_enable_non_security : Bool | Nil #

Indicates whether the list of approved patches includes non-security updates that should be applied to the managed nodes. The default value is false. Applies to Linux managed nodes only.


[View source]
def approved_patches_enable_non_security=(approved_patches_enable_non_security : Bool | Nil) #

Indicates whether the list of approved patches includes non-security updates that should be applied to the managed nodes. The default value is false. Applies to Linux managed nodes only.


[View source]
def available_security_updates_compliance_status : PatchComplianceStatus | Nil #

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.

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.

Supported for Windows Server managed nodes only.


[View source]
def available_security_updates_compliance_status=(available_security_updates_compliance_status : PatchComplianceStatus | Nil) #

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.

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.

Supported for Windows Server managed nodes only.


[View source]
def client_token : String | Nil #

User-provided idempotency token.


[View source]
def client_token=(client_token : String | Nil) #

User-provided idempotency token.


[View source]
def description : String | Nil #

A description of the patch baseline.


[View source]
def description=(description : String | Nil) #

A description of the patch baseline.


[View source]
def global_filters : PatchFilterGroup | Nil #

A set of global filters used to include patches in the baseline.

The GlobalFilters 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.


[View source]
def global_filters=(global_filters : PatchFilterGroup | Nil) #

A set of global filters used to include patches in the baseline.

The GlobalFilters 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.


[View source]
def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def name : String #

The name of the patch baseline.


[View source]
def name=(name : String) #

The name of the patch baseline.


[View source]
def operating_system : OperatingSystem | Nil #

Defines the operating system the patch baseline applies to. The default value is WINDOWS.


[View source]
def operating_system=(operating_system : OperatingSystem | Nil) #

Defines the operating system the patch baseline applies to. The default value is WINDOWS.


[View source]
def rejected_patches : Array(String) | Nil #

A list of explicitly rejected patches for the baseline.

For information about accepted formats for lists of approved patches and rejected patches, see Package name formats for approved and rejected patch lists in the Amazon Web Services Systems Manager User Guide.


[View source]
def rejected_patches=(rejected_patches : Array(String) | Nil) #

A list of explicitly rejected patches for the baseline.

For information about accepted formats for lists of approved patches and rejected patches, see Package name formats for approved and rejected patch lists in the Amazon Web Services Systems Manager User Guide.


[View source]
def rejected_patches_action : PatchAction | Nil #

The action for Patch Manager to take on patches included in the RejectedPackages list.

ALLOW_AS_DEPENDENCY Linux and macOS: 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 INSTALLED_OTHER. This is the default action if no option is specified.

Windows Server: 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 INSTALLED_OTHER. Any package not already installed on the node is skipped. This is the default action if no option is specified.

BLOCK All OSs: Packages in the rejected patches list, and packages that include them as dependencies, aren't installed by Patch Manager under any circumstances.

State value assignment for patch compliance:

  • 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 INSTALLED_REJECTED.

  • 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 MISSING for SCAN operations and as FAILED for INSTALL operations.


[View source]
def rejected_patches_action=(rejected_patches_action : PatchAction | Nil) #

The action for Patch Manager to take on patches included in the RejectedPackages list.

ALLOW_AS_DEPENDENCY Linux and macOS: 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 INSTALLED_OTHER. This is the default action if no option is specified.

Windows Server: 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 INSTALLED_OTHER. Any package not already installed on the node is skipped. This is the default action if no option is specified.

BLOCK All OSs: Packages in the rejected patches list, and packages that include them as dependencies, aren't installed by Patch Manager under any circumstances.

State value assignment for patch compliance:

  • 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 INSTALLED_REJECTED.

  • 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 MISSING for SCAN operations and as FAILED for INSTALL operations.


[View source]
def sources : Array(PatchSource) | Nil #

Information about the patches to use to update the managed nodes, including target operating systems and source repositories. Applies to Linux managed nodes only.


[View source]
def sources=(sources : Array(PatchSource) | Nil) #

Information about the patches to use to update the managed nodes, including target operating systems and source repositories. Applies to Linux managed nodes only.


[View source]
def tags : Array(Tag) | Nil #

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:

  • Key=PatchSeverity,Value=Critical

  • Key=OS,Value=Windows

To add tags to an existing patch baseline, use the AddTagsToResource operation.


[View source]
def tags=(tags : Array(Tag) | Nil) #

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:

  • Key=PatchSeverity,Value=Critical

  • Key=OS,Value=Windows

To add tags to an existing patch baseline, use the AddTagsToResource operation.


[View source]
def validate! : Nil #

[View source]