Module securityhub

@pulumi/aws > securityhub

class Account

extends CustomResource

Enables Security Hub for this AWS account.

NOTE: Destroying this resource will disable Security Hub for this AWS account.

NOTE: This AWS service is in Preview and may change before General Availability release. Backwards compatibility is not guaranteed between Terraform AWS Provider releases.

Example Usage

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

const example = new aws.securityhub.Account("example", {});

constructor

new Account(name: string, args?: AccountArgs, opts?: pulumi.CustomResourceOptions)

Create a Account resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: AccountState, opts?: pulumi.CustomResourceOptions): Account

Get an existing Account resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class ProductSubscription

extends CustomResource

Subscribes to a Security Hub product.

NOTE: This AWS service is in Preview and may change before General Availability release. Backwards compatibility is not guaranteed between Terraform AWS Provider releases.

Example Usage

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

const exampleAccount = new aws.securityhub.Account("example", {});
const current = pulumi.output(aws.getRegion({}));
const exampleProductSubscription = new aws.securityhub.ProductSubscription("example", {
    productArn: pulumi.interpolate`arn:aws:securityhub:${current.name}:733251395267:product/alertlogic/althreatmanagement`,
}, {dependsOn: [exampleAccount]});

constructor

new ProductSubscription(name: string, args: ProductSubscriptionArgs, opts?: pulumi.CustomResourceOptions)

Create a ProductSubscription resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ProductSubscriptionState, opts?: pulumi.CustomResourceOptions): ProductSubscription

Get an existing ProductSubscription resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property arn

public arn: pulumi.Output<string>;

The ARN of a resource that represents your subscription to the product that generates the findings that you want to import into Security Hub.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property productArn

public productArn: pulumi.Output<string>;

The ARN of the product that generates findings that you want to import into Security Hub - see below.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class StandardsSubscription

extends CustomResource

Subscribes to a Security Hub standard.

NOTE: This AWS service is in Preview and may change before General Availability release. Backwards compatibility is not guaranteed between Terraform AWS Provider releases.

Example Usage

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

const exampleAccount = new aws.securityhub.Account("example", {});
const exampleStandardsSubscription = new aws.securityhub.StandardsSubscription("example", {
    standardsArn: "arn:aws:securityhub:::ruleset/cis-aws-foundations-benchmark/v/1.2.0",
}, {dependsOn: [exampleAccount]});

constructor

new StandardsSubscription(name: string, args: StandardsSubscriptionArgs, opts?: pulumi.CustomResourceOptions)

Create a StandardsSubscription resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: StandardsSubscriptionState, opts?: pulumi.CustomResourceOptions): StandardsSubscription

Get an existing StandardsSubscription resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property standardsArn

public standardsArn: pulumi.Output<string>;

The ARN of a standard - see below.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

interface AccountArgs

The set of arguments for constructing a Account resource.

interface AccountState

Input properties used for looking up and filtering Account resources.

interface ProductSubscriptionArgs

The set of arguments for constructing a ProductSubscription resource.

property productArn

productArn: pulumi.Input<string>;

The ARN of the product that generates findings that you want to import into Security Hub - see below.

interface ProductSubscriptionState

Input properties used for looking up and filtering ProductSubscription resources.

property arn

arn?: pulumi.Input<string>;

The ARN of a resource that represents your subscription to the product that generates the findings that you want to import into Security Hub.

property productArn

productArn?: pulumi.Input<string>;

The ARN of the product that generates findings that you want to import into Security Hub - see below.

interface StandardsSubscriptionArgs

The set of arguments for constructing a StandardsSubscription resource.

property standardsArn

standardsArn: pulumi.Input<string>;

The ARN of a standard - see below.

interface StandardsSubscriptionState

Input properties used for looking up and filtering StandardsSubscription resources.

property standardsArn

standardsArn?: pulumi.Input<string>;

The ARN of a standard - see below.