Package software.amazon.awscdk.services.securityhub

Class CfnDelegatedAdmin

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.CfnDelegatedAdmin

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-10T18:25:31.014Z")
@Stability(Stable)
public class CfnDelegatedAdmin
extends CfnResource
implements IInspectable

The AWS::SecurityHub::DelegatedAdmin resource designates the delegated AWS Security Hub administrator account for an organization.

You must enable the integration between Security Hub and AWS Organizations before you can designate a delegated Security Hub administrator. Only the management account for an organization can designate the delegated Security Hub administrator account. For more information, see Designating the delegated Security Hub administrator in the AWS Security Hub User Guide .

To change the delegated administrator account, remove the current delegated administrator account, and then designate the new account.

To designate multiple delegated administrators in different organizations and AWS Regions , we recommend using AWS CloudFormation mappings .

Tags aren't supported for this resource.

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.*;
 CfnDelegatedAdmin cfnDelegatedAdmin = CfnDelegatedAdmin.Builder.create(this, "MyCfnDelegatedAdmin")
         .adminAccountId("adminAccountId")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityhub-delegatedadmin.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnDelegatedAdmin.Builder	A fluent builder for CfnDelegatedAdmin.

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

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnDelegatedAdmin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDelegatedAdmin(software.amazon.jsii.JsiiObjectRef objRef)
	CfnDelegatedAdmin(software.constructs.Construct scope, String id, CfnDelegatedAdminProps props)

Method Summary

Modifier and Type	Method	Description
String	getAdminAccountId()	The AWS account identifier of the account to designate as the Security Hub administrator account.
String	getAttrDelegatedAdminIdentifier()	The ID of the delegated Security Hub administrator account, in the format of accountID/Region .
String	getAttrStatus()	Whether the delegated Security Hub administrator is set for the organization.
protected Map<String,Object>	getCfnProperties()
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAdminAccountId(String value)	The AWS account identifier of the account to designate as the Security Hub administrator account.

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

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnDelegatedAdmin

protected CfnDelegatedAdmin(software.amazon.jsii.JsiiObjectRef objRef)

CfnDelegatedAdmin

protected CfnDelegatedAdmin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnDelegatedAdmin

@Stability(Stable)
public CfnDelegatedAdmin(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnDelegatedAdminProps 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

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

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 class CfnResource

Parameters:

props - This parameter is required.

getAttrDelegatedAdminIdentifier

@Stability(Stable)
@NotNull
public String getAttrDelegatedAdminIdentifier()

The ID of the delegated Security Hub administrator account, in the format of accountID/Region .

getAttrStatus

@Stability(Stable)
@NotNull
public String getAttrStatus()

Whether the delegated Security Hub administrator is set for the organization.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getAdminAccountId

@Stability(Stable)
@NotNull
public String getAdminAccountId()

The AWS account identifier of the account to designate as the Security Hub administrator account.

setAdminAccountId

@Stability(Stable)
public void setAdminAccountId(@NotNull
 String value)

The AWS account identifier of the account to designate as the Security Hub administrator account.