awslabs · biffgaut · May 11, 2022 · May 10, 2022 · May 10, 2022 · May 10, 2022
@@ -85,8 +85,8 @@ new FargateToDynamoDB(this, "test-construct", new FargateToDynamoDBProps.Builder
 | dynamoTableProps?	| [`dynamodb.TableProps`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-dynamodb.TableProps.html)|Optional user provided props to override the default props for DynamoDB Table.|
 |existingTableInterface?|[`dynamodb.ITable`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-dynamodb.ITable.html)|Existing instance of DynamoDB table object or interface, providing both this and `dynamoTableProps` will cause an error.|
 | tablePermissions?	|`string`|Optional table permissions to grant to the Fargate service. One of the following may be specified: `All`, `Read`, `ReadWrite`, `Write`.|
-|tableArnEnvironmentVariableName?|`string`|Optional Name for the DynamoDB table arn environment variable set for the container.|
-|tableEnvironmentVariableName?|`string`|Optional Name for the DynamoDB table name environment variable set for the container.|
+|tableArnEnvironmentVariableName?|`string`|Optional Name for the container environment variable set to the ARN for the DynamoDB table. Default: DYNAMODB_TABLE_ARN |
+|tableEnvironmentVariableName?|`string`|Optional Name for the container environment variable set to the DynamoDB table name. Default: DYNAMODB_TABLE_NAME |
 
 ## Pattern Properties
 

@@ -120,15 +120,15 @@ export interface FargateToDynamoDBProps {
    */
   readonly tablePermissions?: string
   /**
-   * Optional Name for the DynamoDB table arn environment variable set for the container.
+   * Optional Name for the container environment variable set to the ARN for the DynamoDB table.
    *
-   * @default - None
+   * @default - DYNAMODB_TABLE_ARN
    */
   readonly tableArnEnvironmentVariableName?: string;
   /**
-   * Optional Name for the DynamoDB table name environment variable set for the container.
+   * Optional Name for the container environment variable set to the name of the DynamoDB table.
    *
-   * @default - None
+   * @default - DYNAMODB_TABLE_NAME
    */
   readonly tableEnvironmentVariableName?: string;
 }

@@ -86,8 +86,8 @@ new FargateToS3(this, "test_construct", new FargateToS3Props.Builder()
 |loggingBucketProps?|[`s3.BucketProps`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-s3.BucketProps.html)|Optional user provided props to override the default props for the S3 Logging Bucket.|
 |logS3AccessLogs?| boolean|Whether to turn on Access Logging for the S3 bucket. Creates an S3 bucket with associated storage costs for the logs. Enabling Access Logging is a best practice. default - true|
 |bucketPermissions?|`string[]`|Optional bucket permissions to grant to the Fargate service. One or more of the following may be specified: `Delete`, `Read`, and `Write`. Default is ["Read", "Write"] which includes `[s3:GetObject*, s3:GetBucket*, s3:List*, s3:DeleteObject*, s3:PutObject*, s3:Abort*]`.|
-|bucketArnEnvironmentVariableName?|string|Optional Name for the S3 bucket arn environment variable set for the container.|
-|bucketEnvironmentVariableName?|string|Optional Name for the S3 bucket name environment variable set for the container.|
+|bucketArnEnvironmentVariableName?|string|Optional Name for the container environment variable set to the bucket ARN. Default: S3_BUCKET_ARN |
+|bucketEnvironmentVariableName?|string|Optional Optional Name for the container environment variable set to the bucket name. Default: S3_BUCKET_NAME |
 
 ## Pattern Properties
 

@@ -128,15 +128,15 @@ export interface FargateToS3Props {
    */
   readonly bucketPermissions?: string[];
   /**
-   * Optional Name for the S3 bucket arn environment variable set for the container.
+   * Optional Name for the container environment variable set to the bucket ARN.
    *
-   * @default - None
+   * @default - S3_BUCKET_ARN
    */
   readonly bucketArnEnvironmentVariableName?: string;
   /**
-   * Optional Name for the S3 bucket name environment variable set for the container.
+   * Optional Name for the container environment variable set to the bucket name.
    *
-   * @default - None
+   * @default - S3_BUCKET_NAME
    */
   readonly bucketEnvironmentVariableName?: string;
   /*

@@ -85,7 +85,7 @@ new FargateToSecretsmanager(this, "test-construct", new FargateToSecretsmanagerP
 |secretProps?|[`secretsmanager.SecretProps`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-secretsmanager.SecretProps.html)|Optional user provided props to override the default props for Secrets Manager|
 |existingSecretObj?|[`secretsmanager.Secret`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-secretsmanager.Secret.html)|Existing instance of Secrets Manager Secret object, If this is set then the secretProps is ignored|
 |grantWriteAccess?|`boolean`|Optional write access to the Secret for the Fargate service (Read-Only by default)
-|secretEnvironmentVariableName?|`string`|Optional Name for the Secrets Manager secret environment variable set for the Fargate service.|
+|secretEnvironmentVariableName?|`string`|Optional Name for the container environment variable set to the ARN of the secret. Default: SECRET_ARN |
 
 ## Pattern Properties
 

@@ -121,7 +121,7 @@ export interface FargateToSecretsmanagerProps {
    */
   readonly grantWriteAccess?: string
   /**
-   * Optional Name for container environment variable containing the ARN of the secret.
+   * Optional Name for the container environment variable set to the ARN of the secret.
    *
    * @default - SECRET_ARN
    */

@@ -84,8 +84,8 @@ new FargateToSns(this, "test_construct", new FargateToSnsProps.Builder()
 | existingContainerDefinitionObject? | [ecs.ContainerDefinition](https://docs.aws.amazon.com/cdk/api/v1/docs/@aws-cdk_aws-ecs.ContainerDefinition.html) | A container definition already instantiated as part of a Fargate service. This must be the container in the existingFargateServiceObject |
 |existingTopicObj?|[sns.Topic](https://docs.aws.amazon.com/cdk/api/v1/docs/@aws-cdk_aws-sns.Topic.html)|Existing instance of SNS Topic object, providing both this and `topicProps` will cause an error.|
 |topicProps?|[sns.TopicProps](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-sns.TopicProps.html)|Optional user provided properties to override the default properties for the SNS topic.|
-|topicArnEnvironmentVariableName?|string|Optional Name for the SNS topic arn environment variable set for the container.|
-|topicNameEnvironmentVariableName?|string|Optional Name for the SNS topic name environment variable set for the container.|
+|topicArnEnvironmentVariableName?|string|Optional Name for the container environment variable set to the ARN of the topic. Default: SNS_TOPIC_ARN |
+|topicNameEnvironmentVariableName?|string|Optional Name for the container environment variable set to the name of the topic. Default: SNS_TOPIC_NAME |
 
 ## Pattern Properties
 

@@ -107,15 +107,15 @@ export interface FargateToSnsProps {
    */
   readonly topicProps?: sns.TopicProps;
   /**
-   * Optional Name for the SNS topic arn environment variable set for the container.
+   * Optional Name for the container environment variable set to the ARN of the topic.
    *
-   * @default - None
+   * @default - SNS_TOPIC_ARN
    */
   readonly topicArnEnvironmentVariableName?: string;
   /**
-   * Optional Name for the SNS topic name environment variable set for the container.
+   * Optional Name for the container environment variable set to the name of the topic.
    *
-   * @default - None
+   * @default - SNS_TOPIC_NAME
    */
   readonly topicNameEnvironmentVariableName?: string;
   /*

@@ -87,7 +87,8 @@ new FargateToSqs(this, "test_construct", new FargateToSqsProps.Builder()
 |deployDeadLetterQueue?|boolean|Whether to create a secondary queue to be used as a dead letter queue. Defaults to `true`.|
 |deadLetterQueueProps?|[sqs.QueueProps](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-sqs.QueueProps.html)|Optional user-provided props to override the default props for the dead letter queue. Only used if the `deployDeadLetterQueue` property is set to true.|
 |maxReceiveCount?|integer|The number of times a message can be unsuccessfully dequeued before being moved to the dead letter queue. Defaults to `15`.|
-|queueUrlEnvironmentVariableName?|string|Optional Name for the SQS queue name environment variable set for the container.|
+|queueUrlEnvironmentVariableName?|string|Optional Name for the container environment variable set to the URL of the queue. Default: SQS_QUEUE_URL |
+|queueArnEnvironmentVariableName?|string|Optional Name for the container environment variable set to the arn of the queue. Default: SQS_QUEUE_ARN |
 |queuePermissions?|`string[]`|Optional queue permissions to grant to the Fargate service. One or more of the following may be specified: `Read`,`Write`. Default is `Write`|
 
 

@@ -132,15 +132,15 @@ export interface FargateToSqsProps {
    */
   readonly maxReceiveCount?: number;
   /**
-   * Optional Name for the SQS queue ARN environment variable to set for the container.
+   * Optional Name for the container environment variable set to the arn of the queue.
    *
-   * @default - None
+   * @default - SQS_QUEUE_ARN
    */
   readonly queueArnEnvironmentVariableName?: string;
   /**
-   * Optional Name for the SQS queue name environment variable to set for the container.
+   * Optional Name for the container environment variable set to the URL of the queue.
    *
-   * @default - None
+   * @default - SQS_QUEUE_URL
    */
   readonly queueUrlEnvironmentVariableName?: string;
   /**

@@ -93,7 +93,7 @@ new FargateToSsmstringparameter(this, "test-construct", new FargateToSsmstringpa
 |existingStringParameterObj?|[`ssm.StringParameter`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-ssm.StringParameter.html)|Existing instance of SSM String parameter object, providing both this and `stringParameterProps` will cause an error|
 |stringParameterProps?|[`ssm.StringParameterProps`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-ssm.StringParameterProps.html)|Optional user provided props to override the default props for SSM String parameter. If existingStringParameterObj is not set stringParameterProps is required. The only supported [`ssm.StringParameterProps.type`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-ssm.StringParameterProps.html#type) is [`STRING`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-ssm.ParameterType.html#string) if a different value is provided it will be overridden.|
 |stringParameterPermissions?|`string`|Optional SSM String parameter permissions to grant to the Fargate service. One of the following may be specified: "Read", "ReadWrite".
-|stringParameterEnvironmentVariableName?|`string`|Optional Name for the SSM parameter name environment variable set for the container.|
+|stringParameterEnvironmentVariableName?|`string`|Optional Name for the container environment variable set to the SSM parameter name. Default: SSM_STRING_PARAMETER_NAME |
 
 ## Pattern Properties
 

@@ -120,9 +120,9 @@ export interface FargateToSsmstringparameterProps {
    */
   readonly stringParameterPermissions?: string
   /**
-   * Optional Name for the SSM parameter name environment variable set for the container.
+   * Optional Name for the container environment variable set to the SSM parameter name.
    *
-   * @default - None
+   * @default - SSM_STRING_PARAMETER_NAME
    */
   readonly stringParameterEnvironmentVariableName?: string;
 }

@@ -102,7 +102,7 @@ new FargateToStepfunctions(this, "test-construct", new FargateToStepfunctionsPro
 |stateMachineProps|[`sfn.StateMachineProps`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-stepfunctions.StateMachineProps.html)|User provided props to override the default props for sfn.StateMachine.|
 | createCloudWatchAlarms? | `boolean`|Whether to create recommended CloudWatch alarms. Default is true.|
 |logGroupProps?|[`logs.LogGroupProps`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-logs.LogGroupProps.html)|Optional user provided props to override the default props for for the CloudWatchLogs LogGroup.|
-|stateMachineEnvironmentVariableName?|`string`|Optional name for the container environment variable containing the state machine ARN.|
+|stateMachineEnvironmentVariableName?|`string`|Optional Name for the container environment variable set to the ARN of the state machine. Default: STATE_MACHINE_ARN |
 
 ## Pattern Properties
 

@@ -123,9 +123,9 @@ export interface FargateToStepfunctionsProps {
    */
   readonly logGroupProps?: logs.LogGroupProps;
   /**
-   * Optional name for the container environment variable containing the state machine ARN.
+   * Optional Name for the container environment variable set to the ARN of the state machine.
    *
-   * @default - None
+   * @default - STATE_MACHINE_ARN
    */
   readonly stateMachineEnvironmentVariableName?: string;
 }

@@ -50,7 +50,7 @@ export interface KinesisstreamsToGluejobProps {
    * The ETL script can be provided either under glue.CfnJob.JobCommandProperty or set as an Asset instance under
    * @KinesisstreamsToGluejobProps.etlCodeAsset.
    *
-   * If an S3 location is know and exists, provide the S3 url in the `scriptLocation` attribute in glue.CfnJob.JobCommandProperty as an
+   * If an S3 location is know and exists, provide the S3 URL in the `scriptLocation` attribute in glue.CfnJob.JobCommandProperty as an
    * S3 format URL (example: `s3://bucketname/keyprefix.py`)
    *
    * If the ETL script exists as a local files or directories, create an instance of the Asset (aws-cdk-lib » aws_s3_assets) class

@@ -86,7 +86,7 @@ new LambdaToDynamoDB(this, "test_lambda_dynamodb_stack", new LambdaToDynamoDBPro
 |dynamoTableProps?|[`dynamodb.TableProps`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-dynamodb.TableProps.html)|Optional user provided props to override the default props for DynamoDB Table|
 |existingTableObj?|[`dynamodb.Table`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-dynamodb.Table.html)|Existing instance of DynamoDB table object, providing both this and `dynamoTableProps` will cause an error.|
 |tablePermissions?|`string`|Optional table permissions to grant to the Lambda function. One of the following may be specified: `All`, `Read`, `ReadWrite`, `Write`.|
-|tableEnvironmentVariableName?|`string`|Optional Name for the DynamoDB table environment variable set for the Lambda function.|
+|tableEnvironmentVariableName?|`string`|Optional Name for the Lambda function environment variable set to the name of the DynamoDB table. Default: DDB_TABLE_NAME |
 |existingVpc?|[`ec2.IVpc`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-ec2.IVpc.html)|An optional, existing VPC into which this pattern should be deployed. When deployed in a VPC, the Lambda function will use ENIs in the VPC to access network resources and a Gateway Endpoint will be created in the VPC for Amazon DynamoDB. If an existing VPC is provided, the `deployVpc` property cannot be `true`. This uses `ec2.IVpc` to allow clients to supply VPCs that exist outside the stack using the [`ec2.Vpc.fromLookup()`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-ec2.Vpc.html#static-fromwbrlookupscope-id-options) method.|
 |vpcProps?|[`ec2.VpcProps`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-ec2.VpcProps.html)|Optional user-provided properties to override the default properties for the new VPC. `enableDnsHostnames`, `enableDnsSupport`, `natGateways` and `subnetConfiguration` are set by the pattern, so any values for those properties supplied here will be overrriden. If `deployVpc` is not `true` then this property will be ignored.|
 |deployVpc?|`boolean`|Whether to create a new VPC based on `vpcProps` into which to deploy this pattern. Setting this to true will deploy the minimal, most private VPC to run the pattern:<ul><li> One isolated subnet in each Availability Zone used by the CDK program</li><li>`enableDnsHostnames` and `enableDnsSupport` will both be set to true</li></ul>If this property is `true` then `existingVpc` cannot be specified. Defaults to `false`.|

@@ -54,9 +54,9 @@ export interface LambdaToDynamoDBProps {
    */
   readonly tablePermissions?: string;
   /**
-   * Optional Name for the DynamoDB table environment variable set for the Lambda function.
+   * Optional Name for the Lambda function environment variable set to the name of the DynamoDB table.
    *
-   * @default - None
+   * @default - DDB_TABLE_NAME
    */
   readonly tableEnvironmentVariableName?: string;
   /**

@@ -83,7 +83,7 @@ new LambdaToElasticachememcached(this, "LambdaToCachePattern", new LambdaToElast
 |lambdaFunctionProps?|[`lambda.FunctionProps`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-lambda.FunctionProps.html)|Optional user provided props to override the default props for the Lambda function.|
 |existingVpc?|[`ec2.IVpc`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-ec2.IVpc.html)|An optional, existing VPC into which this pattern should be deployed. When deployed in a VPC, the Lambda function will use ENIs in the VPC to access network resources and an Interface Endpoint will be created in the VPC for Amazon SQS. If an existing VPC is provided, the `deployVpc` property cannot be `true`. This uses `ec2.IVpc` to allow clients to supply VPCs that exist outside the stack using the [`ec2.Vpc.fromLookup()`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-ec2.Vpc.html#static-fromwbrlookupscope-id-options) method.|
 |vpcProps?|[`ec2.VpcProps`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-ec2.VpcProps.html)|Optional user provided properties to override the default properties for the new VPC. `subnetConfiguration` is set by the pattern, so any values for those properties supplied here will be overrriden. |
-| cacheEndpointEnvironmentVariableName?| string | Lambda function environment variable name for the cache Endpoint. Defaults to CACHE_ENDPOINT |
+| cacheEndpointEnvironmentVariableName?| string | Optional Name for the Lambda function environment variable set to the cache endpoint. Default: CACHE_ENDPOINT |
 | cacheProps? | [`cache.CfnCacheClusterProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_elasticache.CfnCacheClusterProps.html) | Optional user provided props to override the default props for the Elasticache Cluster. Providing both this and `existingCache` will cause an error. |
 | existingCache? | [`cache.CfnCacheCluster`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_elasticache.CfnCacheCluster.html#attrconfigurationendpointport) | Existing instance of Elasticache Cluster object, providing both this and `cacheProps` will cause an error. If you provide this, you must provide the associated VPC in existingVpc. |
 
@@ -117,4 +117,4 @@ Out of the box implementation of the Construct without any override will set the
 ![Architecture Diagram](architecture.png)
 
 ***
-&copy; Copyright 2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+&copy; Copyright 2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
@@ -50,7 +50,7 @@ export interface LambdaToElasticachememcachedProps {
    */
   readonly vpcProps?: ec2.VpcProps;
   /**
-   * Optional Name for the Elasticache Endpoint environment variable
+   * Optional Name for the Lambda function environment variable set to the cache endpoint.
    *
    * @default - CACHE_ENDPOINT
    */