commonMain.aws.sdk.kotlin.services.elasticbeanstalk.model.TerminateEnvironmentRequest.kt Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of elasticbeanstalk-jvm Show documentation
The AWS SDK for Kotlin client for Elastic Beanstalk
There is a newer version: 1.3.31
// Code generated by smithy-kotlin-codegen. DO NOT EDIT!

package aws.sdk.kotlin.services.elasticbeanstalk.model

import aws.smithy.kotlin.runtime.SdkDsl

/**
 * Request to terminate an environment.
 */
public class TerminateEnvironmentRequest private constructor(builder: Builder) {
    /**
     * The ID of the environment to terminate.
     *
     *  Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns `MissingRequiredParameter` error.
     */
    public val environmentId: kotlin.String? = builder.environmentId
    /**
     * The name of the environment to terminate.
     *
     *  Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns `MissingRequiredParameter` error.
     */
    public val environmentName: kotlin.String? = builder.environmentName
    /**
     * Terminates the target environment even if another environment in the same group is dependent on it.
     */
    public val forceTerminate: kotlin.Boolean? = builder.forceTerminate
    /**
     * Indicates whether the associated AWS resources should shut down when the environment is terminated:
     * + `true`: The specified environment as well as the associated AWS resources, such as Auto Scaling group and LoadBalancer, are terminated.
     * + `false`: AWS Elastic Beanstalk resource management is removed from the environment, but the AWS resources continue to operate.
     *
     *  For more information, see the [ AWS Elastic Beanstalk User Guide. ](https://docs.aws.amazon.com/elasticbeanstalk/latest/ug/)
     *
     *  Default: `true`
     *
     *  Valid Values: `true` | `false`
     */
    public val terminateResources: kotlin.Boolean? = builder.terminateResources

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

    override fun toString(): kotlin.String = buildString {
        append("TerminateEnvironmentRequest(")
        append("environmentId=$environmentId,")
        append("environmentName=$environmentName,")
        append("forceTerminate=$forceTerminate,")
        append("terminateResources=$terminateResources")
        append(")")
    }

    override fun hashCode(): kotlin.Int {
        var result = environmentId?.hashCode() ?: 0
        result = 31 * result + (environmentName?.hashCode() ?: 0)
        result = 31 * result + (forceTerminate?.hashCode() ?: 0)
        result = 31 * result + (terminateResources?.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 TerminateEnvironmentRequest

        if (environmentId != other.environmentId) return false
        if (environmentName != other.environmentName) return false
        if (forceTerminate != other.forceTerminate) return false
        if (terminateResources != other.terminateResources) return false

        return true
    }

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

    @SdkDsl
    public class Builder {
        /**
         * The ID of the environment to terminate.
         *
         *  Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns `MissingRequiredParameter` error.
         */
        public var environmentId: kotlin.String? = null
        /**
         * The name of the environment to terminate.
         *
         *  Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns `MissingRequiredParameter` error.
         */
        public var environmentName: kotlin.String? = null
        /**
         * Terminates the target environment even if another environment in the same group is dependent on it.
         */
        public var forceTerminate: kotlin.Boolean? = null
        /**
         * Indicates whether the associated AWS resources should shut down when the environment is terminated:
         * + `true`: The specified environment as well as the associated AWS resources, such as Auto Scaling group and LoadBalancer, are terminated.
         * + `false`: AWS Elastic Beanstalk resource management is removed from the environment, but the AWS resources continue to operate.
         *
         *  For more information, see the [ AWS Elastic Beanstalk User Guide. ](https://docs.aws.amazon.com/elasticbeanstalk/latest/ug/)
         *
         *  Default: `true`
         *
         *  Valid Values: `true` | `false`
         */
        public var terminateResources: kotlin.Boolean? = null

        @PublishedApi
        internal constructor()
        @PublishedApi
        internal constructor(x: aws.sdk.kotlin.services.elasticbeanstalk.model.TerminateEnvironmentRequest) : this() {
            this.environmentId = x.environmentId
            this.environmentName = x.environmentName
            this.forceTerminate = x.forceTerminate
            this.terminateResources = x.terminateResources
        }

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

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