CfnSecurityControlPropsMixin

class aws_cdk.mixins_preview.aws_securityhub.mixins.CfnSecurityControlPropsMixin(props, *, strategy=None)

Bases: Mixin

The AWS::SecurityHub::SecurityControl resource specifies custom parameter values for an AWS Security Hub CSPM control.

For a list of controls that support custom parameters, see Security Hub CSPM controls reference . You can also use this resource to specify the use of default parameter values for a control. For more information about custom parameters, see Custom control parameters in the AWS Security Hub CSPM User Guide .

Tags aren’t supported for this resource.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityhub-securitycontrol.html
CloudformationResource:: AWS::SecurityHub::SecurityControl
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_securityhub import mixins as securityhub_mixins

cfn_security_control_props_mixin = securityhub_mixins.CfnSecurityControlPropsMixin(securityhub_mixins.CfnSecurityControlMixinProps(
    last_update_reason="lastUpdateReason",
    parameters={
        "parameters_key": securityhub_mixins.CfnSecurityControlPropsMixin.ParameterConfigurationProperty(
            value=securityhub_mixins.CfnSecurityControlPropsMixin.ParameterValueProperty(
                boolean=False,
                double=123,
                enum="enum",
                enum_list=["enumList"],
                integer=123,
                integer_list=[123],
                string="string",
                string_list=["stringList"]
            ),
            value_type="valueType"
        )
    },
    security_control_arn="securityControlArn",
    security_control_id="securityControlId"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::SecurityHub::SecurityControl.

Parameters:

props (Union[CfnSecurityControlMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: None

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['lastUpdateReason', 'parameters', 'securityControlArn', 'securityControlId']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

ParameterConfigurationProperty

class CfnSecurityControlPropsMixin.ParameterConfigurationProperty(*, value=None, value_type=None)

Bases: object

An object that provides the current value of a security control parameter and identifies whether it has been customized.

Parameters:

value (Union[IResolvable, ParameterValueProperty, Dict[str, Any], None]) – The current value of a control parameter.
value_type (Optional[str]) – Identifies whether a control parameter uses a custom user-defined value or subscribes to the default AWS Security Hub CSPM behavior. When ValueType is set equal to DEFAULT , the default behavior can be a specific Security Hub CSPM default value, or the default behavior can be to ignore a specific parameter. When ValueType is set equal to DEFAULT , Security Hub CSPM ignores user-provided input for the Value field. When ValueType is set equal to CUSTOM , the Value field can’t be empty.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-securitycontrol-parameterconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_securityhub import mixins as securityhub_mixins

parameter_configuration_property = securityhub_mixins.CfnSecurityControlPropsMixin.ParameterConfigurationProperty(
    value=securityhub_mixins.CfnSecurityControlPropsMixin.ParameterValueProperty(
        boolean=False,
        double=123,
        enum="enum",
        enum_list=["enumList"],
        integer=123,
        integer_list=[123],
        string="string",
        string_list=["stringList"]
    ),
    value_type="valueType"
)

Attributes

value

The current value of a control parameter.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-securitycontrol-parameterconfiguration.html#cfn-securityhub-securitycontrol-parameterconfiguration-value

value_type

Identifies whether a control parameter uses a custom user-defined value or subscribes to the default AWS Security Hub CSPM behavior.

When ValueType is set equal to DEFAULT , the default behavior can be a specific Security Hub CSPM default value, or the default behavior can be to ignore a specific parameter. When ValueType is set equal to DEFAULT , Security Hub CSPM ignores user-provided input for the Value field.

When ValueType is set equal to CUSTOM , the Value field can’t be empty.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-securitycontrol-parameterconfiguration.html#cfn-securityhub-securitycontrol-parameterconfiguration-valuetype

ParameterValueProperty

class CfnSecurityControlPropsMixin.ParameterValueProperty(*, boolean=None, double=None, enum=None, enum_list=None, integer=None, integer_list=None, string=None, string_list=None)

Bases: object

An object that includes the data type of a security control parameter and its current value.

Parameters:

boolean (Union[bool, IResolvable, None]) – A control parameter that is a boolean.
double (Union[int, float, None]) – A control parameter that is a double.
enum (Optional[str]) – A control parameter that is an enum.
enum_list (Optional[Sequence[str]]) – A control parameter that is a list of enums.
integer (Union[int, float, None]) – A control parameter that is an integer.
integer_list (Union[Sequence[Union[int, float]], IResolvable, None]) – A control parameter that is a list of integers.
string (Optional[str]) – A control parameter that is a string.
string_list (Optional[Sequence[str]]) – A control parameter that is a list of strings.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-securitycontrol-parametervalue.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_securityhub import mixins as securityhub_mixins

parameter_value_property = securityhub_mixins.CfnSecurityControlPropsMixin.ParameterValueProperty(
    boolean=False,
    double=123,
    enum="enum",
    enum_list=["enumList"],
    integer=123,
    integer_list=[123],
    string="string",
    string_list=["stringList"]
)