Package com.pulumi.aws.securityhub

Class OrganizationAdminAccount

  • public class OrganizationAdminAccount
extends com.pulumi.resources.CustomResource
    Manages a Security Hub administrator account for an organization. The AWS account utilizing this resource must be an Organizations primary account. More information about Organizations support in Security Hub can be found in the [Security Hub User Guide](https://docs.aws.amazon.com/securityhub/latest/userguide/designate-orgs-admin-account.html). ## Example Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.organizations.Organization;
 import com.pulumi.aws.organizations.OrganizationArgs;
 import com.pulumi.aws.securityhub.Account;
 import com.pulumi.aws.securityhub.OrganizationAdminAccount;
 import com.pulumi.aws.securityhub.OrganizationAdminAccountArgs;
 import com.pulumi.aws.securityhub.OrganizationConfiguration;
 import com.pulumi.aws.securityhub.OrganizationConfigurationArgs;
 import com.pulumi.resources.CustomResourceOptions;
 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 Organization("example", OrganizationArgs.builder()
             .awsServiceAccessPrincipals("securityhub.amazonaws.com")
             .featureSet("ALL")
             .build());
 
         var exampleAccount = new Account("exampleAccount");
 
         var exampleOrganizationAdminAccount = new OrganizationAdminAccount("exampleOrganizationAdminAccount", OrganizationAdminAccountArgs.builder()
             .adminAccountId("123456789012")
             .build(), CustomResourceOptions.builder()
                 .dependsOn(example)
                 .build());
 
         // Auto enable security hub in organization member accounts
         var exampleOrganizationConfiguration = new OrganizationConfiguration("exampleOrganizationConfiguration", OrganizationConfigurationArgs.builder()
             .autoEnable(true)
             .build());
 
     }
 }
    ## Import ### Identity Schema #### Required - `adminAccountId` (String) ID of the administrator AWS account. #### Optional * `accountId` (String) AWS Account where this resource is managed. * `region` (String) Region where this resource is managed. Using `pulumi import`, import Security Hub administrator accounts using `adminAccountId`. For example: ```sh $ pulumi import aws:securityhub/organizationAdminAccount:OrganizationAdminAccount example 123456789012 ```

    • 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> adminAccountId()  
      static OrganizationAdminAccount get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, OrganizationAdminAccountState 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()  

      • 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

      • OrganizationAdminAccount

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

      • OrganizationAdminAccount

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

      • OrganizationAdminAccount

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

      • adminAccountId

        public com.pulumi.core.Output<java.lang.String> adminAccountId()
        Returns:
        The AWS account identifier of the account to designate as the Security Hub administrator account.

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

      • get

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