ac360

aj.stuyvenberg

dschep

eahefnawy

pmuens

@serverless/domain

    "test": "echo \"Error: no test specified\" && exit 1",

const { Component } = require('@serverless/core')

    this.context.debug(`Starting Domain component deployment.`)

    this.context.debug(`Validating inputs.`)

    inputs.region = inputs.region || 'us-east-1'

    inputs.privateZone = inputs.privateZone || false

      throw Error(`"domain" is a required input.`)

    // TODO: Check if domain has changed.

    // On domain change, call remove for all previous state.

    const clients = getClients(this.context.credentials.aws, inputs.region)

    this.context.debug(`Formatting domains and identifying cloud services being used.`)

    const subdomains = prepareSubdomains(inputs)

    this.state.privateZone = JSON.parse(inputs.privateZone)

    this.context.debug(`Getting the Hosted Zone ID for the domain ${inputs.domain}.`)

    const domainHostedZoneId = await getDomainHostedZoneId(

      `Searching for an AWS ACM Certificate based on the domain: ${inputs.domain}.`

    let certificateArn = await getCertificateArnByDomain(clients.acm, inputs.domain)

      this.context.debug(`No existing AWS ACM Certificates found for the domain: ${inputs.domain}.`)

      this.context.debug(`Creating a new AWS ACM Certificate for the domain: ${inputs.domain}.`)

      certificateArn = await createCertificate(clients.acm, inputs.domain)

    this.context.debug(`Checking the status of AWS ACM Certificate.`)

    const certificate = await describeCertificateByArn(clients.acm, certificateArn)

    if (certificate.Status === 'PENDING_VALIDATION') {

      this.context.debug(`AWS ACM Certificate Validation Status is "PENDING_VALIDATION".`)

      this.context.debug(`Validating AWS ACM Certificate via Route53 "DNS" method.`)

        'Your AWS ACM Certificate has been created and is being validated via DNS.  This could take up to 30 minutes since it depends on DNS propagation.  Continuining deployment, but you may have to wait for DNS propagation.'

    if (certificate.Status !== 'ISSUED' && certificate.Status !== 'PENDING_VALIDATION') {

      // TODO: Should we auto-create a new one in this scenario?

        `Your AWS ACM Certificate for the domain "${inputs.domain}" has an unsupported status of: "${certificate.Status}".  Please remove it manually and deploy again.`

    // Setting up domains for different services

    for (const subdomain of subdomains) {

      if (subdomain.type === 'awsS3Website') {

        this.context.debug(`Configuring domain "${subdomain.domain}" for S3 Bucket Website`)

        await addDomainToCloudfrontDistribution(clients.cf, subdomain)

        await addDomainToCloudfrontDistribution(clients.cf, subdomain, certificate.CertificateArn)

        this.context.debug(`Configuring DNS for distribution "${subdomain.url}".`)

        await configureDnsForCloudFrontDistribution(

      // TODO: Remove unused domains that are kept in state

    outputs.domains = subdomains.map((subdomain) => {

      if (subdomain.domain.startsWith('www')) {

      return `https://${subdomain.domain}`

      outputs.domains.unshift(`https://${inputs.domain.replace('www.', '')}`)

    this.context.debug(`Starting Domain component removal.`)

    const clients = getClients(this.context.credentials.aws, this.state.region)

    this.context.debug(`Getting the Hosted Zone ID for the domain ${this.state.domain}.`)

    for (const subdomain in this.state.subdomains) {

      const domainState = this.state.subdomains[subdomain]

      if (domainState.type === 'awsS3Website') {

          `Fetching CloudFront distribution info for removal for domain ${domainState.domain}.`

        const distribution = await getCloudFrontDistributionByDomain(clients.cf, domainState.domain)

          this.context.debug(`Removing DNS records for website domain ${domainState.domain}.`)

          await removeWebsiteDomainDnsRecords(

          if (domainState.domain.startsWith('www')) {

            await removeWebsiteDomainDnsRecords(

              domainState.domain.replace('www.', ''), // it'll move on if it doesn't exist

      } else if (domainState.type === 'awsApiGateway') {

          `Fetching API Gateway domain ${domainState.domain} information for removal.`

        const domainRes = await getApiDomainName(clients.apig, domainState.domain)

          this.context.debug(`Removing API Gateway domain ${domainState.domain}.`)

          await removeApiDomain(clients.apig, domainState.domain)

          this.context.debug(`Removing DNS records for API Gateway domain ${domainState.domain}.`)

          await removeApiDomainDnsRecords(

            domainRes.distributionHostedZoneId,

            domainRes.distributionDomainName

const { utils } = require('@serverless/core')

 * - Gets AWS SDK clients to use within this Component

const getClients = (credentials, region = 'us-east-1') => {

    region: 'us-east-1' // ACM must be in us-east-1

 * - Formats component domains & identifies cloud services they're using.

  for (const subdomain in inputs.subdomains || {}) {

    domainObj.domain = `${subdomain}.${inputs.domain}`

    if (inputs.subdomains[subdomain].url.includes('s3')) {

      // Get S3 static hosting endpoint of existing bucket to use w/ CloudFront.

      // todo this doesn't work with bucket names with periods

      domainObj.s3BucketName = inputs.subdomains[subdomain].url.replace('http://', '').split('.')[0]

    // Check if referenced Component is using AWS API Gateway...

    if (inputs.subdomains[subdomain].url.includes('execute-api')) {

      domainObj.apiId = inputs.subdomains[subdomain].url.split('.')[0].split('//')[1]

    if (inputs.subdomains[subdomain].url.includes('cloudfront')) {

      domainObj.distributionId = inputs.subdomains[subdomain].id

      domainObj.url = inputs.subdomains[subdomain].url

const getOutdatedDomains = (inputs, state) => {

  for (const domain of state.subdomains) {

    if (!inputs.subdomains[domain.domain]) {

 * - Every Domain on Route53 always has a Hosted Zone w/ 2 Record Sets.

 * - These Record Sets are: "Name Servers (NS)" & "Start of Authority (SOA)"

 * - These don't need to be created and SHOULD NOT be modified.

const addDomainToCloudfrontDistribution = async (cf, subdomain, distributionUrl) => {

const addDomainToCloudfrontDistribution = async (cf, subdomain, certificateArn) => {

  // https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/CloudFront.html#updateDistribution-property

  const params = await cf.getDistributionConfig({ Id: subdomain.id }).promise()

  const params = await cf.getDistributionConfig({ Id: subdomain.distributionId }).promise()

  params.DistributionConfig.ViewerCertificate = {

    MinimumProtocolVersion: 'TLSv1.1_2016',

  const res = await cf.updateDistribution(params).promise()

		{
		"name": "@serverless/domain",
		"version": "3.0.0",
		"version": "3.0.1",
		"main": "./serverless.js",
		@@ -5,0 +5,0 @@ "publishConfig": {

		@@ -794,3 +794,3 @@ const aws = require('aws-sdk')

		const addDomainToCloudfrontDistribution = async (cf, subdomain, distributionUrl) => {
		const addDomainToCloudfrontDistribution = async (cf, subdomain, certificateArn) => {
		// Update logic is a bit weird...
		@@ -800,3 +800,3 @@ // https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/CloudFront.html#updateDistribution-property
		// 1. we gotta get the config first...
		const params = await cf.getDistributionConfig({ Id: subdomain.id }).promise()
		const params = await cf.getDistributionConfig({ Id: subdomain.distributionId }).promise()

		@@ -810,3 +810,3 @@ // 2. then add this property
		// 4. then set this property
		params.Id = subdomain.id
		params.Id = subdomain.distributionId

		@@ -819,2 +819,10 @@ // 5. then make our changes

		params.DistributionConfig.ViewerCertificate = {
		ACMCertificateArn: certificateArn,
		SSLSupportMethod: 'sni-only',
		MinimumProtocolVersion: 'TLSv1.1_2016',
		Certificate: certificateArn,
		CertificateSource: 'acm'
		}

		// 6. then finally update!
		@@ -821,0 +829,0 @@ const res = await cf.updateDistribution(params).promise()

		@@ -149,3 +149,3 @@ const { Component } = require('@serverless/core')
		)
		await addDomainToCloudfrontDistribution(clients.cf, subdomain)
		await addDomainToCloudfrontDistribution(clients.cf, subdomain, certificate.CertificateArn)

		@@ -152,0 +152,0 @@ this.context.debug(`Configuring DNS for distribution "${subdomain.url}".`)

Improved metrics