1. Packages
  2. AWS Classic
  3. API Docs
  4. securityhub
  5. OrganizationConfiguration

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.27.0 published on Monday, Mar 18, 2024 by Pulumi

aws.securityhub.OrganizationConfiguration

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.27.0 published on Monday, Mar 18, 2024 by Pulumi

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

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = new aws.organizations.Organization("example", {
        awsServiceAccessPrincipals: ["securityhub.amazonaws.com"],
        featureSet: "ALL",
    });
    const exampleOrganizationAdminAccount = new aws.securityhub.OrganizationAdminAccount("example", {adminAccountId: "123456789012"});
    const exampleOrganizationConfiguration = new aws.securityhub.OrganizationConfiguration("example", {autoEnable: true});
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.organizations.Organization("example",
        aws_service_access_principals=["securityhub.amazonaws.com"],
        feature_set="ALL")
    example_organization_admin_account = aws.securityhub.OrganizationAdminAccount("example", admin_account_id="123456789012")
    example_organization_configuration = aws.securityhub.OrganizationConfiguration("example", auto_enable=True)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/organizations"
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/securityhub"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := organizations.NewOrganization(ctx, "example", &organizations.OrganizationArgs{
    			AwsServiceAccessPrincipals: pulumi.StringArray{
    				pulumi.String("securityhub.amazonaws.com"),
    			},
    			FeatureSet: pulumi.String("ALL"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = securityhub.NewOrganizationAdminAccount(ctx, "example", &securityhub.OrganizationAdminAccountArgs{
    			AdminAccountId: pulumi.String("123456789012"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = securityhub.NewOrganizationConfiguration(ctx, "example", &securityhub.OrganizationConfigurationArgs{
    			AutoEnable: pulumi.Bool(true),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Aws.Organizations.Organization("example", new()
        {
            AwsServiceAccessPrincipals = new[]
            {
                "securityhub.amazonaws.com",
            },
            FeatureSet = "ALL",
        });
    
        var exampleOrganizationAdminAccount = new Aws.SecurityHub.OrganizationAdminAccount("example", new()
        {
            AdminAccountId = "123456789012",
        });
    
        var exampleOrganizationConfiguration = new Aws.SecurityHub.OrganizationConfiguration("example", new()
        {
            AutoEnable = true,
        });
    
    });
    
    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 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());
    
            var exampleOrganizationConfiguration = new OrganizationConfiguration("exampleOrganizationConfiguration", OrganizationConfigurationArgs.builder()        
                .autoEnable(true)
                .build());
    
        }
    }
    
    resources:
      example:
        type: aws:organizations:Organization
        properties:
          awsServiceAccessPrincipals:
            - securityhub.amazonaws.com
          featureSet: ALL
      exampleOrganizationAdminAccount:
        type: aws:securityhub:OrganizationAdminAccount
        name: example
        properties:
          adminAccountId: '123456789012'
      exampleOrganizationConfiguration:
        type: aws:securityhub:OrganizationConfiguration
        name: example
        properties:
          autoEnable: true
    

    Central Configuration

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = new aws.securityhub.OrganizationAdminAccount("example", {adminAccountId: "123456789012"});
    const exampleFindingAggregator = new aws.securityhub.FindingAggregator("example", {linkingMode: "ALL_REGIONS"});
    const exampleOrganizationConfiguration = new aws.securityhub.OrganizationConfiguration("example", {
        autoEnable: false,
        autoEnableStandards: "NONE",
        organizationConfiguration: {
            configurationType: "CENTRAL",
        },
    });
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.securityhub.OrganizationAdminAccount("example", admin_account_id="123456789012")
    example_finding_aggregator = aws.securityhub.FindingAggregator("example", linking_mode="ALL_REGIONS")
    example_organization_configuration = aws.securityhub.OrganizationConfiguration("example",
        auto_enable=False,
        auto_enable_standards="NONE",
        organization_configuration=aws.securityhub.OrganizationConfigurationOrganizationConfigurationArgs(
            configuration_type="CENTRAL",
        ))
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/securityhub"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := securityhub.NewOrganizationAdminAccount(ctx, "example", &securityhub.OrganizationAdminAccountArgs{
    			AdminAccountId: pulumi.String("123456789012"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = securityhub.NewFindingAggregator(ctx, "example", &securityhub.FindingAggregatorArgs{
    			LinkingMode: pulumi.String("ALL_REGIONS"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = securityhub.NewOrganizationConfiguration(ctx, "example", &securityhub.OrganizationConfigurationArgs{
    			AutoEnable:          pulumi.Bool(false),
    			AutoEnableStandards: pulumi.String("NONE"),
    			OrganizationConfiguration: &securityhub.OrganizationConfigurationOrganizationConfigurationArgs{
    				ConfigurationType: pulumi.String("CENTRAL"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Aws.SecurityHub.OrganizationAdminAccount("example", new()
        {
            AdminAccountId = "123456789012",
        });
    
        var exampleFindingAggregator = new Aws.SecurityHub.FindingAggregator("example", new()
        {
            LinkingMode = "ALL_REGIONS",
        });
    
        var exampleOrganizationConfiguration = new Aws.SecurityHub.OrganizationConfiguration("example", new()
        {
            AutoEnable = false,
            AutoEnableStandards = "NONE",
            OrganizationConfigurationDetails = new Aws.SecurityHub.Inputs.OrganizationConfigurationOrganizationConfigurationArgs
            {
                ConfigurationType = "CENTRAL",
            },
        });
    
    });
    
    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 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());
    
            var exampleFindingAggregator = new FindingAggregator("exampleFindingAggregator", FindingAggregatorArgs.builder()        
                .linkingMode("ALL_REGIONS")
                .build());
    
            var exampleOrganizationConfiguration = new OrganizationConfiguration("exampleOrganizationConfiguration", OrganizationConfigurationArgs.builder()        
                .autoEnable(false)
                .autoEnableStandards("NONE")
                .organizationConfiguration(OrganizationConfigurationOrganizationConfigurationArgs.builder()
                    .configurationType("CENTRAL")
                    .build())
                .build());
    
        }
    }
    
    resources:
      example:
        type: aws:securityhub:OrganizationAdminAccount
        properties:
          adminAccountId: '123456789012'
      exampleFindingAggregator:
        type: aws:securityhub:FindingAggregator
        name: example
        properties:
          linkingMode: ALL_REGIONS
      exampleOrganizationConfiguration:
        type: aws:securityhub:OrganizationConfiguration
        name: example
        properties:
          autoEnable: false
          autoEnableStandards: NONE
          organizationConfiguration:
            configurationType: CENTRAL
    

    Create OrganizationConfiguration Resource

    new OrganizationConfiguration(name: string, args: OrganizationConfigurationArgs, opts?: CustomResourceOptions);
    @overload
    def OrganizationConfiguration(resource_name: str,
                                  opts: Optional[ResourceOptions] = None,
                                  auto_enable: Optional[bool] = None,
                                  auto_enable_standards: Optional[str] = None,
                                  organization_configuration: Optional[OrganizationConfigurationOrganizationConfigurationArgs] = None)
    @overload
    def OrganizationConfiguration(resource_name: str,
                                  args: OrganizationConfigurationArgs,
                                  opts: Optional[ResourceOptions] = None)
    func NewOrganizationConfiguration(ctx *Context, name string, args OrganizationConfigurationArgs, opts ...ResourceOption) (*OrganizationConfiguration, error)
    public OrganizationConfiguration(string name, OrganizationConfigurationArgs args, CustomResourceOptions? opts = null)
    public OrganizationConfiguration(String name, OrganizationConfigurationArgs args)
    public OrganizationConfiguration(String name, OrganizationConfigurationArgs args, CustomResourceOptions options)
    
    type: aws:securityhub:OrganizationConfiguration
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args OrganizationConfigurationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args OrganizationConfigurationArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args OrganizationConfigurationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args OrganizationConfigurationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args OrganizationConfigurationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    OrganizationConfiguration Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The OrganizationConfiguration resource accepts the following input properties:

    AutoEnable bool
    Whether to automatically enable Security Hub for new accounts in the organization.
    AutoEnableStandards string
    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.
    OrganizationConfigurationDetails OrganizationConfigurationOrganizationConfiguration
    Provides information about the way an organization is configured in Security Hub.
    AutoEnable bool
    Whether to automatically enable Security Hub for new accounts in the organization.
    AutoEnableStandards string
    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.
    OrganizationConfiguration OrganizationConfigurationOrganizationConfigurationArgs
    Provides information about the way an organization is configured in Security Hub.
    autoEnable Boolean
    Whether to automatically enable Security Hub for new accounts in the organization.
    autoEnableStandards String
    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.
    organizationConfiguration OrganizationConfigurationOrganizationConfiguration
    Provides information about the way an organization is configured in Security Hub.
    autoEnable boolean
    Whether to automatically enable Security Hub for new accounts in the organization.
    autoEnableStandards string
    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.
    organizationConfiguration OrganizationConfigurationOrganizationConfiguration
    Provides information about the way an organization is configured in Security Hub.
    auto_enable bool
    Whether to automatically enable Security Hub for new accounts in the organization.
    auto_enable_standards str
    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.
    organization_configuration OrganizationConfigurationOrganizationConfigurationArgs
    Provides information about the way an organization is configured in Security Hub.
    autoEnable Boolean
    Whether to automatically enable Security Hub for new accounts in the organization.
    autoEnableStandards String
    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.
    organizationConfiguration Property Map
    Provides information about the way an organization is configured in Security Hub.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the OrganizationConfiguration resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing OrganizationConfiguration Resource

    Get an existing OrganizationConfiguration resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: OrganizationConfigurationState, opts?: CustomResourceOptions): OrganizationConfiguration
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            auto_enable: Optional[bool] = None,
            auto_enable_standards: Optional[str] = None,
            organization_configuration: Optional[OrganizationConfigurationOrganizationConfigurationArgs] = None) -> OrganizationConfiguration
    func GetOrganizationConfiguration(ctx *Context, name string, id IDInput, state *OrganizationConfigurationState, opts ...ResourceOption) (*OrganizationConfiguration, error)
    public static OrganizationConfiguration Get(string name, Input<string> id, OrganizationConfigurationState? state, CustomResourceOptions? opts = null)
    public static OrganizationConfiguration get(String name, Output<String> id, OrganizationConfigurationState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AutoEnable bool
    Whether to automatically enable Security Hub for new accounts in the organization.
    AutoEnableStandards string
    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.
    OrganizationConfigurationDetails OrganizationConfigurationOrganizationConfiguration
    Provides information about the way an organization is configured in Security Hub.
    AutoEnable bool
    Whether to automatically enable Security Hub for new accounts in the organization.
    AutoEnableStandards string
    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.
    OrganizationConfiguration OrganizationConfigurationOrganizationConfigurationArgs
    Provides information about the way an organization is configured in Security Hub.
    autoEnable Boolean
    Whether to automatically enable Security Hub for new accounts in the organization.
    autoEnableStandards String
    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.
    organizationConfiguration OrganizationConfigurationOrganizationConfiguration
    Provides information about the way an organization is configured in Security Hub.
    autoEnable boolean
    Whether to automatically enable Security Hub for new accounts in the organization.
    autoEnableStandards string
    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.
    organizationConfiguration OrganizationConfigurationOrganizationConfiguration
    Provides information about the way an organization is configured in Security Hub.
    auto_enable bool
    Whether to automatically enable Security Hub for new accounts in the organization.
    auto_enable_standards str
    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.
    organization_configuration OrganizationConfigurationOrganizationConfigurationArgs
    Provides information about the way an organization is configured in Security Hub.
    autoEnable Boolean
    Whether to automatically enable Security Hub for new accounts in the organization.
    autoEnableStandards String
    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.
    organizationConfiguration Property Map
    Provides information about the way an organization is configured in Security Hub.

    Supporting Types

    OrganizationConfigurationOrganizationConfiguration, OrganizationConfigurationOrganizationConfigurationArgs

    ConfigurationType string
    Indicates whether the organization uses local or central configuration. If using central configuration, auto_enable must be set to false and auto_enable_standards set to NONE. More information can be found in the documentation for central configuration. Valid values: LOCAL, CENTRAL.
    ConfigurationType string
    Indicates whether the organization uses local or central configuration. If using central configuration, auto_enable must be set to false and auto_enable_standards set to NONE. More information can be found in the documentation for central configuration. Valid values: LOCAL, CENTRAL.
    configurationType String
    Indicates whether the organization uses local or central configuration. If using central configuration, auto_enable must be set to false and auto_enable_standards set to NONE. More information can be found in the documentation for central configuration. Valid values: LOCAL, CENTRAL.
    configurationType string
    Indicates whether the organization uses local or central configuration. If using central configuration, auto_enable must be set to false and auto_enable_standards set to NONE. More information can be found in the documentation for central configuration. Valid values: LOCAL, CENTRAL.
    configuration_type str
    Indicates whether the organization uses local or central configuration. If using central configuration, auto_enable must be set to false and auto_enable_standards set to NONE. More information can be found in the documentation for central configuration. Valid values: LOCAL, CENTRAL.
    configurationType String
    Indicates whether the organization uses local or central configuration. If using central configuration, auto_enable must be set to false and auto_enable_standards set to NONE. More information can be found in the documentation for central configuration. Valid values: LOCAL, CENTRAL.

    Import

    Using pulumi import, import an existing Security Hub enabled account using the AWS account ID. For example:

    $ pulumi import aws:securityhub/organizationConfiguration:OrganizationConfiguration example 123456789012
    

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.27.0 published on Monday, Mar 18, 2024 by Pulumi