DirectoryService / Client / add_ip_routes

add_ip_routes#

DirectoryService.Client.add_ip_routes(**kwargs)#

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.

Request Syntax

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

Parameters:

DirectoryId (string) –
[REQUIRED]

Identifier (ID) of the directory to which to add the address block.
IpRoutes (list) –
[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 self-managed domain.
- (dict) –
  
  IP address block. This is often the address block of the DNS server used for your self-managed 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 self-managed 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.
UpdateSecurityGroupForDirectoryControllers (boolean) –
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.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

(dict) –

Exceptions

DirectoryService.Client.exceptions.EntityDoesNotExistException
DirectoryService.Client.exceptions.EntityAlreadyExistsException
DirectoryService.Client.exceptions.InvalidParameterException
DirectoryService.Client.exceptions.DirectoryUnavailableException
DirectoryService.Client.exceptions.IpRouteLimitExceededException
DirectoryService.Client.exceptions.ClientException
DirectoryService.Client.exceptions.ServiceException