CfnStandardPropsMixin

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

Bases: Mixin

The AWS::SecurityHub::Standard resource specifies the enablement of a security standard.

The standard is identified by the StandardsArn property. To view a list of Security Hub standards and their Amazon Resource Names (ARNs), use the `DescribeStandards <https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_DescribeStandards.html>`_ API operation.

You must create a separate AWS::SecurityHub::Standard resource for each standard that you want to enable.

For more information about Security Hub standards, see Security Hub standards reference in the Security Hub User Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityhub-standard.html

CloudformationResource:

AWS::SecurityHub::Standard

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_standard_props_mixin = securityhub_mixins.CfnStandardPropsMixin(securityhub_mixins.CfnStandardMixinProps(
    disabled_standards_controls=[securityhub_mixins.CfnStandardPropsMixin.StandardsControlProperty(
        reason="reason",
        standards_control_arn="standardsControlArn"
    )],
    standards_arn="standardsArn"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:
  • props (Union[CfnStandardMixinProps, 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:

IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:

construct (IConstruct)

Return type:

bool

Attributes

CFN_PROPERTY_KEYS = ['disabledStandardsControls', 'standardsArn']

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

StandardsControlProperty

class CfnStandardPropsMixin.StandardsControlProperty(*, reason=None, standards_control_arn=None)

Bases: object

Provides details about an individual security control.

For a list of Security Hub controls, see Security Hub controls reference in the Security Hub User Guide .

Parameters:
  • reason (Optional[str]) – A user-defined reason for changing a control’s enablement status in a specified standard. If you are disabling a control, then this property is required.

  • standards_control_arn (Optional[str]) – The Amazon Resource Name (ARN) of the control.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-standard-standardscontrol.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

standards_control_property = securityhub_mixins.CfnStandardPropsMixin.StandardsControlProperty(
    reason="reason",
    standards_control_arn="standardsControlArn"
)

Attributes

reason

A user-defined reason for changing a control’s enablement status in a specified standard.

If you are disabling a control, then this property is required.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-standard-standardscontrol.html#cfn-securityhub-standard-standardscontrol-reason

standards_control_arn

The Amazon Resource Name (ARN) of the control.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-standard-standardscontrol.html#cfn-securityhub-standard-standardscontrol-standardscontrolarn