commonMain.aws.sdk.kotlin.services.s3control.model.PutBucketPolicyRequest.kt Maven / Gradle / Ivy

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

package aws.sdk.kotlin.services.s3control.model



public class PutBucketPolicyRequest private constructor(builder: Builder) {
    /**
     * The Amazon Web Services account ID of the Outposts bucket.
     */
    public val accountId: kotlin.String? = builder.accountId
    /**
     * Specifies the bucket.
     *
     * For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.
     *
     * For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format `arn:aws:s3-outposts:::outpost//bucket/`. For example, to access the bucket `reports` through Outpost `my-outpost` owned by account `123456789012` in Region `us-west-2`, use the URL encoding of `arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports`. The value must be URL encoded.
     */
    public val bucket: kotlin.String? = builder.bucket
    /**
     * Set this parameter to true to confirm that you want to remove your permissions to change this bucket policy in the future.
     *
     * This is not supported by Amazon S3 on Outposts buckets.
     */
    public val confirmRemoveSelfBucketAccess: kotlin.Boolean? = builder.confirmRemoveSelfBucketAccess
    /**
     * The bucket policy as a JSON document.
     */
    public val policy: kotlin.String? = builder.policy

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

    override fun toString(): kotlin.String = buildString {
        append("PutBucketPolicyRequest(")
        append("accountId=$accountId,")
        append("bucket=$bucket,")
        append("confirmRemoveSelfBucketAccess=$confirmRemoveSelfBucketAccess,")
        append("policy=$policy")
        append(")")
    }

    override fun hashCode(): kotlin.Int {
        var result = accountId?.hashCode() ?: 0
        result = 31 * result + (bucket?.hashCode() ?: 0)
        result = 31 * result + (confirmRemoveSelfBucketAccess?.hashCode() ?: 0)
        result = 31 * result + (policy?.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 PutBucketPolicyRequest

        if (accountId != other.accountId) return false
        if (bucket != other.bucket) return false
        if (confirmRemoveSelfBucketAccess != other.confirmRemoveSelfBucketAccess) return false
        if (policy != other.policy) return false

        return true
    }

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

    public class Builder {
        /**
         * The Amazon Web Services account ID of the Outposts bucket.
         */
        public var accountId: kotlin.String? = null
        /**
         * Specifies the bucket.
         *
         * For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.
         *
         * For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format `arn:aws:s3-outposts:::outpost//bucket/`. For example, to access the bucket `reports` through Outpost `my-outpost` owned by account `123456789012` in Region `us-west-2`, use the URL encoding of `arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports`. The value must be URL encoded.
         */
        public var bucket: kotlin.String? = null
        /**
         * Set this parameter to true to confirm that you want to remove your permissions to change this bucket policy in the future.
         *
         * This is not supported by Amazon S3 on Outposts buckets.
         */
        public var confirmRemoveSelfBucketAccess: kotlin.Boolean? = null
        /**
         * The bucket policy as a JSON document.
         */
        public var policy: kotlin.String? = null

        @PublishedApi
        internal constructor()
        @PublishedApi
        internal constructor(x: aws.sdk.kotlin.services.s3control.model.PutBucketPolicyRequest) : this() {
            this.accountId = x.accountId
            this.bucket = x.bucket
            this.confirmRemoveSelfBucketAccess = x.confirmRemoveSelfBucketAccess
            this.policy = x.policy
        }

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

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