S3StaticWebsiteService

Hierarchy

• Service
  • S3StaticWebsiteService

Index

Constructors

• constructor

Properties

• NODE_NAME
• NODE_TYPE
• awsRegionId
• bucketName
• excludePaths
• serviceId
• sourcePaths

Methods

• addAnchor
• addChild
• addRelationship
• addSource
• diff
• diffProperties
• getAncestors
• getAnchor
• getAnchorIndex
• getAnchors
• getBoundaryMembers
• getChild
• getChildren
• getContext
• getDependencies
• getDependency
• getDependencyIndex
• getParents
• getSiblings
• hasAncestor
• removeAllAnchors
• removeAnchor
• removeDependency
• removeRelationship
• saveSourceManifest
• setContext
• synth
• unSynth

Constructors

constructor

• new S3StaticWebsiteService(regionId: RegionId, bucketName: string): S3StaticWebsiteService

• Overrides Service.constructor

  Parameters

  • regionId: RegionId

  • bucketName: string

  Returns S3StaticWebsiteService

Properties

readonlyNODE_NAME

NODE_NAME: string

Inherited from Service.NODE_NAME

readonlyNODE_TYPE

NODE_TYPE: NodeType

Inherited from Service.NODE_TYPE

readonlyawsRegionId

awsRegionId: string

readonlybucketName

bucketName: string

readonlyexcludePaths

excludePaths: { directoryPath: string; subDirectoryOrFilePath: string }[] = []

readonlyserviceId

serviceId: string

Inherited from Service.serviceId

The ID of the service.

readonlysourcePaths

sourcePaths: { directoryPath: string; isDirectory: boolean; remotePath: string; subDirectoryOrFilePath: string }[] = []

Methods

addAnchor

• addAnchor(anchor: AAnchor): void

• Inherited from Service.addAnchor

  Parameters

  • anchor: AAnchor

  Returns void

addChild

• addChild(onField: string, child: UnknownNode, toField: string): { childToParentDependency: Dependency; parentToChildDependency: Dependency }

• Inherited from Service.addChild

  Parameters

  • onField: string

  • child: UnknownNode

  • toField: string

  Returns { childToParentDependency: Dependency; parentToChildDependency: Dependency }

  • childToParentDependency: Dependency

  • parentToChildDependency: Dependency

addRelationship

• addRelationship(to: UnknownNode): { thatToThisDependency: Dependency; thisToThatDependency: Dependency }

• Inherited from Service.addRelationship

  Parameters

  • to: UnknownNode

  Returns { thatToThisDependency: Dependency; thisToThatDependency: Dependency }

  • thatToThisDependency: Dependency

  • thisToThatDependency: Dependency

addSource

• addSource(directoryPath: string, subDirectoryOrFilePath?: string, filter?: (filePath: string) => boolean, transform?: (filePath: string) => string): Promise<void>

• Parameters

  • directoryPath: string

  • optionalsubDirectoryOrFilePath: string

  • optionalfilter: (filePath: string) => boolean

  • optionaltransform: (filePath: string) => string

  Returns Promise<void>

diff

• diff(): Promise<Diff[]>

• Inherited from Service.diff

  Returns Promise<Diff[]>

diffProperties

• diffProperties(): Promise<Diff[]>

• Overrides Service.diffProperties

  Returns Promise<Diff[]>

getAncestors

• getAncestors(): UnknownNode[]

• Inherited from Service.getAncestors

  Returns UnknownNode[]

getAnchor

• getAnchor(anchorId: string, parent?: UnknownModel): undefined | AAnchor

• Inherited from Service.getAnchor

  Parameters

  • anchorId: string

  • optionalparent: UnknownModel

  Returns undefined | AAnchor

getAnchorIndex

• getAnchorIndex(anchorId: string, parent?: UnknownModel): number

• Inherited from Service.getAnchorIndex

  Parameters

  • anchorId: string

  • optionalparent: UnknownModel

  Returns number

getAnchors

• getAnchors(filters?: { key: string; value: any }[]): AAnchor[]

• Inherited from Service.getAnchors

  Parameters

  • optionalfilters: { key: string; value: any }[]

  Returns AAnchor[]

getBoundaryMembers

• getBoundaryMembers(): UnknownNode[]

• Inherited from Service.getBoundaryMembers

  Returns UnknownNode[]

getChild

• getChild(name: string, filters?: { key: string; value: any }[]): undefined | UnknownNode

• Inherited from Service.getChild

  Parameters

  • name: string

  • optionalfilters: { key: string; value: any }[]

  Returns undefined | UnknownNode

getChildren

• getChildren(name?: string): {}

• Inherited from Service.getChildren

  Parameters

  • optionalname: string

  Returns {}

  • [key string]: Dependency[]

getContext

• getContext(): string

• Inherited from Service.getContext

  Returns string

getDependencies

• getDependencies(to?: UnknownNode): Dependency[]

• Inherited from Service.getDependencies

  Parameters

  • optionalto: UnknownNode

  Returns Dependency[]

getDependency

• getDependency(to: UnknownNode, relationship: DependencyRelationship): undefined | Dependency

• Inherited from Service.getDependency

  Parameters

  • to: UnknownNode

  • relationship: DependencyRelationship

  Returns undefined | Dependency

getDependencyIndex

• getDependencyIndex(to: UnknownNode, relationship: DependencyRelationship): number

• Inherited from Service.getDependencyIndex

  Parameters

  • to: UnknownNode

  • relationship: DependencyRelationship

  Returns number

getParents

• getParents(name?: string): {}

• Inherited from Service.getParents

  Parameters

  • optionalname: string

  Returns {}

  • [key string]: Dependency[]

getSiblings

• getSiblings(name?: string): {}

• Inherited from Service.getSiblings

  Parameters

  • optionalname: string

  Returns {}

  • [key string]: Dependency[]

hasAncestor

• hasAncestor(node: UnknownNode): boolean

• Inherited from Service.hasAncestor

  Parameters

  • node: UnknownNode

  Returns boolean

removeAllAnchors

• removeAllAnchors(): void

• Inherited from Service.removeAllAnchors

  Returns void

removeAnchor

• removeAnchor(anchor: AAnchor): void

• Inherited from Service.removeAnchor

  Parameters

  • anchor: AAnchor

  Returns void

removeDependency

• removeDependency(dependencyIndex: number): void

• Inherited from Service.removeDependency

  Parameters

  • dependencyIndex: number

  Returns void

removeRelationship

• removeRelationship(node: UnknownNode): void

• Inherited from Service.removeRelationship

  Parameters

  • node: UnknownNode

  Returns void

saveSourceManifest

• saveSourceManifest(): Promise<void>

• Returns Promise<void>

setContext

• setContext(): string

• Inherited from Service.setContext

  Returns string

synth

• synth(): IS3StaticWebsiteService

• Overrides Service.synth

  Returns IS3StaticWebsiteService

staticunSynth

• unSynth(s3StaticWebsite: IS3StaticWebsiteService): Promise<S3StaticWebsiteService>

• Overrides Service.unSynth

  Parameters

  • s3StaticWebsite: IS3StaticWebsiteService

  Returns Promise<S3StaticWebsiteService>