Skip to content

Latest commit

 

History

History
258 lines (122 loc) · 8.25 KB

API.md

File metadata and controls

258 lines (122 loc) · 8.25 KB
Raw

API Reference

Classes

Name Description
ClamavLayer Clamav Lambda layer.
DefinitionBucket No description
DefinitionInitializer No description
Sandbox No description
Scanner No description

Structs

Name Description
DefinitionBucketProps No description
DefinitionInitializerProps No description
SandboxProps No description
ScannerProps No description

class ClamavLayer

Clamav Lambda layer.

Implements: IConstruct, IConstruct, IConstruct, IDependable, IResource, IConstruct, IDependable, IConstruct, ILayerVersion, IConstruct, IDependable, IConstruct, IResource Extends: LayerVersion

Initializer

new ClamavLayer(scope: Construct, id: string)
  • scope (Construct) No description
  • id (string) No description

class DefinitionBucket

Implements: IConstruct, IConstruct, IConstruct, IDependable, IResource, IConstruct, IDependable, IConstruct, IBucket, IConstruct, IDependable, IConstruct, IResource Extends: Bucket

Initializer

new DefinitionBucket(scope: Construct, id: string, props: DefinitionBucketProps)
  • scope (Construct) No description
  • id (string) No description
  • props (DefinitionBucketProps) No description
    • vpcEndpoint (string) No description
    • bucketName (string) No description Optional

class DefinitionInitializer

Implements: IConstruct, IConstruct, IConstruct, IDependable Extends: Construct

Initializer

new DefinitionInitializer(scope: Construct, id: string, props: DefinitionInitializerProps)

class Sandbox

Implements: IConstruct, IConstruct, IConstruct, IDependable Extends: Construct

Initializer

new Sandbox(scope: Construct, id: string, props?: SandboxProps)
  • scope (Construct) No description
  • id (string) No description
  • props (SandboxProps) No description
    • encryptedFileSystem (boolean) No description Optional

Properties

Name Type Description
definitionBucket DefinitionBucket
lambdaAccessPoint IAccessPoint
s3Endpoint GatewayVpcEndpoint
vpc IVpc

Methods

addToS3EnpointPolicy(statement) 

addToS3EnpointPolicy(statement: PolicyStatement): void

class Scanner

Implements: IConstruct, IConstruct, IConstruct, IDependable Extends: Construct

Initializer

new Scanner(scope: Construct, id: string, props?: ScannerProps)
  • scope (Construct) No description
  • id (string) No description
  • props (ScannerProps) No description
    • buckets (Array<Bucket>) No description Optional
    • onError (IDestination) No description Optional
    • onResult (IDestination) No description Optional
    • scanStatusTagName (string) No description Default: cc:scan-status
    • updateSchedule (Schedule) No description Optional

Properties

Name Type Description
sandbox Sandbox
scanFunction IFunction
scanStatusTagName string
updateFunction IFunction

Methods

addSourceBucket(bucket) 

addSourceBucket(bucket: Bucket): void
  • bucket (Bucket) No description

struct DefinitionBucketProps

Name Type Description
vpcEndpoint string
bucketName? string Optional

struct DefinitionInitializerProps

Name Type Description
fn IFunction

struct SandboxProps

Name Type Description
encryptedFileSystem? boolean Optional

struct ScannerProps

Name Type Description
buckets? Array<Bucket> Optional
onError? IDestination Optional
onResult? IDestination Optional
scanStatusTagName? string Default: cc:scan-status
updateSchedule? Schedule Optional