API Reference

Classes

Function

A helper class for working with AWS functions.

Initializers

bring aws;

new aws.Function();

Name	Type	Description

---

Static Functions

Name	Description
from	If the inflight host is an AWS function, return a helper interface for working with it.

---

from

bring aws;

aws.Function.from(host: IInflightHost);

If the inflight host is an AWS function, return a helper interface for working with it.

host^Required

• Type: IInflightHost

The inflight host.

---

Structs

PolicyStatement

AWS IAM Policy Statement.

Initializer

bring aws;

let PolicyStatement = aws.PolicyStatement{ ... };

Properties

Name	Type	Description
actions	MutArray<str>	Actions.
effect	Effect	Effect ("Allow" or "Deny").
resources	MutArray<str>	Resources.

---

actions^Optional

actions: MutArray<str>;

• Type: MutArray<str>

Actions.

---

effect^Optional

effect: Effect;

• Type: Effect

Effect ("Allow" or "Deny").

---

resources^Optional

resources: MutArray<str>;

• Type: MutArray<str>

Resources.

---

Protocols

IAwsFunction

• Implemented By: IAwsFunction

A shared interface for AWS functions.

Methods

Name	Description
addEnvironment	Add an environment variable to the function.
addPolicyStatements	Add policy statements to the function's IAM role.

---

addEnvironment

addEnvironment(key: str, value: str): void

Add an environment variable to the function.

key^Required

• Type: str

---

value^Required

• Type: str

---

addPolicyStatements

addPolicyStatements(...policies: Array<PolicyStatement>): void

Add policy statements to the function's IAM role.

policies^Required

• Type: PolicyStatement

---

Enums

Effect

The Effect element of an AWS IAM policy statement.

Members

Name	Description
ALLOW	Allow.
DENY	Deny.

---

ALLOW

Allow.

---

DENY

Deny.

---