Class ConfigurationPolicy


  • public class ConfigurationPolicy
    extends com.pulumi.resources.CustomResource
    Manages Security Hub configuration policy > **NOTE:** This resource requires `aws.securityhub.OrganizationConfiguration` to be configured of type `CENTRAL`. More information about Security Hub central configuration and configuration policies can be found in the [How Security Hub configuration policies work](https://docs.aws.amazon.com/securityhub/latest/userguide/configuration-policies-overview.html) documentation. ## Example Usage ### Default standards enabled
     
     package generated_program;
     
     import com.pulumi.Context;
     import com.pulumi.Pulumi;
     import com.pulumi.core.Output;
     import com.pulumi.aws.securityhub.FindingAggregator;
     import com.pulumi.aws.securityhub.FindingAggregatorArgs;
     import com.pulumi.aws.securityhub.OrganizationConfiguration;
     import com.pulumi.aws.securityhub.OrganizationConfigurationArgs;
     import com.pulumi.aws.securityhub.inputs.OrganizationConfigurationOrganizationConfigurationArgs;
     import com.pulumi.aws.securityhub.ConfigurationPolicy;
     import com.pulumi.aws.securityhub.ConfigurationPolicyArgs;
     import com.pulumi.aws.securityhub.inputs.ConfigurationPolicyConfigurationPolicyArgs;
     import com.pulumi.aws.securityhub.inputs.ConfigurationPolicyConfigurationPolicySecurityControlsConfigurationArgs;
     import com.pulumi.resources.CustomResourceOptions;
     import java.util.ArrayList;
     import java.util.Arrays;
     import java.util.Map;
     import java.io.File;
     import java.nio.file.Files;
     import java.nio.file.Paths;
     
     public class App {
         public static void main(String[] args) {
             Pulumi.run(App::stack);
         }
     
         public static void stack(Context ctx) {
             var example = new FindingAggregator("example", FindingAggregatorArgs.builder()
                 .linkingMode("ALL_REGIONS")
                 .build());
     
             var exampleOrganizationConfiguration = new OrganizationConfiguration("exampleOrganizationConfiguration", OrganizationConfigurationArgs.builder()
                 .organizationConfiguration(OrganizationConfigurationOrganizationConfigurationArgs.builder()
                     .configurationType("CENTRAL")
                     .build())
                 .autoEnable(false)
                 .autoEnableStandards("NONE")
                 .build(), CustomResourceOptions.builder()
                     .dependsOn(example)
                     .build());
     
             var exampleConfigurationPolicy = new ConfigurationPolicy("exampleConfigurationPolicy", ConfigurationPolicyArgs.builder()
                 .configurationPolicy(ConfigurationPolicyConfigurationPolicyArgs.builder()
                     .securityControlsConfiguration(ConfigurationPolicyConfigurationPolicySecurityControlsConfigurationArgs.builder()
                         .disabledControlIdentifiers()
                         .build())
                     .serviceEnabled(true)
                     .enabledStandardArns(                
                         "arn:aws:securityhub:us-east-1::standards/aws-foundational-security-best-practices/v/1.0.0",
                         "arn:aws:securityhub:::ruleset/cis-aws-foundations-benchmark/v/1.2.0")
                     .build())
                 .name("Example")
                 .description("This is an example configuration policy")
                 .build(), CustomResourceOptions.builder()
                     .dependsOn(exampleOrganizationConfiguration)
                     .build());
     
         }
     }
     
     
    ### Disabled Policy
     
     package generated_program;
     
     import com.pulumi.Context;
     import com.pulumi.Pulumi;
     import com.pulumi.core.Output;
     import com.pulumi.aws.securityhub.ConfigurationPolicy;
     import com.pulumi.aws.securityhub.ConfigurationPolicyArgs;
     import com.pulumi.aws.securityhub.inputs.ConfigurationPolicyConfigurationPolicyArgs;
     import com.pulumi.resources.CustomResourceOptions;
     import java.util.ArrayList;
     import java.util.Arrays;
     import java.util.Map;
     import java.io.File;
     import java.nio.file.Files;
     import java.nio.file.Paths;
     
     public class App {
         public static void main(String[] args) {
             Pulumi.run(App::stack);
         }
     
         public static void stack(Context ctx) {
             var disabled = new ConfigurationPolicy("disabled", ConfigurationPolicyArgs.builder()
                 .configurationPolicy(ConfigurationPolicyConfigurationPolicyArgs.builder()
                     .serviceEnabled(false)
                     .build())
                 .name("Disabled")
                 .description("This is an example of disabled configuration policy")
                 .build(), CustomResourceOptions.builder()
                     .dependsOn(example)
                     .build());
     
         }
     }
     
     
    ### Custom Control Configuration
     
     package generated_program;
     
     import com.pulumi.Context;
     import com.pulumi.Pulumi;
     import com.pulumi.core.Output;
     import com.pulumi.aws.securityhub.ConfigurationPolicy;
     import com.pulumi.aws.securityhub.ConfigurationPolicyArgs;
     import com.pulumi.aws.securityhub.inputs.ConfigurationPolicyConfigurationPolicyArgs;
     import com.pulumi.aws.securityhub.inputs.ConfigurationPolicyConfigurationPolicySecurityControlsConfigurationArgs;
     import com.pulumi.aws.securityhub.inputs.ConfigurationPolicyConfigurationPolicySecurityControlsConfigurationSecurityControlCustomParameterArgs;
     import com.pulumi.aws.securityhub.inputs.ConfigurationPolicyConfigurationPolicySecurityControlsConfigurationSecurityControlCustomParameterParameterArgs;
     import com.pulumi.aws.securityhub.inputs.ConfigurationPolicyConfigurationPolicySecurityControlsConfigurationSecurityControlCustomParameterParameterEnumArgs;
     import com.pulumi.aws.securityhub.inputs.ConfigurationPolicyConfigurationPolicySecurityControlsConfigurationSecurityControlCustomParameterParameterBoolArgs;
     import com.pulumi.aws.securityhub.inputs.ConfigurationPolicyConfigurationPolicySecurityControlsConfigurationSecurityControlCustomParameterParameterIntArgs;
     import com.pulumi.resources.CustomResourceOptions;
     import java.util.ArrayList;
     import java.util.Arrays;
     import java.util.Map;
     import java.io.File;
     import java.nio.file.Files;
     import java.nio.file.Paths;
     
     public class App {
         public static void main(String[] args) {
             Pulumi.run(App::stack);
         }
     
         public static void stack(Context ctx) {
             var disabled = new ConfigurationPolicy("disabled", ConfigurationPolicyArgs.builder()
                 .configurationPolicy(ConfigurationPolicyConfigurationPolicyArgs.builder()
                     .securityControlsConfiguration(ConfigurationPolicyConfigurationPolicySecurityControlsConfigurationArgs.builder()
                         .securityControlCustomParameters(                    
                             ConfigurationPolicyConfigurationPolicySecurityControlsConfigurationSecurityControlCustomParameterArgs.builder()
                                 .parameters(ConfigurationPolicyConfigurationPolicySecurityControlsConfigurationSecurityControlCustomParameterParameterArgs.builder()
                                     .enum_(ConfigurationPolicyConfigurationPolicySecurityControlsConfigurationSecurityControlCustomParameterParameterEnumArgs.builder()
                                         .value("INFO")
                                         .build())
                                     .name("loggingLevel")
                                     .valueType("CUSTOM")
                                     .build())
                                 .securityControlId("APIGateway.1")
                                 .build(),
                             ConfigurationPolicyConfigurationPolicySecurityControlsConfigurationSecurityControlCustomParameterArgs.builder()
                                 .parameters(                            
                                     ConfigurationPolicyConfigurationPolicySecurityControlsConfigurationSecurityControlCustomParameterParameterArgs.builder()
                                         .bool(ConfigurationPolicyConfigurationPolicySecurityControlsConfigurationSecurityControlCustomParameterParameterBoolArgs.builder()
                                             .value(false)
                                             .build())
                                         .name("RequireLowercaseCharacters")
                                         .valueType("CUSTOM")
                                         .build(),
                                     ConfigurationPolicyConfigurationPolicySecurityControlsConfigurationSecurityControlCustomParameterParameterArgs.builder()
                                         .int_(ConfigurationPolicyConfigurationPolicySecurityControlsConfigurationSecurityControlCustomParameterParameterIntArgs.builder()
                                             .value(60)
                                             .build())
                                         .name("MaxPasswordAge")
                                         .valueType("CUSTOM")
                                         .build())
                                 .securityControlId("IAM.7")
                                 .build())
                         .enabledControlIdentifiers(                    
                             "APIGateway.1",
                             "IAM.7")
                         .build())
                     .serviceEnabled(true)
                     .enabledStandardArns(                
                         "arn:aws:securityhub:us-east-1::standards/aws-foundational-security-best-practices/v/1.0.0",
                         "arn:aws:securityhub:::ruleset/cis-aws-foundations-benchmark/v/1.2.0")
                     .build())
                 .name("Custom Controls")
                 .description("This is an example of configuration policy with custom control settings")
                 .build(), CustomResourceOptions.builder()
                     .dependsOn(example)
                     .build());
     
         }
     }
     
     
    ## Import ### Identity Schema #### Required - `id` (String) UUID of the configuration policy. #### Optional * `accountId` (String) AWS Account where this resource is managed. * `region` (String) Region where this resource is managed. Using `pulumi import`, import Security Hub configuration policies using `id`. For example: ```sh $ pulumi import aws:securityhub/configurationPolicy:ConfigurationPolicy example 00000000-1111-2222-3333-444444444444 ```
    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal
      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal
    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<ConfigurationPolicyConfigurationPolicy> configurationPolicy()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()  
      static ConfigurationPolicy get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, ConfigurationPolicyState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> name()  
      com.pulumi.core.Output<java.lang.String> region()  
      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture
      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • ConfigurationPolicy

        public ConfigurationPolicy​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.
      • ConfigurationPolicy

        public ConfigurationPolicy​(java.lang.String name,
                                   ConfigurationPolicyArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
      • ConfigurationPolicy

        public ConfigurationPolicy​(java.lang.String name,
                                   ConfigurationPolicyArgs args,
                                   @Nullable
                                   com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.
    • Method Detail

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
      • description

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()
        Returns:
        The description of the configuration policy.
      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        The name of the configuration policy.
      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
      • get

        public static ConfigurationPolicy get​(java.lang.String name,
                                              com.pulumi.core.Output<java.lang.String> id,
                                              @Nullable
                                              ConfigurationPolicyState state,
                                              @Nullable
                                              com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.