Class CfnHub
- All Implemented Interfaces:
IInspectable,IEnvironmentAware,IHubRef,ITaggable,software.amazon.jsii.JsiiSerializable,software.constructs.IConstruct,software.constructs.IDependable
AWS::SecurityHub::Hub resource specifies the enablement of the Security Hub service in your AWS account .
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.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.securityhub.*;
Object tags;
CfnHub cfnHub = CfnHub.Builder.create(this, "MyCfnHub")
.autoEnableControls(false)
.controlFindingGenerator("controlFindingGenerator")
.enableDefaultStandards(false)
.tags(tags)
.build();
- See Also:
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationModeNested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$DefaultNested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.securityhub.IHubRef
IHubRef.Jsii$Default, IHubRef.Jsii$ProxyNested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$ProxyNested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable
ITaggable.Jsii$Default, ITaggable.Jsii$Proxy -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringThe CloudFormation resource type name for this resource class. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedCfnHub(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protectedCfnHub(software.amazon.jsii.JsiiObjectRef objRef) Create a newAWS::SecurityHub::Hub.CfnHub(software.constructs.Construct scope, String id, CfnHubProps props) Create a newAWS::SecurityHub::Hub. -
Method Summary
Modifier and TypeMethodDescriptionstatic StringThe Amazon Resource Name (ARN) of theHubresource that was retrieved.The date and time when Security Hub was enabled in your account.Whether to automatically enable new controls when they are added to standards that are enabled.Specifies whether an account has consolidated control findings turned on or off.Whether to enable the security standards that Security Hub has designated as automatically enabled.A reference to a Hub resource.getTags()Tag Manager which manages the tags for this resource.An array of key-value pairs to apply to this resource.voidinspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.static BooleanChecks whether the given object is a CfnHub.renderProperties(Map<String, Object> props) voidsetAutoEnableControls(Boolean value) Whether to automatically enable new controls when they are added to standards that are enabled.voidsetAutoEnableControls(IResolvable value) Whether to automatically enable new controls when they are added to standards that are enabled.voidsetControlFindingGenerator(String value) Specifies whether an account has consolidated control findings turned on or off.voidsetEnableDefaultStandards(Boolean value) Whether to enable the security standards that Security Hub has designated as automatically enabled.voidWhether to enable the security standards that Security Hub has designated as automatically enabled.voidsetTagsRaw(Object value) An array of key-value pairs to apply to this resource.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validatePropertiesMethods inherited from class software.amazon.awscdk.CfnRefElement
getRefMethods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalIdMethods inherited from class software.constructs.Construct
getNode, isConstructMethods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSetMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface software.constructs.IConstruct
getNodeMethods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware
getEnvMethods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnHub
protected CfnHub(software.amazon.jsii.JsiiObjectRef objRef) -
CfnHub
protected CfnHub(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnHub
@Stability(Stable) public CfnHub(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnHubProps props) Create a newAWS::SecurityHub::Hub.- Parameters:
scope- Scope in which this resource is defined. This parameter is required.id- Construct identifier for this resource (unique in its scope). This parameter is required.props- Resource properties.
-
CfnHub
Create a newAWS::SecurityHub::Hub.- Parameters:
scope- Scope in which this resource is defined. This parameter is required.id- Construct identifier for this resource (unique in its scope). This parameter is required.
-
-
Method Details
-
arnForHub
- Parameters:
resource- This parameter is required.
-
isCfnHub
Checks whether the given object is a CfnHub.- Parameters:
x- This parameter is required.
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspectin interfaceIInspectable- Parameters:
inspector- tree inspector to collect and process attributes. This parameter is required.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderPropertiesin classCfnResource- Parameters:
props- This parameter is required.
-
getAttrArn
The Amazon Resource Name (ARN) of theHubresource that was retrieved. -
getAttrSubscribedAt
The date and time when Security Hub was enabled in your account. -
getCfnProperties
- Overrides:
getCfnPropertiesin classCfnResource
-
getHubRef
A reference to a Hub resource. -
getTags
Tag Manager which manages the tags for this resource. -
getAutoEnableControls
Whether to automatically enable new controls when they are added to standards that are enabled.Returns union: either
BooleanorIResolvable -
setAutoEnableControls
Whether to automatically enable new controls when they are added to standards that are enabled. -
setAutoEnableControls
Whether to automatically enable new controls when they are added to standards that are enabled. -
getControlFindingGenerator
Specifies whether an account has consolidated control findings turned on or off. -
setControlFindingGenerator
Specifies whether an account has consolidated control findings turned on or off. -
getEnableDefaultStandards
Whether to enable the security standards that Security Hub has designated as automatically enabled.Returns union: either
BooleanorIResolvable -
setEnableDefaultStandards
Whether to enable the security standards that Security Hub has designated as automatically enabled. -
setEnableDefaultStandards
Whether to enable the security standards that Security Hub has designated as automatically enabled. -
getTagsRaw
An array of key-value pairs to apply to this resource. -
setTagsRaw
An array of key-value pairs to apply to this resource.
-