You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ssm/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

Instance Attribute Details

#approval_rulesTypes::PatchRuleGroup

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



14191
14192
14193
14194
14195
14196
14197
14198
14199
14200
14201
14202
14203
14204
14205
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 14191

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

Returns:

  • (Array<String>)


14191
14192
14193
14194
14195
14196
14197
14198
14199
14200
14201
14202
14203
14204
14205
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 14191

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_levelString

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

Returns:

  • (String)


14191
14192
14193
14194
14195
14196
14197
14198
14199
14200
14201
14202
14203
14204
14205
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 14191

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_securityBoolean

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)


14191
14192
14193
14194
14195
14196
14197
14198
14199
14200
14201
14202
14203
14204
14205
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 14191

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_idString

The ID of the patch baseline to update.

Returns:

  • (String)


14191
14192
14193
14194
14195
14196
14197
14198
14199
14200
14201
14202
14203
14204
14205
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 14191

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

#descriptionString

A description of the patch baseline.

Returns:

  • (String)


14191
14192
14193
14194
14195
14196
14197
14198
14199
14200
14201
14202
14203
14204
14205
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 14191

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_filtersTypes::PatchFilterGroup

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



14191
14192
14193
14194
14195
14196
14197
14198
14199
14200
14201
14202
14203
14204
14205
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 14191

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

#nameString

The name of the patch baseline.

Returns:

  • (String)


14191
14192
14193
14194
14195
14196
14197
14198
14199
14200
14201
14202
14203
14204
14205
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 14191

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

Returns:

  • (Array<String>)


14191
14192
14193
14194
14195
14196
14197
14198
14199
14200
14201
14202
14203
14204
14205
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 14191

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_actionString

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)


14191
14192
14193
14194
14195
14196
14197
14198
14199
14200
14201
14202
14203
14204
14205
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 14191

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

#replaceBoolean

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)


14191
14192
14193
14194
14195
14196
14197
14198
14199
14200
14201
14202
14203
14204
14205
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 14191

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

#sourcesArray<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:



14191
14192
14193
14194
14195
14196
14197
14198
14199
14200
14201
14202
14203
14204
14205
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 14191

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