Skip to content

Latest commit

 

History

History

Fastly-Tls-Domain

README.md

Fastly::Tls::Domain

This resource type manages a Fastly Domain activation

Documentation

Prerequisites

AWS Management Console

To get started:

  1. Sign in to the AWS Management Console with your account and navigate to CloudFormation.

  2. Select "Public extensions" from the left hand pane and filter Publisher by "Third Party".

  3. Use the search bar to filter by the "Fastly" prefix.

Note: All official Fastly resources begin with Fastly:: and specify that they are Published by Fastly.

  1. Select the desired resource name to view more information about its schema, and click Activate.

  2. On the Extension details page, specify:

  • Extension name
  • Execution role ARN
  • Automatic updates for minor version releases
  • Configuration
  1. In your terminal, specify the configuration data for the registered Fastly CloudFormation resource type, in the given account and region by using the SetTypeConfiguration operation:

For example:

$ aws cloudformation set-type-configuration \
--region us-west-2 --type RESOURCE \
--type-name Fastly::Tls::Domain \
--configuration-alias default \
--configuration "{ \"FastlyAccess\":{\"Token\":\"YOURTOKEN\"}}"
  1. After you have your resource configured, create your AWS stack that includes any of the activated Fastly resources.

For more information about available commands and workflows, see the official AWS documentation.

Supported regions

The Fastly CloudFormation resources are available on the CloudFormation Public Registry in the following regions:

Code Name
us-east-1 US East (N. Virginia)
us-east-2 US East (Ohio)
us-west-1 US West (N. California)
us-west-2 US West (Oregon)
ap-south-1 Asia Pacific (Mumbai)
ap-northeast-1 Asia Pacific (Tokyo)
ap-northeast-2 Asia Pacific (Seoul)
ap-southeast-1 Asia Pacific (Singapore)
ap-southeast-2 Asia Pacific (Sydney)
ca-central-1 Canada (Central)
eu-central-1 Europe (Frankfurt)
eu-west-1 Europe (Ireland)
eu-west-2 Europe (London)
eu-west-3 Europe (Paris)
eu-north-1 Europe (Stockholm)
sa-east-1 South America (São Paulo)

Note: To privately register a resource in any other region, use the provided packages.

Examples

Shows how to activate a custom Tls Domain for Fastly

---
AWSTemplateFormatVersion: '2010-09-09'
Description: Shows how to activate a custom Tls Domain for Fastly
Resources:
  MySampleProject:
    Type: Fastly::Tls::Domain
    Properties:
        Type: tls_activation
        Relationships: 
            TlsCertificate: 
                Data: 
                    Id: tlsCertId123,
                    Type: tls_certificate
            TlsDomain: 
                Data:
                    Id: example.com,
                    Type: tls_domain
            TlsConfiguration: 
                Data:
                    Id: tlsConfigId123,
                    Type: tls_configuration

While importing the @amazon-web-services-cloudformation/cloudformation-cli-typescript-lib library, failures can be passed back to CloudFormation by either raising an exception from exceptions, or setting the ProgressEvent's status to OperationStatus.Failed and errorCode to one of HandlerErrorCode. There is a static helper function, ProgressEvent.failed, for this common case.

Keep in mind, during runtime all logs will be delivered to CloudWatch if you use the log() method from LoggerProxy class.