Class: AWSCDK::SecurityHub::CfnHubProps

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

Overview

Properties for defining a CfnHub.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(auto_enable_controls: nil, control_finding_generator: nil, enable_default_standards: nil, tags: nil) ⇒ CfnHubProps

Returns a new instance of CfnHubProps.

Parameters:

  • auto_enable_controls (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    Whether to automatically enable new controls when they are added to standards that are enabled.

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

    Specifies whether an account has consolidated control findings turned on or off.

  • enable_default_standards (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    Whether to enable the security standards that Security Hub CSPM has designated as automatically enabled.

  • tags (Object, nil) (defaults to: nil) —

    An array of key-value pairs to apply to this resource.



13
14
15
16
17
18
19
20
21
22
 
# File 'security_hub/cfn_hub_props.rb', line 13

def initialize(auto_enable_controls: nil, control_finding_generator: nil, enable_default_standards: nil, tags: nil)
  @auto_enable_controls = auto_enable_controls
  Jsii::Type.check_type(@auto_enable_controls, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "autoEnableControls") unless @auto_enable_controls.nil?
  @control_finding_generator = control_finding_generator
  Jsii::Type.check_type(@control_finding_generator, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "controlFindingGenerator") unless @control_finding_generator.nil?
  @enable_default_standards = enable_default_standards
  Jsii::Type.check_type(@enable_default_standards, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "enableDefaultStandards") unless @enable_default_standards.nil?
  @tags = tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "tags") unless @tags.nil?
end

Instance Attribute Details

#auto_enable_controls ⇒ Boolean, ... (readonly)

Whether to automatically enable new controls when they are added to standards that are enabled.

By default, this is set to true , and new controls are enabled automatically. To not automatically enable new controls, set this to false .

When you automatically enable new controls, you can interact with the controls in the console and programmatically immediately after release. However, automatically enabled controls have a temporary default status of DISABLED . It can take up to several days for Security Hub CSPM to process the control release and designate the control as ENABLED in your account. During the processing period, you can manually enable or disable a control, and Security Hub CSPM will maintain that designation regardless of whether you have AutoEnableControls set to true .

Returns:

See Also:



32
33
34
 
# File 'security_hub/cfn_hub_props.rb', line 32

def auto_enable_controls
  @auto_enable_controls
end

#control_finding_generator ⇒ String? (readonly)

Specifies whether an account has consolidated control findings turned on or off.

If the value for this field is set to SECURITY_CONTROL , Security Hub CSPM generates a single finding for a control check even when the check applies to multiple enabled standards.

If the value for this field is set to STANDARD_CONTROL , Security Hub CSPM generates separate findings for a control check when the check applies to multiple enabled standards.

The value for this field in a member account matches the value in the administrator account. For accounts that aren't part of an organization, the default value of this field is SECURITY_CONTROL if you enabled Security Hub CSPM on or after February 23, 2023.

Returns:

  • (String, nil)

See Also:



43
44
45
 
# File 'security_hub/cfn_hub_props.rb', line 43

def control_finding_generator
  @control_finding_generator
end

#enable_default_standards ⇒ Boolean, ... (readonly)

Whether to enable the security standards that Security Hub CSPM has designated as automatically enabled.

If you don't provide a value for EnableDefaultStandards , it is set to true , and the designated standards are automatically enabled in each AWS Region where you enable Security Hub CSPM . If you don't want to enable the designated standards, set EnableDefaultStandards to false .

Currently, the automatically enabled standards are the Center for Internet Security (CIS) AWS Foundations Benchmark v1.2.0 and AWS Foundational Security Best Practices (FSBP).

Returns:

See Also:



52
53
54
 
# File 'security_hub/cfn_hub_props.rb', line 52

def enable_default_standards
  @enable_default_standards
end

#tags ⇒ Object? (readonly)

An array of key-value pairs to apply to this resource.

For more information, see Tag .

Returns:

  • (Object, nil)

See Also:



59
60
61
 
# File 'security_hub/cfn_hub_props.rb', line 59

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



61
62
63
64
65
66
67
68
 
# File 'security_hub/cfn_hub_props.rb', line 61

def self.jsii_properties
  {
    :auto_enable_controls => "autoEnableControls",
    :control_finding_generator => "controlFindingGenerator",
    :enable_default_standards => "enableDefaultStandards",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



70
71
72
73
74
75
76
77
78
79
 
# File 'security_hub/cfn_hub_props.rb', line 70

def to_jsii
  result = {}
  result.merge!({
    "autoEnableControls" => @auto_enable_controls,
    "controlFindingGenerator" => @control_finding_generator,
    "enableDefaultStandards" => @enable_default_standards,
    "tags" => @tags,
  })
  result.compact
end