AwsFms

Service-level AWS Firewall Manager component.

Remarks

Exactly one capability topic must be configured per component instance: resourceSets or policies.

Naming:

• Root type ${namespace}:aws:AwsFms has capability fms and LOGICAL-ONLY identity args.identity; target ${env}-${projectHash}-fms-${sanitiseNamePart(args.identity)}.
• aws:fms/resourceSet:ResourceSet children have parent type ${namespace}:aws:AwsFms and tuple [args.identity, args.resourceSets map key]; target ${env}-${projectHash}-${sanitiseNamePart(args.identity)}-${sanitiseNamePart(key)}.
• aws:fms/policy:Policy children have parent type ${namespace}:aws:AwsFms and tuple [args.identity, args.policies map key]; target ${env}-${projectHash}-${sanitiseNamePart(args.identity)}-${sanitiseNamePart(key)}.
• Resource-set resourceSets[0].name and policy name each use their entry's args.<capability>[key].name with stackAndPurpose, ${env}-${projectHash}-${purpose}, and a component-owned 115-character purpose limit for the FMS 128-character provider limit.

Example

import { AwsFms } from '@jobcloud/aws-fms';

const fms = new AwsFms({
  identity: 'example',
  resourceSets: {
    workloadResources: {
      name: 'workloadResources',
      resourceTypeListsTemplate: {
        path: 'templates/fms-resource-types/workload.json',
      },
    },
  },
});

export const resourceSetId = fms.resourceSetIds.workloadResources;

Constructors

new AwsFms( args: AwsFmsArgs, options?: ComponentResourceOptions, ): AwsFms

Parameters

• args (AwsFmsArgs) — Service-level Firewall Manager capability inputs.
• options (ComponentResourceOptions, optional) — Optional resource settings controlling provider and parenting behaviour.

Returns

AwsFms

Hierarchy

• ComponentResource
• AwsFms

Properties

policies: Record<string, aws.fms.Policy>

Policies created by this component instance.

policyArns: Record<string, pulumi.Output<string>>

Policy ARNs keyed by capability key.

policyIds: Record<string, pulumi.Output<string>>

Policy IDs keyed by capability key.

resourceSetArns: Record<string, pulumi.Output<string>>

Resource-set ARNs keyed by capability key.

resourceSetIds: Record<string, pulumi.Output<string>>

Resource-set IDs keyed by capability key.

resourceSets: Record<string, aws.fms.ResourceSet>

Resource sets created by this component instance.

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>