Class: AWSCDK::SecurityHub::CfnOrganizationConfigurationProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
security_hub/cfn_organization_configuration_props.rb

Overview

Properties for defining a CfnOrganizationConfiguration.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(auto_enable:, auto_enable_standards: nil, configuration_type: nil) ⇒ CfnOrganizationConfigurationProps

Returns a new instance of CfnOrganizationConfigurationProps.

Parameters:

  • auto_enable (Boolean, AWSCDK::IResolvable) —

    Whether to automatically enable Security Hub CSPM in new member accounts when they join the organization.

  • auto_enable_standards (String, nil) (defaults to: nil) —

    Whether to automatically enable Security Hub CSPM default standards in new member accounts when they join the organization.

  • configuration_type (String, nil) (defaults to: nil) —

    Indicates whether the organization uses local or central configuration.



12
13
14
15
16
17
18
19
 
# File 'security_hub/cfn_organization_configuration_props.rb', line 12

def initialize(auto_enable:, auto_enable_standards: nil, configuration_type: nil)
  @auto_enable = auto_enable
  Jsii::Type.check_type(@auto_enable, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "autoEnable")
  @auto_enable_standards = auto_enable_standards
  Jsii::Type.check_type(@auto_enable_standards, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "autoEnableStandards") unless @auto_enable_standards.nil?
  @configuration_type = configuration_type
  Jsii::Type.check_type(@configuration_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "configurationType") unless @configuration_type.nil?
end

Instance Attribute Details

#auto_enable ⇒ Boolean, AWSCDK::IResolvable (readonly)

Whether to automatically enable Security Hub CSPM in new member accounts when they join the organization.

If set to true , then Security Hub CSPM is automatically enabled in new accounts. If set to false , then Security Hub CSPM isn't enabled in new accounts automatically. The default value is false .

If the ConfigurationType of your organization is set to CENTRAL , then this field is set to false and can't be changed in the home Region and linked Regions. However, in that case, the delegated administrator can create a configuration policy in which Security Hub CSPM is enabled and associate the policy with new organization accounts.

Returns:

See Also:



29
30
31
 
# File 'security_hub/cfn_organization_configuration_props.rb', line 29

def auto_enable
  @auto_enable
end

#auto_enable_standards ⇒ String? (readonly)

Whether to automatically enable Security Hub CSPM default standards in new member accounts when they join the organization.

The default value of this parameter is equal to DEFAULT .

If equal to DEFAULT , then Security Hub CSPM default standards are automatically enabled for new member accounts. If equal to NONE , then default standards are not automatically enabled for new member accounts.

If the ConfigurationType of your organization is set to CENTRAL , then this field is set to NONE and can't be changed in the home Region and linked Regions. However, in that case, the delegated administrator can create a configuration policy in which specific security standards are enabled and associate the policy with new organization accounts.

Returns:

  • (String, nil)

See Also:



40
41
42
 
# File 'security_hub/cfn_organization_configuration_props.rb', line 40

def auto_enable_standards
  @auto_enable_standards
end

#configuration_type ⇒ String? (readonly)

Indicates whether the organization uses local or central configuration.

If you use local configuration, the Security Hub CSPM delegated administrator can set AutoEnable to true and AutoEnableStandards to DEFAULT . This automatically enables Security Hub CSPM and default security standards in new organization accounts. These new account settings must be set separately in each AWS Region , and settings may be different in each Region.

If you use central configuration, the delegated administrator can create configuration policies. Configuration policies can be used to configure Security Hub CSPM, security standards, and security controls in multiple accounts and Regions. If you want new organization accounts to use a specific configuration, you can create a configuration policy and associate it with the root or specific organizational units (OUs). New accounts will inherit the policy from the root or their assigned OU.

Returns:

  • (String, nil)

See Also:



49
50
51
 
# File 'security_hub/cfn_organization_configuration_props.rb', line 49

def configuration_type
  @configuration_type
end

Class Method Details

.jsii_properties ⇒ Object 



51
52
53
54
55
56
57
 
# File 'security_hub/cfn_organization_configuration_props.rb', line 51

def self.jsii_properties
  {
    :auto_enable => "autoEnable",
    :auto_enable_standards => "autoEnableStandards",
    :configuration_type => "configurationType",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



59
60
61
62
63
64
65
66
67
 
# File 'security_hub/cfn_organization_configuration_props.rb', line 59

def to_jsii
  result = {}
  result.merge!({
    "autoEnable" => @auto_enable,
    "autoEnableStandards" => @auto_enable_standards,
    "configurationType" => @configuration_type,
  })
  result.compact
end