ConfigurationPolicyAssociation class
Manages Security Hub configuration policy associations.
> NOTE: This resource requires aws.securityhub.OrganizationConfiguration to be configured with type CENTRAL. More information about Security Hub central configuration and configuration policies can be found in the How Security Hub configuration policies work documentation.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.securityhub.FindingAggregator("example", {linkingMode: "ALL_REGIONS"});
const exampleOrganizationConfiguration = new aws.securityhub.OrganizationConfiguration("example", {
organizationConfiguration: {
configurationType: "CENTRAL",
},
autoEnable: false,
autoEnableStandards: "NONE",
}, {
dependsOn: [example],
});
const exampleConfigurationPolicy = new aws.securityhub.ConfigurationPolicy("example", {
configurationPolicy: {
securityControlsConfiguration: {
disabledControlIdentifiers: [],
},
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",
],
},
name: "Example",
description: "This is an example configuration policy",
}, {
dependsOn: [exampleOrganizationConfiguration],
});
const accountExample = new aws.securityhub.ConfigurationPolicyAssociation("account_example", {
targetId: "123456789012",
policyId: exampleConfigurationPolicy.id,
});
const rootExample = new aws.securityhub.ConfigurationPolicyAssociation("root_example", {
targetId: "r-abcd",
policyId: exampleConfigurationPolicy.id,
});
const ouExample = new aws.securityhub.ConfigurationPolicyAssociation("ou_example", {
targetId: "ou-abcd-12345678",
policyId: exampleConfigurationPolicy.id,
});
const selfManagedExample = new aws.securityhub.ConfigurationPolicyAssociation("self_managed_example", {
targetId: "123456789012",
policyId: "SELF_MANAGED_SECURITY_HUB",
});
import pulumi
import pulumi_aws as aws
example = aws.securityhub.FindingAggregator("example", linking_mode="ALL_REGIONS")
example_organization_configuration = aws.securityhub.OrganizationConfiguration("example",
organization_configuration={
"configuration_type": "CENTRAL",
},
auto_enable=False,
auto_enable_standards="NONE",
opts = pulumi.ResourceOptions(depends_on=[example]))
example_configuration_policy = aws.securityhub.ConfigurationPolicy("example",
configuration_policy={
"security_controls_configuration": {
"disabled_control_identifiers": [],
},
"service_enabled": True,
"enabled_standard_arns": [
"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",
],
},
name="Example",
description="This is an example configuration policy",
opts = pulumi.ResourceOptions(depends_on=[example_organization_configuration]))
account_example = aws.securityhub.ConfigurationPolicyAssociation("account_example",
target_id="123456789012",
policy_id=example_configuration_policy.id)
root_example = aws.securityhub.ConfigurationPolicyAssociation("root_example",
target_id="r-abcd",
policy_id=example_configuration_policy.id)
ou_example = aws.securityhub.ConfigurationPolicyAssociation("ou_example",
target_id="ou-abcd-12345678",
policy_id=example_configuration_policy.id)
self_managed_example = aws.securityhub.ConfigurationPolicyAssociation("self_managed_example",
target_id="123456789012",
policy_id="SELF_MANAGED_SECURITY_HUB")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.SecurityHub.FindingAggregator("example", new()
{
LinkingMode = "ALL_REGIONS",
});
var exampleOrganizationConfiguration = new Aws.SecurityHub.OrganizationConfiguration("example", new()
{
OrganizationConfigurationDetails = new Aws.SecurityHub.Inputs.OrganizationConfigurationOrganizationConfigurationArgs
{
ConfigurationType = "CENTRAL",
},
AutoEnable = false,
AutoEnableStandards = "NONE",
}, new CustomResourceOptions
{
DependsOn =
{
example,
},
});
var exampleConfigurationPolicy = new Aws.SecurityHub.ConfigurationPolicy("example", new()
{
ConfigurationPolicyDetails = new Aws.SecurityHub.Inputs.ConfigurationPolicyConfigurationPolicyArgs
{
SecurityControlsConfiguration = new Aws.SecurityHub.Inputs.ConfigurationPolicyConfigurationPolicySecurityControlsConfigurationArgs
{
DisabledControlIdentifiers = new() { },
},
ServiceEnabled = true,
EnabledStandardArns = new[]
{
"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",
},
},
Name = "Example",
Description = "This is an example configuration policy",
}, new CustomResourceOptions
{
DependsOn =
{
exampleOrganizationConfiguration,
},
});
var accountExample = new Aws.SecurityHub.ConfigurationPolicyAssociation("account_example", new()
{
TargetId = "123456789012",
PolicyId = exampleConfigurationPolicy.Id,
});
var rootExample = new Aws.SecurityHub.ConfigurationPolicyAssociation("root_example", new()
{
TargetId = "r-abcd",
PolicyId = exampleConfigurationPolicy.Id,
});
var ouExample = new Aws.SecurityHub.ConfigurationPolicyAssociation("ou_example", new()
{
TargetId = "ou-abcd-12345678",
PolicyId = exampleConfigurationPolicy.Id,
});
var selfManagedExample = new Aws.SecurityHub.ConfigurationPolicyAssociation("self_managed_example", new()
{
TargetId = "123456789012",
PolicyId = "SELF_MANAGED_SECURITY_HUB",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/securityhub"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := securityhub.NewFindingAggregator(ctx, "example", &securityhub.FindingAggregatorArgs{
LinkingMode: pulumi.String("ALL_REGIONS"),
})
if err != nil {
return err
}
exampleOrganizationConfiguration, err := securityhub.NewOrganizationConfiguration(ctx, "example", &securityhub.OrganizationConfigurationArgs{
OrganizationConfiguration: &securityhub.OrganizationConfigurationOrganizationConfigurationArgs{
ConfigurationType: pulumi.String("CENTRAL"),
},
AutoEnable: pulumi.Bool(false),
AutoEnableStandards: pulumi.String("NONE"),
}, pulumi.DependsOn([]pulumi.Resource{
example,
}))
if err != nil {
return err
}
exampleConfigurationPolicy, err := securityhub.NewConfigurationPolicy(ctx, "example", &securityhub.ConfigurationPolicyArgs{
ConfigurationPolicy: &securityhub.ConfigurationPolicyConfigurationPolicyArgs{
SecurityControlsConfiguration: &securityhub.ConfigurationPolicyConfigurationPolicySecurityControlsConfigurationArgs{
DisabledControlIdentifiers: pulumi.StringArray{},
},
ServiceEnabled: pulumi.Bool(true),
EnabledStandardArns: pulumi.StringArray{
pulumi.String("arn:aws:securityhub:us-east-1::standards/aws-foundational-security-best-practices/v/1.0.0"),
pulumi.String("arn:aws:securityhub:::ruleset/cis-aws-foundations-benchmark/v/1.2.0"),
},
},
Name: pulumi.String("Example"),
Description: pulumi.String("This is an example configuration policy"),
}, pulumi.DependsOn([]pulumi.Resource{
exampleOrganizationConfiguration,
}))
if err != nil {
return err
}
_, err = securityhub.NewConfigurationPolicyAssociation(ctx, "account_example", &securityhub.ConfigurationPolicyAssociationArgs{
TargetId: pulumi.String("123456789012"),
PolicyId: exampleConfigurationPolicy.ID().ToIDOutput().ToStringOutput(),
})
if err != nil {
return err
}
_, err = securityhub.NewConfigurationPolicyAssociation(ctx, "root_example", &securityhub.ConfigurationPolicyAssociationArgs{
TargetId: pulumi.String("r-abcd"),
PolicyId: exampleConfigurationPolicy.ID().ToIDOutput().ToStringOutput(),
})
if err != nil {
return err
}
_, err = securityhub.NewConfigurationPolicyAssociation(ctx, "ou_example", &securityhub.ConfigurationPolicyAssociationArgs{
TargetId: pulumi.String("ou-abcd-12345678"),
PolicyId: exampleConfigurationPolicy.ID().ToIDOutput().ToStringOutput(),
})
if err != nil {
return err
}
_, err = securityhub.NewConfigurationPolicyAssociation(ctx, "self_managed_example", &securityhub.ConfigurationPolicyAssociationArgs{
TargetId: pulumi.String("123456789012"),
PolicyId: pulumi.String("SELF_MANAGED_SECURITY_HUB"),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_securityhub_findingaggregator" "example" {
linking_mode = "ALL_REGIONS"
}
resource "aws_securityhub_organizationconfiguration" "example" {
depends_on = [aws_securityhub_findingaggregator.example]
organization_configuration = {
configuration_type = "CENTRAL"
}
auto_enable = false
auto_enable_standards = "NONE"
}
resource "aws_securityhub_configurationpolicy" "example" {
depends_on = [aws_securityhub_organizationconfiguration.example]
configuration_policy = {
security_controls_configuration = {
disabled_control_identifiers = []
}
service_enabled = true
enabled_standard_arns = ["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"]
}
name = "Example"
description = "This is an example configuration policy"
}
resource "aws_securityhub_configurationpolicyassociation" "account_example" {
target_id = "123456789012"
policy_id = aws_securityhub_configurationpolicy.example.id
}
resource "aws_securityhub_configurationpolicyassociation" "root_example" {
target_id = "r-abcd"
policy_id = aws_securityhub_configurationpolicy.example.id
}
resource "aws_securityhub_configurationpolicyassociation" "ou_example" {
target_id = "ou-abcd-12345678"
policy_id = aws_securityhub_configurationpolicy.example.id
}
resource "aws_securityhub_configurationpolicyassociation" "self_managed_example" {
target_id = "123456789012"
policy_id = "SELF_MANAGED_SECURITY_HUB"
}
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.aws.securityhub.ConfigurationPolicyAssociation;
import com.pulumi.aws.securityhub.ConfigurationPolicyAssociationArgs;
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());
var accountExample = new ConfigurationPolicyAssociation("accountExample", ConfigurationPolicyAssociationArgs.builder()
.targetId("123456789012")
.policyId(exampleConfigurationPolicy.id())
.build());
var rootExample = new ConfigurationPolicyAssociation("rootExample", ConfigurationPolicyAssociationArgs.builder()
.targetId("r-abcd")
.policyId(exampleConfigurationPolicy.id())
.build());
var ouExample = new ConfigurationPolicyAssociation("ouExample", ConfigurationPolicyAssociationArgs.builder()
.targetId("ou-abcd-12345678")
.policyId(exampleConfigurationPolicy.id())
.build());
var selfManagedExample = new ConfigurationPolicyAssociation("selfManagedExample", ConfigurationPolicyAssociationArgs.builder()
.targetId("123456789012")
.policyId("SELF_MANAGED_SECURITY_HUB")
.build());
}
}
resources:
example:
type: aws:securityhub:FindingAggregator
properties:
linkingMode: ALL_REGIONS
exampleOrganizationConfiguration:
type: aws:securityhub:OrganizationConfiguration
name: example
properties:
organizationConfiguration:
configurationType: CENTRAL
autoEnable: false
autoEnableStandards: NONE
options:
dependsOn:
- ${example}
exampleConfigurationPolicy:
type: aws:securityhub:ConfigurationPolicy
name: example
properties:
configurationPolicy:
securityControlsConfiguration:
disabledControlIdentifiers: []
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
name: Example
description: This is an example configuration policy
options:
dependsOn:
- ${exampleOrganizationConfiguration}
accountExample:
type: aws:securityhub:ConfigurationPolicyAssociation
name: account_example
properties:
targetId: '123456789012'
policyId: ${exampleConfigurationPolicy.id}
rootExample:
type: aws:securityhub:ConfigurationPolicyAssociation
name: root_example
properties:
targetId: r-abcd
policyId: ${exampleConfigurationPolicy.id}
ouExample:
type: aws:securityhub:ConfigurationPolicyAssociation
name: ou_example
properties:
targetId: ou-abcd-12345678
policyId: ${exampleConfigurationPolicy.id}
selfManagedExample:
type: aws:securityhub:ConfigurationPolicyAssociation
name: self_managed_example
properties:
targetId: '123456789012'
policyId: SELF_MANAGED_SECURITY_HUB
Import
Identity Schema
Required
targetId(String) Identifier of the target account, organizational unit, or the root that is associated with the configuration.
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 policy associations using targetId. For example:
$ pulumi import aws:securityhub/configurationPolicyAssociation:ConfigurationPolicyAssociation example 123456789012
Constructors
- ConfigurationPolicyAssociation(String name, {ConfigurationPolicyAssociationArgs? args, CustomResourceOptions? options})
-
Creates a new ConfigurationPolicyAssociation.
nameThe Pulumi resource name.argsArguments used to configure this ConfigurationPolicyAssociation. The set of arguments for ConfigurationPolicyAssociation.optionsResource options controlling this resource's behavior. - ConfigurationPolicyAssociation.reference(String urn)
- Creates a typed reference to an existing ConfigurationPolicyAssociation resource.
Properties
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
policyId
↔ Output<
String> -
The universally unique identifier (UUID) of the configuration policy, or
SELF_MANAGED_SECURITY_HUBfor a self-managed configuration.latefinal -
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
targetId
↔ Output<
String> -
The identifier of the target account, organizational unit, or the root to associate with the specified configuration.
latefinal
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
get(
String name, Input< String> id, {ConfigurationPolicyAssociationState? state, CustomResourceOptions? options}) → ConfigurationPolicyAssociation -
Gets an existing ConfigurationPolicyAssociation resource's state with the given
nameandid.