commonMain.aws.sdk.kotlin.services.configservice.model.ConfigSnapshotDeliveryProperties.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of configservice-jvm Show documentation
The AWS Kotlin client for Config Service
There is a newer version: 1.3.99
// Code generated by smithy-kotlin-codegen. DO NOT EDIT!

package aws.sdk.kotlin.services.configservice.model



/**
 * Provides options for how often Config delivers configuration snapshots to the Amazon S3 bucket in your delivery channel.
 *
 * The frequency for a rule that triggers evaluations for your resources when Config delivers the configuration snapshot is set by one of two values, depending on which is less frequent:
 * + The value for the `deliveryFrequency` parameter within the delivery channel configuration, which sets how often Config delivers configuration snapshots. This value also sets how often Config invokes evaluations for Config rules.
 * + The value for the `MaximumExecutionFrequency` parameter, which sets the maximum frequency with which Config invokes evaluations for the rule. For more information, see ConfigRule.
 *
 * If the `deliveryFrequency` value is less frequent than the `MaximumExecutionFrequency` value for a rule, Config invokes the rule only as often as the `deliveryFrequency` value.
 * + For example, you want your rule to run evaluations when Config delivers the configuration snapshot.
 * + You specify the `MaximumExecutionFrequency` value for `Six_Hours`.
 * + You then specify the delivery channel `deliveryFrequency` value for `TwentyFour_Hours`.
 * + Because the value for `deliveryFrequency` is less frequent than `MaximumExecutionFrequency`, Config invokes evaluations for the rule every 24 hours.
 *
 * You should set the `MaximumExecutionFrequency` value to be at least as frequent as the `deliveryFrequency` value. You can view the `deliveryFrequency` value by using the `DescribeDeliveryChannnels` action.
 *
 * To update the `deliveryFrequency` with which Config delivers your configuration snapshots, use the `PutDeliveryChannel` action.
 */
public class ConfigSnapshotDeliveryProperties private constructor(builder: Builder) {
    /**
     * The frequency with which Config delivers configuration snapshots.
     */
    public val deliveryFrequency: aws.sdk.kotlin.services.configservice.model.MaximumExecutionFrequency? = builder.deliveryFrequency

    public companion object {
        public operator fun invoke(block: Builder.() -> kotlin.Unit): aws.sdk.kotlin.services.configservice.model.ConfigSnapshotDeliveryProperties = Builder().apply(block).build()
    }

    override fun toString(): kotlin.String = buildString {
        append("ConfigSnapshotDeliveryProperties(")
        append("deliveryFrequency=$deliveryFrequency")
        append(")")
    }

    override fun hashCode(): kotlin.Int {
        var result = deliveryFrequency?.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 ConfigSnapshotDeliveryProperties

        if (deliveryFrequency != other.deliveryFrequency) return false

        return true
    }

    public inline fun copy(block: Builder.() -> kotlin.Unit = {}): aws.sdk.kotlin.services.configservice.model.ConfigSnapshotDeliveryProperties = Builder(this).apply(block).build()

    public class Builder {
        /**
         * The frequency with which Config delivers configuration snapshots.
         */
        public var deliveryFrequency: aws.sdk.kotlin.services.configservice.model.MaximumExecutionFrequency? = null

        @PublishedApi
        internal constructor()
        @PublishedApi
        internal constructor(x: aws.sdk.kotlin.services.configservice.model.ConfigSnapshotDeliveryProperties) : this() {
            this.deliveryFrequency = x.deliveryFrequency
        }

        @PublishedApi
        internal fun build(): aws.sdk.kotlin.services.configservice.model.ConfigSnapshotDeliveryProperties = ConfigSnapshotDeliveryProperties(this)

        internal fun correctErrors(): Builder {
            return this
        }
    }
}