Class CreatePatchBaselineRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.ssm.model.SsmRequest
software.amazon.awssdk.services.ssm.model.CreatePatchBaselineRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreatePatchBaselineRequest.Builder,CreatePatchBaselineRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreatePatchBaselineRequest extends SsmRequest implements ToCopyableBuilder<CreatePatchBaselineRequest.Builder,CreatePatchBaselineRequest>

  • Method Details

    • operatingSystem

      public final OperatingSystem operatingSystem()

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

      If the service returns an enum value that is not available in the current SDK version, operatingSystem will return OperatingSystem.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from operatingSystemAsString().

      Returns:
      Defines the operating system the patch baseline applies to. The default value is WINDOWS.
      See Also:

    • operatingSystemAsString

      public final String operatingSystemAsString()

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

      If the service returns an enum value that is not available in the current SDK version, operatingSystem will return OperatingSystem.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from operatingSystemAsString().

      Returns:
      Defines the operating system the patch baseline applies to. The default value is WINDOWS.
      See Also:

    • name

      public final String name()

      The name of the patch baseline.

      Returns:
      The name of the patch baseline.

    • globalFilters

      public final PatchFilterGroup globalFilters()

      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.

      Returns:
      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.

    • approvalRules

      public final PatchRuleGroup approvalRules()

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

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

    • hasApprovedPatches

      public final boolean hasApprovedPatches()
      For responses, this returns true if the service returned a value for the ApprovedPatches property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • approvedPatches

      public final List<String> approvedPatches()

      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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasApprovedPatches() method.

      Returns:
      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.

    • approvedPatchesComplianceLevel

      public final PatchComplianceLevel approvedPatchesComplianceLevel()

      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.

      If the service returns an enum value that is not available in the current SDK version, approvedPatchesComplianceLevel will return PatchComplianceLevel.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from approvedPatchesComplianceLevelAsString().

      Returns:
      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.
      See Also:

    • approvedPatchesComplianceLevelAsString

      public final String approvedPatchesComplianceLevelAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, approvedPatchesComplianceLevel will return PatchComplianceLevel.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from approvedPatchesComplianceLevelAsString().

      Returns:
      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.
      See Also:

    • approvedPatchesEnableNonSecurity

      public final Boolean approvedPatchesEnableNonSecurity()

      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.

      Returns:
      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.

    • hasRejectedPatches

      public final boolean hasRejectedPatches()
      For responses, this returns true if the service returned a value for the RejectedPatches property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • rejectedPatches

      public final List<String> rejectedPatches()

      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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRejectedPatches() method.

      Returns:
      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.

    • rejectedPatchesAction

      public final PatchAction rejectedPatchesAction()

      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. 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 the service returns an enum value that is not available in the current SDK version, rejectedPatchesAction will return PatchAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from rejectedPatchesActionAsString().

      Returns:
      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. 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.

      See Also:

    • rejectedPatchesActionAsString

      public final String rejectedPatchesActionAsString()

      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. 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 the service returns an enum value that is not available in the current SDK version, rejectedPatchesAction will return PatchAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from rejectedPatchesActionAsString().

      Returns:
      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. 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.

      See Also:

    • description

      public final String description()

      A description of the patch baseline.

      Returns:
      A description of the patch baseline.

    • hasSources

      public final boolean hasSources()
      For responses, this returns true if the service returned a value for the Sources property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • sources

      public final List<PatchSource> sources()

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

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSources() method.

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

    • availableSecurityUpdatesComplianceStatus

      public final PatchComplianceStatus availableSecurityUpdatesComplianceStatus()

      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.

      If the service returns an enum value that is not available in the current SDK version, availableSecurityUpdatesComplianceStatus will return PatchComplianceStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from availableSecurityUpdatesComplianceStatusAsString().

      Returns:
      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.

      See Also:

    • availableSecurityUpdatesComplianceStatusAsString

      public final String availableSecurityUpdatesComplianceStatusAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, availableSecurityUpdatesComplianceStatus will return PatchComplianceStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from availableSecurityUpdatesComplianceStatusAsString().

      Returns:
      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.

      See Also:

    • clientToken

      public final String clientToken()

      User-provided idempotency token.

      Returns:
      User-provided idempotency token.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final List<Tag> tags()

      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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      Returns:
      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.

    • toBuilder

      public CreatePatchBaselineRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreatePatchBaselineRequest.Builder,CreatePatchBaselineRequest>
      Specified by:
      toBuilder in class SsmRequest
      Returns:
      a builder for type T

    • builder

      public static CreatePatchBaselineRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreatePatchBaselineRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.