Docs Packages
  1. Packages
  2. AWS Native
  3. API Docs
  4. securityhub
  5. Hub

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.105.0 published on Thursday, May 2, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.securityhub.Hub

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.105.0 published on Thursday, May 2, 2024 by Pulumi
pulumi/pulumi-aws-native

    The AWS::SecurityHub::Hub resource represents the implementation of the AWS Security Hub service in your account. One hub resource is created for each Region in which you enable Security Hub.

    Example Usage

    Example

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AwsNative = Pulumi.AwsNative;

return await Deployment.RunAsync(() => 
{
    var exampleHubWithTags = new AwsNative.SecurityHub.Hub("exampleHubWithTags", new()
    {
        Tags = 
        {
            { "key1", "value1" },
            { "key2", "value2" },
        },
        EnableDefaultStandards = true,
        ControlFindingGenerator = "SECURITY_CONTROL",
    });

    return new Dictionary<string, object?>
    {
        ["hubArn"] = exampleHubWithTags.Id,
    };
});

    package main

import (
	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/securityhub"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleHubWithTags, err := securityhub.NewHub(ctx, "exampleHubWithTags", &securityhub.HubArgs{
			Tags: pulumi.StringMap{
				"key1": pulumi.String("value1"),
				"key2": pulumi.String("value2"),
			},
			EnableDefaultStandards:  pulumi.Bool(true),
			ControlFindingGenerator: pulumi.String("SECURITY_CONTROL"),
		})
		if err != nil {
			return err
		}
		ctx.Export("hubArn", exampleHubWithTags.ID())
		return nil
	})
}

    Coming soon!

    import pulumi
import pulumi_aws_native as aws_native

example_hub_with_tags = aws_native.securityhub.Hub("exampleHubWithTags",
    tags={
        "key1": "value1",
        "key2": "value2",
    },
    enable_default_standards=True,
    control_finding_generator="SECURITY_CONTROL")
pulumi.export("hubArn", example_hub_with_tags.id)

    import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";

const exampleHubWithTags = new aws_native.securityhub.Hub("exampleHubWithTags", {
    tags: {
        key1: "value1",
        key2: "value2",
    },
    enableDefaultStandards: true,
    controlFindingGenerator: "SECURITY_CONTROL",
});
export const hubArn = exampleHubWithTags.id;

    Coming soon!

    Example

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AwsNative = Pulumi.AwsNative;

return await Deployment.RunAsync(() => 
{
    var exampleHubWithTags = new AwsNative.SecurityHub.Hub("exampleHubWithTags", new()
    {
        Tags = 
        {
            { "key1", "value1" },
            { "key2", "value2" },
        },
        EnableDefaultStandards = true,
        ControlFindingGenerator = "SECURITY_CONTROL",
    });

    return new Dictionary<string, object?>
    {
        ["hubArn"] = exampleHubWithTags.Id,
    };
});

    package main

import (
	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/securityhub"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleHubWithTags, err := securityhub.NewHub(ctx, "exampleHubWithTags", &securityhub.HubArgs{
			Tags: pulumi.StringMap{
				"key1": pulumi.String("value1"),
				"key2": pulumi.String("value2"),
			},
			EnableDefaultStandards:  pulumi.Bool(true),
			ControlFindingGenerator: pulumi.String("SECURITY_CONTROL"),
		})
		if err != nil {
			return err
		}
		ctx.Export("hubArn", exampleHubWithTags.ID())
		return nil
	})
}

    Coming soon!

    import pulumi
import pulumi_aws_native as aws_native

example_hub_with_tags = aws_native.securityhub.Hub("exampleHubWithTags",
    tags={
        "key1": "value1",
        "key2": "value2",
    },
    enable_default_standards=True,
    control_finding_generator="SECURITY_CONTROL")
pulumi.export("hubArn", example_hub_with_tags.id)

    import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";

const exampleHubWithTags = new aws_native.securityhub.Hub("exampleHubWithTags", {
    tags: {
        key1: "value1",
        key2: "value2",
    },
    enableDefaultStandards: true,
    controlFindingGenerator: "SECURITY_CONTROL",
});
export const hubArn = exampleHubWithTags.id;

    Coming soon!

    Example

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AwsNative = Pulumi.AwsNative;

return await Deployment.RunAsync(() => 
{
    var exampleHubWithTags = new AwsNative.SecurityHub.Hub("exampleHubWithTags", new()
    {
        Tags = 
        {
            { "key1", "value1" },
            { "key2", "value2" },
        },
        EnableDefaultStandards = false,
        ControlFindingGenerator = "STANDARD_CONTROL",
    });

    return new Dictionary<string, object?>
    {
        ["hubArn"] = exampleHubWithTags.Id,
    };
});

    package main

import (
	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/securityhub"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleHubWithTags, err := securityhub.NewHub(ctx, "exampleHubWithTags", &securityhub.HubArgs{
			Tags: pulumi.StringMap{
				"key1": pulumi.String("value1"),
				"key2": pulumi.String("value2"),
			},
			EnableDefaultStandards:  pulumi.Bool(false),
			ControlFindingGenerator: pulumi.String("STANDARD_CONTROL"),
		})
		if err != nil {
			return err
		}
		ctx.Export("hubArn", exampleHubWithTags.ID())
		return nil
	})
}

    Coming soon!

    import pulumi
import pulumi_aws_native as aws_native

example_hub_with_tags = aws_native.securityhub.Hub("exampleHubWithTags",
    tags={
        "key1": "value1",
        "key2": "value2",
    },
    enable_default_standards=False,
    control_finding_generator="STANDARD_CONTROL")
pulumi.export("hubArn", example_hub_with_tags.id)

    import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";

const exampleHubWithTags = new aws_native.securityhub.Hub("exampleHubWithTags", {
    tags: {
        key1: "value1",
        key2: "value2",
    },
    enableDefaultStandards: false,
    controlFindingGenerator: "STANDARD_CONTROL",
});
export const hubArn = exampleHubWithTags.id;

    Coming soon!

    Example

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AwsNative = Pulumi.AwsNative;

return await Deployment.RunAsync(() => 
{
    var exampleHubWithTags = new AwsNative.SecurityHub.Hub("exampleHubWithTags", new()
    {
        Tags = 
        {
            { "key1", "value1" },
            { "key2", "value2" },
        },
        EnableDefaultStandards = false,
        ControlFindingGenerator = "STANDARD_CONTROL",
    });

    return new Dictionary<string, object?>
    {
        ["hubArn"] = exampleHubWithTags.Id,
    };
});

    package main

import (
	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/securityhub"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleHubWithTags, err := securityhub.NewHub(ctx, "exampleHubWithTags", &securityhub.HubArgs{
			Tags: pulumi.StringMap{
				"key1": pulumi.String("value1"),
				"key2": pulumi.String("value2"),
			},
			EnableDefaultStandards:  pulumi.Bool(false),
			ControlFindingGenerator: pulumi.String("STANDARD_CONTROL"),
		})
		if err != nil {
			return err
		}
		ctx.Export("hubArn", exampleHubWithTags.ID())
		return nil
	})
}

    Coming soon!

    import pulumi
import pulumi_aws_native as aws_native

example_hub_with_tags = aws_native.securityhub.Hub("exampleHubWithTags",
    tags={
        "key1": "value1",
        "key2": "value2",
    },
    enable_default_standards=False,
    control_finding_generator="STANDARD_CONTROL")
pulumi.export("hubArn", example_hub_with_tags.id)

    import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";

const exampleHubWithTags = new aws_native.securityhub.Hub("exampleHubWithTags", {
    tags: {
        key1: "value1",
        key2: "value2",
    },
    enableDefaultStandards: false,
    controlFindingGenerator: "STANDARD_CONTROL",
});
export const hubArn = exampleHubWithTags.id;

    Coming soon!

    Create Hub Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Hub(name: string, args?: HubArgs, opts?: CustomResourceOptions);
    @overload
def Hub(resource_name: str,
        args: Optional[HubArgs] = None,
        opts: Optional[ResourceOptions] = None)

@overload
def Hub(resource_name: str,
        opts: Optional[ResourceOptions] = None,
        auto_enable_controls: Optional[bool] = None,
        control_finding_generator: Optional[str] = None,
        enable_default_standards: Optional[bool] = None,
        tags: Optional[Mapping[str, str]] = None)
    func NewHub(ctx *Context, name string, args *HubArgs, opts ...ResourceOption) (*Hub, error)
    public Hub(string name, HubArgs? args = null, CustomResourceOptions? opts = null)
    public Hub(String name, HubArgs args)
public Hub(String name, HubArgs args, CustomResourceOptions options)

    type: aws-native:securityhub:Hub
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args HubArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args HubArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args HubArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args HubArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args HubArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    const hubResource = new aws_native.securityhub.Hub("hubResource", {
    autoEnableControls: false,
    controlFindingGenerator: "string",
    enableDefaultStandards: false,
    tags: {
        string: "string",
    },
});

    Coming soon!

    Hub Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Hub resource accepts the following input properties:

    AutoEnableControls bool
    Whether to automatically enable new controls when they are added to standards that are enabled
    ControlFindingGenerator string
    This field, used when enabling Security Hub, specifies whether the calling account has consolidated control findings turned on. If the value for this field is set to SECURITY_CONTROL, Security Hub generates a single finding for a control check even when the check applies to multiple enabled standards. If the value for this field is set to STANDARD_CONTROL, Security Hub generates separate findings for a control check when the check applies to multiple enabled standards.
    EnableDefaultStandards bool
    Whether to enable the security standards that Security Hub has designated as automatically enabled.
    Tags Dictionary<string, string>
    AutoEnableControls bool
    Whether to automatically enable new controls when they are added to standards that are enabled
    ControlFindingGenerator string
    This field, used when enabling Security Hub, specifies whether the calling account has consolidated control findings turned on. If the value for this field is set to SECURITY_CONTROL, Security Hub generates a single finding for a control check even when the check applies to multiple enabled standards. If the value for this field is set to STANDARD_CONTROL, Security Hub generates separate findings for a control check when the check applies to multiple enabled standards.
    EnableDefaultStandards bool
    Whether to enable the security standards that Security Hub has designated as automatically enabled.
    Tags map[string]string
    autoEnableControls Boolean
    Whether to automatically enable new controls when they are added to standards that are enabled
    controlFindingGenerator String
    This field, used when enabling Security Hub, specifies whether the calling account has consolidated control findings turned on. If the value for this field is set to SECURITY_CONTROL, Security Hub generates a single finding for a control check even when the check applies to multiple enabled standards. If the value for this field is set to STANDARD_CONTROL, Security Hub generates separate findings for a control check when the check applies to multiple enabled standards.
    enableDefaultStandards Boolean
    Whether to enable the security standards that Security Hub has designated as automatically enabled.
    tags Map<String,String>
    autoEnableControls boolean
    Whether to automatically enable new controls when they are added to standards that are enabled
    controlFindingGenerator string
    This field, used when enabling Security Hub, specifies whether the calling account has consolidated control findings turned on. If the value for this field is set to SECURITY_CONTROL, Security Hub generates a single finding for a control check even when the check applies to multiple enabled standards. If the value for this field is set to STANDARD_CONTROL, Security Hub generates separate findings for a control check when the check applies to multiple enabled standards.
    enableDefaultStandards boolean
    Whether to enable the security standards that Security Hub has designated as automatically enabled.
    tags {[key: string]: string}
    auto_enable_controls bool
    Whether to automatically enable new controls when they are added to standards that are enabled
    control_finding_generator str
    This field, used when enabling Security Hub, specifies whether the calling account has consolidated control findings turned on. If the value for this field is set to SECURITY_CONTROL, Security Hub generates a single finding for a control check even when the check applies to multiple enabled standards. If the value for this field is set to STANDARD_CONTROL, Security Hub generates separate findings for a control check when the check applies to multiple enabled standards.
    enable_default_standards bool
    Whether to enable the security standards that Security Hub has designated as automatically enabled.
    tags Mapping[str, str]
    autoEnableControls Boolean
    Whether to automatically enable new controls when they are added to standards that are enabled
    controlFindingGenerator String
    This field, used when enabling Security Hub, specifies whether the calling account has consolidated control findings turned on. If the value for this field is set to SECURITY_CONTROL, Security Hub generates a single finding for a control check even when the check applies to multiple enabled standards. If the value for this field is set to STANDARD_CONTROL, Security Hub generates separate findings for a control check when the check applies to multiple enabled standards.
    enableDefaultStandards Boolean
    Whether to enable the security standards that Security Hub has designated as automatically enabled.
    tags Map<String>

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Hub resource produces the following output properties:

    Arn string
    An ARN is automatically created for the customer.
    Id string
    The provider-assigned unique ID for this managed resource.
    SubscribedAt string
    The date and time when Security Hub was enabled in the account.
    Arn string
    An ARN is automatically created for the customer.
    Id string
    The provider-assigned unique ID for this managed resource.
    SubscribedAt string
    The date and time when Security Hub was enabled in the account.
    arn String
    An ARN is automatically created for the customer.
    id String
    The provider-assigned unique ID for this managed resource.
    subscribedAt String
    The date and time when Security Hub was enabled in the account.
    arn string
    An ARN is automatically created for the customer.
    id string
    The provider-assigned unique ID for this managed resource.
    subscribedAt string
    The date and time when Security Hub was enabled in the account.
    arn str
    An ARN is automatically created for the customer.
    id str
    The provider-assigned unique ID for this managed resource.
    subscribed_at str
    The date and time when Security Hub was enabled in the account.
    arn String
    An ARN is automatically created for the customer.
    id String
    The provider-assigned unique ID for this managed resource.
    subscribedAt String
    The date and time when Security Hub was enabled in the account.

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.105.0 published on Thursday, May 2, 2024 by Pulumi
    pulumi/pulumi-aws-native