Package com.pulumi.aws.directoryservice

Class IpRoutesExclusive

  • public class IpRoutesExclusive
extends com.pulumi.resources.CustomResource
    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](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_update-directory-type.html). ## Example Usage ### Basic Usage 
     
 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.id())
                 .subnetIds(exampleAwsSubnet.stream().map(element -> element.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());
 
     }
 }
    ### IPv6 IPv6 routes require an existing directory that has been updated to dual-stack. 
     
 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());
 
     }
 }
    ### 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. 
     
 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.id())
             .build());
 
     }
 }
    ## 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: ```sh $ pulumi import aws:directoryservice/ipRoutesExclusive:IpRoutesExclusive example d-1234567890 ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> directoryId()  
      static IpRoutesExclusive get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, IpRoutesExclusiveState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.util.Optional<java.util.List<IpRoutesExclusiveIpRoute>>> ipRoutes()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.util.Optional<IpRoutesExclusiveTimeouts>> timeouts()  
      com.pulumi.core.Output<java.lang.Boolean> updateSecurityGroupForDirectoryControllers()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • IpRoutesExclusive

        public IpRoutesExclusive​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • IpRoutesExclusive

        public IpRoutesExclusive​(java.lang.String name,
                         IpRoutesExclusiveArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • IpRoutesExclusive

        public IpRoutesExclusive​(java.lang.String name,
                         IpRoutesExclusiveArgs args,
                         @Nullable
                         com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • directoryId

        public com.pulumi.core.Output<java.lang.String> directoryId()
        Returns:
        Identifier of the directory. Changing this forces a new resource to be created. The following arguments are optional:

      • ipRoutes

        public com.pulumi.core.Output<java.util.Optional<java.util.List<IpRoutesExclusiveIpRoute>>> ipRoutes()
        Returns:
        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

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource is managed. Defaults to the Region set in the provider configuration.

      • updateSecurityGroupForDirectoryControllers

        public com.pulumi.core.Output<java.lang.Boolean> updateSecurityGroupForDirectoryControllers()
        Returns:
        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`.

      • get

        public static IpRoutesExclusive get​(java.lang.String name,
                                    com.pulumi.core.Output<java.lang.String> id,
                                    @Nullable
                                    IpRoutesExclusiveState state,
                                    @Nullable
                                    com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.