commonMain.aws.sdk.kotlin.services.ssm.model.CreatePatchBaselineRequest.kt Maven / Gradle / Ivy
// Code generated by smithy-kotlin-codegen. DO NOT EDIT!
package aws.sdk.kotlin.services.ssm.model
import aws.smithy.kotlin.runtime.SdkDsl
public class CreatePatchBaselineRequest private constructor(builder: Builder) {
/**
* A set of rules used to include patches in the baseline.
*/
public val approvalRules: aws.sdk.kotlin.services.ssm.model.PatchRuleGroup? = builder.approvalRules
/**
* 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](https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-approved-rejected-package-name-formats.html) in the *Amazon Web Services Systems Manager User Guide*.
*/
public val approvedPatches: List? = builder.approvedPatches
/**
* 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`.
*/
public val approvedPatchesComplianceLevel: aws.sdk.kotlin.services.ssm.model.PatchComplianceLevel? = builder.approvedPatchesComplianceLevel
/**
* 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.
*/
public val approvedPatchesEnableNonSecurity: kotlin.Boolean? = builder.approvedPatchesEnableNonSecurity
/**
* User-provided idempotency token.
*/
public val clientToken: kotlin.String? = builder.clientToken
/**
* A description of the patch baseline.
*/
public val description: kotlin.String? = builder.description
/**
* 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.
*/
public val globalFilters: aws.sdk.kotlin.services.ssm.model.PatchFilterGroup? = builder.globalFilters
/**
* The name of the patch baseline.
*/
public val name: kotlin.String? = builder.name
/**
* Defines the operating system the patch baseline applies to. The default value is `WINDOWS`.
*/
public val operatingSystem: aws.sdk.kotlin.services.ssm.model.OperatingSystem? = builder.operatingSystem
/**
* 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](https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-approved-rejected-package-name-formats.html) in the *Amazon Web Services Systems Manager User Guide*.
*/
public val rejectedPatches: List? = builder.rejectedPatches
/**
* 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`.
*/
public val rejectedPatchesAction: aws.sdk.kotlin.services.ssm.model.PatchAction? = builder.rejectedPatchesAction
/**
* Information about the patches to use to update the managed nodes, including target operating systems and source repositories. Applies to Linux managed nodes only.
*/
public val sources: List? = builder.sources
/**
* 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.
*/
public val tags: List? = builder.tags
public companion object {
public operator fun invoke(block: Builder.() -> kotlin.Unit): aws.sdk.kotlin.services.ssm.model.CreatePatchBaselineRequest = Builder().apply(block).build()
}
override fun toString(): kotlin.String = buildString {
append("CreatePatchBaselineRequest(")
append("approvalRules=$approvalRules,")
append("approvedPatches=$approvedPatches,")
append("approvedPatchesComplianceLevel=$approvedPatchesComplianceLevel,")
append("approvedPatchesEnableNonSecurity=$approvedPatchesEnableNonSecurity,")
append("clientToken=$clientToken,")
append("description=$description,")
append("globalFilters=$globalFilters,")
append("name=$name,")
append("operatingSystem=$operatingSystem,")
append("rejectedPatches=$rejectedPatches,")
append("rejectedPatchesAction=$rejectedPatchesAction,")
append("sources=$sources,")
append("tags=$tags")
append(")")
}
override fun hashCode(): kotlin.Int {
var result = approvalRules?.hashCode() ?: 0
result = 31 * result + (approvedPatches?.hashCode() ?: 0)
result = 31 * result + (approvedPatchesComplianceLevel?.hashCode() ?: 0)
result = 31 * result + (approvedPatchesEnableNonSecurity?.hashCode() ?: 0)
result = 31 * result + (clientToken?.hashCode() ?: 0)
result = 31 * result + (description?.hashCode() ?: 0)
result = 31 * result + (globalFilters?.hashCode() ?: 0)
result = 31 * result + (name?.hashCode() ?: 0)
result = 31 * result + (operatingSystem?.hashCode() ?: 0)
result = 31 * result + (rejectedPatches?.hashCode() ?: 0)
result = 31 * result + (rejectedPatchesAction?.hashCode() ?: 0)
result = 31 * result + (sources?.hashCode() ?: 0)
result = 31 * result + (tags?.hashCode() ?: 0)
return result
}
override fun equals(other: kotlin.Any?): kotlin.Boolean {
if (this === other) return true
if (other == null || this::class != other::class) return false
other as CreatePatchBaselineRequest
if (approvalRules != other.approvalRules) return false
if (approvedPatches != other.approvedPatches) return false
if (approvedPatchesComplianceLevel != other.approvedPatchesComplianceLevel) return false
if (approvedPatchesEnableNonSecurity != other.approvedPatchesEnableNonSecurity) return false
if (clientToken != other.clientToken) return false
if (description != other.description) return false
if (globalFilters != other.globalFilters) return false
if (name != other.name) return false
if (operatingSystem != other.operatingSystem) return false
if (rejectedPatches != other.rejectedPatches) return false
if (rejectedPatchesAction != other.rejectedPatchesAction) return false
if (sources != other.sources) return false
if (tags != other.tags) return false
return true
}
public inline fun copy(block: Builder.() -> kotlin.Unit = {}): aws.sdk.kotlin.services.ssm.model.CreatePatchBaselineRequest = Builder(this).apply(block).build()
@SdkDsl
public class Builder {
/**
* A set of rules used to include patches in the baseline.
*/
public var approvalRules: aws.sdk.kotlin.services.ssm.model.PatchRuleGroup? = null
/**
* 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](https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-approved-rejected-package-name-formats.html) in the *Amazon Web Services Systems Manager User Guide*.
*/
public var approvedPatches: List? = null
/**
* 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`.
*/
public var approvedPatchesComplianceLevel: aws.sdk.kotlin.services.ssm.model.PatchComplianceLevel? = null
/**
* 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.
*/
public var approvedPatchesEnableNonSecurity: kotlin.Boolean? = null
/**
* User-provided idempotency token.
*/
public var clientToken: kotlin.String? = null
/**
* A description of the patch baseline.
*/
public var description: kotlin.String? = null
/**
* 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.
*/
public var globalFilters: aws.sdk.kotlin.services.ssm.model.PatchFilterGroup? = null
/**
* The name of the patch baseline.
*/
public var name: kotlin.String? = null
/**
* Defines the operating system the patch baseline applies to. The default value is `WINDOWS`.
*/
public var operatingSystem: aws.sdk.kotlin.services.ssm.model.OperatingSystem? = null
/**
* 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](https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-approved-rejected-package-name-formats.html) in the *Amazon Web Services Systems Manager User Guide*.
*/
public var rejectedPatches: List? = null
/**
* 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`.
*/
public var rejectedPatchesAction: aws.sdk.kotlin.services.ssm.model.PatchAction? = null
/**
* Information about the patches to use to update the managed nodes, including target operating systems and source repositories. Applies to Linux managed nodes only.
*/
public var sources: List? = null
/**
* 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.
*/
public var tags: List? = null
@PublishedApi
internal constructor()
@PublishedApi
internal constructor(x: aws.sdk.kotlin.services.ssm.model.CreatePatchBaselineRequest) : this() {
this.approvalRules = x.approvalRules
this.approvedPatches = x.approvedPatches
this.approvedPatchesComplianceLevel = x.approvedPatchesComplianceLevel
this.approvedPatchesEnableNonSecurity = x.approvedPatchesEnableNonSecurity
this.clientToken = x.clientToken
this.description = x.description
this.globalFilters = x.globalFilters
this.name = x.name
this.operatingSystem = x.operatingSystem
this.rejectedPatches = x.rejectedPatches
this.rejectedPatchesAction = x.rejectedPatchesAction
this.sources = x.sources
this.tags = x.tags
}
@PublishedApi
internal fun build(): aws.sdk.kotlin.services.ssm.model.CreatePatchBaselineRequest = CreatePatchBaselineRequest(this)
/**
* construct an [aws.sdk.kotlin.services.ssm.model.PatchRuleGroup] inside the given [block]
*/
public fun approvalRules(block: aws.sdk.kotlin.services.ssm.model.PatchRuleGroup.Builder.() -> kotlin.Unit) {
this.approvalRules = aws.sdk.kotlin.services.ssm.model.PatchRuleGroup.invoke(block)
}
/**
* construct an [aws.sdk.kotlin.services.ssm.model.PatchFilterGroup] inside the given [block]
*/
public fun globalFilters(block: aws.sdk.kotlin.services.ssm.model.PatchFilterGroup.Builder.() -> kotlin.Unit) {
this.globalFilters = aws.sdk.kotlin.services.ssm.model.PatchFilterGroup.invoke(block)
}
internal fun correctErrors(): Builder {
return this
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy