Package com.pulumi.aws.directoryservice

Class ServiceRegion

  • public class ServiceRegion
extends com.pulumi.resources.CustomResource
    Manages a replicated Region and directory for Multi-Region replication. Multi-Region replication is only supported for the Enterprise Edition of AWS Managed Microsoft AD. ## Example Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.AwsFunctions;
 import com.pulumi.aws.inputs.GetRegionArgs;
 import com.pulumi.aws.inputs.GetAvailabilityZonesArgs;
 import com.pulumi.aws.inputs.GetAvailabilityZonesFilterArgs;
 import com.pulumi.aws.ec2.Vpc;
 import com.pulumi.aws.ec2.VpcArgs;
 import com.pulumi.aws.ec2.Subnet;
 import com.pulumi.aws.ec2.SubnetArgs;
 import com.pulumi.std.StdFunctions;
 import com.pulumi.std.inputs.CidrsubnetArgs;
 import com.pulumi.aws.directoryservice.Directory;
 import com.pulumi.aws.directoryservice.DirectoryArgs;
 import com.pulumi.aws.directoryservice.inputs.DirectoryVpcSettingsArgs;
 import com.pulumi.aws.directoryservice.ServiceRegion;
 import com.pulumi.aws.directoryservice.ServiceRegionArgs;
 import com.pulumi.aws.directoryservice.inputs.ServiceRegionVpcSettingsArgs;
 import com.pulumi.codegen.internal.KeyedValue;
 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) {
         final var example = AwsFunctions.getRegion(GetRegionArgs.builder()
             .build());
 
         final var available = AwsFunctions.getAvailabilityZones(GetAvailabilityZonesArgs.builder()
             .filters(GetAvailabilityZonesFilterArgs.builder()
                 .name("opt-in-status")
                 .values("opt-in-not-required")
                 .build())
             .state("available")
             .build());
 
         var exampleVpc = new Vpc("exampleVpc", VpcArgs.builder()
             .cidrBlock("10.0.0.0/16")
             .tags(Map.of("Name", "Primary"))
             .build());
 
         for (var i = 0; i < 2; i++) {
             new Subnet("exampleSubnet-" + i, SubnetArgs.builder()
                 .vpcId(exampleVpc.id())
                 .availabilityZone(available.names()[range.value()])
                 .cidrBlock(StdFunctions.cidrsubnet(CidrsubnetArgs.builder()
                     .input(exampleVpc.cidrBlock())
                     .newbits(8)
                     .netnum(range.value())
                     .build()).applyValue(_invoke -> _invoke.result()))
                 .tags(Map.of("Name", "Primary"))
                 .build());
 
         
 }
         var exampleDirectory = new Directory("exampleDirectory", DirectoryArgs.builder()
             .vpcSettings(DirectoryVpcSettingsArgs.builder()
                 .vpcId(exampleVpc.id())
                 .subnetIds(exampleSubnet.stream().map(element -> element.id()).collect(toList()))
                 .build())
             .name("example.com")
             .password("SuperSecretPassw0rd")
             .type("MicrosoftAD")
             .build());
 
         final var available-secondary = AwsFunctions.getAvailabilityZones(GetAvailabilityZonesArgs.builder()
             .filters(GetAvailabilityZonesFilterArgs.builder()
                 .name("opt-in-status")
                 .values("opt-in-not-required")
                 .build())
             .state("available")
             .build());
 
         var example_secondary = new Vpc("example-secondary", VpcArgs.builder()
             .cidrBlock("10.1.0.0/16")
             .tags(Map.of("Name", "Secondary"))
             .build());
 
         for (var i = 0; i < 2; i++) {
             new Subnet("example-secondarySubnet-" + i, SubnetArgs.builder()
                 .vpcId(example_secondary.id())
                 .availabilityZone(available_secondary.names()[range.value()])
                 .cidrBlock(StdFunctions.cidrsubnet(CidrsubnetArgs.builder()
                     .input(example_secondary.cidrBlock())
                     .newbits(8)
                     .netnum(range.value())
                     .build()).applyValue(_invoke -> _invoke.result()))
                 .tags(Map.of("Name", "Secondary"))
                 .build());
 
         
 }
         var exampleServiceRegion = new ServiceRegion("exampleServiceRegion", ServiceRegionArgs.builder()
             .vpcSettings(ServiceRegionVpcSettingsArgs.builder()
                 .vpcId(example_secondary.id())
                 .subnetIds(example_secondarySubnet.stream().map(element -> element.id()).collect(toList()))
                 .build())
             .directoryId(exampleDirectory.id())
             .regionName(example.region())
             .tags(Map.of("Name", "Secondary"))
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import Replicated Regions using directory ID,Region name. For example: ```sh $ pulumi import aws:directoryservice/serviceRegion:ServiceRegion example d-9267651497,us-east-2 ```

    • 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.Integer> desiredNumberOfDomainControllers()  
      com.pulumi.core.Output<java.lang.String> directoryId()  
      static ServiceRegion get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, ServiceRegionState 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.lang.String> region()  
      com.pulumi.core.Output<java.lang.String> regionName()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  
      com.pulumi.core.Output<ServiceRegionVpcSettings> vpcSettings()  

      • 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

      • ServiceRegion

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

      • ServiceRegion

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

      • ServiceRegion

        public ServiceRegion​(java.lang.String name,
                     ServiceRegionArgs 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

      • desiredNumberOfDomainControllers

        public com.pulumi.core.Output<java.lang.Integer> desiredNumberOfDomainControllers()
        Returns:
        The number of domain controllers desired in the replicated directory. Minimum value of `2`.

      • directoryId

        public com.pulumi.core.Output<java.lang.String> directoryId()
        Returns:
        The identifier of the directory to which you want to add Region replication.

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • regionName

        public com.pulumi.core.Output<java.lang.String> regionName()
        Returns:
        The name of the Region where you want to add domain controllers for replication.

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Map of tags to assign to this resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
        Returns:
        A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

      • vpcSettings

        public com.pulumi.core.Output<ServiceRegionVpcSettings> vpcSettings()
        Returns:
        VPC information in the replicated Region. Detailed below.

      • get

        public static ServiceRegion get​(java.lang.String name,
                                com.pulumi.core.Output<java.lang.String> id,
                                @Nullable
                                ServiceRegionState 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.