Copyright	(c) 2013-2018 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.AWS.DirectoryService.AddIPRoutes

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

If the DNS server for your on-premises domain uses a publicly addressable IP address, you must add a CIDR address block to correctly route traffic to and from your Microsoft AD on Amazon Web Services. AddIpRoutes adds this address block. You can also use AddIpRoutes to facilitate routing traffic that uses public IP ranges from your Microsoft AD on AWS to a peer VPC.

Before you call AddIpRoutes , ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the AddIpRoutes operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference .

Synopsis

Creating a Request

addIPRoutes #

Arguments

:: Text	`airDirectoryId`
-> AddIPRoutes

Creates a value of AddIPRoutes with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

airUpdateSecurityGroupForDirectoryControllers - If set to true, updates the inbound and outbound rules of the security group that has the description: "AWS created security group for directory ID directory controllers." Following are the new rules: Inbound: * Type: Custom UDP Rule, Protocol: UDP, Range: 88, Source: 0.0.0.00 * Type: Custom UDP Rule, Protocol: UDP, Range: 123, Source: 0.0.0.00 * Type: Custom UDP Rule, Protocol: UDP, Range: 138, Source: 0.0.0.00 * Type: Custom UDP Rule, Protocol: UDP, Range: 389, Source: 0.0.0.00 * Type: Custom UDP Rule, Protocol: UDP, Range: 464, Source: 0.0.0.00 * Type: Custom UDP Rule, Protocol: UDP, Range: 445, Source: 0.0.0.00 * Type: Custom TCP Rule, Protocol: TCP, Range: 88, Source: 0.0.0.00 * Type: Custom TCP Rule, Protocol: TCP, Range: 135, Source: 0.0.0.00 * Type: Custom TCP Rule, Protocol: TCP, Range: 445, Source: 0.0.0.00 * Type: Custom TCP Rule, Protocol: TCP, Range: 464, Source: 0.0.0.00 * Type: Custom TCP Rule, Protocol: TCP, Range: 636, Source: 0.0.0.00 * Type: Custom TCP Rule, Protocol: TCP, Range: 1024-65535, Source: 0.0.0.00 * Type: Custom TCP Rule, Protocol: TCP, Range: 3268-33269, Source: 0.0.0.00 * Type: DNS (UDP), Protocol: UDP, Range: 53, Source: 0.0.0.00 * Type: DNS (TCP), Protocol: TCP, Range: 53, Source: 0.0.0.00 * Type: LDAP, Protocol: TCP, Range: 389, Source: 0.0.0.00 * Type: All ICMP, Protocol: All, Range: NA, Source: 0.0.0.00 Outbound: * Type: All traffic, Protocol: All, Range: All, Destination: 0.0.0.0/0 These security rules impact an internal network interface that is not exposed publicly.
airDirectoryId - Identifier (ID) of the directory to which to add the address block.
airIPRoutes - IP address blocks, using CIDR format, of the traffic to route. This is often the IP address block of the DNS server used for your on-premises domain.

data AddIPRoutes #

See: addIPRoutes smart constructor.

Instances

Eq AddIPRoutes #
Instance details Defined in Network.AWS.DirectoryService.AddIPRoutes Methods (==) :: AddIPRoutes -> AddIPRoutes -> Bool # (/=) :: AddIPRoutes -> AddIPRoutes -> Bool #
Data AddIPRoutes #
Instance details Defined in Network.AWS.DirectoryService.AddIPRoutes Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> AddIPRoutes -> c AddIPRoutes # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c AddIPRoutes # toConstr :: AddIPRoutes -> Constr # dataTypeOf :: AddIPRoutes -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c AddIPRoutes) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c AddIPRoutes) # gmapT :: (forall b. Data b => b -> b) -> AddIPRoutes -> AddIPRoutes # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> AddIPRoutes -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> AddIPRoutes -> r # gmapQ :: (forall d. Data d => d -> u) -> AddIPRoutes -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> AddIPRoutes -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> AddIPRoutes -> m AddIPRoutes # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> AddIPRoutes -> m AddIPRoutes # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> AddIPRoutes -> m AddIPRoutes #
Read AddIPRoutes #
Instance details Defined in Network.AWS.DirectoryService.AddIPRoutes Methods readsPrec :: Int -> ReadS AddIPRoutes # readList :: ReadS [AddIPRoutes] # readPrec :: ReadPrec AddIPRoutes # readListPrec :: ReadPrec [AddIPRoutes] #
Show AddIPRoutes #
Instance details Defined in Network.AWS.DirectoryService.AddIPRoutes Methods showsPrec :: Int -> AddIPRoutes -> ShowS # show :: AddIPRoutes -> String # showList :: [AddIPRoutes] -> ShowS #
Generic AddIPRoutes #
Instance details Defined in Network.AWS.DirectoryService.AddIPRoutes Associated Types type Rep AddIPRoutes :: Type -> Type # Methods from :: AddIPRoutes -> Rep AddIPRoutes x # to :: Rep AddIPRoutes x -> AddIPRoutes #
Hashable AddIPRoutes #
Instance details Defined in Network.AWS.DirectoryService.AddIPRoutes Methods hashWithSalt :: Int -> AddIPRoutes -> Int # hash :: AddIPRoutes -> Int #
ToJSON AddIPRoutes #
Instance details Defined in Network.AWS.DirectoryService.AddIPRoutes Methods toJSON :: AddIPRoutes -> Value # toEncoding :: AddIPRoutes -> Encoding # toJSONList :: [AddIPRoutes] -> Value # toEncodingList :: [AddIPRoutes] -> Encoding #
AWSRequest AddIPRoutes #
Instance details Defined in Network.AWS.DirectoryService.AddIPRoutes Associated Types type Rs AddIPRoutes :: Type # Methods request :: AddIPRoutes -> Request AddIPRoutes # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy AddIPRoutes -> ClientResponse -> m (Response AddIPRoutes) #
ToHeaders AddIPRoutes #
Instance details Defined in Network.AWS.DirectoryService.AddIPRoutes Methods toHeaders :: AddIPRoutes -> [Header] #
ToPath AddIPRoutes #
Instance details Defined in Network.AWS.DirectoryService.AddIPRoutes Methods toPath :: AddIPRoutes -> ByteString #
ToQuery AddIPRoutes #
Instance details Defined in Network.AWS.DirectoryService.AddIPRoutes Methods toQuery :: AddIPRoutes -> QueryString #
NFData AddIPRoutes #
Instance details Defined in Network.AWS.DirectoryService.AddIPRoutes Methods rnf :: AddIPRoutes -> () #
type Rep AddIPRoutes #
Instance details Defined in Network.AWS.DirectoryService.AddIPRoutes type Rep AddIPRoutes = D1 (MetaData "AddIPRoutes" "Network.AWS.DirectoryService.AddIPRoutes" "amazonka-ds-1.6.1-1iv1gndTenqDVwqckveA92" False) (C1 (MetaCons "AddIPRoutes'" PrefixI True) (S1 (MetaSel (Just "_airUpdateSecurityGroupForDirectoryControllers") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 (MetaSel (Just "_airDirectoryId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: S1 (MetaSel (Just "_airIPRoutes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [IPRoute]))))
type Rs AddIPRoutes #
Instance details Defined in Network.AWS.DirectoryService.AddIPRoutes type Rs AddIPRoutes = AddIPRoutesResponse

Request Lenses

airUpdateSecurityGroupForDirectoryControllers :: Lens' AddIPRoutes (Maybe Bool) #

If set to true, updates the inbound and outbound rules of the security group that has the description: "AWS created security group for directory ID directory controllers." Following are the new rules: Inbound: * Type: Custom UDP Rule, Protocol: UDP, Range: 88, Source: 0.0.0.00 * Type: Custom UDP Rule, Protocol: UDP, Range: 123, Source: 0.0.0.00 * Type: Custom UDP Rule, Protocol: UDP, Range: 138, Source: 0.0.0.00 * Type: Custom UDP Rule, Protocol: UDP, Range: 389, Source: 0.0.0.00 * Type: Custom UDP Rule, Protocol: UDP, Range: 464, Source: 0.0.0.00 * Type: Custom UDP Rule, Protocol: UDP, Range: 445, Source: 0.0.0.00 * Type: Custom TCP Rule, Protocol: TCP, Range: 88, Source: 0.0.0.00 * Type: Custom TCP Rule, Protocol: TCP, Range: 135, Source: 0.0.0.00 * Type: Custom TCP Rule, Protocol: TCP, Range: 445, Source: 0.0.0.00 * Type: Custom TCP Rule, Protocol: TCP, Range: 464, Source: 0.0.0.00 * Type: Custom TCP Rule, Protocol: TCP, Range: 636, Source: 0.0.0.00 * Type: Custom TCP Rule, Protocol: TCP, Range: 1024-65535, Source: 0.0.0.00 * Type: Custom TCP Rule, Protocol: TCP, Range: 3268-33269, Source: 0.0.0.00 * Type: DNS (UDP), Protocol: UDP, Range: 53, Source: 0.0.0.00 * Type: DNS (TCP), Protocol: TCP, Range: 53, Source: 0.0.0.00 * Type: LDAP, Protocol: TCP, Range: 389, Source: 0.0.0.00 * Type: All ICMP, Protocol: All, Range: NA, Source: 0.0.0.00 Outbound: * Type: All traffic, Protocol: All, Range: All, Destination: 0.0.0.0/0 These security rules impact an internal network interface that is not exposed publicly.

airDirectoryId :: Lens' AddIPRoutes Text #

Identifier (ID) of the directory to which to add the address block.

airIPRoutes :: Lens' AddIPRoutes [IPRoute] #

IP address blocks, using CIDR format, of the traffic to route. This is often the IP address block of the DNS server used for your on-premises domain.

Destructuring the Response

addIPRoutesResponse #

Arguments

:: Int	`airrsResponseStatus`
-> AddIPRoutesResponse

Creates a value of AddIPRoutesResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

airrsResponseStatus - -- | The response status code.

data AddIPRoutesResponse #

See: addIPRoutesResponse smart constructor.

Instances

Eq AddIPRoutesResponse #
Instance details Defined in Network.AWS.DirectoryService.AddIPRoutes Methods (==) :: AddIPRoutesResponse -> AddIPRoutesResponse -> Bool # (/=) :: AddIPRoutesResponse -> AddIPRoutesResponse -> Bool #
Data AddIPRoutesResponse #
Instance details Defined in Network.AWS.DirectoryService.AddIPRoutes Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> AddIPRoutesResponse -> c AddIPRoutesResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c AddIPRoutesResponse # toConstr :: AddIPRoutesResponse -> Constr # dataTypeOf :: AddIPRoutesResponse -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c AddIPRoutesResponse) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c AddIPRoutesResponse) # gmapT :: (forall b. Data b => b -> b) -> AddIPRoutesResponse -> AddIPRoutesResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> AddIPRoutesResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> AddIPRoutesResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> AddIPRoutesResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> AddIPRoutesResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> AddIPRoutesResponse -> m AddIPRoutesResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> AddIPRoutesResponse -> m AddIPRoutesResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> AddIPRoutesResponse -> m AddIPRoutesResponse #
Read AddIPRoutesResponse #
Instance details Defined in Network.AWS.DirectoryService.AddIPRoutes Methods readsPrec :: Int -> ReadS AddIPRoutesResponse # readList :: ReadS [AddIPRoutesResponse] # readPrec :: ReadPrec AddIPRoutesResponse # readListPrec :: ReadPrec [AddIPRoutesResponse] #
Show AddIPRoutesResponse #
Instance details Defined in Network.AWS.DirectoryService.AddIPRoutes Methods showsPrec :: Int -> AddIPRoutesResponse -> ShowS # show :: AddIPRoutesResponse -> String # showList :: [AddIPRoutesResponse] -> ShowS #
Generic AddIPRoutesResponse #
Instance details Defined in Network.AWS.DirectoryService.AddIPRoutes Associated Types type Rep AddIPRoutesResponse :: Type -> Type # Methods from :: AddIPRoutesResponse -> Rep AddIPRoutesResponse x # to :: Rep AddIPRoutesResponse x -> AddIPRoutesResponse #
NFData AddIPRoutesResponse #
Instance details Defined in Network.AWS.DirectoryService.AddIPRoutes Methods rnf :: AddIPRoutesResponse -> () #
type Rep AddIPRoutesResponse #
Instance details Defined in Network.AWS.DirectoryService.AddIPRoutes type Rep AddIPRoutesResponse = D1 (MetaData "AddIPRoutesResponse" "Network.AWS.DirectoryService.AddIPRoutes" "amazonka-ds-1.6.1-1iv1gndTenqDVwqckveA92" True) (C1 (MetaCons "AddIPRoutesResponse'" PrefixI True) (S1 (MetaSel (Just "_airrsResponseStatus") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int)))

Response Lenses

airrsResponseStatus :: Lens' AddIPRoutesResponse Int #

- | The response status code.