AWS Native is in preview. AWS Classic is fully supported.
aws-native.securityhub.OrganizationConfiguration
Explore with Pulumi AI
AWS Native is in preview. AWS Classic is fully supported.
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
The OrganizationConfiguration resource accepts the following input properties:
- Auto
Enable bool - Whether to automatically enable Security Hub in new member accounts when they join the organization.
- Auto
Enable Pulumi.Standards Aws Native. Security Hub. Organization Configuration Auto Enable Standards - Whether to automatically enable Security Hub default standards in new member accounts when they join the organization.
- Configuration
Type Pulumi.Aws Native. Security Hub. Organization Configuration Configuration Type - 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 OrganizationStandards Configuration Auto Enable Standards - Whether to automatically enable Security Hub default standards in new member accounts when they join the organization.
- Configuration
Type OrganizationConfiguration Configuration Type - Indicates whether the organization uses local or central configuration.
- auto
Enable Boolean - Whether to automatically enable Security Hub in new member accounts when they join the organization.
- auto
Enable OrganizationStandards Configuration Auto Enable Standards - Whether to automatically enable Security Hub default standards in new member accounts when they join the organization.
- configuration
Type OrganizationConfiguration Configuration Type - Indicates whether the organization uses local or central configuration.
- auto
Enable boolean - Whether to automatically enable Security Hub in new member accounts when they join the organization.
- auto
Enable OrganizationStandards Configuration Auto Enable Standards - Whether to automatically enable Security Hub default standards in new member accounts when they join the organization.
- configuration
Type OrganizationConfiguration Configuration Type - 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_ Organizationstandards Configuration Auto Enable Standards - Whether to automatically enable Security Hub default standards in new member accounts when they join the organization.
- configuration_
type OrganizationConfiguration Configuration Type - Indicates whether the organization uses local or central configuration.
- auto
Enable Boolean - Whether to automatically enable Security Hub in new member accounts when they join the organization.
- auto
Enable "DEFAULT" | "NONE"Standards - Whether to automatically enable Security Hub default standards in new member accounts when they join the organization.
- configuration
Type "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.
- Member
Account boolLimit Reached - Whether the maximum number of allowed member accounts are already associated with the Security Hub administrator account.
- Organization
Configuration stringIdentifier - The identifier of the OrganizationConfiguration being created and assigned as the unique identifier.
- Status
Pulumi.
Aws Native. Security Hub. Organization Configuration Status - Describes whether central configuration could be enabled as the ConfigurationType for the organization.
- Status
Message 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.
- Member
Account boolLimit Reached - Whether the maximum number of allowed member accounts are already associated with the Security Hub administrator account.
- Organization
Configuration stringIdentifier - The identifier of the OrganizationConfiguration being created and assigned as the unique identifier.
- Status
Organization
Configuration Status - Describes whether central configuration could be enabled as the ConfigurationType for the organization.
- Status
Message 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.
- member
Account BooleanLimit Reached - Whether the maximum number of allowed member accounts are already associated with the Security Hub administrator account.
- organization
Configuration StringIdentifier - The identifier of the OrganizationConfiguration being created and assigned as the unique identifier.
- status
Organization
Configuration Status - Describes whether central configuration could be enabled as the ConfigurationType for the organization.
- status
Message 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.
- member
Account booleanLimit Reached - Whether the maximum number of allowed member accounts are already associated with the Security Hub administrator account.
- organization
Configuration stringIdentifier - The identifier of the OrganizationConfiguration being created and assigned as the unique identifier.
- status
Organization
Configuration Status - Describes whether central configuration could be enabled as the ConfigurationType for the organization.
- status
Message 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_ boollimit_ reached - Whether the maximum number of allowed member accounts are already associated with the Security Hub administrator account.
- organization_
configuration_ stridentifier - The identifier of the OrganizationConfiguration being created and assigned as the unique identifier.
- status
Organization
Configuration Status - 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.
- member
Account BooleanLimit Reached - Whether the maximum number of allowed member accounts are already associated with the Security Hub administrator account.
- organization
Configuration StringIdentifier - 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.
- status
Message 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
- Organization
Configuration Auto Enable Standards Default - DEFAULT
- Organization
Configuration Auto Enable Standards None - NONE
- Default
- DEFAULT
- None
- NONE
- Default
- DEFAULT
- None
- NONE
- DEFAULT
- DEFAULT
- NONE
- NONE
- "DEFAULT"
- DEFAULT
- "NONE"
- NONE
OrganizationConfigurationConfigurationType, OrganizationConfigurationConfigurationTypeArgs
- Central
- CENTRAL
- Local
- LOCAL
- Organization
Configuration Configuration Type Central - CENTRAL
- Organization
Configuration Configuration Type Local - 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
- Organization
Configuration Status Pending - PENDING
- Organization
Configuration Status Enabled - ENABLED
- Organization
Configuration Status Failed - 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 is in preview. AWS Classic is fully supported.