AWS Directory Service

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.

Request Syntax

client.add_ip_routes(
    DirectoryId='string',
    IpRoutes=[
        {
            'CidrIp': 'string',
            'Description': 'string'
        },
    ],
    UpdateSecurityGroupForDirectoryControllers=True|False
)

type DirectoryId

string

param DirectoryId

[REQUIRED]

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

type IpRoutes

list

param IpRoutes

[REQUIRED]

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.

• (dict) --

  IP address block. This is often the address block of the DNS server used for your on-premises domain.

  • CidrIp (string) --

    IP address block using CIDR format, for example 10.0.0.0/24. This is often the address block of the DNS server used for your on-premises domain. For a single IP address use a CIDR address block with /32. For example 10.0.0.0/32.

  • Description (string) --

    Description of the address block.

type UpdateSecurityGroupForDirectoryControllers

boolean

param UpdateSecurityGroupForDirectoryControllers

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.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.

rtype

dict

returns

Response Syntax

{}

Response Structure

• (dict) --

Lists the address blocks that you have added to a directory.

Request Syntax

client.list_ip_routes(
    DirectoryId='string',
    NextToken='string',
    Limit=123
)

type DirectoryId

string

param DirectoryId

[REQUIRED]

Identifier (ID) of the directory for which you want to retrieve the IP addresses.

type NextToken

string

param NextToken

The ListIpRoutes.NextToken value from a previous call to ListIpRoutes . Pass null if this is the first call.

type Limit

integer

param Limit

Maximum number of items to return. If this value is zero, the maximum number of items is specified by the limitations of the operation.

rtype

dict

returns

Response Syntax

{
    'IpRoutesInfo': [
        {
            'DirectoryId': 'string',
            'CidrIp': 'string',
            'IpRouteStatusMsg': 'Adding'|'Added'|'Removing'|'Removed'|'AddFailed'|'RemoveFailed',
            'AddedDateTime': datetime(2015, 1, 1),
            'IpRouteStatusReason': 'string',
            'Description': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • IpRoutesInfo (list) --

    A list of IpRoute s.

    • (dict) --

      Information about one or more IP address blocks.

      • DirectoryId (string) --

        Identifier (ID) of the directory associated with the IP addresses.

      • CidrIp (string) --

        IP address block in the IpRoute .

      • IpRouteStatusMsg (string) --

        The status of the IP address block.

      • AddedDateTime (datetime) --

        The date and time the address block was added to the directory.

      • IpRouteStatusReason (string) --

        The reason for the IpRouteStatusMsg.

      • Description (string) --

        Description of the IpRouteInfo .

  • NextToken (string) --

    If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call to ListIpRoutes to retrieve the next set of items.

Removes IP address blocks from a directory.

Request Syntax

client.remove_ip_routes(
    DirectoryId='string',
    CidrIps=[
        'string',
    ]
)

type DirectoryId

string

param DirectoryId

[REQUIRED]

Identifier (ID) of the directory from which you want to remove the IP addresses.

type CidrIps

list

param CidrIps

[REQUIRED]

IP address blocks that you want to remove.

• (string) --

rtype

dict

returns

Response Syntax

{}

Response Structure

• (dict) --