com.pulumi.aws.securityhub.OrganizationConfiguration Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws Show documentation
Show all versions of aws Show documentation
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
package com.pulumi.aws.securityhub;
import com.pulumi.aws.Utilities;
import com.pulumi.aws.securityhub.OrganizationConfigurationArgs;
import com.pulumi.aws.securityhub.inputs.OrganizationConfigurationState;
import com.pulumi.aws.securityhub.outputs.OrganizationConfigurationOrganizationConfiguration;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Export;
import com.pulumi.core.annotations.ResourceType;
import com.pulumi.core.internal.Codegen;
import java.lang.Boolean;
import java.lang.String;
import javax.annotation.Nullable;
/**
* Manages the Security Hub Organization Configuration.
*
* > **NOTE:** This resource requires an `aws.securityhub.OrganizationAdminAccount` to be configured (not necessarily with Pulumi). More information about managing Security Hub in an organization can be found in the [Managing administrator and member accounts](https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-accounts.html) documentation.
*
* > **NOTE:** In order to set the `configuration_type` to `CENTRAL`, the delegated admin must be a member account of the organization and not the management account. Central configuration also requires an `aws.securityhub.FindingAggregator` to be configured.
*
* > **NOTE:** This is an advanced AWS resource. Pulumi will automatically assume management of the Security Hub Organization Configuration without import and perform no actions on removal from the Pulumi program.
*
* > **NOTE:** Deleting this resource resets security hub to a local organization configuration with auto enable false.
*
* ## Example Usage
*
* ### Local Configuration
*
* <!--Start PulumiCodeChooser -->
*
* {@code
* 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.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.List;
* import java.util.ArrayList;
* 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 exampleOrganizationAdminAccount = new OrganizationAdminAccount("exampleOrganizationAdminAccount", OrganizationAdminAccountArgs.builder()
* .adminAccountId("123456789012")
* .build(), CustomResourceOptions.builder()
* .dependsOn(example)
* .build());
*
* var exampleOrganizationConfiguration = new OrganizationConfiguration("exampleOrganizationConfiguration", OrganizationConfigurationArgs.builder()
* .autoEnable(true)
* .build());
*
* }
* }
* }
*
* <!--End PulumiCodeChooser -->
*
* ### Central Configuration
*
* <!--Start PulumiCodeChooser -->
*
* {@code
* package generated_program;
*
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.aws.securityhub.OrganizationAdminAccount;
* import com.pulumi.aws.securityhub.OrganizationAdminAccountArgs;
* import com.pulumi.aws.securityhub.FindingAggregator;
* import com.pulumi.aws.securityhub.FindingAggregatorArgs;
* import com.pulumi.aws.securityhub.OrganizationConfiguration;
* import com.pulumi.aws.securityhub.OrganizationConfigurationArgs;
* import com.pulumi.aws.securityhub.inputs.OrganizationConfigurationOrganizationConfigurationArgs;
* import com.pulumi.resources.CustomResourceOptions;
* import java.util.List;
* import java.util.ArrayList;
* 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 OrganizationAdminAccount("example", OrganizationAdminAccountArgs.builder()
* .adminAccountId("123456789012")
* .build(), CustomResourceOptions.builder()
* .dependsOn(exampleAwsOrganizationsOrganization)
* .build());
*
* var exampleFindingAggregator = new FindingAggregator("exampleFindingAggregator", FindingAggregatorArgs.builder()
* .linkingMode("ALL_REGIONS")
* .build(), CustomResourceOptions.builder()
* .dependsOn(example)
* .build());
*
* var exampleOrganizationConfiguration = new OrganizationConfiguration("exampleOrganizationConfiguration", OrganizationConfigurationArgs.builder()
* .autoEnable(false)
* .autoEnableStandards("NONE")
* .organizationConfiguration(OrganizationConfigurationOrganizationConfigurationArgs.builder()
* .configurationType("CENTRAL")
* .build())
* .build(), CustomResourceOptions.builder()
* .dependsOn(exampleFindingAggregator)
* .build());
*
* }
* }
* }
*
* <!--End PulumiCodeChooser -->
*
* ## Import
*
* Using `pulumi import`, import an existing Security Hub enabled account using the AWS account ID. For example:
*
* ```sh
* $ pulumi import aws:securityhub/organizationConfiguration:OrganizationConfiguration example 123456789012
* ```
*
*/
@ResourceType(type="aws:securityhub/organizationConfiguration:OrganizationConfiguration")
public class OrganizationConfiguration extends com.pulumi.resources.CustomResource {
/**
* Whether to automatically enable Security Hub for new accounts in the organization.
*
*/
@Export(name="autoEnable", refs={Boolean.class}, tree="[0]")
private Output autoEnable;
/**
* @return Whether to automatically enable Security Hub for new accounts in the organization.
*
*/
public Output autoEnable() {
return this.autoEnable;
}
/**
* Whether to automatically enable Security Hub default standards for new member accounts in the organization. By default, this parameter is equal to `DEFAULT`, and new member accounts are automatically enabled with default Security Hub standards. To opt out of enabling default standards for new member accounts, set this parameter equal to `NONE`.
*
*/
@Export(name="autoEnableStandards", refs={String.class}, tree="[0]")
private Output autoEnableStandards;
/**
* @return Whether to automatically enable Security Hub default standards for new member accounts in the organization. By default, this parameter is equal to `DEFAULT`, and new member accounts are automatically enabled with default Security Hub standards. To opt out of enabling default standards for new member accounts, set this parameter equal to `NONE`.
*
*/
public Output autoEnableStandards() {
return this.autoEnableStandards;
}
/**
* Provides information about the way an organization is configured in Security Hub.
*
*/
@Export(name="organizationConfiguration", refs={OrganizationConfigurationOrganizationConfiguration.class}, tree="[0]")
private Output organizationConfiguration;
/**
* @return Provides information about the way an organization is configured in Security Hub.
*
*/
public Output organizationConfiguration() {
return this.organizationConfiguration;
}
/**
*
* @param name The _unique_ name of the resulting resource.
*/
public OrganizationConfiguration(java.lang.String name) {
this(name, OrganizationConfigurationArgs.Empty);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
*/
public OrganizationConfiguration(java.lang.String name, OrganizationConfigurationArgs args) {
this(name, args, null);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
* @param options A bag of options that control this resource's behavior.
*/
public OrganizationConfiguration(java.lang.String name, OrganizationConfigurationArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("aws:securityhub/organizationConfiguration:OrganizationConfiguration", name, makeArgs(args, options), makeResourceOptions(options, Codegen.empty()), false);
}
private OrganizationConfiguration(java.lang.String name, Output id, @Nullable OrganizationConfigurationState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("aws:securityhub/organizationConfiguration:OrganizationConfiguration", name, state, makeResourceOptions(options, id), false);
}
private static OrganizationConfigurationArgs makeArgs(OrganizationConfigurationArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
if (options != null && options.getUrn().isPresent()) {
return null;
}
return args == null ? OrganizationConfigurationArgs.Empty : args;
}
private static com.pulumi.resources.CustomResourceOptions makeResourceOptions(@Nullable com.pulumi.resources.CustomResourceOptions options, @Nullable Output id) {
var defaultOptions = com.pulumi.resources.CustomResourceOptions.builder()
.version(Utilities.getVersion())
.build();
return com.pulumi.resources.CustomResourceOptions.merge(defaultOptions, options, id);
}
/**
* Get an existing Host resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state
* @param options Optional settings to control the behavior of the CustomResource.
*/
public static OrganizationConfiguration get(java.lang.String name, Output id, @Nullable OrganizationConfigurationState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
return new OrganizationConfiguration(name, id, state, options);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy