Merge pull request #1 from getcft/release-1.0

Release 1.0

Author: nethacker

README.md

@@ -1 +1,40 @@
-# aws-encrypted-dynamodb-cf-template
+# aws-encrypted-dynamodb-cf-template
+
+## Description:
+
+This solution creates an [AWS DynamoDB](https://aws.amazon.com/dynamodb/) encrypted table with a primary key and sort key.
+
+The AWS CloudFormation template creates a AWS DynamoDB encrypted example table that reflects a scenario where you have clients and invoices associated to those clients. The primary keys would be email address and the sort key would be invoices
+
+Amazon DynamoDB is a key-value and document database that delivers single-digit millisecond performance at any scale. It's a fully managed, multi-region, multi-master database with built-in security, backup and restore, and in-memory caching for internet-scale applications.
+
+_***note AWS DynamoDB will incur costs**_
+
+* [DynamoDB pricing](https://aws.amazon.com/dynamodb/pricing/) resource used in example: 1 Provisioned Write and 1 Provisioned Read Capacity Unit
+
+## Prerequisites:
+
+* AWS account and environment configured with AWS Credentials
+* IAM user with AWSCloudFormationReadOnlyAccess, AmazonDynamoDBFullAccess
+
+## See how it works:
+
+AWS Management Console
+
+* Login to AWS Management Console
+* Launch in CloudFormation encrypted-dynamodb-cf-template.yml (from the repo you cloned)
+
+CloudFormation Fields
+
+* Stack name (Enter a name to associate to your AWS VPC deployment)**Next**
+* Continue choosing **Next**
+* Click **Create**
+
+## Test:
+
+In the AWS Management Console under DynamoDB you should be able to verify the following have been created:
+
+* 1 encrypted table named "Client_Invoice"
+* 1 Provisioned Write and 1 Provisioned Read Capacity Unit
+* Primary Key "client_email"
+* Sort Key "invoice_number"

encrypted-dynamodb-cf-template.yml

@@ -0,0 +1,44 @@
+# Copyright [2018] [Phil Chen]
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+#    http://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+AWSTemplateFormatVersion: 2010-09-09
+Description: 'Encrypted DynamoDB Template'
+
+Resources:
+
+  ClientInvoiceTable:
+    Type: 'AWS::DynamoDB::Table'
+    Properties:
+      SSESpecification:
+        SSEEnabled: 'true'
+      AttributeDefinitions:
+        - AttributeName: 'client_email'
+          AttributeType: 'S'
+        - AttributeName: 'invoice_number'
+          AttributeType: 'S'
+      KeySchema:
+        - AttributeName: 'client_email'
+          KeyType: 'HASH'
+        - AttributeName: 'invoice_number'
+          KeyType: 'RANGE'
+      ProvisionedThroughput:
+        ReadCapacityUnits: 1
+        WriteCapacityUnits: 1
+      TableName: Client_Invoice
+
+Outputs:
+    ClientInvoiceTable:
+        Description: 'Client Invoice Table'
+        Value:
+          Ref: 'ClientInvoiceTable'