1. Registry
  2. Packages
  3. AWS
  4. API Docs
  5. directoryservice
  6. IpRoutesExclusive
Viewing docs for AWS v7.52.1
published on Wednesday, Oct 28, 2026 by Pulumi
aws logo aws logo
Viewing docs for AWS v7.52.1
published on Wednesday, Oct 28, 2026 by Pulumi

    Manages an exclusive set of IP routes 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.

    This resource takes exclusive ownership over the IP routes of a directory. This includes removal of IP routes which are not explicitly configured. To prevent persistent drift, ensure any aws.directoryservice.IpRoute resources managed alongside this resource have an equivalent ipRoute block.

    Destruction of this resource means Terraform will no longer manage reconciliation of the configured IP routes. It will not remove the configured IP routes from the directory.

    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 exampleIpRoutesExclusive = new aws.directoryservice.IpRoutesExclusive("example", {
        ipRoutes: [
            {
                cidrIp: "10.0.0.0/24",
                description: "On-premises network",
            },
            {
                cidrIp: "192.168.100.0/24",
                description: "Peered VPC",
            },
        ],
        directoryId: example.id,
        updateSecurityGroupForDirectoryControllers: true,
    });
    
    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_routes_exclusive = aws.directoryservice.IpRoutesExclusive("example",
        ip_routes=[
            {
                "cidr_ip": "10.0.0.0/24",
                "description": "On-premises network",
            },
            {
                "cidr_ip": "192.168.100.0/24",
                "description": "Peered VPC",
            },
        ],
        directory_id=example.id,
        update_security_group_for_directory_controllers=True)
    
    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.NewIpRoutesExclusive(ctx, "example", &directoryservice.IpRoutesExclusiveArgs{
    IpRoutes: directoryservice.IpRoutesExclusiveIpRouteArray{
    &directoryservice.IpRoutesExclusiveIpRouteArgs{
    CidrIp: pulumi.String("10.0.0.0/24"),
    Description: pulumi.String("On-premises network"),
    },
    &directoryservice.IpRoutesExclusiveIpRouteArgs{
    CidrIp: pulumi.String("192.168.100.0/24"),
    Description: pulumi.String("Peered VPC"),
    },
    },
    DirectoryId: example.ID(),
    UpdateSecurityGroupForDirectoryControllers: pulumi.Bool(true),
    })
    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 exampleIpRoutesExclusive = new Aws.DirectoryService.IpRoutesExclusive("example", new()
        {
            IpRoutes = new[]
            {
                new Aws.DirectoryService.Inputs.IpRoutesExclusiveIpRouteArgs
                {
                    CidrIp = "10.0.0.0/24",
                    Description = "On-premises network",
                },
                new Aws.DirectoryService.Inputs.IpRoutesExclusiveIpRouteArgs
                {
                    CidrIp = "192.168.100.0/24",
                    Description = "Peered VPC",
                },
            },
            DirectoryId = example.Id,
            UpdateSecurityGroupForDirectoryControllers = true,
        });
    
    });
    
    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.IpRoutesExclusive;
    import com.pulumi.aws.directoryservice.IpRoutesExclusiveArgs;
    import com.pulumi.aws.directoryservice.inputs.IpRoutesExclusiveIpRouteArgs;
    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 exampleIpRoutesExclusive = new IpRoutesExclusive("exampleIpRoutesExclusive", IpRoutesExclusiveArgs.builder()
                .ipRoutes(            
                    IpRoutesExclusiveIpRouteArgs.builder()
                        .cidrIp("10.0.0.0/24")
                        .description("On-premises network")
                        .build(),
                    IpRoutesExclusiveIpRouteArgs.builder()
                        .cidrIp("192.168.100.0/24")
                        .description("Peered VPC")
                        .build())
                .directoryId(example.id())
                .updateSecurityGroupForDirectoryControllers(true)
                .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_routes_exclusive" "example" {
      lifecycle {
        create_before_destroy = true
      }
      ip_routes {
        cidr_ip     = "10.0.0.0/24"
        description = "On-premises network"
      }
      ip_routes {
        cidr_ip     = "192.168.100.0/24"
        description = "Peered VPC"
      }
      directory_id                                    = aws_directoryservice_directory.example.id
      update_security_group_for_directory_controllers = true
    }
    

    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.IpRoutesExclusive("example", {
        ipRoutes: [{
            cidrIpv6: "2001:db8::/64",
            description: "On-premises IPv6 network",
        }],
        directoryId: "d-1234567890",
    });
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.directoryservice.IpRoutesExclusive("example",
        ip_routes=[{
            "cidr_ipv6": "2001:db8::/64",
            "description": "On-premises IPv6 network",
        }],
        directory_id="d-1234567890")
    
    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.NewIpRoutesExclusive(ctx, "example", &directoryservice.IpRoutesExclusiveArgs{
    			IpRoutes: directoryservice.IpRoutesExclusiveIpRouteArray{
    				&directoryservice.IpRoutesExclusiveIpRouteArgs{
    					CidrIpv6:    pulumi.String("2001:db8::/64"),
    					Description: pulumi.String("On-premises IPv6 network"),
    				},
    			},
    			DirectoryId: pulumi.String("d-1234567890"),
    		})
    		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.IpRoutesExclusive("example", new()
        {
            IpRoutes = new[]
            {
                new Aws.DirectoryService.Inputs.IpRoutesExclusiveIpRouteArgs
                {
                    CidrIpv6 = "2001:db8::/64",
                    Description = "On-premises IPv6 network",
                },
            },
            DirectoryId = "d-1234567890",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.directoryservice.IpRoutesExclusive;
    import com.pulumi.aws.directoryservice.IpRoutesExclusiveArgs;
    import com.pulumi.aws.directoryservice.inputs.IpRoutesExclusiveIpRouteArgs;
    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 IpRoutesExclusive("example", IpRoutesExclusiveArgs.builder()
                .ipRoutes(IpRoutesExclusiveIpRouteArgs.builder()
                    .cidrIpv6("2001:db8::/64")
                    .description("On-premises IPv6 network")
                    .build())
                .directoryId("d-1234567890")
                .build());
    
        }
    }
    
    resources:
      example:
        type: aws:directoryservice:IpRoutesExclusive
        properties:
          ipRoutes:
            - cidrIpv6: 2001:db8::/64
              description: On-premises IPv6 network
          directoryId: d-1234567890
    
    terraform {
      required_providers {
        aws = {
          source = "pulumi/aws"
        }
      }
    }
    
    resource "aws_directoryservice_ip_routes_exclusive" "example" {
      lifecycle {
        create_before_destroy = true
      }
      ip_routes {
        cidr_ipv6   = "2001:db8::/64"
        description = "On-premises IPv6 network"
      }
      directory_id = "d-1234567890"
    }
    

    Disallow IP Routes

    To remove all IP routes from a directory, omit all ipRoute blocks. Any IP routes added outside of Terraform are detected on the next refresh and removed on the next apply.

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = new aws.directoryservice.IpRoutesExclusive("example", {directoryId: exampleAwsDirectoryServiceDirectory.id});
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.directoryservice.IpRoutesExclusive("example", directory_id=example_aws_directory_service_directory["id"])
    
    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.NewIpRoutesExclusive(ctx, "example", &directoryservice.IpRoutesExclusiveArgs{
    			DirectoryId: pulumi.Any(exampleAwsDirectoryServiceDirectory.Id),
    		})
    		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.IpRoutesExclusive("example", new()
        {
            DirectoryId = exampleAwsDirectoryServiceDirectory.Id,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.directoryservice.IpRoutesExclusive;
    import com.pulumi.aws.directoryservice.IpRoutesExclusiveArgs;
    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 IpRoutesExclusive("example", IpRoutesExclusiveArgs.builder()
                .directoryId(exampleAwsDirectoryServiceDirectory.get("id"))
                .build());
    
        }
    }
    
    resources:
      example:
        type: aws:directoryservice:IpRoutesExclusive
        properties:
          directoryId: ${exampleAwsDirectoryServiceDirectory.id}
    
    terraform {
      required_providers {
        aws = {
          source = "pulumi/aws"
        }
      }
    }
    
    resource "aws_directoryservice_ip_routes_exclusive" "example" {
      lifecycle {
        create_before_destroy = true
      }
      directory_id = exampleAwsDirectoryServiceDirectory.id
    }
    

    Create IpRoutesExclusive Resource

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

    Constructor syntax

    new IpRoutesExclusive(name: string, args: IpRoutesExclusiveArgs, opts?: CustomResourceOptions);
    @overload
    def IpRoutesExclusive(resource_name: str,
                          args: IpRoutesExclusiveArgs,
                          opts: Optional[ResourceOptions] = None)
    
    @overload
    def IpRoutesExclusive(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          directory_id: Optional[str] = None,
                          ip_routes: Optional[Sequence[IpRoutesExclusiveIpRouteArgs]] = None,
                          region: Optional[str] = None,
                          timeouts: Optional[IpRoutesExclusiveTimeoutsArgs] = None,
                          update_security_group_for_directory_controllers: Optional[bool] = None)
    func NewIpRoutesExclusive(ctx *Context, name string, args IpRoutesExclusiveArgs, opts ...ResourceOption) (*IpRoutesExclusive, error)
    public IpRoutesExclusive(string name, IpRoutesExclusiveArgs args, CustomResourceOptions? opts = null)
    public IpRoutesExclusive(String name, IpRoutesExclusiveArgs args)
    public IpRoutesExclusive(String name, IpRoutesExclusiveArgs args, CustomResourceOptions options)
    
    type: aws:directoryservice:IpRoutesExclusive
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "aws_directoryservice_ip_routes_exclusive" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args IpRoutesExclusiveArgs
    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 IpRoutesExclusiveArgs
    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 IpRoutesExclusiveArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IpRoutesExclusiveArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IpRoutesExclusiveArgs
    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 ipRoutesExclusiveResource = new Aws.DirectoryService.IpRoutesExclusive("ipRoutesExclusiveResource", new()
    {
        DirectoryId = "string",
        IpRoutes = new[]
        {
            new Aws.DirectoryService.Inputs.IpRoutesExclusiveIpRouteArgs
            {
                CidrIp = "string",
                CidrIpv6 = "string",
                Description = "string",
            },
        },
        Region = "string",
        Timeouts = new Aws.DirectoryService.Inputs.IpRoutesExclusiveTimeoutsArgs
        {
            Create = "string",
            Update = "string",
        },
        UpdateSecurityGroupForDirectoryControllers = false,
    });
    
    example, err := directoryservice.NewIpRoutesExclusive(ctx, "ipRoutesExclusiveResource", &directoryservice.IpRoutesExclusiveArgs{
    	DirectoryId: pulumi.String("string"),
    	IpRoutes: directoryservice.IpRoutesExclusiveIpRouteArray{
    		&directoryservice.IpRoutesExclusiveIpRouteArgs{
    			CidrIp:      pulumi.String("string"),
    			CidrIpv6:    pulumi.String("string"),
    			Description: pulumi.String("string"),
    		},
    	},
    	Region: pulumi.String("string"),
    	Timeouts: &directoryservice.IpRoutesExclusiveTimeoutsArgs{
    		Create: pulumi.String("string"),
    		Update: pulumi.String("string"),
    	},
    	UpdateSecurityGroupForDirectoryControllers: pulumi.Bool(false),
    })
    
    resource "aws_directoryservice_ip_routes_exclusive" "ipRoutesExclusiveResource" {
      lifecycle {
        create_before_destroy = true
      }
      directory_id = "string"
      ip_routes {
        cidr_ip     = "string"
        cidr_ipv6   = "string"
        description = "string"
      }
      region = "string"
      timeouts = {
        create = "string"
        update = "string"
      }
      update_security_group_for_directory_controllers = false
    }
    
    var ipRoutesExclusiveResource = new IpRoutesExclusive("ipRoutesExclusiveResource", IpRoutesExclusiveArgs.builder()
        .directoryId("string")
        .ipRoutes(IpRoutesExclusiveIpRouteArgs.builder()
            .cidrIp("string")
            .cidrIpv6("string")
            .description("string")
            .build())
        .region("string")
        .timeouts(IpRoutesExclusiveTimeoutsArgs.builder()
            .create("string")
            .update("string")
            .build())
        .updateSecurityGroupForDirectoryControllers(false)
        .build());
    
    ip_routes_exclusive_resource = aws.directoryservice.IpRoutesExclusive("ipRoutesExclusiveResource",
        directory_id="string",
        ip_routes=[{
            "cidr_ip": "string",
            "cidr_ipv6": "string",
            "description": "string",
        }],
        region="string",
        timeouts={
            "create": "string",
            "update": "string",
        },
        update_security_group_for_directory_controllers=False)
    
    const ipRoutesExclusiveResource = new aws.directoryservice.IpRoutesExclusive("ipRoutesExclusiveResource", {
        directoryId: "string",
        ipRoutes: [{
            cidrIp: "string",
            cidrIpv6: "string",
            description: "string",
        }],
        region: "string",
        timeouts: {
            create: "string",
            update: "string",
        },
        updateSecurityGroupForDirectoryControllers: false,
    });
    
    type: aws:directoryservice:IpRoutesExclusive
    properties:
        directoryId: string
        ipRoutes:
            - cidrIp: string
              cidrIpv6: string
              description: string
        region: string
        timeouts:
            create: string
            update: string
        updateSecurityGroupForDirectoryControllers: false
    

    IpRoutesExclusive 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 IpRoutesExclusive resource accepts the following input properties:

    DirectoryId string

    Identifier of the directory. Changing this forces a new resource to be created.

    The following arguments are optional:

    IpRoutes List<IpRoutesExclusiveIpRoute>
    Set of IP routes the directory should have. Omit all ipRoute blocks to remove every IP route from the directory. See ipRoute Block below.
    Region string
    Region where this resource is managed. Defaults to the Region set in the provider configuration.
    Timeouts IpRoutesExclusiveTimeouts
    UpdateSecurityGroupForDirectoryControllers bool
    Whether to update the inbound and outbound rules of the security group for the directory controllers when adding IP routes. Applies only to IP routes added by this resource. Defaults to false.
    DirectoryId string

    Identifier of the directory. Changing this forces a new resource to be created.

    The following arguments are optional:

    IpRoutes []IpRoutesExclusiveIpRouteArgs
    Set of IP routes the directory should have. Omit all ipRoute blocks to remove every IP route from the directory. See ipRoute Block below.
    Region string
    Region where this resource is managed. Defaults to the Region set in the provider configuration.
    Timeouts IpRoutesExclusiveTimeoutsArgs
    UpdateSecurityGroupForDirectoryControllers bool
    Whether to update the inbound and outbound rules of the security group for the directory controllers when adding IP routes. Applies only to IP routes added by this resource. Defaults to false.
    directory_id string

    Identifier of the directory. Changing this forces a new resource to be created.

    The following arguments are optional:

    ip_routes list(object)
    Set of IP routes the directory should have. Omit all ipRoute blocks to remove every IP route from the directory. See ipRoute Block below.
    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 when adding IP routes. Applies only to IP routes added by this resource. Defaults to false.
    directoryId String

    Identifier of the directory. Changing this forces a new resource to be created.

    The following arguments are optional:

    ipRoutes List<IpRoutesExclusiveIpRoute>
    Set of IP routes the directory should have. Omit all ipRoute blocks to remove every IP route from the directory. See ipRoute Block below.
    region String
    Region where this resource is managed. Defaults to the Region set in the provider configuration.
    timeouts IpRoutesExclusiveTimeouts
    updateSecurityGroupForDirectoryControllers Boolean
    Whether to update the inbound and outbound rules of the security group for the directory controllers when adding IP routes. Applies only to IP routes added by this resource. Defaults to false.
    directoryId string

    Identifier of the directory. Changing this forces a new resource to be created.

    The following arguments are optional:

    ipRoutes IpRoutesExclusiveIpRoute[]
    Set of IP routes the directory should have. Omit all ipRoute blocks to remove every IP route from the directory. See ipRoute Block below.
    region string
    Region where this resource is managed. Defaults to the Region set in the provider configuration.
    timeouts IpRoutesExclusiveTimeouts
    updateSecurityGroupForDirectoryControllers boolean
    Whether to update the inbound and outbound rules of the security group for the directory controllers when adding IP routes. Applies only to IP routes added by this resource. Defaults to false.
    directory_id str

    Identifier of the directory. Changing this forces a new resource to be created.

    The following arguments are optional:

    ip_routes Sequence[IpRoutesExclusiveIpRouteArgs]
    Set of IP routes the directory should have. Omit all ipRoute blocks to remove every IP route from the directory. See ipRoute Block below.
    region str
    Region where this resource is managed. Defaults to the Region set in the provider configuration.
    timeouts IpRoutesExclusiveTimeoutsArgs
    update_security_group_for_directory_controllers bool
    Whether to update the inbound and outbound rules of the security group for the directory controllers when adding IP routes. Applies only to IP routes added by this resource. Defaults to false.
    directoryId String

    Identifier of the directory. Changing this forces a new resource to be created.

    The following arguments are optional:

    ipRoutes List<Property Map>
    Set of IP routes the directory should have. Omit all ipRoute blocks to remove every IP route from the directory. See ipRoute Block below.
    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 when adding IP routes. Applies only to IP routes added by this resource. Defaults to false.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the IpRoutesExclusive 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 IpRoutesExclusive Resource

    Get an existing IpRoutesExclusive 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?: IpRoutesExclusiveState, opts?: CustomResourceOptions): IpRoutesExclusive
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            directory_id: Optional[str] = None,
            ip_routes: Optional[Sequence[IpRoutesExclusiveIpRouteArgs]] = None,
            region: Optional[str] = None,
            timeouts: Optional[IpRoutesExclusiveTimeoutsArgs] = None,
            update_security_group_for_directory_controllers: Optional[bool] = None) -> IpRoutesExclusive
    func GetIpRoutesExclusive(ctx *Context, name string, id IDInput, state *IpRoutesExclusiveState, opts ...ResourceOption) (*IpRoutesExclusive, error)
    public static IpRoutesExclusive Get(string name, Input<string> id, IpRoutesExclusiveState? state, CustomResourceOptions? opts = null)
    public static IpRoutesExclusive get(String name, Output<String> id, IpRoutesExclusiveState state, CustomResourceOptions options)
    resources:  _:    type: aws:directoryservice:IpRoutesExclusive    get:      id: ${id}
    import {
      to = aws_directoryservice_ip_routes_exclusive.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:
    DirectoryId string

    Identifier of the directory. Changing this forces a new resource to be created.

    The following arguments are optional:

    IpRoutes List<IpRoutesExclusiveIpRoute>
    Set of IP routes the directory should have. Omit all ipRoute blocks to remove every IP route from the directory. See ipRoute Block below.
    Region string
    Region where this resource is managed. Defaults to the Region set in the provider configuration.
    Timeouts IpRoutesExclusiveTimeouts
    UpdateSecurityGroupForDirectoryControllers bool
    Whether to update the inbound and outbound rules of the security group for the directory controllers when adding IP routes. Applies only to IP routes added by this resource. Defaults to false.
    DirectoryId string

    Identifier of the directory. Changing this forces a new resource to be created.

    The following arguments are optional:

    IpRoutes []IpRoutesExclusiveIpRouteArgs
    Set of IP routes the directory should have. Omit all ipRoute blocks to remove every IP route from the directory. See ipRoute Block below.
    Region string
    Region where this resource is managed. Defaults to the Region set in the provider configuration.
    Timeouts IpRoutesExclusiveTimeoutsArgs
    UpdateSecurityGroupForDirectoryControllers bool
    Whether to update the inbound and outbound rules of the security group for the directory controllers when adding IP routes. Applies only to IP routes added by this resource. Defaults to false.
    directory_id string

    Identifier of the directory. Changing this forces a new resource to be created.

    The following arguments are optional:

    ip_routes list(object)
    Set of IP routes the directory should have. Omit all ipRoute blocks to remove every IP route from the directory. See ipRoute Block below.
    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 when adding IP routes. Applies only to IP routes added by this resource. Defaults to false.
    directoryId String

    Identifier of the directory. Changing this forces a new resource to be created.

    The following arguments are optional:

    ipRoutes List<IpRoutesExclusiveIpRoute>
    Set of IP routes the directory should have. Omit all ipRoute blocks to remove every IP route from the directory. See ipRoute Block below.
    region String
    Region where this resource is managed. Defaults to the Region set in the provider configuration.
    timeouts IpRoutesExclusiveTimeouts
    updateSecurityGroupForDirectoryControllers Boolean
    Whether to update the inbound and outbound rules of the security group for the directory controllers when adding IP routes. Applies only to IP routes added by this resource. Defaults to false.
    directoryId string

    Identifier of the directory. Changing this forces a new resource to be created.

    The following arguments are optional:

    ipRoutes IpRoutesExclusiveIpRoute[]
    Set of IP routes the directory should have. Omit all ipRoute blocks to remove every IP route from the directory. See ipRoute Block below.
    region string
    Region where this resource is managed. Defaults to the Region set in the provider configuration.
    timeouts IpRoutesExclusiveTimeouts
    updateSecurityGroupForDirectoryControllers boolean
    Whether to update the inbound and outbound rules of the security group for the directory controllers when adding IP routes. Applies only to IP routes added by this resource. Defaults to false.
    directory_id str

    Identifier of the directory. Changing this forces a new resource to be created.

    The following arguments are optional:

    ip_routes Sequence[IpRoutesExclusiveIpRouteArgs]
    Set of IP routes the directory should have. Omit all ipRoute blocks to remove every IP route from the directory. See ipRoute Block below.
    region str
    Region where this resource is managed. Defaults to the Region set in the provider configuration.
    timeouts IpRoutesExclusiveTimeoutsArgs
    update_security_group_for_directory_controllers bool
    Whether to update the inbound and outbound rules of the security group for the directory controllers when adding IP routes. Applies only to IP routes added by this resource. Defaults to false.
    directoryId String

    Identifier of the directory. Changing this forces a new resource to be created.

    The following arguments are optional:

    ipRoutes List<Property Map>
    Set of IP routes the directory should have. Omit all ipRoute blocks to remove every IP route from the directory. See ipRoute Block below.
    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 when adding IP routes. Applies only to IP routes added by this resource. Defaults to false.

    Supporting Types

    IpRoutesExclusiveIpRoute, IpRoutesExclusiveIpRouteArgs

    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. Must be unique across all ipRoute blocks.
    CidrIpv6 string
    IPv6 CIDR block, such as 2001:db8::/64. For a single address, use a /128 block. Must be unique across all ipRoute blocks.
    Description string
    Description of the address block.
    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. Must be unique across all ipRoute blocks.
    CidrIpv6 string
    IPv6 CIDR block, such as 2001:db8::/64. For a single address, use a /128 block. Must be unique across all ipRoute blocks.
    Description string
    Description of the address block.
    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. Must be unique across all ipRoute blocks.
    cidr_ipv6 string
    IPv6 CIDR block, such as 2001:db8::/64. For a single address, use a /128 block. Must be unique across all ipRoute blocks.
    description string
    Description of the address block.
    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. Must be unique across all ipRoute blocks.
    cidrIpv6 String
    IPv6 CIDR block, such as 2001:db8::/64. For a single address, use a /128 block. Must be unique across all ipRoute blocks.
    description String
    Description of the address block.
    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. Must be unique across all ipRoute blocks.
    cidrIpv6 string
    IPv6 CIDR block, such as 2001:db8::/64. For a single address, use a /128 block. Must be unique across all ipRoute blocks.
    description string
    Description of the address block.
    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. Must be unique across all ipRoute blocks.
    cidr_ipv6 str
    IPv6 CIDR block, such as 2001:db8::/64. For a single address, use a /128 block. Must be unique across all ipRoute blocks.
    description str
    Description of the address block.
    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. Must be unique across all ipRoute blocks.
    cidrIpv6 String
    IPv6 CIDR block, such as 2001:db8::/64. For a single address, use a /128 block. Must be unique across all ipRoute blocks.
    description String
    Description of the address block.

    IpRoutesExclusiveTimeouts, IpRoutesExclusiveTimeoutsArgs

    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).
    Update 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).
    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).
    Update 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).
    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).
    update 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).
    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).
    update 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).
    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).
    update 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).
    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).
    update 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).
    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).
    update 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).

    Import

    Identity Schema

    Required

    • directoryId (String) Identifier of the directory.

    Optional

    • accountId (String) AWS Account where this resource is managed.
    • region (String) Region where this resource is managed.

    Using pulumi import, import exclusive management of IP routes using the directory ID. For example:

    $ pulumi import aws:directoryservice/ipRoutesExclusive:IpRoutesExclusive example d-1234567890
    

    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

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial