/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.fsx.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.protocol.StructuredPojo; import com.amazonaws.protocol.ProtocolMarshaller; /** *

* The configuration that Amazon FSx uses to join a FSx for Windows File Server file system or an FSx for ONTAP storage * virtual machine (SVM) to a self-managed (including on-premises) Microsoft Active Directory (AD) directory. For more * information, see Using Amazon FSx * for Windows with your self-managed Microsoft Active Directory or Managing FSx for ONTAP SVMs. *

* * @see AWS API Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class SelfManagedActiveDirectoryConfiguration implements Serializable, Cloneable, StructuredPojo { /** *

* The fully qualified domain name of the self-managed AD directory, such as corp.example.com. *

*/ private String domainName; /** *

* (Optional) The fully qualified distinguished name of the organizational unit within your self-managed AD * directory. Amazon FSx only accepts OU as the direct parent of the file system. An example is * OU=FSx,DC=yourdomain,DC=corp,DC=com. To learn more, see RFC 2253. If none is provided, the FSx file system is created in * the default location of your self-managed AD directory. *

* *

* Only Organizational Unit (OU) objects can be the direct parent of the file system that you're creating. *

* */ private String organizationalUnitDistinguishedName; /** *

* (Optional) The name of the domain group whose members are granted administrative privileges for the file system. * Administrative privileges include taking ownership of files and folders, setting audit controls (audit ACLs) on * files and folders, and administering the file system remotely by using the FSx Remote PowerShell. The group that * you specify must already exist in your domain. If you don't provide one, your AD domain's Domain Admins group is * used. *

*/ private String fileSystemAdministratorsGroup; /** *

* The user name for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD * domain. This account must have the permission to join computers to the domain in the organizational unit provided * in OrganizationalUnitDistinguishedName, or in the default location of your AD domain. *

*/ private String userName; /** *

* The password for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD * domain. *

*/ private String password; /** *

* A list of up to three IP addresses of DNS servers or domain controllers in the self-managed AD directory. *

*/ private java.util.List dnsIps; /** *

* The fully qualified domain name of the self-managed AD directory, such as corp.example.com. *

* * @param domainName * The fully qualified domain name of the self-managed AD directory, such as corp.example.com. */ public void setDomainName(String domainName) { this.domainName = domainName; } /** *

* The fully qualified domain name of the self-managed AD directory, such as corp.example.com. *

* * @return The fully qualified domain name of the self-managed AD directory, such as corp.example.com. */ public String getDomainName() { return this.domainName; } /** *

* The fully qualified domain name of the self-managed AD directory, such as corp.example.com. *

* * @param domainName * The fully qualified domain name of the self-managed AD directory, such as corp.example.com. * @return Returns a reference to this object so that method calls can be chained together. */ public SelfManagedActiveDirectoryConfiguration withDomainName(String domainName) { setDomainName(domainName); return this; } /** *

* (Optional) The fully qualified distinguished name of the organizational unit within your self-managed AD * directory. Amazon FSx only accepts OU as the direct parent of the file system. An example is * OU=FSx,DC=yourdomain,DC=corp,DC=com. To learn more, see RFC 2253. If none is provided, the FSx file system is created in * the default location of your self-managed AD directory. *

* *

* Only Organizational Unit (OU) objects can be the direct parent of the file system that you're creating. *

* * * @param organizationalUnitDistinguishedName * (Optional) The fully qualified distinguished name of the organizational unit within your self-managed AD * directory. Amazon FSx only accepts OU as the direct parent of the file system. An example is * OU=FSx,DC=yourdomain,DC=corp,DC=com. To learn more, see RFC 2253. If none is provided, the FSx file system is * created in the default location of your self-managed AD directory.

*

* Only Organizational Unit (OU) objects can be the direct parent of the file system that you're creating. *

*/ public void setOrganizationalUnitDistinguishedName(String organizationalUnitDistinguishedName) { this.organizationalUnitDistinguishedName = organizationalUnitDistinguishedName; } /** *

* (Optional) The fully qualified distinguished name of the organizational unit within your self-managed AD * directory. Amazon FSx only accepts OU as the direct parent of the file system. An example is * OU=FSx,DC=yourdomain,DC=corp,DC=com. To learn more, see RFC 2253. If none is provided, the FSx file system is created in * the default location of your self-managed AD directory. *

* *

* Only Organizational Unit (OU) objects can be the direct parent of the file system that you're creating. *

* * * @return (Optional) The fully qualified distinguished name of the organizational unit within your self-managed AD * directory. Amazon FSx only accepts OU as the direct parent of the file system. An example is * OU=FSx,DC=yourdomain,DC=corp,DC=com. To learn more, see RFC 2253. If none is provided, the FSx file system is * created in the default location of your self-managed AD directory.

*

* Only Organizational Unit (OU) objects can be the direct parent of the file system that you're creating. *

*/ public String getOrganizationalUnitDistinguishedName() { return this.organizationalUnitDistinguishedName; } /** *

* (Optional) The fully qualified distinguished name of the organizational unit within your self-managed AD * directory. Amazon FSx only accepts OU as the direct parent of the file system. An example is * OU=FSx,DC=yourdomain,DC=corp,DC=com. To learn more, see RFC 2253. If none is provided, the FSx file system is created in * the default location of your self-managed AD directory. *

* *

* Only Organizational Unit (OU) objects can be the direct parent of the file system that you're creating. *

* * * @param organizationalUnitDistinguishedName * (Optional) The fully qualified distinguished name of the organizational unit within your self-managed AD * directory. Amazon FSx only accepts OU as the direct parent of the file system. An example is * OU=FSx,DC=yourdomain,DC=corp,DC=com. To learn more, see RFC 2253. If none is provided, the FSx file system is * created in the default location of your self-managed AD directory.

*

* Only Organizational Unit (OU) objects can be the direct parent of the file system that you're creating. *

* @return Returns a reference to this object so that method calls can be chained together. */ public SelfManagedActiveDirectoryConfiguration withOrganizationalUnitDistinguishedName(String organizationalUnitDistinguishedName) { setOrganizationalUnitDistinguishedName(organizationalUnitDistinguishedName); return this; } /** *

* (Optional) The name of the domain group whose members are granted administrative privileges for the file system. * Administrative privileges include taking ownership of files and folders, setting audit controls (audit ACLs) on * files and folders, and administering the file system remotely by using the FSx Remote PowerShell. The group that * you specify must already exist in your domain. If you don't provide one, your AD domain's Domain Admins group is * used. *

* * @param fileSystemAdministratorsGroup * (Optional) The name of the domain group whose members are granted administrative privileges for the file * system. Administrative privileges include taking ownership of files and folders, setting audit controls * (audit ACLs) on files and folders, and administering the file system remotely by using the FSx Remote * PowerShell. The group that you specify must already exist in your domain. If you don't provide one, your * AD domain's Domain Admins group is used. */ public void setFileSystemAdministratorsGroup(String fileSystemAdministratorsGroup) { this.fileSystemAdministratorsGroup = fileSystemAdministratorsGroup; } /** *

* (Optional) The name of the domain group whose members are granted administrative privileges for the file system. * Administrative privileges include taking ownership of files and folders, setting audit controls (audit ACLs) on * files and folders, and administering the file system remotely by using the FSx Remote PowerShell. The group that * you specify must already exist in your domain. If you don't provide one, your AD domain's Domain Admins group is * used. *

* * @return (Optional) The name of the domain group whose members are granted administrative privileges for the file * system. Administrative privileges include taking ownership of files and folders, setting audit controls * (audit ACLs) on files and folders, and administering the file system remotely by using the FSx Remote * PowerShell. The group that you specify must already exist in your domain. If you don't provide one, your * AD domain's Domain Admins group is used. */ public String getFileSystemAdministratorsGroup() { return this.fileSystemAdministratorsGroup; } /** *

* (Optional) The name of the domain group whose members are granted administrative privileges for the file system. * Administrative privileges include taking ownership of files and folders, setting audit controls (audit ACLs) on * files and folders, and administering the file system remotely by using the FSx Remote PowerShell. The group that * you specify must already exist in your domain. If you don't provide one, your AD domain's Domain Admins group is * used. *

* * @param fileSystemAdministratorsGroup * (Optional) The name of the domain group whose members are granted administrative privileges for the file * system. Administrative privileges include taking ownership of files and folders, setting audit controls * (audit ACLs) on files and folders, and administering the file system remotely by using the FSx Remote * PowerShell. The group that you specify must already exist in your domain. If you don't provide one, your * AD domain's Domain Admins group is used. * @return Returns a reference to this object so that method calls can be chained together. */ public SelfManagedActiveDirectoryConfiguration withFileSystemAdministratorsGroup(String fileSystemAdministratorsGroup) { setFileSystemAdministratorsGroup(fileSystemAdministratorsGroup); return this; } /** *

* The user name for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD * domain. This account must have the permission to join computers to the domain in the organizational unit provided * in OrganizationalUnitDistinguishedName, or in the default location of your AD domain. *

* * @param userName * The user name for the service account on your self-managed AD domain that Amazon FSx will use to join to * your AD domain. This account must have the permission to join computers to the domain in the * organizational unit provided in OrganizationalUnitDistinguishedName, or in the default * location of your AD domain. */ public void setUserName(String userName) { this.userName = userName; } /** *

* The user name for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD * domain. This account must have the permission to join computers to the domain in the organizational unit provided * in OrganizationalUnitDistinguishedName, or in the default location of your AD domain. *

* * @return The user name for the service account on your self-managed AD domain that Amazon FSx will use to join to * your AD domain. This account must have the permission to join computers to the domain in the * organizational unit provided in OrganizationalUnitDistinguishedName, or in the default * location of your AD domain. */ public String getUserName() { return this.userName; } /** *

* The user name for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD * domain. This account must have the permission to join computers to the domain in the organizational unit provided * in OrganizationalUnitDistinguishedName, or in the default location of your AD domain. *

* * @param userName * The user name for the service account on your self-managed AD domain that Amazon FSx will use to join to * your AD domain. This account must have the permission to join computers to the domain in the * organizational unit provided in OrganizationalUnitDistinguishedName, or in the default * location of your AD domain. * @return Returns a reference to this object so that method calls can be chained together. */ public SelfManagedActiveDirectoryConfiguration withUserName(String userName) { setUserName(userName); return this; } /** *

* The password for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD * domain. *

* * @param password * The password for the service account on your self-managed AD domain that Amazon FSx will use to join to * your AD domain. */ public void setPassword(String password) { this.password = password; } /** *

* The password for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD * domain. *

* * @return The password for the service account on your self-managed AD domain that Amazon FSx will use to join to * your AD domain. */ public String getPassword() { return this.password; } /** *

* The password for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD * domain. *

* * @param password * The password for the service account on your self-managed AD domain that Amazon FSx will use to join to * your AD domain. * @return Returns a reference to this object so that method calls can be chained together. */ public SelfManagedActiveDirectoryConfiguration withPassword(String password) { setPassword(password); return this; } /** *

* A list of up to three IP addresses of DNS servers or domain controllers in the self-managed AD directory. *

* * @return A list of up to three IP addresses of DNS servers or domain controllers in the self-managed AD directory. */ public java.util.List getDnsIps() { return dnsIps; } /** *

* A list of up to three IP addresses of DNS servers or domain controllers in the self-managed AD directory. *

* * @param dnsIps * A list of up to three IP addresses of DNS servers or domain controllers in the self-managed AD directory. */ public void setDnsIps(java.util.Collection dnsIps) { if (dnsIps == null) { this.dnsIps = null; return; } this.dnsIps = new java.util.ArrayList(dnsIps); } /** *

* A list of up to three IP addresses of DNS servers or domain controllers in the self-managed AD directory. *

*

* NOTE: This method appends the values to the existing list (if any). Use * {@link #setDnsIps(java.util.Collection)} or {@link #withDnsIps(java.util.Collection)} if you want to override the * existing values. *

* * @param dnsIps * A list of up to three IP addresses of DNS servers or domain controllers in the self-managed AD directory. * @return Returns a reference to this object so that method calls can be chained together. */ public SelfManagedActiveDirectoryConfiguration withDnsIps(String... dnsIps) { if (this.dnsIps == null) { setDnsIps(new java.util.ArrayList(dnsIps.length)); } for (String ele : dnsIps) { this.dnsIps.add(ele); } return this; } /** *

* A list of up to three IP addresses of DNS servers or domain controllers in the self-managed AD directory. *

* * @param dnsIps * A list of up to three IP addresses of DNS servers or domain controllers in the self-managed AD directory. * @return Returns a reference to this object so that method calls can be chained together. */ public SelfManagedActiveDirectoryConfiguration withDnsIps(java.util.Collection dnsIps) { setDnsIps(dnsIps); return this; } /** * Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be * redacted from this string using a placeholder value. * * @return A string representation of this object. * * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getDomainName() != null) sb.append("DomainName: ").append(getDomainName()).append(","); if (getOrganizationalUnitDistinguishedName() != null) sb.append("OrganizationalUnitDistinguishedName: ").append(getOrganizationalUnitDistinguishedName()).append(","); if (getFileSystemAdministratorsGroup() != null) sb.append("FileSystemAdministratorsGroup: ").append(getFileSystemAdministratorsGroup()).append(","); if (getUserName() != null) sb.append("UserName: ").append(getUserName()).append(","); if (getPassword() != null) sb.append("Password: ").append("***Sensitive Data Redacted***").append(","); if (getDnsIps() != null) sb.append("DnsIps: ").append(getDnsIps()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof SelfManagedActiveDirectoryConfiguration == false) return false; SelfManagedActiveDirectoryConfiguration other = (SelfManagedActiveDirectoryConfiguration) obj; if (other.getDomainName() == null ^ this.getDomainName() == null) return false; if (other.getDomainName() != null && other.getDomainName().equals(this.getDomainName()) == false) return false; if (other.getOrganizationalUnitDistinguishedName() == null ^ this.getOrganizationalUnitDistinguishedName() == null) return false; if (other.getOrganizationalUnitDistinguishedName() != null && other.getOrganizationalUnitDistinguishedName().equals(this.getOrganizationalUnitDistinguishedName()) == false) return false; if (other.getFileSystemAdministratorsGroup() == null ^ this.getFileSystemAdministratorsGroup() == null) return false; if (other.getFileSystemAdministratorsGroup() != null && other.getFileSystemAdministratorsGroup().equals(this.getFileSystemAdministratorsGroup()) == false) return false; if (other.getUserName() == null ^ this.getUserName() == null) return false; if (other.getUserName() != null && other.getUserName().equals(this.getUserName()) == false) return false; if (other.getPassword() == null ^ this.getPassword() == null) return false; if (other.getPassword() != null && other.getPassword().equals(this.getPassword()) == false) return false; if (other.getDnsIps() == null ^ this.getDnsIps() == null) return false; if (other.getDnsIps() != null && other.getDnsIps().equals(this.getDnsIps()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getDomainName() == null) ? 0 : getDomainName().hashCode()); hashCode = prime * hashCode + ((getOrganizationalUnitDistinguishedName() == null) ? 0 : getOrganizationalUnitDistinguishedName().hashCode()); hashCode = prime * hashCode + ((getFileSystemAdministratorsGroup() == null) ? 0 : getFileSystemAdministratorsGroup().hashCode()); hashCode = prime * hashCode + ((getUserName() == null) ? 0 : getUserName().hashCode()); hashCode = prime * hashCode + ((getPassword() == null) ? 0 : getPassword().hashCode()); hashCode = prime * hashCode + ((getDnsIps() == null) ? 0 : getDnsIps().hashCode()); return hashCode; } @Override public SelfManagedActiveDirectoryConfiguration clone() { try { return (SelfManagedActiveDirectoryConfiguration) super.clone(); } catch (CloneNotSupportedException e) { throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e); } } @com.amazonaws.annotation.SdkInternalApi @Override public void marshall(ProtocolMarshaller protocolMarshaller) { com.amazonaws.services.fsx.model.transform.SelfManagedActiveDirectoryConfigurationMarshaller.getInstance().marshall(this, protocolMarshaller); } }