Copyright	(c) 2013-2021 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

Amazonka.DirectoryService.AddIpRoutes

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

If the DNS server for your self-managed 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 Amazon Web Services 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 Directory Service API Permissions: Actions, Resources, and Conditions Reference.

Creating a Request

data AddIpRoutes Source #

See: newAddIpRoutes smart constructor.

Constructors

AddIpRoutes'

Fields

updateSecurityGroupForDirectoryControllers :: Maybe Bool
If set to true, updates the inbound and outbound rules of the security group that has the description: "Amazon Web Services 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.0/0
- Type: Custom UDP Rule, Protocol: UDP, Range: 123, Source: 0.0.0.0/0
- Type: Custom UDP Rule, Protocol: UDP, Range: 138, Source: 0.0.0.0/0
- Type: Custom UDP Rule, Protocol: UDP, Range: 389, Source: 0.0.0.0/0
- Type: Custom UDP Rule, Protocol: UDP, Range: 464, Source: 0.0.0.0/0
- Type: Custom UDP Rule, Protocol: UDP, Range: 445, Source: 0.0.0.0/0
- Type: Custom TCP Rule, Protocol: TCP, Range: 88, Source: 0.0.0.0/0
- Type: Custom TCP Rule, Protocol: TCP, Range: 135, Source: 0.0.0.0/0
- Type: Custom TCP Rule, Protocol: TCP, Range: 445, Source: 0.0.0.0/0
- Type: Custom TCP Rule, Protocol: TCP, Range: 464, Source: 0.0.0.0/0
- Type: Custom TCP Rule, Protocol: TCP, Range: 636, Source: 0.0.0.0/0
- Type: Custom TCP Rule, Protocol: TCP, Range: 1024-65535, Source: 0.0.0.0/0
- Type: Custom TCP Rule, Protocol: TCP, Range: 3268-33269, Source: 0.0.0.0/0
- Type: DNS (UDP), Protocol: UDP, Range: 53, Source: 0.0.0.0/0
- Type: DNS (TCP), Protocol: TCP, Range: 53, Source: 0.0.0.0/0
- Type: LDAP, Protocol: TCP, Range: 389, Source: 0.0.0.0/0
- Type: All ICMP, Protocol: All, Range: N/A, Source: 0.0.0.0/0
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.
directoryId :: Text
Identifier (ID) of the directory to which to add the address block.
ipRoutes :: [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 self-managed domain.

Instances

Instances details

Eq AddIpRoutes Source #
Instance details Defined in Amazonka.DirectoryService.AddIpRoutes Methods (==) :: AddIpRoutes -> AddIpRoutes -> Bool # (/=) :: AddIpRoutes -> AddIpRoutes -> Bool #
Read AddIpRoutes Source #
Instance details Defined in Amazonka.DirectoryService.AddIpRoutes Methods readsPrec :: Int -> ReadS AddIpRoutes # readList :: ReadS [AddIpRoutes] # readPrec :: ReadPrec AddIpRoutes # readListPrec :: ReadPrec [AddIpRoutes] #
Show AddIpRoutes Source #
Instance details Defined in Amazonka.DirectoryService.AddIpRoutes Methods showsPrec :: Int -> AddIpRoutes -> ShowS # show :: AddIpRoutes -> String # showList :: [AddIpRoutes] -> ShowS #
Generic AddIpRoutes Source #
Instance details Defined in Amazonka.DirectoryService.AddIpRoutes Associated Types type Rep AddIpRoutes :: Type -> Type # Methods from :: AddIpRoutes -> Rep AddIpRoutes x # to :: Rep AddIpRoutes x -> AddIpRoutes #
NFData AddIpRoutes Source #
Instance details Defined in Amazonka.DirectoryService.AddIpRoutes Methods rnf :: AddIpRoutes -> () #
Hashable AddIpRoutes Source #
Instance details Defined in Amazonka.DirectoryService.AddIpRoutes Methods hashWithSalt :: Int -> AddIpRoutes -> Int # hash :: AddIpRoutes -> Int #
ToJSON AddIpRoutes Source #
Instance details Defined in Amazonka.DirectoryService.AddIpRoutes Methods toJSON :: AddIpRoutes -> Value # toEncoding :: AddIpRoutes -> Encoding # toJSONList :: [AddIpRoutes] -> Value # toEncodingList :: [AddIpRoutes] -> Encoding #
AWSRequest AddIpRoutes Source #
Instance details Defined in Amazonka.DirectoryService.AddIpRoutes Associated Types type AWSResponse AddIpRoutes # Methods request :: AddIpRoutes -> Request AddIpRoutes # response :: MonadResource m => Logger -> Service -> Proxy AddIpRoutes -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse AddIpRoutes))) #
ToHeaders AddIpRoutes Source #
Instance details Defined in Amazonka.DirectoryService.AddIpRoutes Methods toHeaders :: AddIpRoutes -> [Header] #
ToPath AddIpRoutes Source #
Instance details Defined in Amazonka.DirectoryService.AddIpRoutes Methods toPath :: AddIpRoutes -> ByteString #
ToQuery AddIpRoutes Source #
Instance details Defined in Amazonka.DirectoryService.AddIpRoutes Methods toQuery :: AddIpRoutes -> QueryString #
type Rep AddIpRoutes Source #
Instance details Defined in Amazonka.DirectoryService.AddIpRoutes type Rep AddIpRoutes = D1 ('MetaData "AddIpRoutes" "Amazonka.DirectoryService.AddIpRoutes" "libZSservicesZSamazonka-dsZSamazonka-ds" 'False) (C1 ('MetaCons "AddIpRoutes'" 'PrefixI 'True) (S1 ('MetaSel ('Just "updateSecurityGroupForDirectoryControllers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "directoryId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "ipRoutes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [IpRoute]))))
type AWSResponse AddIpRoutes Source #
Instance details Defined in Amazonka.DirectoryService.AddIpRoutes type AWSResponse AddIpRoutes = AddIpRoutesResponse

newAddIpRoutes Source #

Arguments

:: Text	`$sel:directoryId:AddIpRoutes'`
-> AddIpRoutes

Create a value of AddIpRoutes 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:updateSecurityGroupForDirectoryControllers:AddIpRoutes', addIpRoutes_updateSecurityGroupForDirectoryControllers - If set to true, updates the inbound and outbound rules of the security group that has the description: "Amazon Web Services 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.0/0
Type: Custom UDP Rule, Protocol: UDP, Range: 123, Source: 0.0.0.0/0
Type: Custom UDP Rule, Protocol: UDP, Range: 138, Source: 0.0.0.0/0
Type: Custom UDP Rule, Protocol: UDP, Range: 389, Source: 0.0.0.0/0
Type: Custom UDP Rule, Protocol: UDP, Range: 464, Source: 0.0.0.0/0
Type: Custom UDP Rule, Protocol: UDP, Range: 445, Source: 0.0.0.0/0
Type: Custom TCP Rule, Protocol: TCP, Range: 88, Source: 0.0.0.0/0
Type: Custom TCP Rule, Protocol: TCP, Range: 135, Source: 0.0.0.0/0
Type: Custom TCP Rule, Protocol: TCP, Range: 445, Source: 0.0.0.0/0
Type: Custom TCP Rule, Protocol: TCP, Range: 464, Source: 0.0.0.0/0
Type: Custom TCP Rule, Protocol: TCP, Range: 636, Source: 0.0.0.0/0
Type: Custom TCP Rule, Protocol: TCP, Range: 1024-65535, Source: 0.0.0.0/0
Type: Custom TCP Rule, Protocol: TCP, Range: 3268-33269, Source: 0.0.0.0/0
Type: DNS (UDP), Protocol: UDP, Range: 53, Source: 0.0.0.0/0
Type: DNS (TCP), Protocol: TCP, Range: 53, Source: 0.0.0.0/0
Type: LDAP, Protocol: TCP, Range: 389, Source: 0.0.0.0/0
Type: All ICMP, Protocol: All, Range: N/A, Source: 0.0.0.0/0

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.

$sel:directoryId:AddIpRoutes', addIpRoutes_directoryId - Identifier (ID) of the directory to which to add the address block.

$sel:ipRoutes:AddIpRoutes', addIpRoutes_ipRoutes - 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 self-managed domain.

Request Lenses

addIpRoutes_updateSecurityGroupForDirectoryControllers :: Lens' AddIpRoutes (Maybe Bool) Source #

If set to true, updates the inbound and outbound rules of the security group that has the description: "Amazon Web Services 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.0/0
Type: Custom UDP Rule, Protocol: UDP, Range: 123, Source: 0.0.0.0/0
Type: Custom UDP Rule, Protocol: UDP, Range: 138, Source: 0.0.0.0/0
Type: Custom UDP Rule, Protocol: UDP, Range: 389, Source: 0.0.0.0/0
Type: Custom UDP Rule, Protocol: UDP, Range: 464, Source: 0.0.0.0/0
Type: Custom UDP Rule, Protocol: UDP, Range: 445, Source: 0.0.0.0/0
Type: Custom TCP Rule, Protocol: TCP, Range: 88, Source: 0.0.0.0/0
Type: Custom TCP Rule, Protocol: TCP, Range: 135, Source: 0.0.0.0/0
Type: Custom TCP Rule, Protocol: TCP, Range: 445, Source: 0.0.0.0/0
Type: Custom TCP Rule, Protocol: TCP, Range: 464, Source: 0.0.0.0/0
Type: Custom TCP Rule, Protocol: TCP, Range: 636, Source: 0.0.0.0/0
Type: Custom TCP Rule, Protocol: TCP, Range: 1024-65535, Source: 0.0.0.0/0
Type: Custom TCP Rule, Protocol: TCP, Range: 3268-33269, Source: 0.0.0.0/0
Type: DNS (UDP), Protocol: UDP, Range: 53, Source: 0.0.0.0/0
Type: DNS (TCP), Protocol: TCP, Range: 53, Source: 0.0.0.0/0
Type: LDAP, Protocol: TCP, Range: 389, Source: 0.0.0.0/0
Type: All ICMP, Protocol: All, Range: N/A, Source: 0.0.0.0/0

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.

addIpRoutes_directoryId :: Lens' AddIpRoutes Text Source #

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

addIpRoutes_ipRoutes :: Lens' AddIpRoutes [IpRoute] Source #

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 self-managed domain.

Destructuring the Response

data AddIpRoutesResponse Source #

See: newAddIpRoutesResponse smart constructor.

Constructors

AddIpRoutesResponse'
Fields httpStatus :: Int The response's http status code.

Instances

Instances details

Eq AddIpRoutesResponse Source #
Instance details Defined in Amazonka.DirectoryService.AddIpRoutes Methods (==) :: AddIpRoutesResponse -> AddIpRoutesResponse -> Bool # (/=) :: AddIpRoutesResponse -> AddIpRoutesResponse -> Bool #
Read AddIpRoutesResponse Source #
Instance details Defined in Amazonka.DirectoryService.AddIpRoutes Methods readsPrec :: Int -> ReadS AddIpRoutesResponse # readList :: ReadS [AddIpRoutesResponse] # readPrec :: ReadPrec AddIpRoutesResponse # readListPrec :: ReadPrec [AddIpRoutesResponse] #
Show AddIpRoutesResponse Source #
Instance details Defined in Amazonka.DirectoryService.AddIpRoutes Methods showsPrec :: Int -> AddIpRoutesResponse -> ShowS # show :: AddIpRoutesResponse -> String # showList :: [AddIpRoutesResponse] -> ShowS #
Generic AddIpRoutesResponse Source #
Instance details Defined in Amazonka.DirectoryService.AddIpRoutes Associated Types type Rep AddIpRoutesResponse :: Type -> Type # Methods from :: AddIpRoutesResponse -> Rep AddIpRoutesResponse x # to :: Rep AddIpRoutesResponse x -> AddIpRoutesResponse #
NFData AddIpRoutesResponse Source #
Instance details Defined in Amazonka.DirectoryService.AddIpRoutes Methods rnf :: AddIpRoutesResponse -> () #
type Rep AddIpRoutesResponse Source #
Instance details Defined in Amazonka.DirectoryService.AddIpRoutes type Rep AddIpRoutesResponse = D1 ('MetaData "AddIpRoutesResponse" "Amazonka.DirectoryService.AddIpRoutes" "libZSservicesZSamazonka-dsZSamazonka-ds" 'False) (C1 ('MetaCons "AddIpRoutesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newAddIpRoutesResponse Source #

Arguments

:: Int	`$sel:httpStatus:AddIpRoutesResponse'`
-> AddIpRoutesResponse

Create a value of AddIpRoutesResponse 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:httpStatus:AddIpRoutesResponse', addIpRoutesResponse_httpStatus - The response's http status code.

Response Lenses

addIpRoutesResponse_httpStatus :: Lens' AddIpRoutesResponse Int Source #

The response's http status code.