libZSservicesZSamazonka-securityhubZSamazonka-securityhub
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.SecurityHub.EnableSecurityHub

Description

Enables Security Hub for your account in the current Region or the Region you specify in the request.

When you enable Security Hub, you grant to Security Hub the permissions necessary to gather findings from other services that are integrated with Security Hub.

When you use the EnableSecurityHub operation to enable Security Hub, you also automatically enable the following standards.

  • CIS Amazon Web Services Foundations
  • Amazon Web Services Foundational Security Best Practices

You do not enable the Payment Card Industry Data Security Standard (PCI DSS) standard.

To not enable the automatically enabled standards, set EnableDefaultStandards to false.

After you enable Security Hub, to enable a standard, use the BatchEnableStandards operation. To disable a standard, use the BatchDisableStandards operation.

To learn more, see the setup information in the Security Hub User Guide.

Synopsis

Creating a Request

data EnableSecurityHub Source #

See: newEnableSecurityHub smart constructor.

Constructors

EnableSecurityHub' 

Fields

  • enableDefaultStandards :: Maybe Bool

    Whether to enable the security standards that Security Hub has designated as automatically enabled. If you do not provide a value for EnableDefaultStandards, it is set to true. To not enable the automatically enabled standards, set EnableDefaultStandards to false.

  • tags :: Maybe (HashMap Text Text)

    The tags to add to the hub resource when you enable Security Hub.

Instances

Instances details
Eq EnableSecurityHub Source # 
Instance details

Defined in Amazonka.SecurityHub.EnableSecurityHub

Read EnableSecurityHub Source # 
Instance details

Defined in Amazonka.SecurityHub.EnableSecurityHub

Show EnableSecurityHub Source # 
Instance details

Defined in Amazonka.SecurityHub.EnableSecurityHub

Generic EnableSecurityHub Source # 
Instance details

Defined in Amazonka.SecurityHub.EnableSecurityHub

Associated Types

type Rep EnableSecurityHub :: Type -> Type #

NFData EnableSecurityHub Source # 
Instance details

Defined in Amazonka.SecurityHub.EnableSecurityHub

Methods

rnf :: EnableSecurityHub -> () #

Hashable EnableSecurityHub Source # 
Instance details

Defined in Amazonka.SecurityHub.EnableSecurityHub

ToJSON EnableSecurityHub Source # 
Instance details

Defined in Amazonka.SecurityHub.EnableSecurityHub

AWSRequest EnableSecurityHub Source # 
Instance details

Defined in Amazonka.SecurityHub.EnableSecurityHub

Associated Types

type AWSResponse EnableSecurityHub #

ToHeaders EnableSecurityHub Source # 
Instance details

Defined in Amazonka.SecurityHub.EnableSecurityHub

ToPath EnableSecurityHub Source # 
Instance details

Defined in Amazonka.SecurityHub.EnableSecurityHub

ToQuery EnableSecurityHub Source # 
Instance details

Defined in Amazonka.SecurityHub.EnableSecurityHub

type Rep EnableSecurityHub Source # 
Instance details

Defined in Amazonka.SecurityHub.EnableSecurityHub

type Rep EnableSecurityHub = D1 ('MetaData "EnableSecurityHub" "Amazonka.SecurityHub.EnableSecurityHub" "libZSservicesZSamazonka-securityhubZSamazonka-securityhub" 'False) (C1 ('MetaCons "EnableSecurityHub'" 'PrefixI 'True) (S1 ('MetaSel ('Just "enableDefaultStandards") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))))
type AWSResponse EnableSecurityHub Source # 
Instance details

Defined in Amazonka.SecurityHub.EnableSecurityHub

newEnableSecurityHub :: EnableSecurityHub Source #

Create a value of EnableSecurityHub with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:enableDefaultStandards:EnableSecurityHub', enableSecurityHub_enableDefaultStandards - Whether to enable the security standards that Security Hub has designated as automatically enabled. If you do not provide a value for EnableDefaultStandards, it is set to true. To not enable the automatically enabled standards, set EnableDefaultStandards to false.

$sel:tags:EnableSecurityHub', enableSecurityHub_tags - The tags to add to the hub resource when you enable Security Hub.

Request Lenses

enableSecurityHub_enableDefaultStandards :: Lens' EnableSecurityHub (Maybe Bool) Source #

Whether to enable the security standards that Security Hub has designated as automatically enabled. If you do not provide a value for EnableDefaultStandards, it is set to true. To not enable the automatically enabled standards, set EnableDefaultStandards to false.

enableSecurityHub_tags :: Lens' EnableSecurityHub (Maybe (HashMap Text Text)) Source #

The tags to add to the hub resource when you enable Security Hub.

Destructuring the Response

data EnableSecurityHubResponse Source #

See: newEnableSecurityHubResponse smart constructor.

Constructors

EnableSecurityHubResponse' 

Fields

Instances

Instances details
Eq EnableSecurityHubResponse Source # 
Instance details

Defined in Amazonka.SecurityHub.EnableSecurityHub

Read EnableSecurityHubResponse Source # 
Instance details

Defined in Amazonka.SecurityHub.EnableSecurityHub

Show EnableSecurityHubResponse Source # 
Instance details

Defined in Amazonka.SecurityHub.EnableSecurityHub

Generic EnableSecurityHubResponse Source # 
Instance details

Defined in Amazonka.SecurityHub.EnableSecurityHub

Associated Types

type Rep EnableSecurityHubResponse :: Type -> Type #

NFData EnableSecurityHubResponse Source # 
Instance details

Defined in Amazonka.SecurityHub.EnableSecurityHub

type Rep EnableSecurityHubResponse Source # 
Instance details

Defined in Amazonka.SecurityHub.EnableSecurityHub

type Rep EnableSecurityHubResponse = D1 ('MetaData "EnableSecurityHubResponse" "Amazonka.SecurityHub.EnableSecurityHub" "libZSservicesZSamazonka-securityhubZSamazonka-securityhub" 'False) (C1 ('MetaCons "EnableSecurityHubResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newEnableSecurityHubResponse Source #

Create a value of EnableSecurityHubResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:EnableSecurityHubResponse', enableSecurityHubResponse_httpStatus - The response's http status code.

Response Lenses