Class: AWSCDK::SecurityHub::CfnConfigurationPolicyProps

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

Overview

Properties for defining a CfnConfigurationPolicy.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(configuration_policy:, name:, description: nil, tags: nil) ⇒ CfnConfigurationPolicyProps

Returns a new instance of CfnConfigurationPolicyProps.

Parameters:

  • configuration_policy (AWSCDK::IResolvable, AWSCDK::SecurityHub::CfnConfigurationPolicy::PolicyProperty) —

    An object that defines how AWS Security Hub CSPM is configured.

  • name (String) —

    The name of the configuration policy.

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

    The description of the configuration policy.

  • tags (Hash{String => String}, nil) (defaults to: nil) —

    User-defined tags associated with a configuration policy.



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

def initialize(configuration_policy:, name:, description: nil, tags: nil)
  @configuration_policy = configuration_policy.is_a?(Hash) ? ::AWSCDK::SecurityHub::CfnConfigurationPolicy::PolicyProperty.new(**configuration_policy.transform_keys(&:to_sym)) : configuration_policy
  Jsii::Type.check_type(@configuration_policy, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zZWN1cml0eWh1Yi5DZm5Db25maWd1cmF0aW9uUG9saWN5LlBvbGljeVByb3BlcnR5In1dfX0=")), "configurationPolicy")
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @tags = tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoibWFwIn19")), "tags") unless @tags.nil?
end

Instance Attribute Details

#configuration_policy ⇒ AWSCDK::IResolvable, AWSCDK::SecurityHub::CfnConfigurationPolicy::PolicyProperty (readonly)

An object that defines how AWS Security Hub CSPM is configured.

It includes whether Security Hub CSPM is enabled or disabled, a list of enabled security standards, a list of enabled or disabled security controls, and a list of custom parameter values for specified controls. If you provide a list of security controls that are enabled in the configuration policy, Security Hub CSPM disables all other controls (including newly released controls). If you provide a list of security controls that are disabled in the configuration policy, Security Hub CSPM enables all other controls (including newly released controls).

Returns:

See Also:



30
31
32
 
# File 'security_hub/cfn_configuration_policy_props.rb', line 30

def configuration_policy
  @configuration_policy
end

#description ⇒ String? (readonly)

The description of the configuration policy.

Returns:

  • (String, nil)

See Also:



42
43
44
 
# File 'security_hub/cfn_configuration_policy_props.rb', line 42

def description
  @description
end

#name ⇒ String (readonly)

The name of the configuration policy.

Alphanumeric characters and the following ASCII characters are permitted: -, ., !, *, / .

Returns:

  • (String)

See Also:



37
38
39
 
# File 'security_hub/cfn_configuration_policy_props.rb', line 37

def name
  @name
end

#tags ⇒ Hash{String => String}? (readonly)

User-defined tags associated with a configuration policy.

For more information, see Tagging AWS Security Hub CSPM resources in the Security Hub CSPM user guide .

Returns:

  • (Hash{String => String}, nil)

See Also:



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

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



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

def self.jsii_properties
  {
    :configuration_policy => "configurationPolicy",
    :name => "name",
    :description => "description",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



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

def to_jsii
  result = {}
  result.merge!({
    "configurationPolicy" => @configuration_policy,
    "name" => @name,
    "description" => @description,
    "tags" => @tags,
  })
  result.compact
end