@intentius/chant-lexicon-aws 0.84.0 → 0.86.0

package/src/composites/dynamodb-table.ts

@@ -70,6 +70,7 @@ function toKeySchema(partitionKey: DynamoDBKey, sortKey?: DynamoDBKey): Instance
   return sortEntry ? [partitionEntry, sortEntry] : [partitionEntry];
 }
 
+/** A DynamoDB table from a partition key, an optional sort key and optional global secondary indexes. */
 export const DynamoDBTable = Composite((props: DynamoDBTableProps) => {
   const billingMode = props.billingMode ?? "PAY_PER_REQUEST";
   const { defaults } = props;

package/src/composites/ec2-instance-role.ts

@@ -22,6 +22,7 @@ const EC2_ASSUME_ROLE = {
   ],
 };
 
+/** An IAM role that EC2 can assume, with the instance profile that attaches it to an instance. */
 export const Ec2InstanceRole = Composite((props: Ec2InstanceRoleProps) => {
   const { defaults } = props;
 

package/src/composites/ecr-repository.ts

@@ -89,6 +89,7 @@ function toLifecyclePolicyText(rules: EcrLifecycleRule[]): string {
   return JSON.stringify({ rules: rules.map(toJsonRule) });
 }
 
+/** An ECR repository with image scanning, encryption and lifecycle rules. */
 export const EcrRepository = Composite((props: EcrRepositoryProps) => {
   const { defaults } = props;
   const scanOnPush = props.scanOnPush ?? true;

package/src/composites/efs-with-access-point.ts

@@ -28,6 +28,7 @@ export interface EfsWithAccessPointProps {
   throughputMode?: "bursting" | "provisioned" | "elastic";
 }
 
+/** An EFS file system with an access point and the security group that admits NFS traffic to it. */
 export const EfsWithAccessPoint = Composite((props: EfsWithAccessPointProps) => {
   // Ternary (not push-inside-if) keeps the `new`s out of control flow (EVL002).
   const ingressRules: InstanceType<typeof SecurityGroup_Ingress>[] = props.sourceSecurityGroupId

package/src/composites/fargate-alb.ts

@@ -68,6 +68,7 @@ export interface FargateAlbProps {
   };
 }
 
+/** A Fargate service behind its own Application Load Balancer: cluster, task definition, service, target group, listener, logs and roles. */
 export const FargateAlb = Composite((props: FargateAlbProps) => {
   const containerPort = props.containerPort ?? 80;
   const cpu = props.cpu ?? "256";

package/src/composites/fargate-service.ts

@@ -109,6 +109,7 @@ export interface FargateServiceProps {
   };
 }
 
+/** A Fargate service routed by a listener rule on an existing ALB listener, with its task definition, target group, logs, roles and optional autoscaling. */
 export const FargateService = Composite((props: FargateServiceProps) => {
   if (!props.pathPatterns && !props.hostHeaders) {
     throw new Error("FargateService requires at least one of pathPatterns or hostHeaders");

package/src/composites/lambda-api.ts

@@ -14,6 +14,7 @@ export type LambdaApiResult = LambdaFunctionResult & {
   permission: InstanceType<typeof Permission>;
 };
 
+/** A Lambda function with an execution role and the permission that lets API Gateway invoke it. */
 export const LambdaApi = Composite<LambdaApiProps, LambdaApiResult>((props) => {
   const { defaults } = props;
   const { role, func } = LambdaFunction(props);

package/src/composites/lambda-dynamodb.ts

@@ -28,6 +28,7 @@ export interface LambdaDynamoDBProps extends LambdaFunctionProps {
   };
 }
 
+/** A Lambda function with a DynamoDB table, table access for its role and an optional stream trigger. */
 export const LambdaDynamoDB = Composite((props: LambdaDynamoDBProps) => {
   // Conditional entries via spread keep the `new`s out of the `if` (EVL002).
   const attributeDefinitions = [

package/src/composites/lambda-eventbridge.ts

@@ -14,6 +14,7 @@ export interface LambdaEventBridgeProps extends LambdaFunctionProps {
   };
 }
 
+/** A Lambda function triggered by an EventBridge rule, on a schedule or an event pattern. */
 export const LambdaEventBridge = Composite((props: LambdaEventBridgeProps) => {
   const { defaults } = props;
   const { role, func } = LambdaFunction(props);

package/src/composites/lambda-function.ts

@@ -40,6 +40,7 @@ export type LambdaFunctionResult = {
   func: InstanceType<typeof Function>;
 };
 
+/** A Lambda function with its execution role. */
 export const LambdaFunction = Composite<LambdaFunctionProps, LambdaFunctionResult>((props) => {
   const { defaults } = props;
   const managedPolicies = [BASIC_EXECUTION_ARN];

package/src/composites/lambda-s3.ts

@@ -33,6 +33,7 @@ export type LambdaS3Result = LambdaFunctionResult & {
   permission: InstanceType<typeof Permission>;
 };
 
+/** A Lambda function with an S3 bucket, bucket access for its role and an optional bucket-notification trigger. */
 export const LambdaS3 = Composite<LambdaS3Props, LambdaFunctionResult & { bucket: InstanceType<typeof Bucket>; permission?: InstanceType<typeof Permission> }>((props) => {
   const encryptionDefault = new Bucket_ServerSideEncryptionByDefault({ SSEAlgorithm: "AES256" });
   const encryptionRule = new Bucket_ServerSideEncryptionRule({

package/src/composites/lambda-sns.ts

@@ -12,6 +12,7 @@ export interface LambdaSnsProps extends LambdaFunctionProps {
   };
 }
 
+/** A Lambda function subscribed to an SNS topic. */
 export const LambdaSns = Composite((props: LambdaSnsProps) => {
   const { defaults } = props;
   const { role, func } = LambdaFunction(props);

package/src/composites/lambda-sqs.ts

@@ -14,6 +14,7 @@ export interface LambdaSqsProps extends LambdaFunctionProps {
   };
 }
 
+/** A Lambda function fed by an SQS queue through an event source mapping. */
 export const LambdaSqs = Composite((props: LambdaSqsProps) => {
   const { defaults } = props;
 

package/src/composites/landing-zone.ts

@@ -114,6 +114,7 @@ export type RegionRestrictionResult = {
   scpRegionRestriction: InstanceType<typeof OrganizationsPolicy>;
 };
 
+/** A service control policy that denies requests outside the listed regions. */
 export const RegionRestriction = Composite<RegionRestrictionProps, RegionRestrictionResult>((props) => {
   const policy = regionRestriction(props.regions);
   const scpRegionRestriction = new OrganizationsPolicy({
@@ -139,6 +140,7 @@ export type OrganizationTrailResult = {
   trail: InstanceType<typeof Trail>;
 };
 
+/** An organization-wide CloudTrail trail. */
 export const OrganizationTrail = Composite<OrganizationTrailProps, OrganizationTrailResult>((props) => {
   const trail = new Trail({
     IsLogging: true,

package/src/composites/minimal-vpc.ts

@@ -21,6 +21,7 @@ export interface MinimalVpcProps {
   };
 }
 
+/** A VPC with one public subnet, an internet gateway, a public route and a security group. */
 export const MinimalVpc = Composite((props: MinimalVpcProps) => {
   const { defaults } = props;
   const cidr = props.cidr ?? "10.0.0.0/24";

package/src/composites/nlb-service.ts

@@ -46,6 +46,7 @@ export interface NlbServiceProps {
   };
 }
 
+/** A Network Load Balancer with a target group and listener. */
 export const NlbService = Composite((props: NlbServiceProps) => {
   if (props.protocol === "TLS" && !props.certificateArn) {
     throw new Error("NlbService requires certificateArn when protocol is TLS");

package/src/composites/rds-instance.ts

@@ -76,6 +76,7 @@ export interface RdsInstanceProps {
   };
 }
 
+/** An RDS database instance with its subnet group, parameter group and security group, defaulting to PostgreSQL. */
 export const RdsInstance = Composite((props: RdsInstanceProps) => {
   const engine = props.engine ?? "postgres";
   const defaults = ENGINE_DEFAULTS.get(engine)!;

package/src/composites/scheduled-lambda.ts

@@ -13,6 +13,7 @@ export interface ScheduledLambdaProps extends LambdaFunctionProps {
   };
 }
 
+/** A Lambda function run on a schedule by an EventBridge rule. */
 export const LambdaScheduled = Composite((props: ScheduledLambdaProps) => {
   const { defaults } = props;
   const { role, func } = LambdaFunction(props);

package/src/composites/solr-fargate-service.ts

@@ -15,6 +15,8 @@ export interface SolrFargateServiceProps extends FargateServiceProps {
 }
 
 /**
+ * A FargateService preset for Apache Solr, with JVM heap and GC settings.
+ *
  * A pass-through composite: it returns another composite's instance rather than
  * building a members record. `CompositeFactoryMembers` admits that explicitly
  * (#1366) — it works at runtime because a composite instance keeps `members`

package/src/composites/step-functions-workflow.ts

@@ -75,6 +75,7 @@ export interface StepFunctionsWorkflowProps {
   };
 }
 
+/** A Step Functions state machine with its execution role and a log group. */
 export const StepFunctionsWorkflow = Composite((props: StepFunctionsWorkflowProps) => {
   const { defaults } = props;
 

package/src/composites/vpc-default.ts

@@ -60,6 +60,7 @@ export type VpcDefaultResult = {
   privateRta3?: InstanceType<typeof SubnetRouteTableAssociation>;
 };
 
+/** A VPC across two or three availability zones with public and private subnets, an internet gateway, a NAT gateway and their route tables. */
 export const VpcDefault = Composite<VpcDefaultProps, VpcDefaultResult>((props) => {
   const { defaults: defs } = props;
   const cidr = props.cidr ?? "10.0.0.0/16";

package/src/plugin.ts

@@ -1,3 +1,4 @@
+import { compositeCatalog } from "./composites/catalog";
 import { createRequire } from "module";
 import { awsBehaviourKinds } from "./behaviour-kinds";
 import { detectTemplate } from "./detect";
@@ -971,6 +972,10 @@ aws cloudformation wait stack-update-complete --stack-name my-app-prod`,
     return merged;
   },
 
+  composites() {
+    return compositeCatalog;
+  },
+
   mcpTools() {
     return [
       {