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

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

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 CreatePatchBaselineRequest data as a hash:

{
  operating_system: "WINDOWS", # accepts WINDOWS, AMAZON_LINUX, AMAZON_LINUX_2, UBUNTU, REDHAT_ENTERPRISE_LINUX, SUSE, CENTOS
  name: "BaselineName", # required
  global_filters: {
    patch_filters: [ # required
      {
        key: "PATCH_SET", # required, accepts PATCH_SET, PRODUCT, PRODUCT_FAMILY, CLASSIFICATION, MSRC_SEVERITY, PATCH_ID, SECTION, PRIORITY, SEVERITY
        values: ["PatchFilterValue"], # required
      },
    ],
  },
  approval_rules: {
    patch_rules: [ # required
      {
        patch_filter_group: { # required
          patch_filters: [ # required
            {
              key: "PATCH_SET", # required, accepts PATCH_SET, PRODUCT, PRODUCT_FAMILY, 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
    },
  ],
  client_token: "ClientToken",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
}

Instance Attribute Summary collapse

Instance Attribute Details

#approval_rulesTypes::PatchRuleGroup

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



3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 3116

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)
  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>)


3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 3116

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)
  include Aws::Structure
end

#approved_patches_compliance_levelString

Defines the compliance level for approved patches. This means that if an approved patch is reported as missing, this is the severity of the compliance violation. The default value is UNSPECIFIED.

Returns:

  • (String)


3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 3116

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)
  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)


3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 3116

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)
  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)


3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 3116

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)
  include Aws::Structure
end

#descriptionString

A description of the patch baseline.

Returns:

  • (String)


3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 3116

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)
  include Aws::Structure
end

#global_filtersTypes::PatchFilterGroup

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



3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 3116

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)
  include Aws::Structure
end

#nameString

The name of the patch baseline.

Returns:

  • (String)


3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 3116

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)
  include Aws::Structure
end

#operating_systemString

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

Returns:

  • (String)


3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 3116

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)
  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>)


3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 3116

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)
  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)


3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 3116

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)
  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:



3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 3116

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)
  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 name/value pairs:

  • Key=PatchSeverity,Value=Critical

  • Key=OS,Value=Windows

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

Returns:



3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 3116

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)
  include Aws::Structure
end