Skip to content

Latest commit

 

History

History
123 lines (68 loc) · 5.35 KB

API.md

File metadata and controls

123 lines (68 loc) · 5.35 KB

API Reference

Classes

Name Description
ImageRepository No description

Structs

Name Description
ImageRepositoryProps No description
OnFindingOptions No description

Enums

Name Description
Severity No description

class ImageRepository

Implements: IConstruct, IConstruct, IConstruct, IDependable, IResource, IConstruct, IDependable, IConstruct, IRepository, IConstruct, IDependable, IConstruct, IResource Extends: Repository

Initializer

new ImageRepository(scope: Construct, id: string, props?: ImageRepositoryProps)
  • scope (Construct) No description
  • id (string) No description
  • props (ImageRepositoryProps) No description
    • imageScanOnPush (boolean) Enable the scan on push when creating the repository. Default: false
    • imageTagMutability (TagMutability) The tag mutability setting for the repository. Default: TagMutability.MUTABLE
    • lifecycleRegistryId (string) The AWS account ID associated with the registry that contains the repository. Default: The default registry is assumed.
    • lifecycleRules (Array<LifecycleRule>) Life cycle rules to apply to this registry. Default: No life cycle rules
    • removalPolicy (RemovalPolicy) Determine what happens to the repository when the resource/stack is deleted. Default: RemovalPolicy.Retain
    • repositoryName (string) Name for this repository. Default: Automatically generated name.
    • forceDelete (boolean) If a repository contains images, forces the deletion during stack deletion. Default: false

Methods

onFinding(id, options) 

onFinding(id: string, options: OnFindingOptions): Rule
  • id (string) No description
  • options (OnFindingOptions) No description
    • alarmTopic (ITopic) No description
    • severity (Severity) No description
    • imageTags (Array) Only watch changes to the image tags specified. Default: Watch the changes to the repository with all image tags

Returns:

struct ImageRepositoryProps

Name Type Description
forceDelete? boolean If a repository contains images, forces the deletion during stack deletion.
Default: false
imageScanOnPush? boolean Enable the scan on push when creating the repository.
Default: false
imageTagMutability? TagMutability The tag mutability setting for the repository.
Default: TagMutability.MUTABLE
lifecycleRegistryId? string The AWS account ID associated with the registry that contains the repository.
Default: The default registry is assumed.
lifecycleRules? Array<LifecycleRule> Life cycle rules to apply to this registry.
Default: No life cycle rules
removalPolicy? RemovalPolicy Determine what happens to the repository when the resource/stack is deleted.
Default: RemovalPolicy.Retain
repositoryName? string Name for this repository.
Default: Automatically generated name.

struct OnFindingOptions

Name Type Description
alarmTopic ITopic
severity Severity
imageTags? Array Only watch changes to the image tags specified.
Default: Watch the changes to the repository with all image tags

enum Severity

Name Description
CRITICAL
HIGH
MEDIUM
LOW
INFORMATIONAL
UNDEFINED