Class CfnOrganizationConfiguration
java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.securityhub.CfnOrganizationConfiguration
- All Implemented Interfaces:
IInspectable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
date="2024-10-05T03:43:51.335Z")
@Stability(Stable)
public class CfnOrganizationConfiguration
extends CfnResource
implements IInspectable
The
AWS::SecurityHub::OrganizationConfiguration
resource specifies the way that your AWS organization is configured in AWS Security Hub .
Specifically, you can use this resource to specify the configuration type for your organization and whether to automatically Security Hub and security standards in new member accounts. For more information, see Managing administrator and member accounts in the AWS Security Hub User Guide .
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.*; CfnOrganizationConfiguration cfnOrganizationConfiguration = CfnOrganizationConfiguration.Builder.create(this, "MyCfnOrganizationConfiguration") .autoEnable(false) // the properties below are optional .autoEnableStandards("autoEnableStandards") .configurationType("configurationType") .build();
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
A fluent builder forCfnOrganizationConfiguration
.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnOrganizationConfiguration
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnOrganizationConfiguration
(software.amazon.jsii.JsiiObjectRef objRef) CfnOrganizationConfiguration
(software.constructs.Construct scope, String id, CfnOrganizationConfigurationProps props) -
Method Summary
Modifier and TypeMethodDescriptionWhether the maximum number of allowed member accounts are already associated with the Security Hub administrator account.The organization configuration identifier, formatted asAccountId/Region/securityhub-organization-configuration
.Describes whether central configuration could be enabled as theConfigurationType
for the organization.Provides an explanation if the value ofStatus
is equal toFAILED
whenConfigurationType
is equal toCENTRAL
.Whether to automatically enable Security Hub in new member accounts when they join the organization.Whether to automatically enable Security Hub default standards in new member accounts when they join the organization.Indicates whether the organization uses local or central configuration.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setAutoEnable
(Boolean value) Whether to automatically enable Security Hub in new member accounts when they join the organization.void
setAutoEnable
(IResolvable value) Whether to automatically enable Security Hub in new member accounts when they join the organization.void
setAutoEnableStandards
(String value) Whether to automatically enable Security Hub default standards in new member accounts when they join the organization.void
setConfigurationType
(String value) Indicates whether the organization uses local or central configuration.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.constructs.Construct
getNode, isConstruct
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods 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
-
CfnOrganizationConfiguration
protected CfnOrganizationConfiguration(software.amazon.jsii.JsiiObjectRef objRef) -
CfnOrganizationConfiguration
protected CfnOrganizationConfiguration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnOrganizationConfiguration
@Stability(Stable) public CfnOrganizationConfiguration(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnOrganizationConfigurationProps props) - 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. This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in 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:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrMemberAccountLimitReached
Whether the maximum number of allowed member accounts are already associated with the Security Hub administrator account. -
getAttrOrganizationConfigurationIdentifier
The organization configuration identifier, formatted asAccountId/Region/securityhub-organization-configuration
.For example,
123456789012/us-east-1/securityhub-organization-configuration
. -
getAttrStatus
Describes whether central configuration could be enabled as theConfigurationType
for the organization.If your
ConfigurationType
is local configuration, then the value ofStatus
is alwaysENABLED
. -
getAttrStatusMessage
Provides an explanation if the value ofStatus
is equal toFAILED
whenConfigurationType
is equal toCENTRAL
. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getAutoEnable
Whether to automatically enable Security Hub in new member accounts when they join the organization. -
setAutoEnable
Whether to automatically enable Security Hub in new member accounts when they join the organization. -
setAutoEnable
Whether to automatically enable Security Hub in new member accounts when they join the organization. -
getAutoEnableStandards
Whether to automatically enable Security Hub default standards in new member accounts when they join the organization. -
setAutoEnableStandards
Whether to automatically enable Security Hub default standards in new member accounts when they join the organization. -
getConfigurationType
Indicates whether the organization uses local or central configuration. -
setConfigurationType
Indicates whether the organization uses local or central configuration.
-