Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Add C# Static-Site #173

Merged
merged 4 commits into from
Dec 3, 2019
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Add C# Static-Site
Richard Boyd committed Nov 26, 2019
commit 74131fb9b82c9bbfcf0e08a4e1d628fdfa91cdd4
342 changes: 342 additions & 0 deletions csharp/static-site/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,342 @@
# CDK asset staging directory
.cdk.staging
cdk.out

# Created by https://www.gitignore.io/api/csharp

### Csharp ###
## Ignore Visual Studio temporary files, build results, and
## files generated by popular Visual Studio add-ons.
##
## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore

# User-specific files
*.suo
*.user
*.userosscache
*.sln.docstates

# User-specific files (MonoDevelop/Xamarin Studio)
*.userprefs

# Build results
[Dd]ebug/
[Dd]ebugPublic/
[Rr]elease/
[Rr]eleases/
x64/
x86/
bld/
[Bb]in/
[Oo]bj/
[Ll]og/

# Visual Studio 2015/2017 cache/options directory
.vs/
# Uncomment if you have tasks that create the project's static files in wwwroot
#wwwroot/

# Visual Studio 2017 auto generated files
Generated\ Files/

# MSTest test Results
[Tt]est[Rr]esult*/
[Bb]uild[Ll]og.*

# NUNIT
*.VisualState.xml
TestResult.xml

# Build Results of an ATL Project
[Dd]ebugPS/
[Rr]eleasePS/
dlldata.c

# Benchmark Results
BenchmarkDotNet.Artifacts/

# .NET Core
project.lock.json
project.fragment.lock.json
artifacts/

# StyleCop
StyleCopReport.xml

# Files built by Visual Studio
*_i.c
*_p.c
*_i.h
*.ilk
*.meta
*.obj
*.iobj
*.pch
*.pdb
*.ipdb
*.pgc
*.pgd
*.rsp
*.sbr
*.tlb
*.tli
*.tlh
*.tmp
*.tmp_proj
*.log
*.vspscc
*.vssscc
.builds
*.pidb
*.svclog
*.scc

# Chutzpah Test files
_Chutzpah*

# Visual C++ cache files
ipch/
*.aps
*.ncb
*.opendb
*.opensdf
*.sdf
*.cachefile
*.VC.db
*.VC.VC.opendb

# Visual Studio profiler
*.psess
*.vsp
*.vspx
*.sap

# Visual Studio Trace Files
*.e2e

# TFS 2012 Local Workspace
$tf/

# Guidance Automation Toolkit
*.gpState

# ReSharper is a .NET coding add-in
_ReSharper*/
*.[Rr]e[Ss]harper
*.DotSettings.user

# JustCode is a .NET coding add-in
.JustCode

# TeamCity is a build add-in
_TeamCity*

# DotCover is a Code Coverage Tool
*.dotCover

# AxoCover is a Code Coverage Tool
.axoCover/*
!.axoCover/settings.json

# Visual Studio code coverage results
*.coverage
*.coveragexml

# NCrunch
_NCrunch_*
.*crunch*.local.xml
nCrunchTemp_*

# MightyMoose
*.mm.*
AutoTest.Net/

# Web workbench (sass)
.sass-cache/

# Installshield output folder
[Ee]xpress/

# DocProject is a documentation generator add-in
DocProject/buildhelp/
DocProject/Help/*.HxT
DocProject/Help/*.HxC
DocProject/Help/*.hhc
DocProject/Help/*.hhk
DocProject/Help/*.hhp
DocProject/Help/Html2
DocProject/Help/html

# Click-Once directory
publish/

# Publish Web Output
*.[Pp]ublish.xml
*.azurePubxml
# Note: Comment the next line if you want to checkin your web deploy settings,
# but database connection strings (with potential passwords) will be unencrypted
*.pubxml
*.publishproj

# Microsoft Azure Web App publish settings. Comment the next line if you want to
# checkin your Azure Web App publish settings, but sensitive information contained
# in these scripts will be unencrypted
PublishScripts/

# NuGet Packages
*.nupkg
# The packages folder can be ignored because of Package Restore
**/[Pp]ackages/*
# except build/, which is used as an MSBuild target.
!**/[Pp]ackages/build/
# Uncomment if necessary however generally it will be regenerated when needed
#!**/[Pp]ackages/repositories.config
# NuGet v3's project.json files produces more ignorable files
*.nuget.props
*.nuget.targets

# Microsoft Azure Build Output
csx/
*.build.csdef

# Microsoft Azure Emulator
ecf/
rcf/

# Windows Store app package directories and files
AppPackages/
BundleArtifacts/
Package.StoreAssociation.xml
_pkginfo.txt
*.appx

# Visual Studio cache files
# files ending in .cache can be ignored
*.[Cc]ache
# but keep track of directories ending in .cache
!*.[Cc]ache/

# Others
ClientBin/
~$*
*~
*.dbmdl
*.dbproj.schemaview
*.jfm
*.pfx
*.publishsettings
orleans.codegen.cs

# Including strong name files can present a security risk
# (https://github.com/github/gitignore/pull/2483#issue-259490424)
#*.snk

# Since there are multiple workflows, uncomment next line to ignore bower_components
# (https://github.com/github/gitignore/pull/1529#issuecomment-104372622)
#bower_components/

# RIA/Silverlight projects
Generated_Code/

# Backup & report files from converting an old project file
# to a newer Visual Studio version. Backup files are not needed,
# because we have git ;-)
_UpgradeReport_Files/
Backup*/
UpgradeLog*.XML
UpgradeLog*.htm
ServiceFabricBackup/
*.rptproj.bak

# SQL Server files
*.mdf
*.ldf
*.ndf

# Business Intelligence projects
*.rdl.data
*.bim.layout
*.bim_*.settings
*.rptproj.rsuser

# Microsoft Fakes
FakesAssemblies/

# GhostDoc plugin setting file
*.GhostDoc.xml

# Node.js Tools for Visual Studio
.ntvs_analysis.dat
node_modules/

# Visual Studio 6 build log
*.plg

# Visual Studio 6 workspace options file
*.opt

# Visual Studio 6 auto-generated workspace file (contains which files were open etc.)
*.vbw

# Visual Studio LightSwitch build output
**/*.HTMLClient/GeneratedArtifacts
**/*.DesktopClient/GeneratedArtifacts
**/*.DesktopClient/ModelManifest.xml
**/*.Server/GeneratedArtifacts
**/*.Server/ModelManifest.xml
_Pvt_Extensions

# Paket dependency manager
.paket/paket.exe
paket-files/

# FAKE - F# Make
.fake/

# JetBrains Rider
.idea/
*.sln.iml

# CodeRush
.cr/

# Python Tools for Visual Studio (PTVS)
__pycache__/
*.pyc

# Cake - Uncomment if you are using it
# tools/**
# !tools/packages.config

# Tabs Studio
*.tss

# Telerik's JustMock configuration file
*.jmconfig

# BizTalk build output
*.btp.cs
*.btm.cs
*.odx.cs
*.xsd.cs

# OpenCover UI analysis results
OpenCover/

# Azure Stream Analytics local run output
ASALocalRun/

# MSBuild Binary and Structured Log
*.binlog

# NVidia Nsight GPU debugger configuration file
*.nvuser

# MFractors (Xamarin productivity tool) working folder
.mfractor/

# Local History for Visual Studio
.localhistory/


# End of https://www.gitignore.io/api/csharp
33 changes: 33 additions & 0 deletions csharp/static-site/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@

# Static site
<!--BEGIN STABILITY BANNER-->
---

![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge)

> **This is an experimental example. It may not build out of the box**
>
> This examples does is built on Construct Libraries marked "Experimental" and may not be updated for latest breaking changes.
>
> If build is unsuccessful, please create an [issue](https://github.com/aws-samples/aws-cdk-examples/issues/new) so that we may debug the problem
---
<!--END STABILITY BANNER-->

This example creates the infrastructure for a static site, which uses an S3 bucket for storing the content. The site contents (located in the 'site-contents' sub-directory) are deployed to the bucket.

The site redirects from HTTP to HTTPS, using a CloudFront distribution, Route53 alias record, and ACM certificate.

## Prep

The domain for the static site (i.e. mystaticsite.com) must be configured as a hosted zone in Route53 prior to deploying this example. For instructions on configuring Route53 as the DNS service for your domain, see the [Route53 documentation](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-configuring.html).

## Deploy

```
$ npm install -g aws-cdk
$ dotnet build src
$ cdk deploy StaticSiteStack -c -c domain=mystaticsite.com -c subdomain=www
```

Enjoy!
3 changes: 3 additions & 0 deletions csharp/static-site/cdk.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"app": "dotnet run -p src/StaticSite/StaticSite.csproj"
}
6 changes: 6 additions & 0 deletions csharp/static-site/site-contents/error.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<html>
<header><title>Hello world: Error</title></header>
<body>
Uh oh, Spaghetti O's! you reached the error page!
</body>
</html>
7 changes: 7 additions & 0 deletions csharp/static-site/site-contents/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
<html>
<header><title>Hello world</title></header>
<body>
Hello, world!<br>
Clare was here!
</body>
</html>
34 changes: 34 additions & 0 deletions csharp/static-site/src/StaticSite.sln
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@

Microsoft Visual Studio Solution File, Format Version 12.00
# Visual Studio 15
VisualStudioVersion = 15.0.26124.0
MinimumVisualStudioVersion = 15.0.26124.0
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "StaticSite", "StaticSite\StaticSite.csproj", "{55AB4C86-3A23-494F-A8AF-F31F12E140AB}"
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Debug|Any CPU = Debug|Any CPU
Debug|x64 = Debug|x64
Debug|x86 = Debug|x86
Release|Any CPU = Release|Any CPU
Release|x64 = Release|x64
Release|x86 = Release|x86
EndGlobalSection
GlobalSection(SolutionProperties) = preSolution
HideSolutionNode = FALSE
EndGlobalSection
GlobalSection(ProjectConfigurationPlatforms) = postSolution
{55AB4C86-3A23-494F-A8AF-F31F12E140AB}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{55AB4C86-3A23-494F-A8AF-F31F12E140AB}.Debug|Any CPU.Build.0 = Debug|Any CPU
{55AB4C86-3A23-494F-A8AF-F31F12E140AB}.Debug|x64.ActiveCfg = Debug|Any CPU
{55AB4C86-3A23-494F-A8AF-F31F12E140AB}.Debug|x64.Build.0 = Debug|Any CPU
{55AB4C86-3A23-494F-A8AF-F31F12E140AB}.Debug|x86.ActiveCfg = Debug|Any CPU
{55AB4C86-3A23-494F-A8AF-F31F12E140AB}.Debug|x86.Build.0 = Debug|Any CPU
{55AB4C86-3A23-494F-A8AF-F31F12E140AB}.Release|Any CPU.ActiveCfg = Release|Any CPU
{55AB4C86-3A23-494F-A8AF-F31F12E140AB}.Release|Any CPU.Build.0 = Release|Any CPU
{55AB4C86-3A23-494F-A8AF-F31F12E140AB}.Release|x64.ActiveCfg = Release|Any CPU
{55AB4C86-3A23-494F-A8AF-F31F12E140AB}.Release|x64.Build.0 = Release|Any CPU
{55AB4C86-3A23-494F-A8AF-F31F12E140AB}.Release|x86.ActiveCfg = Release|Any CPU
{55AB4C86-3A23-494F-A8AF-F31F12E140AB}.Release|x86.Build.0 = Release|Any CPU
EndGlobalSection
EndGlobal
24 changes: 24 additions & 0 deletions csharp/static-site/src/StaticSite/Program.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
using Amazon.CDK;
using System;
using System.Collections.Generic;
using System.Linq;

namespace StaticSite
{
class Program
{
static void Main(string[] args)
{
var app = new App(null);

// A CDK app can contain multiple stacks. You can view a list of all the stacks in your
// app by typing `cdk list`.

// Stack must be in us-east-1, because the ACM certificate for a
// global CloudFront distribution must be requested in us-east-1.
new StaticSiteStack(app, "StaticSiteStack", new StackProps{Env = new Amazon.CDK.Environment{Account = "111111111", Region="us-east-1"}});

app.Synth();
}
}
}
19 changes: 19 additions & 0 deletions csharp/static-site/src/StaticSite/StaticSite.csproj
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
<OutputType>Exe</OutputType>
<TargetFramework>netcoreapp3.0</TargetFramework>
</PropertyGroup>

<ItemGroup>
<!-- CDK Construct Library dependencies -->
<PackageReference Include="Amazon.CDK" Version="1.18.0" />
<PackageReference Include="Amazon.CDK.AWS.CloudFront" Version="1.18.0" />
<PackageReference Include="Amazon.CDK.AWS.Route53" Version="1.18.0" />
<PackageReference Include="Amazon.CDK.AWS.Route53.Targets" Version="1.18.0" />
<PackageReference Include="Amazon.CDK.AWS.S3" Version="1.18.0" />
<PackageReference Include="Amazon.CDK.AWS.S3.Deployment" Version="1.18.0" />
<PackageReference Include="Amazon.CDK.AWS.CertificateManager" Version="1.18.0" />
</ItemGroup>

</Project>
93 changes: 93 additions & 0 deletions csharp/static-site/src/StaticSite/StaticSiteConstruct.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
using Amazon.CDK;
using Amazon.CDK.AWS.Route53;
using Amazon.CDK.AWS.Route53.Targets;
using Amazon.CDK.AWS.S3;
using Amazon.CDK.AWS.S3.Deployment;
using Amazon.CDK.AWS.CertificateManager;
using Amazon.CDK.AWS.CloudFront;
using System.Linq;

namespace StaticSite
{
public class StaticSiteConstructProps
{
public string DomainName;

public string SiteSubDomain;
}

public class StaticSiteConstruct : Construct
{

// A simple construct that contains a collection of AWS S3 buckets.
public StaticSiteConstruct(Construct parent, string id, StaticSiteConstructProps props) : base(parent, id)
{
var zone = HostedZone.FromLookup(this, "Zone", new HostedZoneProviderProps{DomainName = props.DomainName});
var siteDomain = (string) (props.SiteSubDomain + "." + props.DomainName);
new CfnOutput(this, "Site", new CfnOutputProps{Value = "https://" + siteDomain});

var siteBucket = new Bucket(this, "SiteBucket", new BucketProps
{
BucketName = siteDomain,
WebsiteIndexDocument = "index.html",
WebsiteErrorDocument = "error.html",
PublicReadAccess = true,

// The default removal policy is RETAIN, which means that cdk destroy will not attempt to delete
// the new bucket, and it will remain in your account until manually deleted. By setting the policy to
// DESTROY, cdk destroy will attempt to delete the bucket, but will error if the bucket is not empty.
RemovalPolicy = RemovalPolicy.DESTROY // NOT recommended for production code
});

new CfnOutput(this, "Bucket", new CfnOutputProps{Value = siteBucket.BucketName});

var certificateArn = new DnsValidatedCertificate(this, "SiteCertificate", new DnsValidatedCertificateProps
{
DomainName = siteDomain,
HostedZone = zone
}).CertificateArn;

new CfnOutput(this, "Certificate", new CfnOutputProps{Value = certificateArn});

var behavior = new Behavior();
behavior.IsDefaultBehavior = true;

var distribution = new CloudFrontWebDistribution(this, "SiteDistribution", new CloudFrontWebDistributionProps
{
AliasConfiguration = new AliasConfiguration
{
AcmCertRef = certificateArn,
Names = new string[] {siteDomain},
SslMethod = SSLMethod.SNI,
SecurityPolicy = SecurityPolicyProtocol.TLS_V1_2016
},
OriginConfigs = new ISourceConfiguration[]
{
new SourceConfiguration{
S3OriginSource = new S3OriginConfig{
S3BucketSource = siteBucket
},
Behaviors = new Behavior[] {behavior}
}
}
});

new CfnOutput(this, "DistributionId", new CfnOutputProps{Value = distribution.DistributionId});

new ARecord(this, "SiteAliasRecord", new ARecordProps
{
RecordName = siteDomain,
Target = RecordTarget.FromAlias(new CloudFrontTarget(distribution)),
Zone = zone
});

new BucketDeployment(this, "DeployWithInvalidation", new BucketDeploymentProps
{
Sources = new ISource[] {Source.Asset("./site-contents")},
DestinationBucket = siteBucket,
Distribution = distribution,
DistributionPaths = new string[] {"/*"}
});
}
}
}
28 changes: 28 additions & 0 deletions csharp/static-site/src/StaticSite/StaticSiteStack.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
using Amazon.CDK;

namespace StaticSite
{
public class StaticSiteStack : Stack
{
//
// This stack relies on getting the domain name from CDK context.
// Use 'cdk synth -c domain=mystaticsite.com -c subdomain=www'
// Or add the following to cdk.context.json:
// {
// "context": {
// "domain": "mystaticsite.com",
// "subdomain": "www"
// }
// }
//
public StaticSiteStack(Construct parent, string id, IStackProps props) : base(parent, id, props)
{
// You can also define your own constructs and use them in your stack.
StaticSiteConstruct hello = new StaticSiteConstruct(this, "MyStaticSite", new StaticSiteConstructProps()
{
DomainName= (string) this.Node.TryGetContext("domain"),
SiteSubDomain= (string) this.Node.TryGetContext("subdomain")
});
}
}
}