Class: Aws::SSM::Types::UpdatePatchBaselineRequest

Inherits:

Struct

Object
Struct
Aws::SSM::Types::UpdatePatchBaselineRequest

show all

Includes:: Aws::Structure

Defined in:: lib/aws-sdk-ssm/types.rb

Overview

Note:

When making an API call, you may pass UpdatePatchBaselineRequest data as a hash:

{
  baseline_id: "BaselineId", # required
  name: "BaselineName",
  global_filters: {
    patch_filters: [ # required
      {
        key: "PRODUCT", # required, accepts PRODUCT, CLASSIFICATION, MSRC_SEVERITY, PATCH_ID, SECTION, PRIORITY, SEVERITY
        values: ["PatchFilterValue"], # required
      },
    ],
  },
  approval_rules: {
    patch_rules: [ # required
      {
        patch_filter_group: { # required
          patch_filters: [ # required
            {
              key: "PRODUCT", # required, accepts PRODUCT, CLASSIFICATION, MSRC_SEVERITY, PATCH_ID, SECTION, PRIORITY, SEVERITY
              values: ["PatchFilterValue"], # required
            },
          ],
        },
        compliance_level: "CRITICAL", # accepts CRITICAL, HIGH, MEDIUM, LOW, INFORMATIONAL, UNSPECIFIED
        approve_after_days: 1, # required
        enable_non_security: false,
      },
    ],
  },
  approved_patches: ["PatchId"],
  approved_patches_compliance_level: "CRITICAL", # accepts CRITICAL, HIGH, MEDIUM, LOW, INFORMATIONAL, UNSPECIFIED
  approved_patches_enable_non_security: false,
  rejected_patches: ["PatchId"],
  rejected_patches_action: "ALLOW_AS_DEPENDENCY", # accepts ALLOW_AS_DEPENDENCY, BLOCK
  description: "BaselineDescription",
  sources: [
    {
      name: "PatchSourceName", # required
      products: ["PatchSourceProduct"], # required
      configuration: "PatchSourceConfiguration", # required
    },
  ],
  replace: false,
}

Instance Attribute Summary collapse

#approval_rules ⇒ Types::PatchRuleGroup

A set of rules used to include patches in the baseline.
#approved_patches ⇒ Array<String>

A list of explicitly approved patches for the baseline.
#approved_patches_compliance_level ⇒ String

Assigns a new compliance severity level to an existing patch baseline.
#approved_patches_enable_non_security ⇒ Boolean

Indicates whether the list of approved patches includes non-security updates that should be applied to the instances.
#baseline_id ⇒ String

The ID of the patch baseline to update.
#description ⇒ String

A description of the patch baseline.
#global_filters ⇒ Types::PatchFilterGroup

A set of global filters used to exclude patches from the baseline.
#name ⇒ String

The name of the patch baseline.
#rejected_patches ⇒ Array<String>

A list of explicitly rejected patches for the baseline.
#rejected_patches_action ⇒ String

The action for Patch Manager to take on patches included in the RejectedPackages list.
#replace ⇒ Boolean

If True, then all fields that are required by the CreatePatchBaseline action are also required for this API request.
#sources ⇒ Array<Types::PatchSource>

Information about the patches to use to update the instances, including target operating systems and source repositories.

Instance Attribute Details

#approval_rules ⇒ `Types::PatchRuleGroup`

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

Returns:

(Types::PatchRuleGroup)

# File 'lib/aws-sdk-ssm/types.rb', line 13853

class UpdatePatchBaselineRequest < Struct.new(
  :baseline_id,
  :name,
  :global_filters,
  :approval_rules,
  :approved_patches,
  :approved_patches_compliance_level,
  :approved_patches_enable_non_security,
  :rejected_patches,
  :rejected_patches_action,
  :description,
  :sources,
  :replace)
  include Aws::Structure
end

#approved_patches ⇒ `Array<String>`

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 *AWS Systems Manager User Guide*.

[1]: docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-approved-rejected-package-name-formats.html

Returns:

(Array<String>)

# File 'lib/aws-sdk-ssm/types.rb', line 13853

class UpdatePatchBaselineRequest < Struct.new(
  :baseline_id,
  :name,
  :global_filters,
  :approval_rules,
  :approved_patches,
  :approved_patches_compliance_level,
  :approved_patches_enable_non_security,
  :rejected_patches,
  :rejected_patches_action,
  :description,
  :sources,
  :replace)
  include Aws::Structure
end

#approved_patches_compliance_level ⇒ `String`

Assigns a new compliance severity level to an existing patch baseline.

Returns:

(String)

# File 'lib/aws-sdk-ssm/types.rb', line 13853

class UpdatePatchBaselineRequest < Struct.new(
  :baseline_id,
  :name,
  :global_filters,
  :approval_rules,
  :approved_patches,
  :approved_patches_compliance_level,
  :approved_patches_enable_non_security,
  :rejected_patches,
  :rejected_patches_action,
  :description,
  :sources,
  :replace)
  include Aws::Structure
end

#approved_patches_enable_non_security ⇒ `Boolean`

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

Returns:

(Boolean)

# File 'lib/aws-sdk-ssm/types.rb', line 13853

class UpdatePatchBaselineRequest < Struct.new(
  :baseline_id,
  :name,
  :global_filters,
  :approval_rules,
  :approved_patches,
  :approved_patches_compliance_level,
  :approved_patches_enable_non_security,
  :rejected_patches,
  :rejected_patches_action,
  :description,
  :sources,
  :replace)
  include Aws::Structure
end

#baseline_id ⇒ `String`

The ID of the patch baseline to update.

Returns:

(String)

# File 'lib/aws-sdk-ssm/types.rb', line 13853

class UpdatePatchBaselineRequest < Struct.new(
  :baseline_id,
  :name,
  :global_filters,
  :approval_rules,
  :approved_patches,
  :approved_patches_compliance_level,
  :approved_patches_enable_non_security,
  :rejected_patches,
  :rejected_patches_action,
  :description,
  :sources,
  :replace)
  include Aws::Structure
end

#description ⇒ `String`

A description of the patch baseline.

Returns:

(String)

# File 'lib/aws-sdk-ssm/types.rb', line 13853

class UpdatePatchBaselineRequest < Struct.new(
  :baseline_id,
  :name,
  :global_filters,
  :approval_rules,
  :approved_patches,
  :approved_patches_compliance_level,
  :approved_patches_enable_non_security,
  :rejected_patches,
  :rejected_patches_action,
  :description,
  :sources,
  :replace)
  include Aws::Structure
end

#global_filters ⇒ `Types::PatchFilterGroup`

A set of global filters used to exclude patches from the baseline.

Returns:

(Types::PatchFilterGroup)

# File 'lib/aws-sdk-ssm/types.rb', line 13853

class UpdatePatchBaselineRequest < Struct.new(
  :baseline_id,
  :name,
  :global_filters,
  :approval_rules,
  :approved_patches,
  :approved_patches_compliance_level,
  :approved_patches_enable_non_security,
  :rejected_patches,
  :rejected_patches_action,
  :description,
  :sources,
  :replace)
  include Aws::Structure
end

#name ⇒ `String`

The name of the patch baseline.

Returns:

(String)

# File 'lib/aws-sdk-ssm/types.rb', line 13853

class UpdatePatchBaselineRequest < Struct.new(
  :baseline_id,
  :name,
  :global_filters,
  :approval_rules,
  :approved_patches,
  :approved_patches_compliance_level,
  :approved_patches_enable_non_security,
  :rejected_patches,
  :rejected_patches_action,
  :description,
  :sources,
  :replace)
  include Aws::Structure
end

#rejected_patches ⇒ `Array<String>`

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 *AWS Systems Manager User Guide*.

[1]: docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-approved-rejected-package-name-formats.html

Returns:

(Array<String>)

# File 'lib/aws-sdk-ssm/types.rb', line 13853

class UpdatePatchBaselineRequest < Struct.new(
  :baseline_id,
  :name,
  :global_filters,
  :approval_rules,
  :approved_patches,
  :approved_patches_compliance_level,
  :approved_patches_enable_non_security,
  :rejected_patches,
  :rejected_patches_action,
  :description,
  :sources,
  :replace)
  include Aws::Structure
end

#rejected_patches_action ⇒ `String`

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

ALLOW_AS_DEPENDENCY: 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 InstalledOther. This is the default action if no option is specified.
BLOCK: Packages in the RejectedPatches list, and packages that include them as dependencies, are not installed under any circumstances. If a package was installed before it was added to the Rejected patches list, it is considered non-compliant with the patch baseline, and its status is reported as InstalledRejected.

Returns:

(String)

# File 'lib/aws-sdk-ssm/types.rb', line 13853

class UpdatePatchBaselineRequest < Struct.new(
  :baseline_id,
  :name,
  :global_filters,
  :approval_rules,
  :approved_patches,
  :approved_patches_compliance_level,
  :approved_patches_enable_non_security,
  :rejected_patches,
  :rejected_patches_action,
  :description,
  :sources,
  :replace)
  include Aws::Structure
end

#replace ⇒ `Boolean`

If True, then all fields that are required by the CreatePatchBaseline action are also required for this API request. Optional fields that are not specified are set to null.

Returns:

(Boolean)

# File 'lib/aws-sdk-ssm/types.rb', line 13853

class UpdatePatchBaselineRequest < Struct.new(
  :baseline_id,
  :name,
  :global_filters,
  :approval_rules,
  :approved_patches,
  :approved_patches_compliance_level,
  :approved_patches_enable_non_security,
  :rejected_patches,
  :rejected_patches_action,
  :description,
  :sources,
  :replace)
  include Aws::Structure
end

#sources ⇒ `Array<Types::PatchSource>`

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

Returns:

(Array<Types::PatchSource>)

# File 'lib/aws-sdk-ssm/types.rb', line 13853

class UpdatePatchBaselineRequest < Struct.new(
  :baseline_id,
  :name,
  :global_filters,
  :approval_rules,
  :approved_patches,
  :approved_patches_compliance_level,
  :approved_patches_enable_non_security,
  :rejected_patches,
  :rejected_patches_action,
  :description,
  :sources,
  :replace)
  include Aws::Structure
end

Class: Aws::SSM::Types::UpdatePatchBaselineRequest

Overview

Instance Attribute Summary collapse

Instance Attribute Details

#approval_rules ⇒ Types::PatchRuleGroup

#approved_patches ⇒ Array<String>

#approved_patches_compliance_level ⇒ String

#approved_patches_enable_non_security ⇒ Boolean

#baseline_id ⇒ String

#description ⇒ String

#global_filters ⇒ Types::PatchFilterGroup

#name ⇒ String

#rejected_patches ⇒ Array<String>

#rejected_patches_action ⇒ String

#replace ⇒ Boolean

#sources ⇒ Array<Types::PatchSource>

#approval_rules ⇒ `Types::PatchRuleGroup`

#approved_patches ⇒ `Array<String>`

#approved_patches_compliance_level ⇒ `String`

#approved_patches_enable_non_security ⇒ `Boolean`

#baseline_id ⇒ `String`

#description ⇒ `String`

#global_filters ⇒ `Types::PatchFilterGroup`

#name ⇒ `String`

#rejected_patches ⇒ `Array<String>`

#rejected_patches_action ⇒ `String`

#replace ⇒ `Boolean`

#sources ⇒ `Array<Types::PatchSource>`