@flowaccount/nx-aws-cdk/src/schematics/schema.json

aws-cdk executors and generators for nx workspace

{
  "$schema": "http://json-schema.org/schema",
  "cli": "nx",
  "title": "Stack Options",
  "description": "Synth an app via the `cdk` cli command.",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Use the indicated name for as the cdk stack project name",
      "$default": {
        "$source": "argv",
        "index": 0
      },
      "x-prompt": "What name would you like to use for the cdk project name?"
    },

    "stackName": {
      "type": "string",
      "$default": {
        "$source": "argv",
        "index": 1
      },
      "x-prompt": "What name would you like to generate as the stack name?"
    },
    "profile": {
      "type": "string",
      "description": "Use the indicated AWS profile as the default environment",
      "default": "dev_console",
      "x-prompt": "What profile would you want to assume (profile from ~/.aws/config) ([profile <profile_name>) ?"
    },
    "region": {
      "type": "string",
      "description": "Use the indicated AWS profile as the default environment",
      "default": "dev_console",
      "x-prompt": "What region would you want to deploy to ?"
    },
    "directory": {
      "type": "string",
      "description": "Use the indicated directory under apps/<directory> for as the cdk stack project directory"
    },
    "tags": {
      "type": "string",
      "description": "Add tags to the project"
    },
    "vpcId": {
      "type": "string",
      "description": "The vpc-id for this serverless application to live on"
    },
    "vpcPrivateSubnetIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Array of vpc private subnet ids"
    },
    "subnets": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Array of lambda subnet ids"
    },
    "availabilityZones": {
      "type": "array",
      "description": "Array for availability zones",
      "uniqueItems": true,
      "items": {
        "type": "string"
      },
      "x-prompt": {
        "message": "Which availability zones would you like to use?",
        "type": "list",
        "multiselect": true,
        "items": ["a", "b", "c"]
      }
    },
    "handlers": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Array for lambda handler names"
    },
    "securityGroupIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Array for lambda security groups"
    },
    "memmorySizes": {
      "type": "array",
      "items": {
        "type": "number"
      },
      "description": "Array for lambda memorrysizes"
    },
    "timeouts": {
      "type": "array",
      "items": {
        "type": "number"
      },
      "description": "Array for lambda timeout"
    },
    "functionNames": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Array for lambda function names"
    },
    "eventSources": {
      "type": "array",
      "description": "Array for event source",
      "uniqueItems": true,
      "items": {
        "type": "string"
      },
      "x-prompt": {
        "message": "Which event sources would you like to use?",
        "type": "list",
        "multiselect": true,
        "items": ["kinesis", "sqs"]
      }
    },
    "eventsArn": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Array for event ARNS"
    }
  },
  "required": [
    "name",
    "profile",
    "region",
    "vpcId",
    "vpcPrivateSubnetIds",
    "subnets",
    "availabilityZones",
    "handlers",
    "functionNames"
  ]
}