1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. securityhub
  5. getOrganizationConfiguration

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi

aws-native.securityhub.getOrganizationConfiguration

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi

    The AWS::SecurityHub::OrganizationConfiguration resource represents the configuration of your organization in Security Hub. Only the Security Hub administrator account can create Organization Configuration resource in each region and can opt-in to Central Configuration only in the aggregation region of FindingAggregator.

    Using getOrganizationConfiguration

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getOrganizationConfiguration(args: GetOrganizationConfigurationArgs, opts?: InvokeOptions): Promise<GetOrganizationConfigurationResult>
    function getOrganizationConfigurationOutput(args: GetOrganizationConfigurationOutputArgs, opts?: InvokeOptions): Output<GetOrganizationConfigurationResult>
    def get_organization_configuration(organization_configuration_identifier: Optional[str] = None,
                                       opts: Optional[InvokeOptions] = None) -> GetOrganizationConfigurationResult
    def get_organization_configuration_output(organization_configuration_identifier: Optional[pulumi.Input[str]] = None,
                                       opts: Optional[InvokeOptions] = None) -> Output[GetOrganizationConfigurationResult]
    func LookupOrganizationConfiguration(ctx *Context, args *LookupOrganizationConfigurationArgs, opts ...InvokeOption) (*LookupOrganizationConfigurationResult, error)
    func LookupOrganizationConfigurationOutput(ctx *Context, args *LookupOrganizationConfigurationOutputArgs, opts ...InvokeOption) LookupOrganizationConfigurationResultOutput

    > Note: This function is named LookupOrganizationConfiguration in the Go SDK.

    public static class GetOrganizationConfiguration 
    {
        public static Task<GetOrganizationConfigurationResult> InvokeAsync(GetOrganizationConfigurationArgs args, InvokeOptions? opts = null)
        public static Output<GetOrganizationConfigurationResult> Invoke(GetOrganizationConfigurationInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetOrganizationConfigurationResult> getOrganizationConfiguration(GetOrganizationConfigurationArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws-native:securityhub:getOrganizationConfiguration
      arguments:
        # arguments dictionary

    The following arguments are supported:

    OrganizationConfigurationIdentifier string
    The identifier of the OrganizationConfiguration being created and assigned as the unique identifier.
    OrganizationConfigurationIdentifier string
    The identifier of the OrganizationConfiguration being created and assigned as the unique identifier.
    organizationConfigurationIdentifier String
    The identifier of the OrganizationConfiguration being created and assigned as the unique identifier.
    organizationConfigurationIdentifier string
    The identifier of the OrganizationConfiguration being created and assigned as the unique identifier.
    organization_configuration_identifier str
    The identifier of the OrganizationConfiguration being created and assigned as the unique identifier.
    organizationConfigurationIdentifier String
    The identifier of the OrganizationConfiguration being created and assigned as the unique identifier.

    getOrganizationConfiguration Result

    The following output properties are available:

    AutoEnable bool
    Whether to automatically enable Security Hub in new member accounts when they join the organization.
    AutoEnableStandards Pulumi.AwsNative.SecurityHub.OrganizationConfigurationAutoEnableStandards
    Whether to automatically enable Security Hub default standards in new member accounts when they join the organization.
    ConfigurationType Pulumi.AwsNative.SecurityHub.OrganizationConfigurationConfigurationType
    Indicates whether the organization uses local or central configuration.
    MemberAccountLimitReached bool
    Whether the maximum number of allowed member accounts are already associated with the Security Hub administrator account.
    OrganizationConfigurationIdentifier string
    The identifier of the OrganizationConfiguration being created and assigned as the unique identifier.
    Status Pulumi.AwsNative.SecurityHub.OrganizationConfigurationStatus
    Describes whether central configuration could be enabled as the ConfigurationType for the organization.
    StatusMessage string
    Provides an explanation if the value of Status is equal to FAILED when ConfigurationType is equal to CENTRAL.
    AutoEnable bool
    Whether to automatically enable Security Hub in new member accounts when they join the organization.
    AutoEnableStandards OrganizationConfigurationAutoEnableStandards
    Whether to automatically enable Security Hub default standards in new member accounts when they join the organization.
    ConfigurationType OrganizationConfigurationConfigurationType
    Indicates whether the organization uses local or central configuration.
    MemberAccountLimitReached bool
    Whether the maximum number of allowed member accounts are already associated with the Security Hub administrator account.
    OrganizationConfigurationIdentifier string
    The identifier of the OrganizationConfiguration being created and assigned as the unique identifier.
    Status OrganizationConfigurationStatus
    Describes whether central configuration could be enabled as the ConfigurationType for the organization.
    StatusMessage string
    Provides an explanation if the value of Status is equal to FAILED when ConfigurationType is equal to CENTRAL.
    autoEnable Boolean
    Whether to automatically enable Security Hub in new member accounts when they join the organization.
    autoEnableStandards OrganizationConfigurationAutoEnableStandards
    Whether to automatically enable Security Hub default standards in new member accounts when they join the organization.
    configurationType OrganizationConfigurationConfigurationType
    Indicates whether the organization uses local or central configuration.
    memberAccountLimitReached Boolean
    Whether the maximum number of allowed member accounts are already associated with the Security Hub administrator account.
    organizationConfigurationIdentifier String
    The identifier of the OrganizationConfiguration being created and assigned as the unique identifier.
    status OrganizationConfigurationStatus
    Describes whether central configuration could be enabled as the ConfigurationType for the organization.
    statusMessage String
    Provides an explanation if the value of Status is equal to FAILED when ConfigurationType is equal to CENTRAL.
    autoEnable boolean
    Whether to automatically enable Security Hub in new member accounts when they join the organization.
    autoEnableStandards OrganizationConfigurationAutoEnableStandards
    Whether to automatically enable Security Hub default standards in new member accounts when they join the organization.
    configurationType OrganizationConfigurationConfigurationType
    Indicates whether the organization uses local or central configuration.
    memberAccountLimitReached boolean
    Whether the maximum number of allowed member accounts are already associated with the Security Hub administrator account.
    organizationConfigurationIdentifier string
    The identifier of the OrganizationConfiguration being created and assigned as the unique identifier.
    status OrganizationConfigurationStatus
    Describes whether central configuration could be enabled as the ConfigurationType for the organization.
    statusMessage string
    Provides an explanation if the value of Status is equal to FAILED when ConfigurationType is equal to CENTRAL.
    auto_enable bool
    Whether to automatically enable Security Hub in new member accounts when they join the organization.
    auto_enable_standards OrganizationConfigurationAutoEnableStandards
    Whether to automatically enable Security Hub default standards in new member accounts when they join the organization.
    configuration_type OrganizationConfigurationConfigurationType
    Indicates whether the organization uses local or central configuration.
    member_account_limit_reached bool
    Whether the maximum number of allowed member accounts are already associated with the Security Hub administrator account.
    organization_configuration_identifier str
    The identifier of the OrganizationConfiguration being created and assigned as the unique identifier.
    status OrganizationConfigurationStatus
    Describes whether central configuration could be enabled as the ConfigurationType for the organization.
    status_message str
    Provides an explanation if the value of Status is equal to FAILED when ConfigurationType is equal to CENTRAL.
    autoEnable Boolean
    Whether to automatically enable Security Hub in new member accounts when they join the organization.
    autoEnableStandards "DEFAULT" | "NONE"
    Whether to automatically enable Security Hub default standards in new member accounts when they join the organization.
    configurationType "CENTRAL" | "LOCAL"
    Indicates whether the organization uses local or central configuration.
    memberAccountLimitReached Boolean
    Whether the maximum number of allowed member accounts are already associated with the Security Hub administrator account.
    organizationConfigurationIdentifier String
    The identifier of the OrganizationConfiguration being created and assigned as the unique identifier.
    status "PENDING" | "ENABLED" | "FAILED"
    Describes whether central configuration could be enabled as the ConfigurationType for the organization.
    statusMessage String
    Provides an explanation if the value of Status is equal to FAILED when ConfigurationType is equal to CENTRAL.

    Supporting Types

    OrganizationConfigurationAutoEnableStandards

    OrganizationConfigurationConfigurationType

    OrganizationConfigurationStatus

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi