CfnConfigurationPolicy

class aws_cdk.aws_securityhub.CfnConfigurationPolicy(scope, id, *, configuration_policy, name, description=None, tags=None)

Bases: CfnResource

The AWS::SecurityHub::ConfigurationPolicy resource creates a central configuration policy with the defined settings.

Only the AWS Security Hub delegated administrator can create this resource in the home Region. For more information, see Central configuration in Security Hub in the AWS Security Hub User Guide .

See:

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

CloudformationResource:

AWS::SecurityHub::ConfigurationPolicy

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 import aws_securityhub as securityhub

cfn_configuration_policy = securityhub.CfnConfigurationPolicy(self, "MyCfnConfigurationPolicy",
    configuration_policy=securityhub.CfnConfigurationPolicy.PolicyProperty(
        security_hub=securityhub.CfnConfigurationPolicy.SecurityHubPolicyProperty(
            enabled_standard_identifiers=["enabledStandardIdentifiers"],
            security_controls_configuration=securityhub.CfnConfigurationPolicy.SecurityControlsConfigurationProperty(
                disabled_security_control_identifiers=["disabledSecurityControlIdentifiers"],
                enabled_security_control_identifiers=["enabledSecurityControlIdentifiers"],
                security_control_custom_parameters=[securityhub.CfnConfigurationPolicy.SecurityControlCustomParameterProperty(
                    parameters={
                        "parameters_key": securityhub.CfnConfigurationPolicy.ParameterConfigurationProperty(
                            value_type="valueType",

                            # the properties below are optional
                            value=securityhub.CfnConfigurationPolicy.ParameterValueProperty(
                                boolean=False,
                                double=123,
                                enum="enum",
                                enum_list=["enumList"],
                                integer=123,
                                integer_list=[123],
                                string="string",
                                string_list=["stringList"]
                            )
                        )
                    },
                    security_control_id="securityControlId"
                )]
            ),
            service_enabled=False
        )
    ),
    name="name",

    # the properties below are optional
    description="description",
    tags={
        "tags_key": "tags"
    }
)

Parameters:

• scope (Construct) – Scope in which this resource is defined.

• id (str) – Construct identifier for this resource (unique in its scope).

• configuration_policy (Union[IResolvable, PolicyProperty, Dict[str, Any]]) – An object that defines how AWS Security Hub is configured. It includes whether Security Hub 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 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 enables all other controls (including newly released controls).

• name (str) – The name of the configuration policy. Alphanumeric characters and the following ASCII characters are permitted: -, ., !, *, / .

• description (Optional[str]) – The description of the configuration policy.

• tags (Optional[Mapping[str, str]]) – User-defined tags associated with a configuration policy. For more information, see Tagging AWS Security Hub resources in the Security Hub user guide .

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:

path (str) – The path of the value to delete.

Return type:

None

add_dependency(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:

target (CfnResource) –

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

• key (str) –

• value (Any) –

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

• path (str) –

  • The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.

• value (Any) –

  • The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:

property_path (str) – The path to the property.

Return type:

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

• property_path (str) – The path of the property.

• value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

• policy (Optional[RemovalPolicy]) –

• apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

• default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

• attribute_name (str) – The name of the attribute.

• type_hint (Optional[ResolutionTypeHint]) –

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:

inspector (TreeInspector) – tree inspector to collect and process attributes.

Return type:

None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:

List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:

List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:

new_logical_id (str) – The new logical ID to use for this stack element.

Return type:

None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:

• target (CfnResource) – The dependency to replace.

• new_target (CfnResource) – The new dependency to add.

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:

str

Returns:

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::SecurityHub::ConfigurationPolicy'

attr_arn

The ARN of the configuration policy.

CloudformationAttribute:

Arn

attr_created_at

The date and time, in UTC and ISO 8601 format.

CloudformationAttribute:

CreatedAt

attr_id

The universally unique identifier (UUID) of the configuration policy.

A self-managed configuration has no UUID. The identifier of a self-managed configuration is SELF_MANAGED_SECURITY_HUB .

CloudformationAttribute:

Id

attr_service_enabled

Indicates whether the service that the configuration policy applies to is enabled in the policy.

CloudformationAttribute:

ServiceEnabled

attr_updated_at

The date and time, in UTC and ISO 8601 format, that the configuration policy was last updated.

CloudformationAttribute:

UpdatedAt

cdk_tag_manager

Tag Manager which manages the tags for this resource.

cfn_options

Options for this resource, such as condition, update policy etc.

cfn_resource_type

AWS resource type.

configuration_policy

An object that defines how AWS Security Hub is configured.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

description

The description of the configuration policy.

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

name

The name of the configuration policy.

node

The tree node.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

tags

User-defined tags associated with a configuration policy.

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any) –

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any) –

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Construct.

ParameterConfigurationProperty

class CfnConfigurationPolicy.ParameterConfigurationProperty(*, value_type, value=None)

Bases: object

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

Parameters:

• value_type (str) – Identifies whether a control parameter uses a custom user-defined value or subscribes to the default AWS Security Hub behavior. When ValueType is set equal to DEFAULT , the default behavior can be a specific Security Hub default value, or the default behavior can be to ignore a specific parameter. When ValueType is set equal to DEFAULT , Security Hub ignores user-provided input for the Value field. When ValueType is set equal to CUSTOM , the Value field can’t be empty.

• value (Union[IResolvable, ParameterValueProperty, Dict[str, Any], None]) – The current value of a control parameter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-configurationpolicy-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 import aws_securityhub as securityhub

parameter_configuration_property = securityhub.CfnConfigurationPolicy.ParameterConfigurationProperty(
    value_type="valueType",

    # the properties below are optional
    value=securityhub.CfnConfigurationPolicy.ParameterValueProperty(
        boolean=False,
        double=123,
        enum="enum",
        enum_list=["enumList"],
        integer=123,
        integer_list=[123],
        string="string",
        string_list=["stringList"]
    )
)

Attributes

value

The current value of a control parameter.

See:

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

value_type

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

When ValueType is set equal to DEFAULT , the default behavior can be a specific Security Hub default value, or the default behavior can be to ignore a specific parameter. When ValueType is set equal to DEFAULT , Security Hub 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-configurationpolicy-parameterconfiguration.html#cfn-securityhub-configurationpolicy-parameterconfiguration-valuetype

ParameterValueProperty

class CfnConfigurationPolicy.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-configurationpolicy-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 import aws_securityhub as securityhub

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

Attributes

boolean

A control parameter that is a boolean.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-configurationpolicy-parametervalue.html#cfn-securityhub-configurationpolicy-parametervalue-boolean

double

A control parameter that is a double.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-configurationpolicy-parametervalue.html#cfn-securityhub-configurationpolicy-parametervalue-double

enum

A control parameter that is an enum.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-configurationpolicy-parametervalue.html#cfn-securityhub-configurationpolicy-parametervalue-enum

enum_list

A control parameter that is a list of enums.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-configurationpolicy-parametervalue.html#cfn-securityhub-configurationpolicy-parametervalue-enumlist

integer

A control parameter that is an integer.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-configurationpolicy-parametervalue.html#cfn-securityhub-configurationpolicy-parametervalue-integer

integer_list

A control parameter that is a list of integers.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-configurationpolicy-parametervalue.html#cfn-securityhub-configurationpolicy-parametervalue-integerlist

string

A control parameter that is a string.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-configurationpolicy-parametervalue.html#cfn-securityhub-configurationpolicy-parametervalue-string

string_list

A control parameter that is a list of strings.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-configurationpolicy-parametervalue.html#cfn-securityhub-configurationpolicy-parametervalue-stringlist

PolicyProperty

class CfnConfigurationPolicy.PolicyProperty(*, security_hub=None)

Bases: object

An object that defines how AWS Security Hub is configured.

It includes whether Security Hub 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 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 enables all other controls (including newly released controls).

Parameters:

security_hub (Union[IResolvable, SecurityHubPolicyProperty, Dict[str, Any], None]) – The AWS service that the configuration policy applies to.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-configurationpolicy-policy.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 import aws_securityhub as securityhub

policy_property = securityhub.CfnConfigurationPolicy.PolicyProperty(
    security_hub=securityhub.CfnConfigurationPolicy.SecurityHubPolicyProperty(
        enabled_standard_identifiers=["enabledStandardIdentifiers"],
        security_controls_configuration=securityhub.CfnConfigurationPolicy.SecurityControlsConfigurationProperty(
            disabled_security_control_identifiers=["disabledSecurityControlIdentifiers"],
            enabled_security_control_identifiers=["enabledSecurityControlIdentifiers"],
            security_control_custom_parameters=[securityhub.CfnConfigurationPolicy.SecurityControlCustomParameterProperty(
                parameters={
                    "parameters_key": securityhub.CfnConfigurationPolicy.ParameterConfigurationProperty(
                        value_type="valueType",

                        # the properties below are optional
                        value=securityhub.CfnConfigurationPolicy.ParameterValueProperty(
                            boolean=False,
                            double=123,
                            enum="enum",
                            enum_list=["enumList"],
                            integer=123,
                            integer_list=[123],
                            string="string",
                            string_list=["stringList"]
                        )
                    )
                },
                security_control_id="securityControlId"
            )]
        ),
        service_enabled=False
    )
)

Attributes

security_hub

The AWS service that the configuration policy applies to.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-configurationpolicy-policy.html#cfn-securityhub-configurationpolicy-policy-securityhub

SecurityControlCustomParameterProperty

class CfnConfigurationPolicy.SecurityControlCustomParameterProperty(*, parameters=None, security_control_id=None)

Bases: object

A list of security controls and control parameter values that are included in a configuration policy.

Parameters:

• parameters (Union[IResolvable, Mapping[str, Union[IResolvable, ParameterConfigurationProperty, Dict[str, Any]]], None]) – An object that specifies parameter values for a control in a configuration policy.

• security_control_id (Optional[str]) – The ID of the security control.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-configurationpolicy-securitycontrolcustomparameter.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 import aws_securityhub as securityhub

security_control_custom_parameter_property = securityhub.CfnConfigurationPolicy.SecurityControlCustomParameterProperty(
    parameters={
        "parameters_key": securityhub.CfnConfigurationPolicy.ParameterConfigurationProperty(
            value_type="valueType",

            # the properties below are optional
            value=securityhub.CfnConfigurationPolicy.ParameterValueProperty(
                boolean=False,
                double=123,
                enum="enum",
                enum_list=["enumList"],
                integer=123,
                integer_list=[123],
                string="string",
                string_list=["stringList"]
            )
        )
    },
    security_control_id="securityControlId"
)

Attributes

parameters

An object that specifies parameter values for a control in a configuration policy.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-configurationpolicy-securitycontrolcustomparameter.html#cfn-securityhub-configurationpolicy-securitycontrolcustomparameter-parameters

security_control_id

The ID of the security control.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-configurationpolicy-securitycontrolcustomparameter.html#cfn-securityhub-configurationpolicy-securitycontrolcustomparameter-securitycontrolid

SecurityControlsConfigurationProperty

class CfnConfigurationPolicy.SecurityControlsConfigurationProperty(*, disabled_security_control_identifiers=None, enabled_security_control_identifiers=None, security_control_custom_parameters=None)

Bases: object

An object that defines which security controls are enabled in an AWS Security Hub configuration policy.

The enablement status of a control is aligned across all of the enabled standards in an account.

This property is required only if ServiceEnabled is set to true in your configuration policy.

Parameters:

• disabled_security_control_identifiers (Optional[Sequence[str]]) – A list of security controls that are disabled in the configuration policy. Provide only one of EnabledSecurityControlIdentifiers or DisabledSecurityControlIdentifiers . If you provide DisabledSecurityControlIdentifiers , Security Hub enables all other controls not in the list, and enables AutoEnableControls .

• enabled_security_control_identifiers (Optional[Sequence[str]]) –

  A list of security controls that are enabled in the configuration policy. Provide only one of EnabledSecurityControlIdentifiers or DisabledSecurityControlIdentifiers . If you provide EnabledSecurityControlIdentifiers , Security Hub disables all other controls not in the list, and disables AutoEnableControls .

• security_control_custom_parameters (Union[IResolvable, Sequence[Union[IResolvable, SecurityControlCustomParameterProperty, Dict[str, Any]]], None]) – A list of security controls and control parameter values that are included in a configuration policy.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-configurationpolicy-securitycontrolsconfiguration.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 import aws_securityhub as securityhub

security_controls_configuration_property = securityhub.CfnConfigurationPolicy.SecurityControlsConfigurationProperty(
    disabled_security_control_identifiers=["disabledSecurityControlIdentifiers"],
    enabled_security_control_identifiers=["enabledSecurityControlIdentifiers"],
    security_control_custom_parameters=[securityhub.CfnConfigurationPolicy.SecurityControlCustomParameterProperty(
        parameters={
            "parameters_key": securityhub.CfnConfigurationPolicy.ParameterConfigurationProperty(
                value_type="valueType",

                # the properties below are optional
                value=securityhub.CfnConfigurationPolicy.ParameterValueProperty(
                    boolean=False,
                    double=123,
                    enum="enum",
                    enum_list=["enumList"],
                    integer=123,
                    integer_list=[123],
                    string="string",
                    string_list=["stringList"]
                )
            )
        },
        security_control_id="securityControlId"
    )]
)

Attributes

disabled_security_control_identifiers

A list of security controls that are disabled in the configuration policy.

Provide only one of EnabledSecurityControlIdentifiers or DisabledSecurityControlIdentifiers .

If you provide DisabledSecurityControlIdentifiers , Security Hub enables all other controls not in the list, and enables AutoEnableControls .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-configurationpolicy-securitycontrolsconfiguration.html#cfn-securityhub-configurationpolicy-securitycontrolsconfiguration-disabledsecuritycontrolidentifiers

enabled_security_control_identifiers

A list of security controls that are enabled in the configuration policy.

Provide only one of EnabledSecurityControlIdentifiers or DisabledSecurityControlIdentifiers .

If you provide EnabledSecurityControlIdentifiers , Security Hub disables all other controls not in the list, and disables AutoEnableControls .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-configurationpolicy-securitycontrolsconfiguration.html#cfn-securityhub-configurationpolicy-securitycontrolsconfiguration-enabledsecuritycontrolidentifiers

security_control_custom_parameters

A list of security controls and control parameter values that are included in a configuration policy.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-configurationpolicy-securitycontrolsconfiguration.html#cfn-securityhub-configurationpolicy-securitycontrolsconfiguration-securitycontrolcustomparameters

SecurityHubPolicyProperty

class CfnConfigurationPolicy.SecurityHubPolicyProperty(*, enabled_standard_identifiers=None, security_controls_configuration=None, service_enabled=None)

Bases: object

An object that defines how AWS Security Hub is configured.

The configuration policy includes whether Security Hub 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 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 enables all other controls (including newly released controls).

Parameters:

• enabled_standard_identifiers (Optional[Sequence[str]]) – A list that defines which security standards are enabled in the configuration policy. This property is required only if ServiceEnabled is set to true in your configuration policy.

• security_controls_configuration (Union[IResolvable, SecurityControlsConfigurationProperty, Dict[str, Any], None]) – An object that defines which security controls are enabled in the configuration policy. The enablement status of a control is aligned across all of the enabled standards in an account. This property is required only if ServiceEnabled is set to true in your configuration policy.

• service_enabled (Union[bool, IResolvable, None]) – Indicates whether Security Hub is enabled in the policy.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-configurationpolicy-securityhubpolicy.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 import aws_securityhub as securityhub

security_hub_policy_property = securityhub.CfnConfigurationPolicy.SecurityHubPolicyProperty(
    enabled_standard_identifiers=["enabledStandardIdentifiers"],
    security_controls_configuration=securityhub.CfnConfigurationPolicy.SecurityControlsConfigurationProperty(
        disabled_security_control_identifiers=["disabledSecurityControlIdentifiers"],
        enabled_security_control_identifiers=["enabledSecurityControlIdentifiers"],
        security_control_custom_parameters=[securityhub.CfnConfigurationPolicy.SecurityControlCustomParameterProperty(
            parameters={
                "parameters_key": securityhub.CfnConfigurationPolicy.ParameterConfigurationProperty(
                    value_type="valueType",

                    # the properties below are optional
                    value=securityhub.CfnConfigurationPolicy.ParameterValueProperty(
                        boolean=False,
                        double=123,
                        enum="enum",
                        enum_list=["enumList"],
                        integer=123,
                        integer_list=[123],
                        string="string",
                        string_list=["stringList"]
                    )
                )
            },
            security_control_id="securityControlId"
        )]
    ),
    service_enabled=False
)

Attributes

enabled_standard_identifiers

A list that defines which security standards are enabled in the configuration policy.

This property is required only if ServiceEnabled is set to true in your configuration policy.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-configurationpolicy-securityhubpolicy.html#cfn-securityhub-configurationpolicy-securityhubpolicy-enabledstandardidentifiers

security_controls_configuration

An object that defines which security controls are enabled in the configuration policy.

The enablement status of a control is aligned across all of the enabled standards in an account.

This property is required only if ServiceEnabled is set to true in your configuration policy.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-configurationpolicy-securityhubpolicy.html#cfn-securityhub-configurationpolicy-securityhubpolicy-securitycontrolsconfiguration

service_enabled

Indicates whether Security Hub is enabled in the policy.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-configurationpolicy-securityhubpolicy.html#cfn-securityhub-configurationpolicy-securityhubpolicy-serviceenabled