Amazonka.StorageGateway.JoinDomain

Adds a file gateway to an Active Directory domain. This operation is only supported for file gateways that support the SMB file protocol.

Creating a Request

data JoinDomain

JoinDomainInput

See: newJoinDomain smart constructor.

Constructors

JoinDomain'

Fields

• domainControllers :: Maybe [Text]

  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 (“:”). For example, mydc.mydomain.com:389.

• organizationalUnit :: Maybe Text

  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.

• timeoutInSeconds :: Maybe Natural

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

• gatewayARN :: Text

  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.

• domainName :: Text

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

• userName :: Text

  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 :: Sensitive Text

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

Instances

ToJSON JoinDomain

Defined in Amazonka.StorageGateway.JoinDomain

Methods

toJSON :: JoinDomain -> Value

toEncoding :: JoinDomain -> Encoding

toJSONList :: [JoinDomain] -> Value

toEncodingList :: [JoinDomain] -> Encoding

ToHeaders JoinDomain

Defined in Amazonka.StorageGateway.JoinDomain

Methods

toHeaders :: JoinDomain -> [Header]

ToPath JoinDomain

Defined in Amazonka.StorageGateway.JoinDomain

Methods

toPath :: JoinDomain -> ByteString

ToQuery JoinDomain

Defined in Amazonka.StorageGateway.JoinDomain

Methods

toQuery :: JoinDomain -> QueryString

AWSRequest JoinDomain

Defined in Amazonka.StorageGateway.JoinDomain

Associated Types

type AWSResponse JoinDomain

Methods

request :: (Service -> Service) -> JoinDomain -> Request JoinDomain

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy JoinDomain -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse JoinDomain)))

Generic JoinDomain

Defined in Amazonka.StorageGateway.JoinDomain

Associated Types

type Rep JoinDomain :: Type -> Type

Methods

from :: JoinDomain -> Rep JoinDomain x

to :: Rep JoinDomain x -> JoinDomain

Show JoinDomain

Defined in Amazonka.StorageGateway.JoinDomain

Methods

showsPrec :: Int -> JoinDomain -> ShowS

show :: JoinDomain -> String

showList :: [JoinDomain] -> ShowS

NFData JoinDomain

Defined in Amazonka.StorageGateway.JoinDomain

Methods

rnf :: JoinDomain -> ()

Eq JoinDomain

Defined in Amazonka.StorageGateway.JoinDomain

Methods

(==) :: JoinDomain -> JoinDomain -> Bool

(/=) :: JoinDomain -> JoinDomain -> Bool

Hashable JoinDomain

Defined in Amazonka.StorageGateway.JoinDomain

Methods

hashWithSalt :: Int -> JoinDomain -> Int

hash :: JoinDomain -> Int

type AWSResponse JoinDomain

Defined in Amazonka.StorageGateway.JoinDomain

type AWSResponse JoinDomain = JoinDomainResponse

type Rep JoinDomain

Defined in Amazonka.StorageGateway.JoinDomain

type Rep JoinDomain = D1 ('MetaData "JoinDomain" "Amazonka.StorageGateway.JoinDomain" "amazonka-storagegateway-2.0-A8x7b0LCNm33wkCZlwgcSL" 'False) (C1 ('MetaCons "JoinDomain'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "domainControllers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "organizationalUnit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "timeoutInSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))) :*: ((S1 ('MetaSel ('Just "gatewayARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "userName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "password") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text))))))

newJoinDomain

Arguments

:: Text

JoinDomain

-> Text

$sel:domainName:JoinDomain'

-> Text

$sel:userName:JoinDomain'

-> Text

$sel:password:JoinDomain'

-> JoinDomain

Create a value of JoinDomain with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:domainControllers:JoinDomain', joinDomain_domainControllers - 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 (“:”). For example, mydc.mydomain.com:389.

$sel:organizationalUnit:JoinDomain', joinDomain_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.

$sel:timeoutInSeconds:JoinDomain', joinDomain_timeoutInSeconds - Specifies the time in seconds, in which the JoinDomain operation must complete. The default is 20 seconds.

JoinDomain, joinDomain_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.

$sel:domainName:JoinDomain', joinDomain_domainName - The name of the domain that you want the gateway to join.

$sel:userName:JoinDomain', joinDomain_userName - 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.

$sel:password:JoinDomain', joinDomain_password - Sets the password of the user who has permission to add the gateway to the Active Directory domain.

Request Lenses

joinDomain_domainControllers :: Lens' JoinDomain (Maybe [Text])

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 (“:”). For example, mydc.mydomain.com:389.

joinDomain_organizationalUnit :: Lens' JoinDomain (Maybe Text)

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.

joinDomain_timeoutInSeconds :: Lens' JoinDomain (Maybe Natural)

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

joinDomain_gatewayARN :: Lens' JoinDomain Text

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.

joinDomain_domainName :: Lens' JoinDomain Text

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

joinDomain_userName :: Lens' JoinDomain Text

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.

joinDomain_password :: Lens' JoinDomain Text

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

Destructuring the Response

data JoinDomainResponse

JoinDomainOutput

See: newJoinDomainResponse smart constructor.

Constructors

JoinDomainResponse'

Fields

• activeDirectoryStatus :: Maybe ActiveDirectoryStatus

  Indicates the status of the gateway as a member of the Active Directory domain.

  • ACCESS_DENIED: Indicates that the JoinDomain operation failed due to an authentication error.
  • DETACHED: Indicates that gateway is not joined to a domain.
  • JOINED: Indicates that the gateway has successfully joined a domain.
  • JOINING: Indicates that a JoinDomain operation is in progress.
  • NETWORK_ERROR: Indicates that JoinDomain operation failed due to a network or connectivity error.
  • TIMEOUT: Indicates that the JoinDomain operation failed because the operation didn't complete within the allotted time.
  • UNKNOWN_ERROR: Indicates that the JoinDomain operation failed due to another type of error.
• gatewayARN :: Maybe Text

  The unique Amazon Resource Name (ARN) of the gateway that joined the domain.

• httpStatus :: Int

  The response's http status code.

Instances

Generic JoinDomainResponse

Defined in Amazonka.StorageGateway.JoinDomain

Associated Types

type Rep JoinDomainResponse :: Type -> Type

Methods

from :: JoinDomainResponse -> Rep JoinDomainResponse x

to :: Rep JoinDomainResponse x -> JoinDomainResponse

Read JoinDomainResponse

Defined in Amazonka.StorageGateway.JoinDomain

Methods

readsPrec :: Int -> ReadS JoinDomainResponse

readList :: ReadS [JoinDomainResponse]

readPrec :: ReadPrec JoinDomainResponse

readListPrec :: ReadPrec [JoinDomainResponse]

Show JoinDomainResponse

Defined in Amazonka.StorageGateway.JoinDomain

Methods

showsPrec :: Int -> JoinDomainResponse -> ShowS

show :: JoinDomainResponse -> String

showList :: [JoinDomainResponse] -> ShowS

NFData JoinDomainResponse

Defined in Amazonka.StorageGateway.JoinDomain

Methods

rnf :: JoinDomainResponse -> ()

Eq JoinDomainResponse

Defined in Amazonka.StorageGateway.JoinDomain

Methods

(==) :: JoinDomainResponse -> JoinDomainResponse -> Bool

(/=) :: JoinDomainResponse -> JoinDomainResponse -> Bool

type Rep JoinDomainResponse

Defined in Amazonka.StorageGateway.JoinDomain

type Rep JoinDomainResponse = D1 ('MetaData "JoinDomainResponse" "Amazonka.StorageGateway.JoinDomain" "amazonka-storagegateway-2.0-A8x7b0LCNm33wkCZlwgcSL" 'False) (C1 ('MetaCons "JoinDomainResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "activeDirectoryStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ActiveDirectoryStatus)) :*: (S1 ('MetaSel ('Just "gatewayARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newJoinDomainResponse

Arguments

:: Int

$sel:httpStatus:JoinDomainResponse'

-> JoinDomainResponse

Create a value of JoinDomainResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:activeDirectoryStatus:JoinDomainResponse', joinDomainResponse_activeDirectoryStatus - Indicates the status of the gateway as a member of the Active Directory domain.

• ACCESS_DENIED: Indicates that the JoinDomain operation failed due to an authentication error.
• DETACHED: Indicates that gateway is not joined to a domain.
• JOINED: Indicates that the gateway has successfully joined a domain.
• JOINING: Indicates that a JoinDomain operation is in progress.
• NETWORK_ERROR: Indicates that JoinDomain operation failed due to a network or connectivity error.
• TIMEOUT: Indicates that the JoinDomain operation failed because the operation didn't complete within the allotted time.
• UNKNOWN_ERROR: Indicates that the JoinDomain operation failed due to another type of error.

JoinDomain, joinDomainResponse_gatewayARN - The unique Amazon Resource Name (ARN) of the gateway that joined the domain.

$sel:httpStatus:JoinDomainResponse', joinDomainResponse_httpStatus - The response's http status code.

Response Lenses

joinDomainResponse_activeDirectoryStatus :: Lens' JoinDomainResponse (Maybe ActiveDirectoryStatus)

Indicates the status of the gateway as a member of the Active Directory domain.

• ACCESS_DENIED: Indicates that the JoinDomain operation failed due to an authentication error.
• DETACHED: Indicates that gateway is not joined to a domain.
• JOINED: Indicates that the gateway has successfully joined a domain.
• JOINING: Indicates that a JoinDomain operation is in progress.
• NETWORK_ERROR: Indicates that JoinDomain operation failed due to a network or connectivity error.
• TIMEOUT: Indicates that the JoinDomain operation failed because the operation didn't complete within the allotted time.
• UNKNOWN_ERROR: Indicates that the JoinDomain operation failed due to another type of error.

joinDomainResponse_gatewayARN :: Lens' JoinDomainResponse (Maybe Text)

The unique Amazon Resource Name (ARN) of the gateway that joined the domain.

joinDomainResponse_httpStatus :: Lens' JoinDomainResponse Int

The response's http status code.