AwsCloudtrail

Service-level AWS CloudTrail component.

Remarks

This is the primary component resource for the package. It orchestrates one capability per instance: trail or event data store.

Naming:

• Root: type ${namespace}:aws:AwsCloudtrail; capability cloudtrail; identity is the raw selected args.trail.name or args.eventDataStore.name; target ${env}-${projectHash}-cloudtrail-${sanitiseNamePart(identity)}. The identity must contain at least one alphanumeric character.
• aws:cloudtrail/trail:Trail has parent AwsCloudtrail, tuple [args.trail.name], and target ${env}-${projectHash}-${sanitiseNamePart(args.trail.name)}.
• aws:cloudtrail/eventDataStore:EventDataStore has parent AwsCloudtrail, tuple [args.eventDataStore.name], and target ${env}-${projectHash}-${sanitiseNamePart(args.eventDataStore.name)}.
• AWS provider names: Trail name (source args.trail.name) and EventDataStore name (source args.eventDataStore.name) use stackAndPurpose ${env}-${projectHash}-${purpose} through buildAwsNameFromCamelCasePurpose(...).

Example

const cloudtrail = new AwsCloudtrail({
  trail: {
    name: 'securityAuditTrail',
    s3BucketName: 'tst-abc12345-audit',
  },
});

Constructors

new AwsCloudtrail( args: AwsCloudtrailArgs, options?: ComponentResourceOptions, ): AwsCloudtrail

Parameters

• args (AwsCloudtrailArgs) — Service-level CloudTrail capability inputs. Use new AwsCloudtrail(args, options).The component logical name is derived from the selected capability identity field:
• options (ComponentResourceOptions, optional) — Optional settings controlling resource behaviour.

Returns

AwsCloudtrail

Hierarchy

• ComponentResource
• AwsCloudtrail

Properties

eventDataStore: EventDataStore

Optional CloudTrail event data store resource created by this component.

trail: Trail

Optional CloudTrail trail resource created by this component.

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>