domains

Creates, updates, deletes or gets a domain resource or lists domains in a region

Overview

Name	domains
Type	Resource
Description	Resource Type definition for AWS::Lightsail::Domain
Id	awscc.lightsail.domains

Fields

Name	Datatype	Description
domain_name	string	The name of the domain to manage in Lightsail.
▶domain_entries	array	An array of key-value pairs containing information about the domain entries.
arn	string	The Amazon Resource Name (ARN) of the domain (read-only).
support_code	string	The support code. Include this code in your email to support when you have questions (read-only).
created_at	string	The timestamp when the domain was created (read-only).
▶location	object	The AWS Region and Availability Zone where the domain was created (read-only).
resource_type	string	The Lightsail resource type (read-only).
▶tags	array	An array of key-value pairs to apply to this resource.
region	string	AWS region.

For more information, see AWS::Lightsail::Domain.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	DomainName, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all properties from an individual domain.

SELECT
region,
domain_name,
domain_entries,
arn,
support_code,
created_at,
location,
resource_type,
tags
FROM awscc.lightsail.domains
WHERE region = 'us-east-1' AND data__Identifier = '<DomainName>';

INSERT example

Use the following StackQL query and manifest file to create a new domain resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.lightsail.domains (
 DomainName,
 region
)
SELECT 
'{{ DomainName }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.lightsail.domains (
 DomainName,
 DomainEntries,
 Tags,
 region
)
SELECT 
 '{{ DomainName }}',
 '{{ DomainEntries }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: domain
    props:
      - name: DomainName
        value: '{{ DomainName }}'
      - name: DomainEntries
        value:
          - Id: '{{ Id }}'
            Name: '{{ Name }}'
            Target: '{{ Target }}'
            IsAlias: '{{ IsAlias }}'
            Type: '{{ Type }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM awscc.lightsail.domains
WHERE data__Identifier = '<DomainName>'
AND region = 'us-east-1';

Permissions

To operate on the domains resource, the following permissions are required:

Create

lightsail:CreateDomain,
lightsail:GetDomain,
lightsail:CreateDomainEntry,
lightsail:TagResource

Read

lightsail:GetDomain

Update

lightsail:GetDomain,
lightsail:CreateDomainEntry,
lightsail:DeleteDomainEntry,
lightsail:TagResource,
lightsail:UntagResource

Delete

lightsail:DeleteDomain,
lightsail:GetDomain

List

lightsail:GetDomains