Class: Aws::SSM::Types::CreatePatchBaselineRequest

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-ssm/types.rb

Overview

Note:

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

{
  operating_system: "WINDOWS", # accepts WINDOWS, AMAZON_LINUX, AMAZON_LINUX_2, UBUNTU, REDHAT_ENTERPRISE_LINUX, SUSE, CENTOS, ORACLE_LINUX, DEBIAN, MACOS
  name: "BaselineName", # required
  global_filters: {
    patch_filters: [ # required
      {
        key: "ARCH", # required, accepts ARCH, ADVISORY_ID, BUGZILLA_ID, PATCH_SET, PRODUCT, PRODUCT_FAMILY, CLASSIFICATION, CVE_ID, EPOCH, MSRC_SEVERITY, NAME, PATCH_ID, SECTION, PRIORITY, REPOSITORY, RELEASE, SEVERITY, SECURITY, VERSION
        values: ["PatchFilterValue"], # required
      },
    ],
  },
  approval_rules: {
    patch_rules: [ # required
      {
        patch_filter_group: { # required
          patch_filters: [ # required
            {
              key: "ARCH", # required, accepts ARCH, ADVISORY_ID, BUGZILLA_ID, PATCH_SET, PRODUCT, PRODUCT_FAMILY, CLASSIFICATION, CVE_ID, EPOCH, MSRC_SEVERITY, NAME, PATCH_ID, SECTION, PRIORITY, REPOSITORY, RELEASE, SEVERITY, SECURITY, VERSION
              values: ["PatchFilterValue"], # required
            },
          ],
        },
        compliance_level: "CRITICAL", # accepts CRITICAL, HIGH, MEDIUM, LOW, INFORMATIONAL, UNSPECIFIED
        approve_after_days: 1,
        approve_until_date: "PatchStringDateTime",
        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
    },
  ],
  client_token: "ClientToken",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#approval_rulesTypes::PatchRuleGroup

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


4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
# File 'lib/aws-sdk-ssm/types.rb', line 4023

class CreatePatchBaselineRequest < Struct.new(
  :operating_system,
  :name,
  :global_filters,
  :approval_rules,
  :approved_patches,
  :approved_patches_compliance_level,
  :approved_patches_enable_non_security,
  :rejected_patches,
  :rejected_patches_action,
  :description,
  :sources,
  :client_token,
  :tags)
  SENSITIVE = []
  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 [About package name formats for approved and rejected patch lists] in the *Amazon Web Services Systems Manager User Guide*.

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

Returns:

  • (Array<String>)

4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
# File 'lib/aws-sdk-ssm/types.rb', line 4023

class CreatePatchBaselineRequest < Struct.new(
  :operating_system,
  :name,
  :global_filters,
  :approval_rules,
  :approved_patches,
  :approved_patches_compliance_level,
  :approved_patches_enable_non_security,
  :rejected_patches,
  :rejected_patches_action,
  :description,
  :sources,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#approved_patches_compliance_levelString

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

Returns:

  • (String)

4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
# File 'lib/aws-sdk-ssm/types.rb', line 4023

class CreatePatchBaselineRequest < Struct.new(
  :operating_system,
  :name,
  :global_filters,
  :approval_rules,
  :approved_patches,
  :approved_patches_compliance_level,
  :approved_patches_enable_non_security,
  :rejected_patches,
  :rejected_patches_action,
  :description,
  :sources,
  :client_token,
  :tags)
  SENSITIVE = []
  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)

4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
# File 'lib/aws-sdk-ssm/types.rb', line 4023

class CreatePatchBaselineRequest < Struct.new(
  :operating_system,
  :name,
  :global_filters,
  :approval_rules,
  :approved_patches,
  :approved_patches_compliance_level,
  :approved_patches_enable_non_security,
  :rejected_patches,
  :rejected_patches_action,
  :description,
  :sources,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#client_tokenString

User-provided idempotency token.

**A suitable default value is auto-generated.** You should normally not need to pass this option.

Returns:

  • (String)

4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
# File 'lib/aws-sdk-ssm/types.rb', line 4023

class CreatePatchBaselineRequest < Struct.new(
  :operating_system,
  :name,
  :global_filters,
  :approval_rules,
  :approved_patches,
  :approved_patches_compliance_level,
  :approved_patches_enable_non_security,
  :rejected_patches,
  :rejected_patches_action,
  :description,
  :sources,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

A description of the patch baseline.

Returns:

  • (String)

4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
# File 'lib/aws-sdk-ssm/types.rb', line 4023

class CreatePatchBaselineRequest < Struct.new(
  :operating_system,
  :name,
  :global_filters,
  :approval_rules,
  :approved_patches,
  :approved_patches_compliance_level,
  :approved_patches_enable_non_security,
  :rejected_patches,
  :rejected_patches_action,
  :description,
  :sources,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#global_filtersTypes::PatchFilterGroup

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


4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
# File 'lib/aws-sdk-ssm/types.rb', line 4023

class CreatePatchBaselineRequest < Struct.new(
  :operating_system,
  :name,
  :global_filters,
  :approval_rules,
  :approved_patches,
  :approved_patches_compliance_level,
  :approved_patches_enable_non_security,
  :rejected_patches,
  :rejected_patches_action,
  :description,
  :sources,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name of the patch baseline.

Returns:

  • (String)

4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
# File 'lib/aws-sdk-ssm/types.rb', line 4023

class CreatePatchBaselineRequest < Struct.new(
  :operating_system,
  :name,
  :global_filters,
  :approval_rules,
  :approved_patches,
  :approved_patches_compliance_level,
  :approved_patches_enable_non_security,
  :rejected_patches,
  :rejected_patches_action,
  :description,
  :sources,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#operating_systemString

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

Returns:

  • (String)

4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
# File 'lib/aws-sdk-ssm/types.rb', line 4023

class CreatePatchBaselineRequest < Struct.new(
  :operating_system,
  :name,
  :global_filters,
  :approval_rules,
  :approved_patches,
  :approved_patches_compliance_level,
  :approved_patches_enable_non_security,
  :rejected_patches,
  :rejected_patches_action,
  :description,
  :sources,
  :client_token,
  :tags)
  SENSITIVE = []
  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 [About package name formats for approved and rejected patch lists] in the *Amazon Web Services Systems Manager User Guide*.

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

Returns:

  • (Array<String>)

4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
# File 'lib/aws-sdk-ssm/types.rb', line 4023

class CreatePatchBaselineRequest < Struct.new(
  :operating_system,
  :name,
  :global_filters,
  :approval_rules,
  :approved_patches,
  :approved_patches_compliance_level,
  :approved_patches_enable_non_security,
  :rejected_patches,
  :rejected_patches_action,
  :description,
  :sources,
  :client_token,
  :tags)
  SENSITIVE = []
  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, aren't 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)

4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
# File 'lib/aws-sdk-ssm/types.rb', line 4023

class CreatePatchBaselineRequest < Struct.new(
  :operating_system,
  :name,
  :global_filters,
  :approval_rules,
  :approved_patches,
  :approved_patches_compliance_level,
  :approved_patches_enable_non_security,
  :rejected_patches,
  :rejected_patches_action,
  :description,
  :sources,
  :client_token,
  :tags)
  SENSITIVE = []
  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:


4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
# File 'lib/aws-sdk-ssm/types.rb', line 4023

class CreatePatchBaselineRequest < Struct.new(
  :operating_system,
  :name,
  :global_filters,
  :approval_rules,
  :approved_patches,
  :approved_patches_compliance_level,
  :approved_patches_enable_non_security,
  :rejected_patches,
  :rejected_patches_action,
  :description,
  :sources,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

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`

<note markdown=“1”> To add tags to an existing patch baseline, use the AddTagsToResource operation.

</note>

Returns:


4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
# File 'lib/aws-sdk-ssm/types.rb', line 4023

class CreatePatchBaselineRequest < Struct.new(
  :operating_system,
  :name,
  :global_filters,
  :approval_rules,
  :approved_patches,
  :approved_patches_compliance_level,
  :approved_patches_enable_non_security,
  :rejected_patches,
  :rejected_patches_action,
  :description,
  :sources,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end