Package com.pulumi.aws.organizations

Class OrganizationalUnit

  • public class OrganizationalUnit
extends com.pulumi.resources.CustomResource
    Provides a resource to create an organizational unit. ## Example Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.organizations.OrganizationalUnit;
 import com.pulumi.aws.organizations.OrganizationalUnitArgs;
 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 OrganizationalUnit("example", OrganizationalUnitArgs.builder()
             .name("example")
             .parentId(exampleAwsOrganizationsOrganization.roots()[0].id())
             .build());
 
     }
 }
    ## Import ### Identity Schema #### Required * `id` (String) ID of the organizational unit. #### Optional * `accountId` (String) AWS Account where this resource is managed. Using `pulumi import`, import AWS Organizations Organizational Units using the `id`. For example: ```sh $ pulumi import aws:organizations/organizationalUnit:OrganizationalUnit example ou-1234567 ```

    • 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.util.List<OrganizationalUnitAccount>> accounts()  
      com.pulumi.core.Output<java.lang.String> arn()  
      static OrganizationalUnit get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, OrganizationalUnitState 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> name()  
      com.pulumi.core.Output<java.lang.String> parentId()  
      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()  

      • 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

      • OrganizationalUnit

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

      • OrganizationalUnit

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

      • OrganizationalUnit

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

      • accounts

        public com.pulumi.core.Output<java.util.List<OrganizationalUnitAccount>> accounts()
        Returns:
        List of child accounts for this Organizational Unit. Does not return account information for child Organizational Units. All elements have these attributes:

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        ARN of the organizational unit

      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        The name for the organizational unit

      • parentId

        public com.pulumi.core.Output<java.lang.String> parentId()
        Returns:
        ID of the parent organizational unit, which may be the root

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Key-value map of resource tags. .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.

      • get

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