CreatePatchBaselineRequest (AWS Java SDK :: Services :: AWS Simple Systems Management (SSM) 2.17.17 API)

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(value="software.amazon.awssdk:codegen")
public final class CreatePatchBaselineRequest
extends SsmRequest
implements ToCopyableBuilder<CreatePatchBaselineRequest.Builder,CreatePatchBaselineRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreatePatchBaselineRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreatePatchBaselineRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PatchRuleGroup`	`approvalRules()` A set of rules used to include patches in the baseline.
`List<String>`	`approvedPatches()` A list of explicitly approved patches for the baseline.
`PatchComplianceLevel`	`approvedPatchesComplianceLevel()` Defines the compliance level for approved patches.
`String`	`approvedPatchesComplianceLevelAsString()` Defines the compliance level for approved patches.
`Boolean`	`approvedPatchesEnableNonSecurity()` Indicates whether the list of approved patches includes non-security updates that should be applied to the instances.
`static CreatePatchBaselineRequest.Builder`	`builder()`
`String`	`clientToken()` User-provided idempotency token.
`String`	`description()` A description of the patch baseline.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`PatchFilterGroup`	`globalFilters()` A set of global filters used to include patches in the baseline.
`boolean`	`hasApprovedPatches()` For responses, this returns true if the service returned a value for the ApprovedPatches property.
`int`	`hashCode()`
`boolean`	`hasRejectedPatches()` For responses, this returns true if the service returned a value for the RejectedPatches property.
`boolean`	`hasSources()` For responses, this returns true if the service returned a value for the Sources property.
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`String`	`name()` The name of the patch baseline.
`OperatingSystem`	`operatingSystem()` Defines the operating system the patch baseline applies to.
`String`	`operatingSystemAsString()` Defines the operating system the patch baseline applies to.
`List<String>`	`rejectedPatches()` A list of explicitly rejected patches for the baseline.
`PatchAction`	`rejectedPatchesAction()` The action for Patch Manager to take on patches included in the `RejectedPackages` list.
`String`	`rejectedPatchesActionAsString()` The action for Patch Manager to take on patches included in the `RejectedPackages` list.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreatePatchBaselineRequest.Builder>`	`serializableBuilderClass()`
`List<PatchSource>`	`sources()` Information about the patches to use to update the instances, including target operating systems and source repositories.
`List<Tag>`	`tags()` Optional metadata that you assign to a resource.
`CreatePatchBaselineRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - 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:
    
    OperatingSystem
  - 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:
    
    OperatingSystem
  - 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.
    
    Returns:
    
    A set of global filters used to include patches in the baseline.
  - 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 About 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 About 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:
    
    PatchComplianceLevel
  - 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:
    
    PatchComplianceLevel
  - approvedPatchesEnableNonSecurity
```
public final Boolean approvedPatchesEnableNonSecurity()
```
    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:
    
    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.
  - 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 About 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 About 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 : 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.
    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 : 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.
    See Also:
    
    PatchAction
  - rejectedPatchesActionAsString
```
public final String rejectedPatchesActionAsString()
```
    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.
    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 : 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.
    See Also:
    
    PatchAction
  - 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 instances, including target operating systems and source repositories. Applies to Linux instances 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 instances, including target operating systems and source repositories. Applies to Linux instances only.
  - 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreatePatchBaselineRequest.Builder,CreatePatchBaselineRequest>
    
    Specified by:
    
    toBuilder in class SsmRequest
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class CreatePatchBaselineRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

operatingSystem

operatingSystemAsString

name

globalFilters

approvalRules

hasApprovedPatches

approvedPatches

approvedPatchesComplianceLevel

approvedPatchesComplianceLevelAsString

approvedPatchesEnableNonSecurity

hasRejectedPatches

rejectedPatches

rejectedPatchesAction

rejectedPatchesActionAsString

description

hasSources

sources

clientToken

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields