Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. AWS
  4. API Docs
  5. directoryservice
  6. IpRoute
Viewing docs for AWS v7.52.1
published on Wednesday, Oct 28, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws

aws.directoryservice.IpRoute

aws logo aws logo
Viewing docs for AWS v7.52.1
published on Wednesday, Oct 28, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws

    Manages an IP route for an AWS Directory Service directory. IP routes are used to route traffic from an AWS Managed Microsoft AD or AD Connector directory to an IPv4 or IPv6 CIDR block, such as an on-premises network reachable over a VPN or AWS Direct Connect connection, or a peered VPC.

    To manage the complete set of IP routes for a directory, and remove any not configured in Terraform, use aws.directoryservice.IpRoutesExclusive instead. Using both resources for the same directory causes persistent drift unless every aws.directoryservice.IpRoute has an equivalent ipRoute block.

    Adding an IPv6 route (cidrIpv6) requires the directory’s network type to be dual-stack (IPv4 and IPv6). Enabling IPv6 support on a directory is a one-way operation performed outside of Terraform; see Updating directory network type.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.directoryservice.Directory("example", {
    vpcSettings: {
        vpcId: exampleAwsVpc.id,
        subnetIds: exampleAwsSubnet.map(__item => __item.id),
    },
    name: "corp.example.com",
    password: "SuperSecretPassw0rd",
    type: "MicrosoftAD",
});
const exampleIpRoute = new aws.directoryservice.IpRoute("example", {
    directoryId: example.id,
    cidrIp: "10.0.0.0/24",
    description: "On-premises network",
});

    import pulumi
import pulumi_aws as aws

example = aws.directoryservice.Directory("example",
    vpc_settings={
        "vpc_id": example_aws_vpc["id"],
        "subnet_ids": [__item["id"] for __item in example_aws_subnet],
    },
    name="corp.example.com",
    password="SuperSecretPassw0rd",
    type="MicrosoftAD")
example_ip_route = aws.directoryservice.IpRoute("example",
    directory_id=example.id,
    cidr_ip="10.0.0.0/24",
    description="On-premises network")

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/directoryservice"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := directoryservice.NewDirectory(ctx, "example", &directoryservice.DirectoryArgs{
VpcSettings: &directoryservice.DirectoryVpcSettingsArgs{
VpcId: pulumi.Any(exampleAwsVpc.Id),
SubnetIds: pulumi.StringArray(%!v(PANIC=Format method: fatal: A failure has occurred: unlowered splat expression @ example.pp:3,17-39)),
},
Name: pulumi.String("corp.example.com"),
Password: pulumi.String("SuperSecretPassw0rd"),
Type: pulumi.String("MicrosoftAD"),
})
if err != nil {
return err
}
_, err = directoryservice.NewIpRoute(ctx, "example", &directoryservice.IpRouteArgs{
DirectoryId: example.ID(),
CidrIp: pulumi.String("10.0.0.0/24"),
Description: pulumi.String("On-premises network"),
})
if err != nil {
return err
}
return nil
})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.DirectoryService.Directory("example", new()
    {
        VpcSettings = new Aws.DirectoryService.Inputs.DirectoryVpcSettingsArgs
        {
            VpcId = exampleAwsVpc.Id,
            SubnetIds = exampleAwsSubnet.Select(__item => __item.Id).ToList(),
        },
        Name = "corp.example.com",
        Password = "SuperSecretPassw0rd",
        Type = "MicrosoftAD",
    });

    var exampleIpRoute = new Aws.DirectoryService.IpRoute("example", new()
    {
        DirectoryId = example.Id,
        CidrIp = "10.0.0.0/24",
        Description = "On-premises network",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.directoryservice.Directory;
import com.pulumi.aws.directoryservice.DirectoryArgs;
import com.pulumi.aws.directoryservice.inputs.DirectoryVpcSettingsArgs;
import com.pulumi.aws.directoryservice.IpRoute;
import com.pulumi.aws.directoryservice.IpRouteArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Directory("example", DirectoryArgs.builder()
            .vpcSettings(DirectoryVpcSettingsArgs.builder()
                .vpcId(exampleAwsVpc.get("id"))
                .subnetIds(exampleAwsSubnet.stream().map(element -> element.get("id")).collect(toList()))
                .build())
            .name("corp.example.com")
            .password("SuperSecretPassw0rd")
            .type("MicrosoftAD")
            .build());

        var exampleIpRoute = new IpRoute("exampleIpRoute", IpRouteArgs.builder()
            .directoryId(example.id())
            .cidrIp("10.0.0.0/24")
            .description("On-premises network")
            .build());

    }
}

    Example coming soon!

    terraform {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_directoryservice_directory" "example" {
  lifecycle {
    create_before_destroy = true
  }
  vpc_settings = {
    vpc_id     = exampleAwsVpc.id
    subnet_ids = exampleAwsSubnet[*].id
  }
  name     = "corp.example.com"
  password = "SuperSecretPassw0rd"
  type     = "MicrosoftAD"
}
resource "aws_directoryservice_ip_route" "example" {
  lifecycle {
    create_before_destroy = true
  }
  directory_id = aws_directoryservice_directory.example.id
  cidr_ip      = "10.0.0.0/24"
  description  = "On-premises network"
}

    IPv6

    IPv6 routes require an existing directory that has been updated to dual-stack.

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.directoryservice.IpRoute("example", {
    directoryId: "d-1234567890",
    cidrIpv6: "2001:db8::/64",
    description: "On-premises IPv6 network",
});

    import pulumi
import pulumi_aws as aws

example = aws.directoryservice.IpRoute("example",
    directory_id="d-1234567890",
    cidr_ipv6="2001:db8::/64",
    description="On-premises IPv6 network")

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/directoryservice"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := directoryservice.NewIpRoute(ctx, "example", &directoryservice.IpRouteArgs{
			DirectoryId: pulumi.String("d-1234567890"),
			CidrIpv6:    pulumi.String("2001:db8::/64"),
			Description: pulumi.String("On-premises IPv6 network"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.DirectoryService.IpRoute("example", new()
    {
        DirectoryId = "d-1234567890",
        CidrIpv6 = "2001:db8::/64",
        Description = "On-premises IPv6 network",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.directoryservice.IpRoute;
import com.pulumi.aws.directoryservice.IpRouteArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new IpRoute("example", IpRouteArgs.builder()
            .directoryId("d-1234567890")
            .cidrIpv6("2001:db8::/64")
            .description("On-premises IPv6 network")
            .build());

    }
}

    resources:
  example:
    type: aws:directoryservice:IpRoute
    properties:
      directoryId: d-1234567890
      cidrIpv6: 2001:db8::/64
      description: On-premises IPv6 network

    terraform {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_directoryservice_ip_route" "example" {
  lifecycle {
    create_before_destroy = true
  }
  directory_id = "d-1234567890"
  cidr_ipv6    = "2001:db8::/64"
  description  = "On-premises IPv6 network"
}

    Create IpRoute Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new IpRoute(name: string, args: IpRouteArgs, opts?: CustomResourceOptions);
    @overload
def IpRoute(resource_name: str,
            args: IpRouteArgs,
            opts: Optional[ResourceOptions] = None)

@overload
def IpRoute(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            directory_id: Optional[str] = None,
            cidr_ip: Optional[str] = None,
            cidr_ipv6: Optional[str] = None,
            description: Optional[str] = None,
            region: Optional[str] = None,
            timeouts: Optional[IpRouteTimeoutsArgs] = None,
            update_security_group_for_directory_controllers: Optional[bool] = None)
    func NewIpRoute(ctx *Context, name string, args IpRouteArgs, opts ...ResourceOption) (*IpRoute, error)
    public IpRoute(string name, IpRouteArgs args, CustomResourceOptions? opts = null)
    public IpRoute(String name, IpRouteArgs args)
public IpRoute(String name, IpRouteArgs args, CustomResourceOptions options)

    type: aws:directoryservice:IpRoute
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "aws_directoryservice_ip_route" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args IpRouteArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args IpRouteArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args IpRouteArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IpRouteArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IpRouteArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var ipRouteResource = new Aws.DirectoryService.IpRoute("ipRouteResource", new()
{
    DirectoryId = "string",
    CidrIp = "string",
    CidrIpv6 = "string",
    Description = "string",
    Region = "string",
    Timeouts = new Aws.DirectoryService.Inputs.IpRouteTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
    },
    UpdateSecurityGroupForDirectoryControllers = false,
});

    example, err := directoryservice.NewIpRoute(ctx, "ipRouteResource", &directoryservice.IpRouteArgs{
	DirectoryId: pulumi.String("string"),
	CidrIp:      pulumi.String("string"),
	CidrIpv6:    pulumi.String("string"),
	Description: pulumi.String("string"),
	Region:      pulumi.String("string"),
	Timeouts: &directoryservice.IpRouteTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
	},
	UpdateSecurityGroupForDirectoryControllers: pulumi.Bool(false),
})

    resource "aws_directoryservice_ip_route" "ipRouteResource" {
  lifecycle {
    create_before_destroy = true
  }
  directory_id = "string"
  cidr_ip      = "string"
  cidr_ipv6    = "string"
  description  = "string"
  region       = "string"
  timeouts = {
    create = "string"
    delete = "string"
  }
  update_security_group_for_directory_controllers = false
}

    var ipRouteResource = new IpRoute("ipRouteResource", IpRouteArgs.builder()
    .directoryId("string")
    .cidrIp("string")
    .cidrIpv6("string")
    .description("string")
    .region("string")
    .timeouts(IpRouteTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .build())
    .updateSecurityGroupForDirectoryControllers(false)
    .build());

    ip_route_resource = aws.directoryservice.IpRoute("ipRouteResource",
    directory_id="string",
    cidr_ip="string",
    cidr_ipv6="string",
    description="string",
    region="string",
    timeouts={
        "create": "string",
        "delete": "string",
    },
    update_security_group_for_directory_controllers=False)

    const ipRouteResource = new aws.directoryservice.IpRoute("ipRouteResource", {
    directoryId: "string",
    cidrIp: "string",
    cidrIpv6: "string",
    description: "string",
    region: "string",
    timeouts: {
        create: "string",
        "delete": "string",
    },
    updateSecurityGroupForDirectoryControllers: false,
});

    type: aws:directoryservice:IpRoute
properties:
    cidrIp: string
    cidrIpv6: string
    description: string
    directoryId: string
    region: string
    timeouts:
        create: string
        delete: string
    updateSecurityGroupForDirectoryControllers: false

    IpRoute Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The IpRoute resource accepts the following input properties:

    DirectoryId string

    Identifier of the directory to which to add the IP route. Changing this forces a new resource to be created.

    The following arguments are optional:

    CidrIp string
    IPv4 CIDR block, such as 10.0.0.0/24. For a single address, use a /32 block, such as 10.0.0.0/32. Exactly one of cidrIp or cidrIpv6 must be set. Changing this forces a new resource to be created.
    CidrIpv6 string
    IPv6 CIDR block, such as 2001:db8::/64. For a single address, use a /128 block. Exactly one of cidrIp or cidrIpv6 must be set. Changing this forces a new resource to be created.
    Description string
    Description of the address block. Changing this forces a new resource to be created.
    Region string
    Region where this resource is managed. Defaults to the Region set in the provider configuration.
    Timeouts IpRouteTimeouts
    UpdateSecurityGroupForDirectoryControllers bool
    Whether to update the inbound and outbound rules of the security group for the directory controllers. Changing this forces a new resource to be created. Defaults to false.
    DirectoryId string

    Identifier of the directory to which to add the IP route. Changing this forces a new resource to be created.

    The following arguments are optional:

    CidrIp string
    IPv4 CIDR block, such as 10.0.0.0/24. For a single address, use a /32 block, such as 10.0.0.0/32. Exactly one of cidrIp or cidrIpv6 must be set. Changing this forces a new resource to be created.
    CidrIpv6 string
    IPv6 CIDR block, such as 2001:db8::/64. For a single address, use a /128 block. Exactly one of cidrIp or cidrIpv6 must be set. Changing this forces a new resource to be created.
    Description string
    Description of the address block. Changing this forces a new resource to be created.
    Region string
    Region where this resource is managed. Defaults to the Region set in the provider configuration.
    Timeouts IpRouteTimeoutsArgs
    UpdateSecurityGroupForDirectoryControllers bool
    Whether to update the inbound and outbound rules of the security group for the directory controllers. Changing this forces a new resource to be created. Defaults to false.
    directory_id string

    Identifier of the directory to which to add the IP route. Changing this forces a new resource to be created.

    The following arguments are optional:

    cidr_ip string
    IPv4 CIDR block, such as 10.0.0.0/24. For a single address, use a /32 block, such as 10.0.0.0/32. Exactly one of cidrIp or cidrIpv6 must be set. Changing this forces a new resource to be created.
    cidr_ipv6 string
    IPv6 CIDR block, such as 2001:db8::/64. For a single address, use a /128 block. Exactly one of cidrIp or cidrIpv6 must be set. Changing this forces a new resource to be created.
    description string
    Description of the address block. Changing this forces a new resource to be created.
    region string
    Region where this resource is managed. Defaults to the Region set in the provider configuration.
    timeouts object
    update_security_group_for_directory_controllers bool
    Whether to update the inbound and outbound rules of the security group for the directory controllers. Changing this forces a new resource to be created. Defaults to false.
    directoryId String

    Identifier of the directory to which to add the IP route. Changing this forces a new resource to be created.

    The following arguments are optional:

    cidrIp String
    IPv4 CIDR block, such as 10.0.0.0/24. For a single address, use a /32 block, such as 10.0.0.0/32. Exactly one of cidrIp or cidrIpv6 must be set. Changing this forces a new resource to be created.
    cidrIpv6 String
    IPv6 CIDR block, such as 2001:db8::/64. For a single address, use a /128 block. Exactly one of cidrIp or cidrIpv6 must be set. Changing this forces a new resource to be created.
    description String
    Description of the address block. Changing this forces a new resource to be created.
    region String
    Region where this resource is managed. Defaults to the Region set in the provider configuration.
    timeouts IpRouteTimeouts
    updateSecurityGroupForDirectoryControllers Boolean
    Whether to update the inbound and outbound rules of the security group for the directory controllers. Changing this forces a new resource to be created. Defaults to false.
    directoryId string

    Identifier of the directory to which to add the IP route. Changing this forces a new resource to be created.

    The following arguments are optional:

    cidrIp string
    IPv4 CIDR block, such as 10.0.0.0/24. For a single address, use a /32 block, such as 10.0.0.0/32. Exactly one of cidrIp or cidrIpv6 must be set. Changing this forces a new resource to be created.
    cidrIpv6 string
    IPv6 CIDR block, such as 2001:db8::/64. For a single address, use a /128 block. Exactly one of cidrIp or cidrIpv6 must be set. Changing this forces a new resource to be created.
    description string
    Description of the address block. Changing this forces a new resource to be created.
    region string
    Region where this resource is managed. Defaults to the Region set in the provider configuration.
    timeouts IpRouteTimeouts
    updateSecurityGroupForDirectoryControllers boolean
    Whether to update the inbound and outbound rules of the security group for the directory controllers. Changing this forces a new resource to be created. Defaults to false.
    directory_id str

    Identifier of the directory to which to add the IP route. Changing this forces a new resource to be created.

    The following arguments are optional:

    cidr_ip str
    IPv4 CIDR block, such as 10.0.0.0/24. For a single address, use a /32 block, such as 10.0.0.0/32. Exactly one of cidrIp or cidrIpv6 must be set. Changing this forces a new resource to be created.
    cidr_ipv6 str
    IPv6 CIDR block, such as 2001:db8::/64. For a single address, use a /128 block. Exactly one of cidrIp or cidrIpv6 must be set. Changing this forces a new resource to be created.
    description str
    Description of the address block. Changing this forces a new resource to be created.
    region str
    Region where this resource is managed. Defaults to the Region set in the provider configuration.
    timeouts IpRouteTimeoutsArgs
    update_security_group_for_directory_controllers bool
    Whether to update the inbound and outbound rules of the security group for the directory controllers. Changing this forces a new resource to be created. Defaults to false.
    directoryId String

    Identifier of the directory to which to add the IP route. Changing this forces a new resource to be created.

    The following arguments are optional:

    cidrIp String
    IPv4 CIDR block, such as 10.0.0.0/24. For a single address, use a /32 block, such as 10.0.0.0/32. Exactly one of cidrIp or cidrIpv6 must be set. Changing this forces a new resource to be created.
    cidrIpv6 String
    IPv6 CIDR block, such as 2001:db8::/64. For a single address, use a /128 block. Exactly one of cidrIp or cidrIpv6 must be set. Changing this forces a new resource to be created.
    description String
    Description of the address block. Changing this forces a new resource to be created.
    region String
    Region where this resource is managed. Defaults to the Region set in the provider configuration.
    timeouts Property Map
    updateSecurityGroupForDirectoryControllers Boolean
    Whether to update the inbound and outbound rules of the security group for the directory controllers. Changing this forces a new resource to be created. Defaults to false.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the IpRoute resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing IpRoute Resource

    Get an existing IpRoute resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: IpRouteState, opts?: CustomResourceOptions): IpRoute
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cidr_ip: Optional[str] = None,
        cidr_ipv6: Optional[str] = None,
        description: Optional[str] = None,
        directory_id: Optional[str] = None,
        region: Optional[str] = None,
        timeouts: Optional[IpRouteTimeoutsArgs] = None,
        update_security_group_for_directory_controllers: Optional[bool] = None) -> IpRoute
    func GetIpRoute(ctx *Context, name string, id IDInput, state *IpRouteState, opts ...ResourceOption) (*IpRoute, error)
    public static IpRoute Get(string name, Input<string> id, IpRouteState? state, CustomResourceOptions? opts = null)
    public static IpRoute get(String name, Output<String> id, IpRouteState state, CustomResourceOptions options)
    resources:  _:    type: aws:directoryservice:IpRoute    get:      id: ${id}
    import {
  to = aws_directoryservice_ip_route.example
  id = "${id}"
}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CidrIp string
    IPv4 CIDR block, such as 10.0.0.0/24. For a single address, use a /32 block, such as 10.0.0.0/32. Exactly one of cidrIp or cidrIpv6 must be set. Changing this forces a new resource to be created.
    CidrIpv6 string
    IPv6 CIDR block, such as 2001:db8::/64. For a single address, use a /128 block. Exactly one of cidrIp or cidrIpv6 must be set. Changing this forces a new resource to be created.
    Description string
    Description of the address block. Changing this forces a new resource to be created.
    DirectoryId string

    Identifier of the directory to which to add the IP route. Changing this forces a new resource to be created.

    The following arguments are optional:

    Region string
    Region where this resource is managed. Defaults to the Region set in the provider configuration.
    Timeouts IpRouteTimeouts
    UpdateSecurityGroupForDirectoryControllers bool
    Whether to update the inbound and outbound rules of the security group for the directory controllers. Changing this forces a new resource to be created. Defaults to false.
    CidrIp string
    IPv4 CIDR block, such as 10.0.0.0/24. For a single address, use a /32 block, such as 10.0.0.0/32. Exactly one of cidrIp or cidrIpv6 must be set. Changing this forces a new resource to be created.
    CidrIpv6 string
    IPv6 CIDR block, such as 2001:db8::/64. For a single address, use a /128 block. Exactly one of cidrIp or cidrIpv6 must be set. Changing this forces a new resource to be created.
    Description string
    Description of the address block. Changing this forces a new resource to be created.
    DirectoryId string

    Identifier of the directory to which to add the IP route. Changing this forces a new resource to be created.

    The following arguments are optional:

    Region string
    Region where this resource is managed. Defaults to the Region set in the provider configuration.
    Timeouts IpRouteTimeoutsArgs
    UpdateSecurityGroupForDirectoryControllers bool
    Whether to update the inbound and outbound rules of the security group for the directory controllers. Changing this forces a new resource to be created. Defaults to false.
    cidr_ip string
    IPv4 CIDR block, such as 10.0.0.0/24. For a single address, use a /32 block, such as 10.0.0.0/32. Exactly one of cidrIp or cidrIpv6 must be set. Changing this forces a new resource to be created.
    cidr_ipv6 string
    IPv6 CIDR block, such as 2001:db8::/64. For a single address, use a /128 block. Exactly one of cidrIp or cidrIpv6 must be set. Changing this forces a new resource to be created.
    description string
    Description of the address block. Changing this forces a new resource to be created.
    directory_id string

    Identifier of the directory to which to add the IP route. Changing this forces a new resource to be created.

    The following arguments are optional:

    region string
    Region where this resource is managed. Defaults to the Region set in the provider configuration.
    timeouts object
    update_security_group_for_directory_controllers bool
    Whether to update the inbound and outbound rules of the security group for the directory controllers. Changing this forces a new resource to be created. Defaults to false.
    cidrIp String
    IPv4 CIDR block, such as 10.0.0.0/24. For a single address, use a /32 block, such as 10.0.0.0/32. Exactly one of cidrIp or cidrIpv6 must be set. Changing this forces a new resource to be created.
    cidrIpv6 String
    IPv6 CIDR block, such as 2001:db8::/64. For a single address, use a /128 block. Exactly one of cidrIp or cidrIpv6 must be set. Changing this forces a new resource to be created.
    description String
    Description of the address block. Changing this forces a new resource to be created.
    directoryId String

    Identifier of the directory to which to add the IP route. Changing this forces a new resource to be created.

    The following arguments are optional:

    region String
    Region where this resource is managed. Defaults to the Region set in the provider configuration.
    timeouts IpRouteTimeouts
    updateSecurityGroupForDirectoryControllers Boolean
    Whether to update the inbound and outbound rules of the security group for the directory controllers. Changing this forces a new resource to be created. Defaults to false.
    cidrIp string
    IPv4 CIDR block, such as 10.0.0.0/24. For a single address, use a /32 block, such as 10.0.0.0/32. Exactly one of cidrIp or cidrIpv6 must be set. Changing this forces a new resource to be created.
    cidrIpv6 string
    IPv6 CIDR block, such as 2001:db8::/64. For a single address, use a /128 block. Exactly one of cidrIp or cidrIpv6 must be set. Changing this forces a new resource to be created.
    description string
    Description of the address block. Changing this forces a new resource to be created.
    directoryId string

    Identifier of the directory to which to add the IP route. Changing this forces a new resource to be created.

    The following arguments are optional:

    region string
    Region where this resource is managed. Defaults to the Region set in the provider configuration.
    timeouts IpRouteTimeouts
    updateSecurityGroupForDirectoryControllers boolean
    Whether to update the inbound and outbound rules of the security group for the directory controllers. Changing this forces a new resource to be created. Defaults to false.
    cidr_ip str
    IPv4 CIDR block, such as 10.0.0.0/24. For a single address, use a /32 block, such as 10.0.0.0/32. Exactly one of cidrIp or cidrIpv6 must be set. Changing this forces a new resource to be created.
    cidr_ipv6 str
    IPv6 CIDR block, such as 2001:db8::/64. For a single address, use a /128 block. Exactly one of cidrIp or cidrIpv6 must be set. Changing this forces a new resource to be created.
    description str
    Description of the address block. Changing this forces a new resource to be created.
    directory_id str

    Identifier of the directory to which to add the IP route. Changing this forces a new resource to be created.

    The following arguments are optional:

    region str
    Region where this resource is managed. Defaults to the Region set in the provider configuration.
    timeouts IpRouteTimeoutsArgs
    update_security_group_for_directory_controllers bool
    Whether to update the inbound and outbound rules of the security group for the directory controllers. Changing this forces a new resource to be created. Defaults to false.
    cidrIp String
    IPv4 CIDR block, such as 10.0.0.0/24. For a single address, use a /32 block, such as 10.0.0.0/32. Exactly one of cidrIp or cidrIpv6 must be set. Changing this forces a new resource to be created.
    cidrIpv6 String
    IPv6 CIDR block, such as 2001:db8::/64. For a single address, use a /128 block. Exactly one of cidrIp or cidrIpv6 must be set. Changing this forces a new resource to be created.
    description String
    Description of the address block. Changing this forces a new resource to be created.
    directoryId String

    Identifier of the directory to which to add the IP route. Changing this forces a new resource to be created.

    The following arguments are optional:

    region String
    Region where this resource is managed. Defaults to the Region set in the provider configuration.
    timeouts Property Map
    updateSecurityGroupForDirectoryControllers Boolean
    Whether to update the inbound and outbound rules of the security group for the directory controllers. Changing this forces a new resource to be created. Defaults to false.

    Supporting Types

    IpRouteTimeouts, IpRouteTimeoutsArgs

    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    create str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.

    Import

    Identity Schema

    Required

    • directoryId (String) Identifier of the directory.

    Optional

    • accountId (String) AWS Account where this resource is managed.
    • cidrIp (String) IPv4 CIDR block. Exactly one of cidrIp or cidrIpv6 must be set.
    • cidrIpv6 (String) IPv6 CIDR block. Exactly one of cidrIp or cidrIpv6 must be set.
    • region (String) Region where this resource is managed.

    Using pulumi import, import an IP route using the directory ID and CIDR block separated by a comma (,). For example:

    $ pulumi import aws:directoryservice/ipRoute:IpRoute example d-1234567890,10.0.0.0/24

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo aws logo
    Viewing docs for AWS v7.52.1
    published on Wednesday, Oct 28, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial