AWS CDK Reference

Appearance

v2.275.0

CfnConfigurationPolicyProps Struct ​

Properties for defining a CfnConfigurationPolicy.

Source
Generated code
Type last changed
v2.145.0 · 7 Jun 2024

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 cfnConfigurationPolicyProps: securityhub.CfnConfigurationPolicyProps = {
  configurationPolicy: {
    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,
    },
  },
  name: 'name',

  // the properties below are optional
  description: 'description',
  tags: {
    tagsKey: 'tags',
  },
};

Properties ​

configurationPolicyIResolvable | CfnConfigurationPolicy.PolicyPropertyconfiguration_policytyping.Union[IResolvable, PolicyProperty]configurationPolicyIResolvableConfigurationPolicyIResolvableConfigurationPolicyinterface{}required#
An object that defines how AWS Security Hub CSPM is configured.
notes

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

descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#
The description of the configuration policy.
namestringnamestrnameStringNamestringName*stringrequired#
The name of the configuration policy.

Alphanumeric characters and the following ASCII characters are permitted: -, ., !, *, / .

tagsoptional{ [key: string]: string }tagsoptionaltyping.Mapping[str, str]tagsoptionalMap<String, String>TagsoptionalIDictionary<string, string>Tagsoptional*map[string]*string#
User-defined tags associated with a configuration policy.

For more information, see Tagging AWS Security Hub CSPM resources in the Security Hub CSPM user guide .