Class DynamoDbInstrument

Hierarchy

Instrument
- DynamoDbInstrument

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new DynamoDbInstrument(packageName: string | string[], name: string, partitionKey: DynamoDbAttribute, sortKey?: DynamoDbAttribute, options?: DynamoDbInstrumentOptions): DynamoDbInstrument

Overrides Instrument.constructor
- Defined in DynamoDbInstrument.ts:31
Parameters
- packageName: string | string[]
- name: string
- partitionKey: DynamoDbAttribute
- Optional sortKey: DynamoDbAttribute
- Default value options: DynamoDbInstrumentOptions = {}
Returns DynamoDbInstrument

Properties

Protected definition

definition: Definition = new Definition()

dependencies

dependencies: Dependency[] = []

Methods

arn

arn(section: Section): string

Inherited from Instrument.arn
- Defined in Instrument.ts:179
Computes the ARN of this instrument at the given section

Parameters
- section: Section
Returns string

arnService

arnService(): string

Overrides Instrument.arnService
- Defined in DynamoDbInstrument.ts:95
Returns string

arnType

arnType(): string

Overrides Instrument.arnType
- Defined in DynamoDbInstrument.ts:99
Returns string

canDo

canDo(action: string, arn: string): this

Inherited from Instrument.canDo
- Defined in Instrument.ts:84
Adds an IAM permission to this instrument

memberof

Instrument

Parameters
- action: string
  
  the action to be allowed
- arn: string
  
  specifies the resource that this instrument is being granted permission to access
Returns this

this

contributeToConsumerDefinition

contributeToConsumerDefinition(rig: Section, consumerDef: Definition): void

Overrides Instrument.contributeToConsumerDefinition
- Defined in DynamoDbInstrument.ts:82
Parameters
- rig: Section
- consumerDef: Definition
Returns void

createFragment

createFragment(pathPrefix: string): DeployableFragment

Overrides Instrument.createFragment
- Defined in DynamoDbInstrument.ts:78
Parameters
- pathPrefix: string
Returns DeployableFragment

fullyQualifiedName

fullyQualifiedName(style?: NameStyle): string

Inherited from Instrument.fullyQualifiedName
- Defined in Instrument.ts:158
Computes the full name of this instrument. The full name is a composition of the "last name" (as specified by the package name) with the "first name" (this instrument's name)

memberof

Instrument

Parameters
- Default value style: NameStyle = NameStyle.DASH
Returns string

the full qualified name

getDefinition

getDefinition(): Definition

Inherited from Instrument.getDefinition
- Defined in Instrument.ts:183
Returns Definition

getEntryPointFile

getEntryPointFile(): string

Overrides Instrument.getEntryPointFile
- Defined in DynamoDbInstrument.ts:107
Returns string

getPhysicalDefinition

getPhysicalDefinition(section: Section): Definition

Inherited from Instrument.getPhysicalDefinition
- Defined in Instrument.ts:187
Parameters
- section: Section
Returns Definition

name

name(): string

Inherited from Instrument.name
- Defined in Instrument.ts:145
Returns the plain name of this instrument.

Returns string

nameProperty

nameProperty(): string

Overrides Instrument.nameProperty
- Defined in DynamoDbInstrument.ts:103
Returns string

physicalName

physicalName(section: Section): string

Inherited from Instrument.physicalName
- Defined in Instrument.ts:171
Computes the physical name of the instrument at the given section. The physical name contains the names of the enclosing bigband and section as well as the fullyQualifiedName.

Parameters
- section: Section
Returns string

uses

uses(supplier: Instrument, name: string): void

Inherited from Instrument.uses
- Defined in Instrument.ts:68
Declares an inter-instrument dependency. It indicates that this instrument ("the consumer") will use the supplier instrument

Parameters
- supplier: Instrument
  
  the supplier instrument.
- name: string
  
  the name of the dependency.
Returns void

Generated using TypeDoc