Package com.pulumi.aws.directoryservice

Class SharedDirectory

  • public class SharedDirectory
extends com.pulumi.resources.CustomResource
    Manages a directory in your account (directory owner) shared with another account (directory consumer). ## Example 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.SharedDirectory;
 import com.pulumi.aws.directoryservice.SharedDirectoryArgs;
 import com.pulumi.aws.directoryservice.inputs.SharedDirectoryTargetArgs;
 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("tf-example")
             .password("SuperSecretPassw0rd")
             .type("MicrosoftAD")
             .edition("Standard")
             .build());
 
         var exampleSharedDirectory = new SharedDirectory("exampleSharedDirectory", SharedDirectoryArgs.builder()
             .target(SharedDirectoryTargetArgs.builder()
                 .id(receiver.accountId())
                 .build())
             .directoryId(example.id())
             .notes("You wanna have a catch?")
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import Directory Service Shared Directories using the owner directory ID/shared directory ID. For example: ```sh $ pulumi import aws:directoryservice/sharedDirectory:SharedDirectory example d-1234567890/d-9267633ece ```

    • 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 SharedDirectory get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, SharedDirectoryState 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.lang.String>> method()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> notes()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.String> sharedDirectoryId()  
      com.pulumi.core.Output<SharedDirectoryTarget> target()  

      • 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

      • SharedDirectory

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

      • SharedDirectory

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

      • SharedDirectory

        public SharedDirectory​(java.lang.String name,
                       SharedDirectoryArgs 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 Managed Microsoft AD directory that you want to share with other accounts.

      • method

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> method()
        Returns:
        Method used when sharing a directory. Valid values are `ORGANIZATIONS` and `HANDSHAKE`. Default is `HANDSHAKE`.

      • notes

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> notes()
        Returns:
        Message sent by the directory owner to the directory consumer to help the directory consumer administrator determine whether to approve or reject the share invitation.

      • 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.

      • sharedDirectoryId

        public com.pulumi.core.Output<java.lang.String> sharedDirectoryId()
        Returns:
        Identifier of the directory that is stored in the directory consumer account that corresponds to the shared directory in the owner account.

      • target

        public com.pulumi.core.Output<SharedDirectoryTarget> target()
        Returns:
        Identifier for the directory consumer account with whom the directory is to be shared. See below. The following arguments are optional:

      • get

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