Package software.amazon.awscdk.services.securityhub

Class CfnOrganizationConfiguration

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.securityhub.CfnOrganizationConfiguration
All Implemented Interfaces:
IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)", date="2024-11-21T06:34:16.103Z") @Stability(Stable) public class CfnOrganizationConfiguration extends CfnResource implements IInspectable
The AWS::SecurityHub::OrganizationConfiguration resource specifies the way that your AWS organization is configured in AWS Security Hub .

Specifically, you can use this resource to specify the configuration type for your organization and whether to automatically Security Hub and security standards in new member accounts. For more information, see Managing administrator and member accounts in the AWS Security Hub User Guide .

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.securityhub.*;
 CfnOrganizationConfiguration cfnOrganizationConfiguration = CfnOrganizationConfiguration.Builder.create(this, "MyCfnOrganizationConfiguration")
         .autoEnable(false)
         // the properties below are optional
         .autoEnableStandards("autoEnableStandards")
         .configurationType("configurationType")
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnOrganizationConfiguration

      protected CfnOrganizationConfiguration(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnOrganizationConfiguration

      protected CfnOrganizationConfiguration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnOrganizationConfiguration

      @Stability(Stable) public CfnOrganizationConfiguration(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnOrganizationConfigurationProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrMemberAccountLimitReached

      @Stability(Stable) @NotNull public IResolvable getAttrMemberAccountLimitReached()
      Whether the maximum number of allowed member accounts are already associated with the Security Hub administrator account.

    • getAttrOrganizationConfigurationIdentifier

      @Stability(Stable) @NotNull public String getAttrOrganizationConfigurationIdentifier()
      The organization configuration identifier, formatted as AccountId/Region/securityhub-organization-configuration .

      For example, 123456789012/us-east-1/securityhub-organization-configuration .

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      Describes whether central configuration could be enabled as the ConfigurationType for the organization.

      If your ConfigurationType is local configuration, then the value of Status is always ENABLED .

    • getAttrStatusMessage

      @Stability(Stable) @NotNull public String getAttrStatusMessage()
      Provides an explanation if the value of Status is equal to FAILED when ConfigurationType is equal to CENTRAL .

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getAutoEnable

      @Stability(Stable) @NotNull public Object getAutoEnable()
      Whether to automatically enable Security Hub in new member accounts when they join the organization.

    • setAutoEnable

      @Stability(Stable) public void setAutoEnable(@NotNull Boolean value)
      Whether to automatically enable Security Hub in new member accounts when they join the organization.

    • setAutoEnable

      @Stability(Stable) public void setAutoEnable(@NotNull IResolvable value)
      Whether to automatically enable Security Hub in new member accounts when they join the organization.

    • getAutoEnableStandards

      @Stability(Stable) @Nullable public String getAutoEnableStandards()
      Whether to automatically enable Security Hub default standards in new member accounts when they join the organization.

    • setAutoEnableStandards

      @Stability(Stable) public void setAutoEnableStandards(@Nullable String value)
      Whether to automatically enable Security Hub default standards in new member accounts when they join the organization.

    • getConfigurationType

      @Stability(Stable) @Nullable public String getConfigurationType()
      Indicates whether the organization uses local or central configuration.

    • setConfigurationType

      @Stability(Stable) public void setConfigurationType(@Nullable String value)
      Indicates whether the organization uses local or central configuration.