software.amazon.awssdk.services.ssm.model

Interface InstancePatchState.Builder

All Superinterfaces:

Buildable, CopyableBuilder<InstancePatchState.Builder,InstancePatchState>, SdkBuilder<InstancePatchState.Builder,InstancePatchState>, SdkPojo

Enclosing class:

InstancePatchState

public static interface InstancePatchState.Builder
extends SdkPojo, CopyableBuilder<InstancePatchState.Builder,InstancePatchState>

Method Summary

Modifier and Type	Method and Description
InstancePatchState.Builder	baselineId(String baselineId) The ID of the patch baseline used to patch the instance.
InstancePatchState.Builder	criticalNonCompliantCount(Integer criticalNonCompliantCount) The number of instances where patches that are specified as Critical for compliance reporting in the patch baseline aren't installed.
InstancePatchState.Builder	failedCount(Integer failedCount) The number of patches from the patch baseline that were attempted to be installed during the last patching operation, but failed to install.
InstancePatchState.Builder	installedCount(Integer installedCount) The number of patches from the patch baseline that are installed on the instance.
InstancePatchState.Builder	installedOtherCount(Integer installedOtherCount) The number of patches not specified in the patch baseline that are installed on the instance.
InstancePatchState.Builder	installedPendingRebootCount(Integer installedPendingRebootCount) The number of patches installed by Patch Manager since the last time the instance was rebooted.
InstancePatchState.Builder	installedRejectedCount(Integer installedRejectedCount) The number of patches installed on an instance that are specified in a RejectedPatches list.
InstancePatchState.Builder	installOverrideList(String installOverrideList) An https URL or an Amazon Simple Storage Service (Amazon S3) path-style URL to a list of patches to be installed.
InstancePatchState.Builder	instanceId(String instanceId) The ID of the managed instance the high-level patch compliance information was collected for.
InstancePatchState.Builder	lastNoRebootInstallOperationTime(Instant lastNoRebootInstallOperationTime) The time of the last attempt to patch the instance with NoReboot specified as the reboot option.
InstancePatchState.Builder	missingCount(Integer missingCount) The number of patches from the patch baseline that are applicable for the instance but aren't currently installed.
InstancePatchState.Builder	notApplicableCount(Integer notApplicableCount) The number of patches from the patch baseline that aren't applicable for the instance and therefore aren't installed on the instance.
InstancePatchState.Builder	operation(PatchOperationType operation) The type of patching operation that was performed: or
InstancePatchState.Builder	operation(String operation) The type of patching operation that was performed: or
InstancePatchState.Builder	operationEndTime(Instant operationEndTime) The time the most recent patching operation completed on the instance.
InstancePatchState.Builder	operationStartTime(Instant operationStartTime) The time the most recent patching operation was started on the instance.
InstancePatchState.Builder	otherNonCompliantCount(Integer otherNonCompliantCount) The number of instances with patches installed that are specified as other than Critical or Security but aren't compliant with the patch baseline.
InstancePatchState.Builder	ownerInformation(String ownerInformation) Placeholder information.
InstancePatchState.Builder	patchGroup(String patchGroup) The name of the patch group the managed instance belongs to.
InstancePatchState.Builder	rebootOption(RebootOption rebootOption) Indicates the reboot option specified in the patch baseline.
InstancePatchState.Builder	rebootOption(String rebootOption) Indicates the reboot option specified in the patch baseline.
InstancePatchState.Builder	securityNonCompliantCount(Integer securityNonCompliantCount) The number of instances where patches that are specified as Security in a patch advisory aren't installed.
InstancePatchState.Builder	snapshotId(String snapshotId) The ID of the patch baseline snapshot used during the patching operation when this compliance data was collected.
InstancePatchState.Builder	unreportedNotApplicableCount(Integer unreportedNotApplicableCount) The number of patches beyond the supported limit of NotApplicableCount that aren't reported by name to Inventory.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

instanceId

InstancePatchState.Builder instanceId(String instanceId)

The ID of the managed instance the high-level patch compliance information was collected for.

Parameters:

instanceId - The ID of the managed instance the high-level patch compliance information was collected for.

Returns:

Returns a reference to this object so that method calls can be chained together.

patchGroup

InstancePatchState.Builder patchGroup(String patchGroup)

The name of the patch group the managed instance belongs to.

Parameters:

patchGroup - The name of the patch group the managed instance belongs to.

Returns:

Returns a reference to this object so that method calls can be chained together.

baselineId

InstancePatchState.Builder baselineId(String baselineId)

The ID of the patch baseline used to patch the instance.

Parameters:

baselineId - The ID of the patch baseline used to patch the instance.

Returns:

Returns a reference to this object so that method calls can be chained together.

snapshotId

InstancePatchState.Builder snapshotId(String snapshotId)

The ID of the patch baseline snapshot used during the patching operation when this compliance data was collected.

Parameters:

snapshotId - The ID of the patch baseline snapshot used during the patching operation when this compliance data was collected.

Returns:

Returns a reference to this object so that method calls can be chained together.

installOverrideList

InstancePatchState.Builder installOverrideList(String installOverrideList)

An https URL or an Amazon Simple Storage Service (Amazon S3) path-style URL to a list of patches to be installed. This patch installation list, which you maintain in an S3 bucket in YAML format and specify in the SSM document AWS-RunPatchBaseline, overrides the patches specified by the default patch baseline.

For more information about the InstallOverrideList parameter, see About the AWS-RunPatchBaseline SSM document in the Amazon Web Services Systems Manager User Guide.

Parameters:

installOverrideList - An https URL or an Amazon Simple Storage Service (Amazon S3) path-style URL to a list of patches to be installed. This patch installation list, which you maintain in an S3 bucket in YAML format and specify in the SSM document AWS-RunPatchBaseline, overrides the patches specified by the default patch baseline.

For more information about the InstallOverrideList parameter, see About the AWS-RunPatchBaseline SSM document in the Amazon Web Services Systems Manager User Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

ownerInformation

InstancePatchState.Builder ownerInformation(String ownerInformation)

Placeholder information. This field will always be empty in the current release of the service.

Parameters:

ownerInformation - Placeholder information. This field will always be empty in the current release of the service.

Returns:

Returns a reference to this object so that method calls can be chained together.

installedCount

InstancePatchState.Builder installedCount(Integer installedCount)

The number of patches from the patch baseline that are installed on the instance.

Parameters:

installedCount - The number of patches from the patch baseline that are installed on the instance.

Returns:

Returns a reference to this object so that method calls can be chained together.

installedOtherCount

InstancePatchState.Builder installedOtherCount(Integer installedOtherCount)

The number of patches not specified in the patch baseline that are installed on the instance.

Parameters:

installedOtherCount - The number of patches not specified in the patch baseline that are installed on the instance.

Returns:

Returns a reference to this object so that method calls can be chained together.

installedPendingRebootCount

InstancePatchState.Builder installedPendingRebootCount(Integer installedPendingRebootCount)

The number of patches installed by Patch Manager since the last time the instance was rebooted.

Parameters:

installedPendingRebootCount - The number of patches installed by Patch Manager since the last time the instance was rebooted.

Returns:

Returns a reference to this object so that method calls can be chained together.

installedRejectedCount

InstancePatchState.Builder installedRejectedCount(Integer installedRejectedCount)

The number of patches installed on an instance that are specified in a RejectedPatches list. Patches with a status of InstalledRejected were typically installed before they were added to a RejectedPatches list.

If ALLOW_AS_DEPENDENCY is the specified option for RejectedPatchesAction, the value of InstalledRejectedCount will always be 0 (zero).

Parameters:

installedRejectedCount - The number of patches installed on an instance that are specified in a RejectedPatches list. Patches with a status of InstalledRejected were typically installed before they were added to a RejectedPatches list.

If ALLOW_AS_DEPENDENCY is the specified option for RejectedPatchesAction, the value of InstalledRejectedCount will always be 0 (zero).

Returns:

Returns a reference to this object so that method calls can be chained together.

missingCount

InstancePatchState.Builder missingCount(Integer missingCount)

The number of patches from the patch baseline that are applicable for the instance but aren't currently installed.

Parameters:

missingCount - The number of patches from the patch baseline that are applicable for the instance but aren't currently installed.

Returns:

Returns a reference to this object so that method calls can be chained together.

failedCount

InstancePatchState.Builder failedCount(Integer failedCount)

The number of patches from the patch baseline that were attempted to be installed during the last patching operation, but failed to install.

Parameters:

failedCount - The number of patches from the patch baseline that were attempted to be installed during the last patching operation, but failed to install.

Returns:

Returns a reference to this object so that method calls can be chained together.

unreportedNotApplicableCount

InstancePatchState.Builder unreportedNotApplicableCount(Integer unreportedNotApplicableCount)

The number of patches beyond the supported limit of NotApplicableCount that aren't reported by name to Inventory. Inventory is a capability of Amazon Web Services Systems Manager.

Parameters:

unreportedNotApplicableCount - The number of patches beyond the supported limit of NotApplicableCount that aren't reported by name to Inventory. Inventory is a capability of Amazon Web Services Systems Manager.

Returns:

Returns a reference to this object so that method calls can be chained together.

notApplicableCount

InstancePatchState.Builder notApplicableCount(Integer notApplicableCount)

The number of patches from the patch baseline that aren't applicable for the instance and therefore aren't installed on the instance. This number may be truncated if the list of patch names is very large. The number of patches beyond this limit are reported in UnreportedNotApplicableCount.

Parameters:

notApplicableCount - The number of patches from the patch baseline that aren't applicable for the instance and therefore aren't installed on the instance. This number may be truncated if the list of patch names is very large. The number of patches beyond this limit are reported in UnreportedNotApplicableCount.

Returns:

Returns a reference to this object so that method calls can be chained together.

operationStartTime

InstancePatchState.Builder operationStartTime(Instant operationStartTime)

The time the most recent patching operation was started on the instance.

Parameters:

operationStartTime - The time the most recent patching operation was started on the instance.

Returns:

Returns a reference to this object so that method calls can be chained together.

operationEndTime

InstancePatchState.Builder operationEndTime(Instant operationEndTime)

The time the most recent patching operation completed on the instance.

Parameters:

operationEndTime - The time the most recent patching operation completed on the instance.

Returns:

Returns a reference to this object so that method calls can be chained together.

operation

InstancePatchState.Builder operation(String operation)

The type of patching operation that was performed: or

• SCAN assesses the patch compliance state.

• INSTALL installs missing patches.

Parameters:

operation - The type of patching operation that was performed: or

• SCAN assesses the patch compliance state.

• INSTALL installs missing patches.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

PatchOperationType, PatchOperationType

operation

InstancePatchState.Builder operation(PatchOperationType operation)

The type of patching operation that was performed: or

• SCAN assesses the patch compliance state.

• INSTALL installs missing patches.

Parameters:

operation - The type of patching operation that was performed: or

• SCAN assesses the patch compliance state.

• INSTALL installs missing patches.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

PatchOperationType, PatchOperationType

lastNoRebootInstallOperationTime

InstancePatchState.Builder lastNoRebootInstallOperationTime(Instant lastNoRebootInstallOperationTime)

The time of the last attempt to patch the instance with NoReboot specified as the reboot option.

Parameters:

lastNoRebootInstallOperationTime - The time of the last attempt to patch the instance with NoReboot specified as the reboot option.

Returns:

Returns a reference to this object so that method calls can be chained together.

rebootOption

InstancePatchState.Builder rebootOption(String rebootOption)

Indicates the reboot option specified in the patch baseline.

Reboot options apply to Install operations only. Reboots aren't attempted for Patch Manager Scan operations.

• RebootIfNeeded: Patch Manager tries to reboot the instance if it installed any patches, or if any patches are detected with a status of InstalledPendingReboot.

• NoReboot: Patch Manager attempts to install missing packages without trying to reboot the system. Patches installed with this option are assigned a status of InstalledPendingReboot. These patches might not be in effect until a reboot is performed.

Parameters:

rebootOption - Indicates the reboot option specified in the patch baseline.

Reboot options apply to Install operations only. Reboots aren't attempted for Patch Manager Scan operations.

• RebootIfNeeded: Patch Manager tries to reboot the instance if it installed any patches, or if any patches are detected with a status of InstalledPendingReboot.

• NoReboot: Patch Manager attempts to install missing packages without trying to reboot the system. Patches installed with this option are assigned a status of InstalledPendingReboot. These patches might not be in effect until a reboot is performed.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

RebootOption, RebootOption

rebootOption

InstancePatchState.Builder rebootOption(RebootOption rebootOption)

Indicates the reboot option specified in the patch baseline.

Reboot options apply to Install operations only. Reboots aren't attempted for Patch Manager Scan operations.

• RebootIfNeeded: Patch Manager tries to reboot the instance if it installed any patches, or if any patches are detected with a status of InstalledPendingReboot.

• NoReboot: Patch Manager attempts to install missing packages without trying to reboot the system. Patches installed with this option are assigned a status of InstalledPendingReboot. These patches might not be in effect until a reboot is performed.

Parameters:

rebootOption - Indicates the reboot option specified in the patch baseline.

Reboot options apply to Install operations only. Reboots aren't attempted for Patch Manager Scan operations.

• RebootIfNeeded: Patch Manager tries to reboot the instance if it installed any patches, or if any patches are detected with a status of InstalledPendingReboot.

• NoReboot: Patch Manager attempts to install missing packages without trying to reboot the system. Patches installed with this option are assigned a status of InstalledPendingReboot. These patches might not be in effect until a reboot is performed.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

RebootOption, RebootOption

criticalNonCompliantCount

InstancePatchState.Builder criticalNonCompliantCount(Integer criticalNonCompliantCount)

The number of instances where patches that are specified as Critical for compliance reporting in the patch baseline aren't installed. These patches might be missing, have failed installation, were rejected, or were installed but awaiting a required instance reboot. The status of these instances is NON_COMPLIANT.

Parameters:

criticalNonCompliantCount - The number of instances where patches that are specified as Critical for compliance reporting in the patch baseline aren't installed. These patches might be missing, have failed installation, were rejected, or were installed but awaiting a required instance reboot. The status of these instances is NON_COMPLIANT.

Returns:

Returns a reference to this object so that method calls can be chained together.

securityNonCompliantCount

InstancePatchState.Builder securityNonCompliantCount(Integer securityNonCompliantCount)

The number of instances where patches that are specified as Security in a patch advisory aren't installed. These patches might be missing, have failed installation, were rejected, or were installed but awaiting a required instance reboot. The status of these instances is NON_COMPLIANT.

Parameters:

securityNonCompliantCount - The number of instances where patches that are specified as Security in a patch advisory aren't installed. These patches might be missing, have failed installation, were rejected, or were installed but awaiting a required instance reboot. The status of these instances is NON_COMPLIANT.

Returns:

Returns a reference to this object so that method calls can be chained together.

otherNonCompliantCount

InstancePatchState.Builder otherNonCompliantCount(Integer otherNonCompliantCount)

The number of instances with patches installed that are specified as other than Critical or Security but aren't compliant with the patch baseline. The status of these instances is NON_COMPLIANT.

Parameters:

otherNonCompliantCount - The number of instances with patches installed that are specified as other than Critical or Security but aren't compliant with the patch baseline. The status of these instances is NON_COMPLIANT.

Returns:

Returns a reference to this object so that method calls can be chained together.