commonMain.aws.sdk.kotlin.services.datasync.model.CreateLocationFsxWindowsRequest.kt Maven / Gradle / Ivy

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

package aws.sdk.kotlin.services.datasync.model

import aws.smithy.kotlin.runtime.SdkDsl

public class CreateLocationFsxWindowsRequest private constructor(builder: Builder) {
    /**
     * Specifies the name of the Microsoft Active Directory domain that the FSx for Windows File Server file system belongs to.
     *
     * If you have multiple Active Directory domains in your environment, configuring this parameter makes sure that DataSync connects to the right file system.
     */
    public val domain: kotlin.String? = builder.domain
    /**
     * Specifies the Amazon Resource Name (ARN) for the FSx for Windows File Server file system.
     */
    public val fsxFilesystemArn: kotlin.String? = builder.fsxFilesystemArn
    /**
     * Specifies the password of the user with the permissions to mount and access the files, folders, and file metadata in your FSx for Windows File Server file system.
     */
    public val password: kotlin.String? = builder.password
    /**
     * Specifies the ARNs of the Amazon EC2 security groups that provide access to your file system's preferred subnet.
     *
     * The security groups that you specify must be able to communicate with your file system's security groups. For information about configuring security groups for file system access, see the *Amazon FSx for Windows File Server User Guide*[](https://docs.aws.amazon.com/fsx/latest/WindowsGuide/limit-access-security-groups.html).
     *
     * If you choose a security group that doesn't allow connections from within itself, do one of the following:
     * + Configure the security group to allow it to communicate within itself.
     * + Choose a different security group that can communicate with the mount target's security group.
     */
    public val securityGroupArns: List? = builder.securityGroupArns
    /**
     * Specifies a mount path for your file system using forward slashes. This is where DataSync reads or writes data (depending on if this is a source or destination location).
     */
    public val subdirectory: kotlin.String? = builder.subdirectory
    /**
     * Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least a name tag for your location.
     */
    public val tags: List? = builder.tags
    /**
     * Specifies the user with the permissions to mount and access the files, folders, and file metadata in your FSx for Windows File Server file system.
     *
     * For information about choosing a user with the right level of access for your transfer, see [required permissions](https://docs.aws.amazon.com/datasync/latest/userguide/create-fsx-location.html#create-fsx-windows-location-permissions) for FSx for Windows File Server locations.
     */
    public val user: kotlin.String? = builder.user

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

    override fun toString(): kotlin.String = buildString {
        append("CreateLocationFsxWindowsRequest(")
        append("domain=$domain,")
        append("fsxFilesystemArn=$fsxFilesystemArn,")
        append("password=*** Sensitive Data Redacted ***,")
        append("securityGroupArns=$securityGroupArns,")
        append("subdirectory=$subdirectory,")
        append("tags=$tags,")
        append("user=$user")
        append(")")
    }

    override fun hashCode(): kotlin.Int {
        var result = domain?.hashCode() ?: 0
        result = 31 * result + (fsxFilesystemArn?.hashCode() ?: 0)
        result = 31 * result + (password?.hashCode() ?: 0)
        result = 31 * result + (securityGroupArns?.hashCode() ?: 0)
        result = 31 * result + (subdirectory?.hashCode() ?: 0)
        result = 31 * result + (tags?.hashCode() ?: 0)
        result = 31 * result + (user?.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 CreateLocationFsxWindowsRequest

        if (domain != other.domain) return false
        if (fsxFilesystemArn != other.fsxFilesystemArn) return false
        if (password != other.password) return false
        if (securityGroupArns != other.securityGroupArns) return false
        if (subdirectory != other.subdirectory) return false
        if (tags != other.tags) return false
        if (user != other.user) return false

        return true
    }

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

    @SdkDsl
    public class Builder {
        /**
         * Specifies the name of the Microsoft Active Directory domain that the FSx for Windows File Server file system belongs to.
         *
         * If you have multiple Active Directory domains in your environment, configuring this parameter makes sure that DataSync connects to the right file system.
         */
        public var domain: kotlin.String? = null
        /**
         * Specifies the Amazon Resource Name (ARN) for the FSx for Windows File Server file system.
         */
        public var fsxFilesystemArn: kotlin.String? = null
        /**
         * Specifies the password of the user with the permissions to mount and access the files, folders, and file metadata in your FSx for Windows File Server file system.
         */
        public var password: kotlin.String? = null
        /**
         * Specifies the ARNs of the Amazon EC2 security groups that provide access to your file system's preferred subnet.
         *
         * The security groups that you specify must be able to communicate with your file system's security groups. For information about configuring security groups for file system access, see the *Amazon FSx for Windows File Server User Guide*[](https://docs.aws.amazon.com/fsx/latest/WindowsGuide/limit-access-security-groups.html).
         *
         * If you choose a security group that doesn't allow connections from within itself, do one of the following:
         * + Configure the security group to allow it to communicate within itself.
         * + Choose a different security group that can communicate with the mount target's security group.
         */
        public var securityGroupArns: List? = null
        /**
         * Specifies a mount path for your file system using forward slashes. This is where DataSync reads or writes data (depending on if this is a source or destination location).
         */
        public var subdirectory: kotlin.String? = null
        /**
         * Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least a name tag for your location.
         */
        public var tags: List? = null
        /**
         * Specifies the user with the permissions to mount and access the files, folders, and file metadata in your FSx for Windows File Server file system.
         *
         * For information about choosing a user with the right level of access for your transfer, see [required permissions](https://docs.aws.amazon.com/datasync/latest/userguide/create-fsx-location.html#create-fsx-windows-location-permissions) for FSx for Windows File Server locations.
         */
        public var user: kotlin.String? = null

        @PublishedApi
        internal constructor()
        @PublishedApi
        internal constructor(x: aws.sdk.kotlin.services.datasync.model.CreateLocationFsxWindowsRequest) : this() {
            this.domain = x.domain
            this.fsxFilesystemArn = x.fsxFilesystemArn
            this.password = x.password
            this.securityGroupArns = x.securityGroupArns
            this.subdirectory = x.subdirectory
            this.tags = x.tags
            this.user = x.user
        }

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

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