AwsSecurityHub

Service-level Security Hub component for delegated-admin CSPM setup.

Remarks

Naming:

• Type token: ${namespace}:aws:AwsSecurityHub. Capability literal: security-hub. Root: ${env}-${projectHash}-security-hub-<sanitised args.identity>; args.identity is logical-only.
• Every child is parented by AwsSecurityHub. aws.securityhub.Account, OrganizationAdminAccount, and OrganizationConfiguration use args.identity. ActionTarget (args.actionTargets), AutomationRule (args.automationRules), ConfigurationPolicy (args.configurationPolicies), ConfigurationPolicyAssociation (args.configurationPolicyAssociations), FindingAggregator (args.findingAggregators), Insight (args.insights), InviteAccepter (args.inviteAccepters), Member (args.members), ProductSubscription (args.productSubscriptions), StandardsControl (args.standardsControls), StandardsControlAssociation (args.standardsControlAssociations), and StandardsSubscription (args.standardsSubscriptions) use ordered tuple args.identity, then their raw keyed map key. Each child formula is ${env}-${projectHash}-<sanitised tuple>. Each map key is the sole consumer-maintained child identity.
• ActionTarget.args.name and Insight.args.name are semantic/external values forwarded unchanged when set; the provider owns their non-whitespace and maximum-20-character constraints, and they otherwise remain provider-generated. AutomationRule.args.ruleName is semantic/external and forwarded unchanged; the provider owns its required non-whitespace constraint. No other resource has a component-controlled AWS provider name, family, or Name tag.

Example

new AwsSecurityHub({ identity: 'security-hub', findingAggregators: { allRegions: { linkingMode: 'ALL_REGIONS' } } });

Constructors

new AwsSecurityHub( args: AwsSecurityHubArgs, options?: ComponentResourceOptions, ): AwsSecurityHub

Parameters

• args (AwsSecurityHubArgs)
• options (ComponentResourceOptions, optional)

Returns

AwsSecurityHub

Hierarchy

• ComponentResource
• AwsSecurityHub

Properties

account: Account | undefined

actionTargets: Record<string, aws.securityhub.ActionTarget>

automationRules: Record<string, aws.securityhub.AutomationRule>

configurationPolicies: Record<string, aws.securityhub.ConfigurationPolicy>

configurationPolicyAssociations: Record<string, aws.securityhub.ConfigurationPolicyAssociation>

findingAggregators: Record<string, aws.securityhub.FindingAggregator>

insights: Record<string, aws.securityhub.Insight>

inviteAccepters: Record<string, aws.securityhub.InviteAccepter>

members: Record<string, aws.securityhub.Member>

organizationAdminAccount: OrganizationAdminAccount | undefined

organizationConfiguration: OrganizationConfiguration | undefined

productSubscriptions: Record<string, aws.securityhub.ProductSubscription>

standardsControlAssociations: Record<string, aws.securityhub.StandardsControlAssociation>

standardsControls: Record<string, aws.securityhub.StandardsControl>

standardsSubscriptions: Record<string, aws.securityhub.StandardsSubscription>

urn: Output<string>

Inherited from urn

The stable logical URN used to distinctly address a resource, both before and after deployments.

Methods

getData(): Promise<any>

Inherited from getData

Retrieves the data produces by initialize. The data is immediately available in a derived class's constructor after the super(...) call to ComponentResource.

Returns

• Promise<any>

getProvider(moduleMember: string): ProviderResource | undefined

Inherited from getProvider

Returns the provider for the given module member, if one exists.

Parameters

• moduleMember (string)

Returns

• ProviderResource | undefined

initialize( args: Inputs, opts?: ComponentResourceOptions, name?: string, type?: string, ): Promise<any>

Inherited from initialize

Can be overridden by a subclass to asynchronously initialize data for this component automatically when constructed. The data will be available immediately for subclass constructors to use. To access the data use getData.

Parameters

• args (Inputs)
• opts (ComponentResourceOptions, optional)
• name (string, optional)
• type (string, optional)

Returns

• Promise<any>

registerOutputs( outputs?: Inputs | Promise<Inputs> | Output<Inputs>, ): void

Inherited from registerOutputs

Registers synthetic outputs that a component has initialized, usually by allocating other child sub-resources and propagating their resulting property values.

Component resources can call this at the end of their constructor to indicate that they are done creating child resources. This is not strictly necessary as this will automatically be called after the initialize method completes.

Parameters

• outputs (Inputs | Promise<Inputs> | Output<Inputs>, optional)

Returns

• void

Static Methods

isInstance(obj: any): obj is ComponentResource<any>

Inherited from isInstance

Returns true if the given object is a CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

Parameters

• obj (any)

Returns

• obj is ComponentResource<any>