Class CfnHub
The AWS::SecurityHub::Hub resource specifies the enablement of the Security Hub service in your AWS account .
Inherited Members
Namespace: Amazon.CDK.AWS.SecurityHub
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnHub : CfnResource, IInspectable, IHubRef, IConstruct, IDependable, IEnvironmentAware, ITaggable
Syntax (vb)
Public Class CfnHub Inherits CfnResource Implements IInspectable, IHubRef, IConstruct, IDependable, IEnvironmentAware, ITaggable
Remarks
The service is enabled in the current AWS Region or the specified Region. You create a separate Hub resource in each Region in which you want to enable Security Hub .
When you use this resource to enable Security Hub , default security standards are enabled. To disable default standards, set the EnableDefaultStandards property to false . You can use the AWS::SecurityHub::Standard resource to enable additional standards.
When you use this resource to enable Security Hub , new controls are automatically enabled for your enabled standards. To disable automatic enablement of new controls, set the AutoEnableControls property to false .
You must create an AWS::SecurityHub::Hub resource for an account before you can create other types of Security Hub resources for the account through CloudFormation . Use a DependsOn attribute , such as "DependsOn": "Hub" , to ensure that you've created an AWS::SecurityHub::Hub resource before creating other Security Hub resources for an account.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityhub-hub.html
CloudformationResource: AWS::SecurityHub::Hub
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.SecurityHub;
var tags;
var cfnHub = new CfnHub(this, "MyCfnHub", new CfnHubProps {
AutoEnableControls = false,
ControlFindingGenerator = "controlFindingGenerator",
EnableDefaultStandards = false,
Tags = tags
});
Synopsis
Constructors
| CfnHub(Construct, string, ICfnHubProps?) | Create a new |
Properties
| AttrArn | The Amazon Resource Name (ARN) of the |
| AttrSubscribedAt | The date and time when Security Hub was enabled in your account. |
| AutoEnableControls | Whether to automatically enable new controls when they are added to standards that are enabled. |
| CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
| CfnProperties | The |
| ControlFindingGenerator | Specifies whether an account has consolidated control findings turned on or off. |
| EnableDefaultStandards | Whether to enable the security standards that Security Hub has designated as automatically enabled. |
| HubRef | A reference to a Hub resource. |
| Tags | Tag Manager which manages the tags for this resource. |
| TagsRaw | An array of key-value pairs to apply to this resource. |
Methods
| ArnForHub(IHubRef) | The |
| Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
| IsCfnHub(object) | Checks whether the given object is a CfnHub. |
| RenderProperties(IDictionary<string, object>) | The |
Constructors
CfnHub(Construct, string, ICfnHubProps?)
Create a new AWS::SecurityHub::Hub.
public CfnHub(Construct scope, string id, ICfnHubProps? props = null)
Parameters
- scope Construct
Scope in which this resource is defined.
- id string
Construct identifier for this resource (unique in its scope).
- props ICfnHubProps
Resource properties.
Remarks
The service is enabled in the current AWS Region or the specified Region. You create a separate Hub resource in each Region in which you want to enable Security Hub .
When you use this resource to enable Security Hub , default security standards are enabled. To disable default standards, set the EnableDefaultStandards property to false . You can use the AWS::SecurityHub::Standard resource to enable additional standards.
When you use this resource to enable Security Hub , new controls are automatically enabled for your enabled standards. To disable automatic enablement of new controls, set the AutoEnableControls property to false .
You must create an AWS::SecurityHub::Hub resource for an account before you can create other types of Security Hub resources for the account through CloudFormation . Use a DependsOn attribute , such as "DependsOn": "Hub" , to ensure that you've created an AWS::SecurityHub::Hub resource before creating other Security Hub resources for an account.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityhub-hub.html
CloudformationResource: AWS::SecurityHub::Hub
ExampleMetadata: fixture=_generated
Properties
AttrArn
The Amazon Resource Name (ARN) of the Hub resource that was retrieved.
public virtual string AttrArn { get; }
Property Value
Remarks
CloudformationAttribute: ARN
AttrSubscribedAt
The date and time when Security Hub was enabled in your account.
public virtual string AttrSubscribedAt { get; }
Property Value
Remarks
CloudformationAttribute: SubscribedAt
AutoEnableControls
Whether to automatically enable new controls when they are added to standards that are enabled.
public virtual object? AutoEnableControls { get; set; }
Property Value
Remarks
Type union: either bool or IResolvable
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
Remarks
The service is enabled in the current AWS Region or the specified Region. You create a separate Hub resource in each Region in which you want to enable Security Hub .
When you use this resource to enable Security Hub , default security standards are enabled. To disable default standards, set the EnableDefaultStandards property to false . You can use the AWS::SecurityHub::Standard resource to enable additional standards.
When you use this resource to enable Security Hub , new controls are automatically enabled for your enabled standards. To disable automatic enablement of new controls, set the AutoEnableControls property to false .
You must create an AWS::SecurityHub::Hub resource for an account before you can create other types of Security Hub resources for the account through CloudFormation . Use a DependsOn attribute , such as "DependsOn": "Hub" , to ensure that you've created an AWS::SecurityHub::Hub resource before creating other Security Hub resources for an account.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityhub-hub.html
CloudformationResource: AWS::SecurityHub::Hub
ExampleMetadata: fixture=_generated
CfnProperties
The AWS::SecurityHub::Hub resource specifies the enablement of the Security Hub service in your AWS account .
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
Overrides
Remarks
The service is enabled in the current AWS Region or the specified Region. You create a separate Hub resource in each Region in which you want to enable Security Hub .
When you use this resource to enable Security Hub , default security standards are enabled. To disable default standards, set the EnableDefaultStandards property to false . You can use the AWS::SecurityHub::Standard resource to enable additional standards.
When you use this resource to enable Security Hub , new controls are automatically enabled for your enabled standards. To disable automatic enablement of new controls, set the AutoEnableControls property to false .
You must create an AWS::SecurityHub::Hub resource for an account before you can create other types of Security Hub resources for the account through CloudFormation . Use a DependsOn attribute , such as "DependsOn": "Hub" , to ensure that you've created an AWS::SecurityHub::Hub resource before creating other Security Hub resources for an account.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityhub-hub.html
CloudformationResource: AWS::SecurityHub::Hub
ExampleMetadata: fixture=_generated
ControlFindingGenerator
Specifies whether an account has consolidated control findings turned on or off.
public virtual string? ControlFindingGenerator { get; set; }
Property Value
Remarks
The service is enabled in the current AWS Region or the specified Region. You create a separate Hub resource in each Region in which you want to enable Security Hub .
When you use this resource to enable Security Hub , default security standards are enabled. To disable default standards, set the EnableDefaultStandards property to false . You can use the AWS::SecurityHub::Standard resource to enable additional standards.
When you use this resource to enable Security Hub , new controls are automatically enabled for your enabled standards. To disable automatic enablement of new controls, set the AutoEnableControls property to false .
You must create an AWS::SecurityHub::Hub resource for an account before you can create other types of Security Hub resources for the account through CloudFormation . Use a DependsOn attribute , such as "DependsOn": "Hub" , to ensure that you've created an AWS::SecurityHub::Hub resource before creating other Security Hub resources for an account.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityhub-hub.html
CloudformationResource: AWS::SecurityHub::Hub
ExampleMetadata: fixture=_generated
EnableDefaultStandards
Whether to enable the security standards that Security Hub has designated as automatically enabled.
public virtual object? EnableDefaultStandards { get; set; }
Property Value
Remarks
Type union: either bool or IResolvable
HubRef
A reference to a Hub resource.
public virtual IHubReference HubRef { get; }
Property Value
Remarks
The service is enabled in the current AWS Region or the specified Region. You create a separate Hub resource in each Region in which you want to enable Security Hub .
When you use this resource to enable Security Hub , default security standards are enabled. To disable default standards, set the EnableDefaultStandards property to false . You can use the AWS::SecurityHub::Standard resource to enable additional standards.
When you use this resource to enable Security Hub , new controls are automatically enabled for your enabled standards. To disable automatic enablement of new controls, set the AutoEnableControls property to false .
You must create an AWS::SecurityHub::Hub resource for an account before you can create other types of Security Hub resources for the account through CloudFormation . Use a DependsOn attribute , such as "DependsOn": "Hub" , to ensure that you've created an AWS::SecurityHub::Hub resource before creating other Security Hub resources for an account.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityhub-hub.html
CloudformationResource: AWS::SecurityHub::Hub
ExampleMetadata: fixture=_generated
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
Remarks
The service is enabled in the current AWS Region or the specified Region. You create a separate Hub resource in each Region in which you want to enable Security Hub .
When you use this resource to enable Security Hub , default security standards are enabled. To disable default standards, set the EnableDefaultStandards property to false . You can use the AWS::SecurityHub::Standard resource to enable additional standards.
When you use this resource to enable Security Hub , new controls are automatically enabled for your enabled standards. To disable automatic enablement of new controls, set the AutoEnableControls property to false .
You must create an AWS::SecurityHub::Hub resource for an account before you can create other types of Security Hub resources for the account through CloudFormation . Use a DependsOn attribute , such as "DependsOn": "Hub" , to ensure that you've created an AWS::SecurityHub::Hub resource before creating other Security Hub resources for an account.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityhub-hub.html
CloudformationResource: AWS::SecurityHub::Hub
ExampleMetadata: fixture=_generated
TagsRaw
An array of key-value pairs to apply to this resource.
public virtual object? TagsRaw { get; set; }
Property Value
Remarks
The service is enabled in the current AWS Region or the specified Region. You create a separate Hub resource in each Region in which you want to enable Security Hub .
When you use this resource to enable Security Hub , default security standards are enabled. To disable default standards, set the EnableDefaultStandards property to false . You can use the AWS::SecurityHub::Standard resource to enable additional standards.
When you use this resource to enable Security Hub , new controls are automatically enabled for your enabled standards. To disable automatic enablement of new controls, set the AutoEnableControls property to false .
You must create an AWS::SecurityHub::Hub resource for an account before you can create other types of Security Hub resources for the account through CloudFormation . Use a DependsOn attribute , such as "DependsOn": "Hub" , to ensure that you've created an AWS::SecurityHub::Hub resource before creating other Security Hub resources for an account.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityhub-hub.html
CloudformationResource: AWS::SecurityHub::Hub
ExampleMetadata: fixture=_generated
Methods
ArnForHub(IHubRef)
The AWS::SecurityHub::Hub resource specifies the enablement of the Security Hub service in your AWS account .
public static string ArnForHub(IHubRef resource)
Parameters
- resource IHubRef
Returns
Remarks
The service is enabled in the current AWS Region or the specified Region. You create a separate Hub resource in each Region in which you want to enable Security Hub .
When you use this resource to enable Security Hub , default security standards are enabled. To disable default standards, set the EnableDefaultStandards property to false . You can use the AWS::SecurityHub::Standard resource to enable additional standards.
When you use this resource to enable Security Hub , new controls are automatically enabled for your enabled standards. To disable automatic enablement of new controls, set the AutoEnableControls property to false .
You must create an AWS::SecurityHub::Hub resource for an account before you can create other types of Security Hub resources for the account through CloudFormation . Use a DependsOn attribute , such as "DependsOn": "Hub" , to ensure that you've created an AWS::SecurityHub::Hub resource before creating other Security Hub resources for an account.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityhub-hub.html
CloudformationResource: AWS::SecurityHub::Hub
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.SecurityHub;
var tags;
var cfnHub = new CfnHub(this, "MyCfnHub", new CfnHubProps {
AutoEnableControls = false,
ControlFindingGenerator = "controlFindingGenerator",
EnableDefaultStandards = false,
Tags = tags
});
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
Remarks
The service is enabled in the current AWS Region or the specified Region. You create a separate Hub resource in each Region in which you want to enable Security Hub .
When you use this resource to enable Security Hub , default security standards are enabled. To disable default standards, set the EnableDefaultStandards property to false . You can use the AWS::SecurityHub::Standard resource to enable additional standards.
When you use this resource to enable Security Hub , new controls are automatically enabled for your enabled standards. To disable automatic enablement of new controls, set the AutoEnableControls property to false .
You must create an AWS::SecurityHub::Hub resource for an account before you can create other types of Security Hub resources for the account through CloudFormation . Use a DependsOn attribute , such as "DependsOn": "Hub" , to ensure that you've created an AWS::SecurityHub::Hub resource before creating other Security Hub resources for an account.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityhub-hub.html
CloudformationResource: AWS::SecurityHub::Hub
ExampleMetadata: fixture=_generated
IsCfnHub(object)
Checks whether the given object is a CfnHub.
public static bool IsCfnHub(object x)
Parameters
- x object
Returns
Remarks
The service is enabled in the current AWS Region or the specified Region. You create a separate Hub resource in each Region in which you want to enable Security Hub .
When you use this resource to enable Security Hub , default security standards are enabled. To disable default standards, set the EnableDefaultStandards property to false . You can use the AWS::SecurityHub::Standard resource to enable additional standards.
When you use this resource to enable Security Hub , new controls are automatically enabled for your enabled standards. To disable automatic enablement of new controls, set the AutoEnableControls property to false .
You must create an AWS::SecurityHub::Hub resource for an account before you can create other types of Security Hub resources for the account through CloudFormation . Use a DependsOn attribute , such as "DependsOn": "Hub" , to ensure that you've created an AWS::SecurityHub::Hub resource before creating other Security Hub resources for an account.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityhub-hub.html
CloudformationResource: AWS::SecurityHub::Hub
ExampleMetadata: fixture=_generated
RenderProperties(IDictionary<string, object>)
The AWS::SecurityHub::Hub resource specifies the enablement of the Security Hub service in your AWS account .
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props IDictionary<string, object>
Returns
Overrides
Remarks
The service is enabled in the current AWS Region or the specified Region. You create a separate Hub resource in each Region in which you want to enable Security Hub .
When you use this resource to enable Security Hub , default security standards are enabled. To disable default standards, set the EnableDefaultStandards property to false . You can use the AWS::SecurityHub::Standard resource to enable additional standards.
When you use this resource to enable Security Hub , new controls are automatically enabled for your enabled standards. To disable automatic enablement of new controls, set the AutoEnableControls property to false .
You must create an AWS::SecurityHub::Hub resource for an account before you can create other types of Security Hub resources for the account through CloudFormation . Use a DependsOn attribute , such as "DependsOn": "Hub" , to ensure that you've created an AWS::SecurityHub::Hub resource before creating other Security Hub resources for an account.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityhub-hub.html
CloudformationResource: AWS::SecurityHub::Hub
ExampleMetadata: fixture=_generated