Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. securityhub
  5. OrganizationConfiguration

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
pulumi/pulumi-aws-native

aws-native.securityhub.OrganizationConfiguration

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
pulumi/pulumi-aws-native

    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.

    Create OrganizationConfiguration Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new OrganizationConfiguration(name: string, args: OrganizationConfigurationArgs, opts?: CustomResourceOptions);
    @overload
def OrganizationConfiguration(resource_name: str,
                              args: OrganizationConfigurationArgs,
                              opts: Optional[ResourceOptions] = None)

@overload
def OrganizationConfiguration(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              auto_enable: Optional[bool] = None,
                              auto_enable_standards: Optional[OrganizationConfigurationAutoEnableStandards] = None,
                              configuration_type: Optional[OrganizationConfigurationConfigurationType] = 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-native:securityhub:OrganizationConfiguration
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    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

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The OrganizationConfiguration resource accepts the following input properties:

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

    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.
    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.
    Id string
    The provider-assigned unique ID for this managed resource.
    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.
    id String
    The provider-assigned unique ID for this managed resource.
    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.
    id string
    The provider-assigned unique ID for this managed resource.
    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.
    id str
    The provider-assigned unique ID for this managed resource.
    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.
    id String
    The provider-assigned unique ID for this managed resource.
    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, OrganizationConfigurationAutoEnableStandardsArgs

    Default
    DEFAULT
    None
    NONE
    OrganizationConfigurationAutoEnableStandardsDefault
    DEFAULT
    OrganizationConfigurationAutoEnableStandardsNone
    NONE
    Default
    DEFAULT
    None
    NONE
    Default
    DEFAULT
    None
    NONE
    DEFAULT
    DEFAULT
    NONE
    NONE
    "DEFAULT"
    DEFAULT
    "NONE"
    NONE

    OrganizationConfigurationConfigurationType, OrganizationConfigurationConfigurationTypeArgs

    Central
    CENTRAL
    Local
    LOCAL
    OrganizationConfigurationConfigurationTypeCentral
    CENTRAL
    OrganizationConfigurationConfigurationTypeLocal
    LOCAL
    Central
    CENTRAL
    Local
    LOCAL
    Central
    CENTRAL
    Local
    LOCAL
    CENTRAL
    CENTRAL
    LOCAL
    LOCAL
    "CENTRAL"
    CENTRAL
    "LOCAL"
    LOCAL

    OrganizationConfigurationStatus, OrganizationConfigurationStatusArgs

    Pending
    PENDING
    Enabled
    ENABLED
    Failed
    FAILED
    OrganizationConfigurationStatusPending
    PENDING
    OrganizationConfigurationStatusEnabled
    ENABLED
    OrganizationConfigurationStatusFailed
    FAILED
    Pending
    PENDING
    Enabled
    ENABLED
    Failed
    FAILED
    Pending
    PENDING
    Enabled
    ENABLED
    Failed
    FAILED
    PENDING
    PENDING
    ENABLED
    ENABLED
    FAILED
    FAILED
    "PENDING"
    PENDING
    "ENABLED"
    ENABLED
    "FAILED"
    FAILED

    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
    pulumi/pulumi-aws-native