commonMain.aws.sdk.kotlin.services.lightsail.model.AccountLevelBpaSync.kt Maven / Gradle / Ivy

Go to download
// Code generated by smithy-kotlin-codegen. DO NOT EDIT!

package aws.sdk.kotlin.services.lightsail.model

import aws.smithy.kotlin.runtime.SdkDsl
import aws.smithy.kotlin.runtime.time.Instant

/**
 * Describes the synchronization status of the Amazon Simple Storage Service (Amazon S3) account-level block public access (BPA) feature for your Lightsail buckets.
 *
 * The account-level BPA feature of Amazon S3 provides centralized controls to limit public access to all Amazon S3 buckets in an account. BPA can make all Amazon S3 buckets in an Amazon Web Services account private regardless of the individual bucket and object permissions that are configured. Lightsail buckets take into account the Amazon S3 account-level BPA configuration when allowing or denying public access. To do this, Lightsail periodically fetches the account-level BPA configuration from Amazon S3. When the account-level BPA status is `InSync`, the Amazon S3 account-level BPA configuration is synchronized and it applies to your Lightsail buckets. For more information about Amazon Simple Storage Service account-level BPA and how it affects Lightsail buckets, see [Block public access for buckets in Amazon Lightsail](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-block-public-access-for-buckets) in the *Amazon Lightsail Developer Guide*.
 */
public class AccountLevelBpaSync private constructor(builder: Builder) {
    /**
     * A Boolean value that indicates whether account-level block public access is affecting your Lightsail buckets.
     */
    public val bpaImpactsLightsail: kotlin.Boolean? = builder.bpaImpactsLightsail
    /**
     * The timestamp of when the account-level BPA configuration was last synchronized. This value is null when the account-level BPA configuration has not been synchronized.
     */
    public val lastSyncedAt: aws.smithy.kotlin.runtime.time.Instant? = builder.lastSyncedAt
    /**
     * A message that provides a reason for a `Failed` or `Defaulted` synchronization status.
     *
     * The following messages are possible:
     * + `SYNC_ON_HOLD` - The synchronization has not yet happened. This status message occurs immediately after you create your first Lightsail bucket. This status message should change after the first synchronization happens, approximately 1 hour after the first bucket is created.
     * + `DEFAULTED_FOR_SLR_MISSING` - The synchronization failed because the required service-linked role is missing from your Amazon Web Services account. The account-level BPA configuration for your Lightsail buckets is defaulted to *active* until the synchronization can occur. This means that all your buckets are private and not publicly accessible. For more information about how to create the required service-linked role to allow synchronization, see [Using Service-Linked Roles for Amazon Lightsail](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-using-service-linked-roles) in the *Amazon Lightsail Developer Guide*.
     * + `DEFAULTED_FOR_SLR_MISSING_ON_HOLD` - The synchronization failed because the required service-linked role is missing from your Amazon Web Services account. Account-level BPA is not yet configured for your Lightsail buckets. Therefore, only the bucket access permissions and individual object access permissions apply to your Lightsail buckets. For more information about how to create the required service-linked role to allow synchronization, see [Using Service-Linked Roles for Amazon Lightsail](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-using-service-linked-roles) in the *Amazon Lightsail Developer Guide*.
     * + `Unknown` - The reason that synchronization failed is unknown. Contact Amazon Web Services Support for more information.
     */
    public val message: aws.sdk.kotlin.services.lightsail.model.BpaStatusMessage? = builder.message
    /**
     * The status of the account-level BPA synchronization.
     *
     * The following statuses are possible:
     * + `InSync` - Account-level BPA is synchronized. The Amazon S3 account-level BPA configuration applies to your Lightsail buckets.
     * + `NeverSynced` - Synchronization has not yet happened. The Amazon S3 account-level BPA configuration does not apply to your Lightsail buckets.
     * + `Failed` - Synchronization failed. The Amazon S3 account-level BPA configuration does not apply to your Lightsail buckets.
     * + `Defaulted` - Synchronization failed and account-level BPA for your Lightsail buckets is defaulted to *active*.
     *
     * You might need to complete further actions if the status is `Failed` or `Defaulted`. The `message` parameter provides more information for those statuses.
     */
    public val status: aws.sdk.kotlin.services.lightsail.model.AccountLevelBpaSyncStatus? = builder.status

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

    override fun toString(): kotlin.String = buildString {
        append("AccountLevelBpaSync(")
        append("bpaImpactsLightsail=$bpaImpactsLightsail,")
        append("lastSyncedAt=$lastSyncedAt,")
        append("message=$message,")
        append("status=$status")
        append(")")
    }

    override fun hashCode(): kotlin.Int {
        var result = bpaImpactsLightsail?.hashCode() ?: 0
        result = 31 * result + (lastSyncedAt?.hashCode() ?: 0)
        result = 31 * result + (message?.hashCode() ?: 0)
        result = 31 * result + (status?.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 AccountLevelBpaSync

        if (bpaImpactsLightsail != other.bpaImpactsLightsail) return false
        if (lastSyncedAt != other.lastSyncedAt) return false
        if (message != other.message) return false
        if (status != other.status) return false

        return true
    }

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

    @SdkDsl
    public class Builder {
        /**
         * A Boolean value that indicates whether account-level block public access is affecting your Lightsail buckets.
         */
        public var bpaImpactsLightsail: kotlin.Boolean? = null
        /**
         * The timestamp of when the account-level BPA configuration was last synchronized. This value is null when the account-level BPA configuration has not been synchronized.
         */
        public var lastSyncedAt: aws.smithy.kotlin.runtime.time.Instant? = null
        /**
         * A message that provides a reason for a `Failed` or `Defaulted` synchronization status.
         *
         * The following messages are possible:
         * + `SYNC_ON_HOLD` - The synchronization has not yet happened. This status message occurs immediately after you create your first Lightsail bucket. This status message should change after the first synchronization happens, approximately 1 hour after the first bucket is created.
         * + `DEFAULTED_FOR_SLR_MISSING` - The synchronization failed because the required service-linked role is missing from your Amazon Web Services account. The account-level BPA configuration for your Lightsail buckets is defaulted to *active* until the synchronization can occur. This means that all your buckets are private and not publicly accessible. For more information about how to create the required service-linked role to allow synchronization, see [Using Service-Linked Roles for Amazon Lightsail](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-using-service-linked-roles) in the *Amazon Lightsail Developer Guide*.
         * + `DEFAULTED_FOR_SLR_MISSING_ON_HOLD` - The synchronization failed because the required service-linked role is missing from your Amazon Web Services account. Account-level BPA is not yet configured for your Lightsail buckets. Therefore, only the bucket access permissions and individual object access permissions apply to your Lightsail buckets. For more information about how to create the required service-linked role to allow synchronization, see [Using Service-Linked Roles for Amazon Lightsail](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-using-service-linked-roles) in the *Amazon Lightsail Developer Guide*.
         * + `Unknown` - The reason that synchronization failed is unknown. Contact Amazon Web Services Support for more information.
         */
        public var message: aws.sdk.kotlin.services.lightsail.model.BpaStatusMessage? = null
        /**
         * The status of the account-level BPA synchronization.
         *
         * The following statuses are possible:
         * + `InSync` - Account-level BPA is synchronized. The Amazon S3 account-level BPA configuration applies to your Lightsail buckets.
         * + `NeverSynced` - Synchronization has not yet happened. The Amazon S3 account-level BPA configuration does not apply to your Lightsail buckets.
         * + `Failed` - Synchronization failed. The Amazon S3 account-level BPA configuration does not apply to your Lightsail buckets.
         * + `Defaulted` - Synchronization failed and account-level BPA for your Lightsail buckets is defaulted to *active*.
         *
         * You might need to complete further actions if the status is `Failed` or `Defaulted`. The `message` parameter provides more information for those statuses.
         */
        public var status: aws.sdk.kotlin.services.lightsail.model.AccountLevelBpaSyncStatus? = null

        @PublishedApi
        internal constructor()
        @PublishedApi
        internal constructor(x: aws.sdk.kotlin.services.lightsail.model.AccountLevelBpaSync) : this() {
            this.bpaImpactsLightsail = x.bpaImpactsLightsail
            this.lastSyncedAt = x.lastSyncedAt
            this.message = x.message
            this.status = x.status
        }

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

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