Initializes an Instrument.
the package name of the instrument. See "Naming" above.
Computes the ARN of this instrument at the given section
Returns the AWS service namespace to be used when constructing the ARN of this instrument. For instance, in a an ARN of a lambda function, "arn:aws:lambda:eu-west-2:111111111111:function:my-function", this is the "lamda" token.
Returns the AWS resource name to be used when constructing the ARN of this instrument. For instance, in a an ARN of a lambda function, "arn:aws:lambda:eu-west-2:111111111111:function:my-function", this is the "function" token.
Adds an IAM permission to this instrument
the action to be allowed
specifies the resource that this instrument is being granted permission to access
this
Called on supplier instruments (as per the uses method). This allows supplier instruments to affect the cloudformation template of their consumer insturments. A supplier would typically add an IAM permission to its consumer.
Returns a DeployableFragment to be added to the bundle of shipped code
path to the directory where the compiled sources file will reside
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)
the full qualified name
Returns the path to a file that needs to be compiled with this instrument. This is needed for instruments that need user-supplied code to be shipped, such as Lambda instruments. An empty string denotes that no node needs to be shipped.
Returns the plain name of this instrument.
Returns the name of the cloudformation property whose value specifies the exact name of the resource. You need to check Cloudformation's "Resource and Property Types Reference" (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html) to find the exact value. For instance, for a lambda function this would be "FunctionName", wheras for a DynamoDB table this would be "TableName"
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.
Declares an inter-instrument dependency. It indicates that this instrument ("the consumer") will use the supplier instrument
the supplier instrument.
the name of the dependency.
Generated using TypeDoc
Bigband's basic building block. Usually corresponds to an AWS resources such as: a Lambda function, a DynamoDB table, a Kinesis stream, etc.
Naming. Inside every Section, Instruments are arranged in a tree-like hierarchy (similar to the way files are arranged in directories). This enables logical grouping of related instruments. The packageName (denoting a "path in the tree") is specified as an array of string: ["p1", "p2", "p3"] denotes a package nested inside the ["p1", "p2"] package. For brevity, a packageName can also be specified as a plain string: "p1" is equivalent to ["p1"]. The instrument's plain name is must be unique within its package. In other words: two instruments can have the same simple name if they belond to two different packages.