FeatureV2 class

Manages an opt-in Security Hub V2 feature, such as network scanning (NetScan), for the calling account in the current AWS Region.

> NOTE: Security Hub V2 must be enabled (see aws.securityhub.AccountV2) before you can enable a feature. Use dependsOn to ensure the correct ordering.

> NOTE: Deleting this resource does not disable the feature, the resource in simply removed from state instead.

> NOTE: You cannot enable a feature that is managed by an organization policy.

Example Usage

Basic

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.securityhub.AccountV2("example", {});
const exampleFeatureV2 = new aws.securityhub.FeatureV2("example", {
    featureName: "NETWORK_SCANNING",
    featureStatus: "ENABLED",
}, {
    dependsOn: [example],
});
import pulumi
import pulumi_aws as aws

example = aws.securityhub.AccountV2("example")
example_feature_v2 = aws.securityhub.FeatureV2("example",
    feature_name="NETWORK_SCANNING",
    feature_status="ENABLED",
    opts = pulumi.ResourceOptions(depends_on=[example]))
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.SecurityHub.AccountV2("example");

    var exampleFeatureV2 = new Aws.SecurityHub.FeatureV2("example", new()
    {
        FeatureName = "NETWORK_SCANNING",
        FeatureStatus = "ENABLED",
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            example,
        },
    });

});
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.NewAccountV2(ctx, "example", nil)
		if err != nil {
			return err
		}
		_, err = securityhub.NewFeatureV2(ctx, "example", &securityhub.FeatureV2Args{
			FeatureName:   pulumi.String("NETWORK_SCANNING"),
			FeatureStatus: pulumi.String("ENABLED"),
		}, pulumi.DependsOn([]pulumi.Resource{
			example,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_securityhub_accountv2" "example" {
}
resource "aws_securityhub_featurev2" "example" {
  depends_on     = [aws_securityhub_accountv2.example]
  feature_name   = "NETWORK_SCANNING"
  feature_status = "ENABLED"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.securityhub.AccountV2;
import com.pulumi.aws.securityhub.FeatureV2;
import com.pulumi.aws.securityhub.FeatureV2Args;
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 AccountV2("example");

        var exampleFeatureV2 = new FeatureV2("exampleFeatureV2", FeatureV2Args.builder()
            .featureName("NETWORK_SCANNING")
            .featureStatus("ENABLED")
            .build(), CustomResourceOptions.builder()
                .dependsOn(example)
                .build());

    }
}
resources:
  example:
    type: aws:securityhub:AccountV2
  exampleFeatureV2:
    type: aws:securityhub:FeatureV2
    name: example
    properties:
      featureName: NETWORK_SCANNING
      featureStatus: ENABLED
    options:
      dependsOn:
        - ${example}

Import

Identity Schema

Required

  • featureName (String) Name of the opt-in Security Hub V2 feature.

Optional

  • accountId (String) AWS Account where this resource is managed.
  • region (String) Region where this resource is managed.

Using pulumi import, import Security Hub V2 features using featureName. For example:

$ pulumi import aws:securityhub/featureV2:FeatureV2 example NETWORK_SCANNING

Constructors

FeatureV2(String name, {FeatureV2Args? args, CustomResourceOptions? options})
Creates a new FeatureV2. name The Pulumi resource name. args Arguments used to configure this FeatureV2. The set of arguments for FeatureV2. options Resource options controlling this resource's behavior.
FeatureV2.reference(String urn)
Creates a typed reference to an existing FeatureV2 resource.

Properties

childResources Set<Resource>
finalinherited
completionSources Map<String, IOutputCompletionSource>
latefinalinherited
featureName ↔ Output<String>
Name of the opt-in feature to enable. Valid values: NETWORK_SCANNING. Changing this forces a new resource to be created.
latefinal
featureStatus ↔ Output<String>
Current enablement status of the feature. Valid values: ENABLED, DISABLED.
latefinal
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
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
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, {FeatureV2State? state, CustomResourceOptions? options}) FeatureV2
Gets an existing FeatureV2 resource's state with the given name and id.