Skip to content

JoinDomainInput

Source code in docs_src/capo_storage_gateway/types/join_domain_input.py 
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
class JoinDomainInput(TypedDict, closed=True):
    gateway_arn: "capo_storage_gateway.types.gateway_arn.GatewayARN"
    """<p>The Amazon Resource Name (ARN) of the gateway. Use the <code>ListGateways</code> operation to return a list of gateways for your account and Amazon Web Services Region.</p>"""
    domain_name: "capo_storage_gateway.types.domain_name.DomainName"
    """<p>The name of the domain that you want the gateway to join.</p>"""
    organizational_unit: NotRequired[
        "capo_storage_gateway.types.organizational_unit.OrganizationalUnit"
    ]
    """<p>The organizational unit (OU) is a container in an Active Directory that can hold users, groups, computers, and other OUs and this parameter specifies the OU that the gateway will join within the AD domain.</p>"""
    domain_controllers: NotRequired["capo_storage_gateway.types.hosts.Hosts"]
    """<p>List of IP addresses, NetBIOS names, or host names of your domain server. If you need to specify the port number include it after the colon (“:”). For example, <code>mydc.mydomain.com:389</code>.</p> <note> <p>S3 File Gateway supports IPv6 addresses in addition to IPv4 and other existing formats.</p> <p>FSx File Gateway does not support IPv6.</p> </note>"""
    timeout_in_seconds: NotRequired[
        "capo_storage_gateway.types.timeout_in_seconds.TimeoutInSeconds"
    ]
    """<p>Specifies the time in seconds, in which the <code>JoinDomain</code> operation must complete. The default is 20 seconds.</p>"""
    user_name: "capo_storage_gateway.types.domain_user_name.DomainUserName"
    """<p>Sets the user name of user who has permission to add the gateway to the Active Directory domain. The domain user account should be enabled to join computers to the domain. For example, you can use the domain administrator account or an account with delegated permissions to join computers to the domain.</p>"""
    password: "capo_storage_gateway.types.domain_user_password.DomainUserPassword"
    """<p>Sets the password of the user who has permission to add the gateway to the Active Directory domain.</p>"""

domain_controllers instance-attribute 

domain_controllers: NotRequired[Hosts]

List of IP addresses, NetBIOS names, or host names of your domain server. If you need to specify the port number include it after the colon (“:”). For example, mydc.mydomain.com:389.

S3 File Gateway supports IPv6 addresses in addition to IPv4 and other existing formats.

FSx File Gateway does not support IPv6.

domain_name instance-attribute 

domain_name: DomainName

The name of the domain that you want the gateway to join.

gateway_arn instance-attribute 

gateway_arn: GatewayARN

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

organizational_unit instance-attribute 

organizational_unit: NotRequired[OrganizationalUnit]

The organizational unit (OU) is a container in an Active Directory that can hold users, groups, computers, and other OUs and this parameter specifies the OU that the gateway will join within the AD domain.

password instance-attribute 

password: DomainUserPassword

Sets the password of the user who has permission to add the gateway to the Active Directory domain.

timeout_in_seconds instance-attribute 

timeout_in_seconds: NotRequired[TimeoutInSeconds]

Specifies the time in seconds, in which the JoinDomain operation must complete. The default is 20 seconds.

user_name instance-attribute 

user_name: DomainUserName

Sets the user name of user who has permission to add the gateway to the Active Directory domain. The domain user account should be enabled to join computers to the domain. For example, you can use the domain administrator account or an account with delegated permissions to join computers to the domain.