Package software.amazon.awscdk.services.securityhub

Interface CfnConfigurationPolicyProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnConfigurationPolicyProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)",
           date="2025-10-14T12:28:20.502Z")
@Stability(Stable)
public interface CfnConfigurationPolicyProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnConfigurationPolicy.

Example:

 // 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.*;
 CfnConfigurationPolicyProps cfnConfigurationPolicyProps = CfnConfigurationPolicyProps.builder()
         .configurationPolicy(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())
         .name("name")
         // the properties below are optional
         .description("description")
         .tags(Map.of(
                 "tagsKey", "tags"))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnConfigurationPolicyProps.Builder	A builder for CfnConfigurationPolicyProps
static final class	CfnConfigurationPolicyProps.Jsii$Proxy	An implementation for CfnConfigurationPolicyProps

Method Summary

Modifier and Type	Method	Description
static CfnConfigurationPolicyProps.Builder	builder()
Object	getConfigurationPolicy()	An object that defines how AWS Security Hub is configured.
default String	getDescription()	The description of the configuration policy.
String	getName()	The name of the configuration policy.
default Map<String,String>	getTags()	User-defined tags associated with a configuration policy.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getConfigurationPolicy

@Stability(Stable)
@NotNull
Object getConfigurationPolicy()

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

See Also:

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

getName

@Stability(Stable)
@NotNull
String getName()

The name of the configuration policy.

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

See Also:

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

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

The description of the configuration policy.

See Also:

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

getTags

@Stability(Stable)
@Nullable
default Map<String,String> getTags()

User-defined tags associated with a configuration policy.

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

See Also:

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

builder

@Stability(Stable)
static CfnConfigurationPolicyProps.Builder builder()

Returns:

a CfnConfigurationPolicyProps.Builder of CfnConfigurationPolicyProps