JoinDomainInput is a JSON Structure definition published by Amazon Storage Gateway, describing 7 properties, of which 4 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.
{
"type": "object",
"$schema": "https://json-structure.org/meta/core/v0/#",
"$id": "https://raw.githubusercontent.com/api-evangelist/amazon-storage-gateway/refs/heads/main/json-structure/amazon-storage-gateway-join-domain-input-structure.json",
"name": "JoinDomainInput",
"description": "JoinDomainInput",
"properties": {
"GatewayARN": {
"allOf": [
{
"$ref": "#/components/schemas/GatewayARN"
},
{
"description": "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."
}
]
},
"DomainName": {
"allOf": [
{
"$ref": "#/components/schemas/DomainName"
},
{
"description": "The name of the domain that you want the gateway to join."
}
]
},
"OrganizationalUnit": {
"allOf": [
{
"$ref": "#/components/schemas/OrganizationalUnit"
},
{
"description": "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."
}
]
},
"DomainControllers": {
"allOf": [
{
"$ref": "#/components/schemas/Hosts"
},
{
"description": "List of IPv4 addresses, NetBIOS names, or host names of your domain server. If you need to specify the port number include it after the colon (\u201c:\u201d). For example, <code>mydc.mydomain.com:389</code>."
}
]
},
"TimeoutInSeconds": {
"allOf": [
{
"$ref": "#/components/schemas/TimeoutInSeconds"
},
{
"description": "Specifies the time in seconds, in which the <code>JoinDomain</code> operation must complete. The default is 20 seconds."
}
]
},
"UserName": {
"allOf": [
{
"$ref": "#/components/schemas/DomainUserName"
},
{
"description": "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."
}
]
},
"Password": {
"allOf": [
{
"$ref": "#/components/schemas/DomainUserPassword"
},
{
"description": "Sets the password of the user who has permission to add the gateway to the Active Directory domain."
}
]
}
},
"required": [
"GatewayARN",
"DomainName",
"UserName",
"Password"
]
}
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.