This page documents the language specification for the aws package. If you're looking for help working with the inputs, outputs, or functions of aws resources in a Pulumi program, please see the resource documentation for examples and API reference.

securityhub

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-aws repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-aws repo.

class pulumi_aws.securityhub.Account(resource_name, opts=None, __props__=None, __name__=None, __opts__=None)

Enables Security Hub for this AWS account.

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

import pulumi
import pulumi_aws as aws

example = aws.securityhub.Account("example")
Parameters
static get(resource_name, id, opts=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_aws.securityhub.Member(resource_name, opts=None, account_id=None, email=None, invite=None, __props__=None, __name__=None, __opts__=None)

Provides a Security Hub member resource.

import pulumi
import pulumi_aws as aws

example_account = aws.securityhub.Account("exampleAccount")
example_member = aws.securityhub.Member("exampleMember",
    account_id="123456789012",
    email="example@example.com",
    invite=True)
Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • account_id (pulumi.Input[str]) – The ID of the member AWS account.

  • email (pulumi.Input[str]) – The email of the member AWS account.

  • invite (pulumi.Input[bool]) – Boolean whether to invite the account to Security Hub as a member. Defaults to false.

account_id: pulumi.Output[str] = None

The ID of the member AWS account.

email: pulumi.Output[str] = None

The email of the member AWS account.

invite: pulumi.Output[bool] = None

Boolean whether to invite the account to Security Hub as a member. Defaults to false.

master_id: pulumi.Output[str] = None

The ID of the master Security Hub AWS account.

member_status: pulumi.Output[str] = None

The status of the relationship between the member account and its master account.

static get(resource_name, id, opts=None, account_id=None, email=None, invite=None, master_id=None, member_status=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • account_id (pulumi.Input[str]) – The ID of the member AWS account.

  • email (pulumi.Input[str]) – The email of the member AWS account.

  • invite (pulumi.Input[bool]) – Boolean whether to invite the account to Security Hub as a member. Defaults to false.

  • master_id (pulumi.Input[str]) – The ID of the master Security Hub AWS account.

  • member_status (pulumi.Input[str]) – The status of the relationship between the member account and its master account.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_aws.securityhub.ProductSubscription(resource_name, opts=None, product_arn=None, __props__=None, __name__=None, __opts__=None)

Subscribes to a Security Hub product.

import pulumi
import pulumi_aws as aws

example_account = aws.securityhub.Account("exampleAccount")
current = aws.get_region()
example_product_subscription = aws.securityhub.ProductSubscription("exampleProductSubscription", product_arn=f"arn:aws:securityhub:{current.name}:733251395267:product/alertlogic/althreatmanagement")
Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • product_arn (pulumi.Input[str]) – The ARN of the product that generates findings that you want to import into Security Hub - see below.

arn: pulumi.Output[str] = None

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

product_arn: pulumi.Output[str] = None

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

static get(resource_name, id, opts=None, arn=None, product_arn=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • arn (pulumi.Input[str]) – The ARN of a resource that represents your subscription to the product that generates the findings that you want to import into Security Hub.

  • product_arn (pulumi.Input[str]) – The ARN of the product that generates findings that you want to import into Security Hub - see below.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_aws.securityhub.StandardsSubscription(resource_name, opts=None, standards_arn=None, __props__=None, __name__=None, __opts__=None)

Subscribes to a Security Hub standard.

import pulumi
import pulumi_aws as aws

example = aws.securityhub.Account("example")
cis = aws.securityhub.StandardsSubscription("cis", standards_arn="arn:aws:securityhub:::ruleset/cis-aws-foundations-benchmark/v/1.2.0")
pci321 = aws.securityhub.StandardsSubscription("pci321", standards_arn="arn:aws:securityhub:us-east-1::standards/pci-dss/v/3.2.1")
Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • standards_arn (pulumi.Input[str]) – The ARN of a standard - see below.

standards_arn: pulumi.Output[str] = None

The ARN of a standard - see below.

static get(resource_name, id, opts=None, standards_arn=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • standards_arn (pulumi.Input[str]) – The ARN of a standard - see below.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str