Package software.amazon.awscdk.services.securityhub

Class CfnConfigurationPolicy

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.securityhub.CfnConfigurationPolicy
All Implemented Interfaces:
IInspectable, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)", date="2024-10-05T03:43:51.292Z") @Stability(Stable) public class CfnConfigurationPolicy extends CfnResource implements IInspectable, ITaggableV2
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 .

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.*;
 CfnConfigurationPolicy cfnConfigurationPolicy = CfnConfigurationPolicy.Builder.create(this, "MyCfnConfigurationPolicy")
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnConfigurationPolicy

      protected CfnConfigurationPolicy(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnConfigurationPolicy

      protected CfnConfigurationPolicy(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnConfigurationPolicy

      @Stability(Stable) public CfnConfigurationPolicy(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnConfigurationPolicyProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The ARN of the configuration policy.

    • getAttrCreatedAt

      @Stability(Stable) @NotNull public String getAttrCreatedAt()
      The date and time, in UTC and ISO 8601 format.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      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 .

    • getAttrServiceEnabled

      @Stability(Stable) @NotNull public IResolvable getAttrServiceEnabled()
      Indicates whether the service that the configuration policy applies to is enabled in the policy.

    • getAttrUpdatedAt

      @Stability(Stable) @NotNull public String getAttrUpdatedAt()
      The date and time, in UTC and ISO 8601 format, that the configuration policy was last updated.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getConfigurationPolicy

      @Stability(Stable) @NotNull public Object getConfigurationPolicy()
      An object that defines how AWS Security Hub is configured.

    • setConfigurationPolicy

      @Stability(Stable) public void setConfigurationPolicy(@NotNull IResolvable value)
      An object that defines how AWS Security Hub is configured.

    • setConfigurationPolicy

      @Stability(Stable) public void setConfigurationPolicy(@NotNull CfnConfigurationPolicy.PolicyProperty value)
      An object that defines how AWS Security Hub is configured.

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the configuration policy.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the configuration policy.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of the configuration policy.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description of the configuration policy.

    • getTags

      @Stability(Stable) @Nullable public Map<String,String> getTags()
      User-defined tags associated with a configuration policy.

    • setTags

      @Stability(Stable) public void setTags(@Nullable Map<String,String> value)
      User-defined tags associated with a configuration policy.