[ aws . ds ]

add-ip-routes

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 .

See also: AWS API Documentation

Synopsis

  add-ip-routes
--directory-id <value>
--ip-routes <value>
[--update-security-group-for-directory-controllers | --no-update-security-group-for-directory-controllers]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--directory-id (string)

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

--ip-routes (list)

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.

(structure)

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.

Shorthand Syntax:

CidrIp=string,Description=string ...

JSON Syntax:

[
  {
    "CidrIp": "string",
    "Description": "string"
  }
  ...
]

--update-security-group-for-directory-controllers | --no-update-security-group-for-directory-controllers (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.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

None