securityhub

package
v3.16.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 26, 2020 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Account 

type Account struct {
	pulumi.CustomResourceState
}

Enables Security Hub for this AWS account.

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

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi-aws/sdk/v3/go/aws/securityhub"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := securityhub.NewAccount(ctx, "example", nil)
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

An existing Security Hub enabled account can be imported using the AWS account ID, e.g.

```sh 

$ pulumi import aws:securityhub/account:Account example 123456789012

```

func GetAccount 

func GetAccount(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *AccountState, opts ...pulumi.ResourceOption) (*Account, error)

GetAccount gets an existing Account resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewAccount 

func NewAccount(ctx *pulumi.Context,
	name string, args *AccountArgs, opts ...pulumi.ResourceOption) (*Account, error)

NewAccount registers a new resource with the given unique name, arguments, and options.

func (Account) ElementType added in v3.13.0 

func (Account) ElementType() reflect.Type

func (Account) ToAccountOutput added in v3.13.0 

func (i Account) ToAccountOutput() AccountOutput

func (Account) ToAccountOutputWithContext added in v3.13.0 

func (i Account) ToAccountOutputWithContext(ctx context.Context) AccountOutput

type AccountArgs 

type AccountArgs struct {
}

The set of arguments for constructing a Account resource.

func (AccountArgs) ElementType 

func (AccountArgs) ElementType() reflect.Type

type AccountInput added in v3.13.0 

type AccountInput interface {
	pulumi.Input

	ToAccountOutput() AccountOutput
	ToAccountOutputWithContext(ctx context.Context) AccountOutput
}

type AccountOutput added in v3.13.0 

type AccountOutput struct {
	*pulumi.OutputState
}

func (AccountOutput) ElementType added in v3.13.0 

func (AccountOutput) ElementType() reflect.Type

func (AccountOutput) ToAccountOutput added in v3.13.0 

func (o AccountOutput) ToAccountOutput() AccountOutput

func (AccountOutput) ToAccountOutputWithContext added in v3.13.0 

func (o AccountOutput) ToAccountOutputWithContext(ctx context.Context) AccountOutput

type AccountState 

type AccountState struct {
}

func (AccountState) ElementType 

func (AccountState) ElementType() reflect.Type

type ActionTarget added in v3.3.0 

type ActionTarget struct {
	pulumi.CustomResourceState

	// Amazon Resource Name (ARN) of the Security Hub custom action target.
	Arn pulumi.StringOutput `pulumi:"arn"`
	// The name of the custom action target.
	Description pulumi.StringOutput `pulumi:"description"`
	// The ID for the custom action target.
	Identifier pulumi.StringOutput `pulumi:"identifier"`
	// The description for the custom action target.
	Name pulumi.StringOutput `pulumi:"name"`
}

Creates Security Hub custom action.

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi-aws/sdk/v3/go/aws/securityhub"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleAccount, err := securityhub.NewAccount(ctx, "exampleAccount", nil)
		if err != nil {
			return err
		}
		_, err = securityhub.NewActionTarget(ctx, "exampleActionTarget", &securityhub.ActionTargetArgs{
			Identifier:  pulumi.String("SendToChat"),
			Description: pulumi.String("This is custom action sends selected findings to chat"),
		}, pulumi.DependsOn([]pulumi.Resource{
			exampleAccount,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

Security Hub custom action can be imported using the action target ARN e.g.

```sh 

$ pulumi import aws:securityhub/actionTarget:ActionTarget example arn:aws:securityhub:eu-west-1:312940875350:action/custom/a

```

func GetActionTarget added in v3.3.0 

func GetActionTarget(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ActionTargetState, opts ...pulumi.ResourceOption) (*ActionTarget, error)

GetActionTarget gets an existing ActionTarget resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewActionTarget added in v3.3.0 

func NewActionTarget(ctx *pulumi.Context,
	name string, args *ActionTargetArgs, opts ...pulumi.ResourceOption) (*ActionTarget, error)

NewActionTarget registers a new resource with the given unique name, arguments, and options.

func (ActionTarget) ElementType added in v3.13.0 

func (ActionTarget) ElementType() reflect.Type

func (ActionTarget) ToActionTargetOutput added in v3.13.0 

func (i ActionTarget) ToActionTargetOutput() ActionTargetOutput

func (ActionTarget) ToActionTargetOutputWithContext added in v3.13.0 

func (i ActionTarget) ToActionTargetOutputWithContext(ctx context.Context) ActionTargetOutput

type ActionTargetArgs added in v3.3.0 

type ActionTargetArgs struct {
	// The name of the custom action target.
	Description pulumi.StringInput
	// The ID for the custom action target.
	Identifier pulumi.StringInput
	// The description for the custom action target.
	Name pulumi.StringPtrInput
}

The set of arguments for constructing a ActionTarget resource.

func (ActionTargetArgs) ElementType added in v3.3.0 

func (ActionTargetArgs) ElementType() reflect.Type

type ActionTargetInput added in v3.13.0 

type ActionTargetInput interface {
	pulumi.Input

	ToActionTargetOutput() ActionTargetOutput
	ToActionTargetOutputWithContext(ctx context.Context) ActionTargetOutput
}

type ActionTargetOutput added in v3.13.0 

type ActionTargetOutput struct {
	*pulumi.OutputState
}

func (ActionTargetOutput) ElementType added in v3.13.0 

func (ActionTargetOutput) ElementType() reflect.Type

func (ActionTargetOutput) ToActionTargetOutput added in v3.13.0 

func (o ActionTargetOutput) ToActionTargetOutput() ActionTargetOutput

func (ActionTargetOutput) ToActionTargetOutputWithContext added in v3.13.0 

func (o ActionTargetOutput) ToActionTargetOutputWithContext(ctx context.Context) ActionTargetOutput

type ActionTargetState added in v3.3.0 

type ActionTargetState struct {
	// Amazon Resource Name (ARN) of the Security Hub custom action target.
	Arn pulumi.StringPtrInput
	// The name of the custom action target.
	Description pulumi.StringPtrInput
	// The ID for the custom action target.
	Identifier pulumi.StringPtrInput
	// The description for the custom action target.
	Name pulumi.StringPtrInput
}

func (ActionTargetState) ElementType added in v3.3.0 

func (ActionTargetState) ElementType() reflect.Type

type Member 

type Member struct {
	pulumi.CustomResourceState

	// The ID of the member AWS account.
	AccountId pulumi.StringOutput `pulumi:"accountId"`
	// The email of the member AWS account.
	Email pulumi.StringOutput `pulumi:"email"`
	// Boolean whether to invite the account to Security Hub as a member. Defaults to `false`.
	Invite pulumi.BoolPtrOutput `pulumi:"invite"`
	// The ID of the master Security Hub AWS account.
	MasterId pulumi.StringOutput `pulumi:"masterId"`
	// The status of the member account relationship.
	MemberStatus pulumi.StringOutput `pulumi:"memberStatus"`
}

Provides a Security Hub member resource.

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi-aws/sdk/v3/go/aws/securityhub"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleAccount, err := securityhub.NewAccount(ctx, "exampleAccount", nil)
		if err != nil {
			return err
		}
		_, err = securityhub.NewMember(ctx, "exampleMember", &securityhub.MemberArgs{
			AccountId: pulumi.String("123456789012"),
			Email:     pulumi.String("example@example.com"),
			Invite:    pulumi.Bool(true),
		}, pulumi.DependsOn([]pulumi.Resource{
			exampleAccount,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

Security Hub members can be imported using their account ID, e.g.

```sh 

$ pulumi import aws:securityhub/member:Member example 123456789012

```

func GetMember 

func GetMember(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *MemberState, opts ...pulumi.ResourceOption) (*Member, error)

GetMember gets an existing Member resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewMember 

func NewMember(ctx *pulumi.Context,
	name string, args *MemberArgs, opts ...pulumi.ResourceOption) (*Member, error)

NewMember registers a new resource with the given unique name, arguments, and options.

func (Member) ElementType added in v3.13.0 

func (Member) ElementType() reflect.Type

func (Member) ToMemberOutput added in v3.13.0 

func (i Member) ToMemberOutput() MemberOutput

func (Member) ToMemberOutputWithContext added in v3.13.0 

func (i Member) ToMemberOutputWithContext(ctx context.Context) MemberOutput

type MemberArgs 

type MemberArgs struct {
	// The ID of the member AWS account.
	AccountId pulumi.StringInput
	// The email of the member AWS account.
	Email pulumi.StringInput
	// Boolean whether to invite the account to Security Hub as a member. Defaults to `false`.
	Invite pulumi.BoolPtrInput
}

The set of arguments for constructing a Member resource.

func (MemberArgs) ElementType 

func (MemberArgs) ElementType() reflect.Type

type MemberInput added in v3.13.0 

type MemberInput interface {
	pulumi.Input

	ToMemberOutput() MemberOutput
	ToMemberOutputWithContext(ctx context.Context) MemberOutput
}

type MemberOutput added in v3.13.0 

type MemberOutput struct {
	*pulumi.OutputState
}

func (MemberOutput) ElementType added in v3.13.0 

func (MemberOutput) ElementType() reflect.Type

func (MemberOutput) ToMemberOutput added in v3.13.0 

func (o MemberOutput) ToMemberOutput() MemberOutput

func (MemberOutput) ToMemberOutputWithContext added in v3.13.0 

func (o MemberOutput) ToMemberOutputWithContext(ctx context.Context) MemberOutput

type MemberState 

type MemberState struct {
	// The ID of the member AWS account.
	AccountId pulumi.StringPtrInput
	// The email of the member AWS account.
	Email pulumi.StringPtrInput
	// Boolean whether to invite the account to Security Hub as a member. Defaults to `false`.
	Invite pulumi.BoolPtrInput
	// The ID of the master Security Hub AWS account.
	MasterId pulumi.StringPtrInput
	// The status of the member account relationship.
	MemberStatus pulumi.StringPtrInput
}

func (MemberState) ElementType 

func (MemberState) ElementType() reflect.Type

type ProductSubscription 

type ProductSubscription struct {
	pulumi.CustomResourceState

	// The ARN of a resource that represents your subscription to the product that generates the findings that you want to import into Security Hub.
	Arn pulumi.StringOutput `pulumi:"arn"`
	// The ARN of the product that generates findings that you want to import into Security Hub - see below.
	ProductArn pulumi.StringOutput `pulumi:"productArn"`
}

Subscribes to a Security Hub product.

## Example Usage

```go package main

import ( 

"fmt"

"github.com/pulumi/pulumi-aws/sdk/v3/go/aws"
"github.com/pulumi/pulumi-aws/sdk/v3/go/aws/securityhub"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleAccount, err := securityhub.NewAccount(ctx, "exampleAccount", nil)
		if err != nil {
			return err
		}
		current, err := aws.GetRegion(ctx, nil, nil)
		if err != nil {
			return err
		}
		_, err = securityhub.NewProductSubscription(ctx, "exampleProductSubscription", &securityhub.ProductSubscriptionArgs{
			ProductArn: pulumi.String(fmt.Sprintf("%v%v%v", "arn:aws:securityhub:", current.Name, ":733251395267:product/alertlogic/althreatmanagement")),
		}, pulumi.DependsOn([]pulumi.Resource{
			exampleAccount,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

Security Hub product subscriptions can be imported in the form `product_arn,arn`, e.g.

```sh 

$ pulumi import aws:securityhub/productSubscription:ProductSubscription example arn:aws:securityhub:eu-west-1:733251395267:product/alertlogic/althreatmanagement,arn:aws:securityhub:eu-west-1:123456789012:product-subscription/alertlogic/althreatmanagement

```

func GetProductSubscription 

func GetProductSubscription(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ProductSubscriptionState, opts ...pulumi.ResourceOption) (*ProductSubscription, error)

GetProductSubscription gets an existing ProductSubscription resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewProductSubscription 

func NewProductSubscription(ctx *pulumi.Context,
	name string, args *ProductSubscriptionArgs, opts ...pulumi.ResourceOption) (*ProductSubscription, error)

NewProductSubscription registers a new resource with the given unique name, arguments, and options.

func (ProductSubscription) ElementType added in v3.13.0 

func (ProductSubscription) ElementType() reflect.Type

func (ProductSubscription) ToProductSubscriptionOutput added in v3.13.0 

func (i ProductSubscription) ToProductSubscriptionOutput() ProductSubscriptionOutput

func (ProductSubscription) ToProductSubscriptionOutputWithContext added in v3.13.0 

func (i ProductSubscription) ToProductSubscriptionOutputWithContext(ctx context.Context) ProductSubscriptionOutput

type ProductSubscriptionArgs 

type ProductSubscriptionArgs struct {
	// The ARN of the product that generates findings that you want to import into Security Hub - see below.
	ProductArn pulumi.StringInput
}

The set of arguments for constructing a ProductSubscription resource.

func (ProductSubscriptionArgs) ElementType 

func (ProductSubscriptionArgs) ElementType() reflect.Type

type ProductSubscriptionInput added in v3.13.0 

type ProductSubscriptionInput interface {
	pulumi.Input

	ToProductSubscriptionOutput() ProductSubscriptionOutput
	ToProductSubscriptionOutputWithContext(ctx context.Context) ProductSubscriptionOutput
}

type ProductSubscriptionOutput added in v3.13.0 

type ProductSubscriptionOutput struct {
	*pulumi.OutputState
}

func (ProductSubscriptionOutput) ElementType added in v3.13.0 

func (ProductSubscriptionOutput) ElementType() reflect.Type

func (ProductSubscriptionOutput) ToProductSubscriptionOutput added in v3.13.0 

func (o ProductSubscriptionOutput) ToProductSubscriptionOutput() ProductSubscriptionOutput

func (ProductSubscriptionOutput) ToProductSubscriptionOutputWithContext added in v3.13.0 

func (o ProductSubscriptionOutput) ToProductSubscriptionOutputWithContext(ctx context.Context) ProductSubscriptionOutput

type ProductSubscriptionState 

type ProductSubscriptionState struct {
	// The ARN of a resource that represents your subscription to the product that generates the findings that you want to import into Security Hub.
	Arn pulumi.StringPtrInput
	// The ARN of the product that generates findings that you want to import into Security Hub - see below.
	ProductArn pulumi.StringPtrInput
}

func (ProductSubscriptionState) ElementType 

func (ProductSubscriptionState) ElementType() reflect.Type

type StandardsSubscription 

type StandardsSubscription struct {
	pulumi.CustomResourceState

	// The ARN of a standard - see below.
	StandardsArn pulumi.StringOutput `pulumi:"standardsArn"`
}

Subscribes to a Security Hub standard.

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi-aws/sdk/v3/go/aws/securityhub"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := securityhub.NewAccount(ctx, "example", nil)
		if err != nil {
			return err
		}
		_, err = securityhub.NewStandardsSubscription(ctx, "cis", &securityhub.StandardsSubscriptionArgs{
			StandardsArn: pulumi.String("arn:aws:securityhub:::ruleset/cis-aws-foundations-benchmark/v/1.2.0"),
		}, pulumi.DependsOn([]pulumi.Resource{
			example,
		}))
		if err != nil {
			return err
		}
		_, err = securityhub.NewStandardsSubscription(ctx, "pci321", &securityhub.StandardsSubscriptionArgs{
			StandardsArn: pulumi.String("arn:aws:securityhub:us-east-1::standards/pci-dss/v/3.2.1"),
		}, pulumi.DependsOn([]pulumi.Resource{
			example,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

Security Hub standards subscriptions can be imported using the standards subscription ARN, e.g.

```sh 

$ pulumi import aws:securityhub/standardsSubscription:StandardsSubscription cis arn:aws:securityhub:eu-west-1:123456789012:subscription/cis-aws-foundations-benchmark/v/1.2.0

```

```sh 

$ pulumi import aws:securityhub/standardsSubscription:StandardsSubscription pci_321 arn:aws:securityhub:eu-west-1:123456789012:subscription/pci-dss/v/3.2.1

```

func GetStandardsSubscription 

func GetStandardsSubscription(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *StandardsSubscriptionState, opts ...pulumi.ResourceOption) (*StandardsSubscription, error)

GetStandardsSubscription gets an existing StandardsSubscription resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewStandardsSubscription 

func NewStandardsSubscription(ctx *pulumi.Context,
	name string, args *StandardsSubscriptionArgs, opts ...pulumi.ResourceOption) (*StandardsSubscription, error)

NewStandardsSubscription registers a new resource with the given unique name, arguments, and options.

func (StandardsSubscription) ElementType added in v3.13.0 

func (StandardsSubscription) ElementType() reflect.Type

func (StandardsSubscription) ToStandardsSubscriptionOutput added in v3.13.0 

func (i StandardsSubscription) ToStandardsSubscriptionOutput() StandardsSubscriptionOutput

func (StandardsSubscription) ToStandardsSubscriptionOutputWithContext added in v3.13.0 

func (i StandardsSubscription) ToStandardsSubscriptionOutputWithContext(ctx context.Context) StandardsSubscriptionOutput

type StandardsSubscriptionArgs 

type StandardsSubscriptionArgs struct {
	// The ARN of a standard - see below.
	StandardsArn pulumi.StringInput
}

The set of arguments for constructing a StandardsSubscription resource.

func (StandardsSubscriptionArgs) ElementType 

func (StandardsSubscriptionArgs) ElementType() reflect.Type

type StandardsSubscriptionInput added in v3.13.0 

type StandardsSubscriptionInput interface {
	pulumi.Input

	ToStandardsSubscriptionOutput() StandardsSubscriptionOutput
	ToStandardsSubscriptionOutputWithContext(ctx context.Context) StandardsSubscriptionOutput
}

type StandardsSubscriptionOutput added in v3.13.0 

type StandardsSubscriptionOutput struct {
	*pulumi.OutputState
}

func (StandardsSubscriptionOutput) ElementType added in v3.13.0 

func (StandardsSubscriptionOutput) ElementType() reflect.Type

func (StandardsSubscriptionOutput) ToStandardsSubscriptionOutput added in v3.13.0 

func (o StandardsSubscriptionOutput) ToStandardsSubscriptionOutput() StandardsSubscriptionOutput

func (StandardsSubscriptionOutput) ToStandardsSubscriptionOutputWithContext added in v3.13.0 

func (o StandardsSubscriptionOutput) ToStandardsSubscriptionOutputWithContext(ctx context.Context) StandardsSubscriptionOutput

type StandardsSubscriptionState 

type StandardsSubscriptionState struct {
	// The ARN of a standard - see below.
	StandardsArn pulumi.StringPtrInput
}

func (StandardsSubscriptionState) ElementType 

func (StandardsSubscriptionState) ElementType() reflect.Type

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.