Skip to content
v2.277.0

PolicyProperty Struct ​

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).

Example ​

ts
// 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 policyProperty: securityhub.CfnConfigurationPolicy.PolicyProperty = {
  securityHub: {
    enabledStandardIdentifiers: ['enabledStandardIdentifiers'],
    securityControlsConfiguration: {
      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',
      }],
    },
    serviceEnabled: false,
  },
};
python
# 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
    )
)
java
// 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.*;

PolicyProperty policyProperty = PolicyProperty.builder()
        .securityHub(SecurityHubPolicyProperty.builder()
                .enabledStandardIdentifiers(List.of("enabledStandardIdentifiers"))
                .securityControlsConfiguration(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())
                .serviceEnabled(false)
                .build())
        .build();
csharp
// 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 policyProperty = new PolicyProperty {
    SecurityHub = new SecurityHubPolicyProperty {
        EnabledStandardIdentifiers = new [] { "enabledStandardIdentifiers" },
        SecurityControlsConfiguration = 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"
            } }
        },
        ServiceEnabled = false
    }
};
go
// 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"

policyProperty := &PolicyProperty{
	SecurityHub: &SecurityHubPolicyProperty{
		EnabledStandardIdentifiers: []*string{
			jsii.String("enabledStandardIdentifiers"),
		},
		SecurityControlsConfiguration: &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"),
				},
			},
		},
		ServiceEnabled: jsii.Boolean(false),
	},
}

Properties ​

securityHuboptionalIResolvable | CfnConfigurationPolicy.SecurityHubPolicyPropertysecurity_huboptionaltyping.Union[IResolvable, SecurityHubPolicyProperty]securityHuboptionalIResolvableSecurityHuboptionalIResolvableSecurityHuboptionalinterface{} #
The AWS service that the configuration policy applies to.