aws-cdk-lib.aws_securityhub.CfnConfigurationPolicy.SecurityControlsConfigurationProperty

SecurityControlsConfigurationProperty Struct

An object that defines which security controls are enabled in an AWS Security Hub CSPM 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.

Source

Generated code

Type last changed

v2.145.0 · 7 Jun 2024

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_securityhub as securityhub } from 'aws-cdk-lib';
const securityControlsConfigurationProperty: securityhub.CfnConfigurationPolicy.SecurityControlsConfigurationProperty = {
  disabledSecurityControlIdentifiers: ['disabledSecurityControlIdentifiers'],
  enabledSecurityControlIdentifiers: ['enabledSecurityControlIdentifiers'],
  securityControlCustomParameters: [{
    parameters: {
      parametersKey: {
        valueType: 'valueType',

        // the properties below are optional
        value: {
          boolean: false,
          double: 123,
          enum: 'enum',
          enumList: ['enumList'],
          integer: 123,
          integerList: [123],
          string: 'string',
          stringList: ['stringList'],
        },
      },
    },
    securityControlId: 'securityControlId',
  }],
};

# 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"
    )]
)

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.securityhub.*;

SecurityControlsConfigurationProperty securityControlsConfigurationProperty = SecurityControlsConfigurationProperty.builder()
        .disabledSecurityControlIdentifiers(List.of("disabledSecurityControlIdentifiers"))
        .enabledSecurityControlIdentifiers(List.of("enabledSecurityControlIdentifiers"))
        .securityControlCustomParameters(List.of(SecurityControlCustomParameterProperty.builder()
                .parameters(Map.of(
                        "parametersKey", ParameterConfigurationProperty.builder()
                                .valueType("valueType")

                                // the properties below are optional
                                .value(ParameterValueProperty.builder()
                                        .boolean(false)
                                        .double(123)
                                        .enum("enum")
                                        .enumList(List.of("enumList"))
                                        .integer(123)
                                        .integerList(List.of(123))
                                        .string("string")
                                        .stringList(List.of("stringList"))
                                        .build())
                                .build()))
                .securityControlId("securityControlId")
                .build()))
        .build();

// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.SecurityHub;

var securityControlsConfigurationProperty = new SecurityControlsConfigurationProperty {
    DisabledSecurityControlIdentifiers = new [] { "disabledSecurityControlIdentifiers" },
    EnabledSecurityControlIdentifiers = new [] { "enabledSecurityControlIdentifiers" },
    SecurityControlCustomParameters = new [] { new SecurityControlCustomParameterProperty {
        Parameters = new Dictionary<string, object> {
            { "parametersKey", new ParameterConfigurationProperty {
                ValueType = "valueType",

                // the properties below are optional
                Value = new ParameterValueProperty {
                    Boolean = false,
                    Double = 123,
                    Enum = "enum",
                    EnumList = new [] { "enumList" },
                    Integer = 123,
                    IntegerList = new [] { 123 },
                    String = "string",
                    StringList = new [] { "stringList" }
                }
            } }
        },
        SecurityControlId = "securityControlId"
    } }
};

// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

securityControlsConfigurationProperty := &SecurityControlsConfigurationProperty{
	DisabledSecurityControlIdentifiers: []*string{
		jsii.String("disabledSecurityControlIdentifiers"),
	},
	EnabledSecurityControlIdentifiers: []*string{
		jsii.String("enabledSecurityControlIdentifiers"),
	},
	SecurityControlCustomParameters: []interface{}{
		&SecurityControlCustomParameterProperty{
			Parameters: map[string]interface{}{
				"parametersKey": &ParameterConfigurationProperty{
					"valueType": jsii.String("valueType"),

					// the properties below are optional
					"value": &ParameterValueProperty{
						"boolean": jsii.Boolean(false),
						"double": jsii.Number(123),
						"enum": jsii.String("enum"),
						"enumList": []*string{
							jsii.String("enumList"),
						},
						"integer": jsii.Number(123),
						"integerList": []interface{}{
							jsii.Number(123),
						},
						"string": jsii.String("string"),
						"stringList": []*string{
							jsii.String("stringList"),
						},
					},
				},
			},
			SecurityControlId: jsii.String("securityControlId"),
		},
	},
}

Properties

disabledSecurityControlIdentifiers?optionalstring[]disabled_security_control_identifiers?optionaltyping.List[str]disabledSecurityControlIdentifiers?optionalList<String>DisabledSecurityControlIdentifiers?optionalstring[]DisabledSecurityControlIdentifiers?optional*[]*string#

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

notes

Provide only one of EnabledSecurityControlIdentifiers or DisabledSecurityControlIdentifiers .

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

enabledSecurityControlIdentifiers?optionalstring[]enabled_security_control_identifiers?optionaltyping.List[str]enabledSecurityControlIdentifiers?optionalList<String>EnabledSecurityControlIdentifiers?optionalstring[]EnabledSecurityControlIdentifiers?optional*[]*string#

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

notes

Provide only one of EnabledSecurityControlIdentifiers or DisabledSecurityControlIdentifiers .

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

securityControlCustomParameters?optionalIResolvable | IResolvable | CfnConfigurationPolicy.SecurityControlCustomParameterProperty[]security_control_custom_parameters?optionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, SecurityControlCustomParameterProperty]]]securityControlCustomParameters?optionalIResolvableSecurityControlCustomParameters?optionalIResolvableSecurityControlCustomParameters?optionalinterface{}#

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