load_balancer_tls_certificates

Creates, updates, deletes or gets a load_balancer_tls_certificate resource or lists load_balancer_tls_certificates in a region

Overview

Name	load_balancer_tls_certificates
Type	Resource
Description	Resource Type definition for AWS::Lightsail::LoadBalancerTlsCertificate
Id	awscc.lightsail.load_balancer_tls_certificates

Fields

get (all properties)

Name	Datatype	Description
load_balancer_name	string	The name of your load balancer.
certificate_name	string	The SSL/TLS certificate name.
certificate_domain_name	string	The domain name (e.g., example.com ) for your SSL/TLS certificate.
certificate_alternative_names	array	An array of strings listing alternative domains and subdomains for your SSL/TLS certificate.
load_balancer_tls_certificate_arn	string
is_attached	boolean	When true, the SSL/TLS certificate is attached to the Lightsail load balancer.
https_redirection_enabled	boolean	A Boolean value that indicates whether HTTPS redirection is enabled for the load balancer.
status	string	The validation status of the SSL/TLS certificate.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
load_balancer_name	string	The name of your load balancer.
certificate_name	string	The SSL/TLS certificate name.
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	load_balancer_tls_certificates	INSERT	LoadBalancerName, CertificateName, CertificateDomainName, region
delete_resource	load_balancer_tls_certificates	DELETE	Identifier, region
update_resource	load_balancer_tls_certificates	UPDATE	Identifier, PatchDocument, region
list_resources	load_balancer_tls_certificates_list_only	SELECT	region
get_resource	load_balancer_tls_certificates	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual load_balancer_tls_certificate.

SELECT
  region,
  load_balancer_name,
  certificate_name,
  certificate_domain_name,
  certificate_alternative_names,
  load_balancer_tls_certificate_arn,
  is_attached,
  https_redirection_enabled,
  status
FROM awscc.lightsail.load_balancer_tls_certificates
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ certificate_name }}|{{ load_balancer_name }}';

list (identifiers only)

Lists all load_balancer_tls_certificates in a region.

SELECT
  region,
  certificate_name,
  load_balancer_name
FROM awscc.lightsail.load_balancer_tls_certificates_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.lightsail.load_balancer_tls_certificates (
  LoadBalancerName,
  CertificateName,
  CertificateDomainName,
  region
)
SELECT
  '{{ load_balancer_name }}',
  '{{ certificate_name }}',
  '{{ certificate_domain_name }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.lightsail.load_balancer_tls_certificates (
  LoadBalancerName,
  CertificateName,
  CertificateDomainName,
  CertificateAlternativeNames,
  IsAttached,
  HttpsRedirectionEnabled,
  region
)
SELECT
  '{{ load_balancer_name }}',
  '{{ certificate_name }}',
  '{{ certificate_domain_name }}',
  '{{ certificate_alternative_names }}',
  '{{ is_attached }}',
  '{{ https_redirection_enabled }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: load_balancer_tls_certificate
    props:
      - name: load_balancer_name
        value: '{{ load_balancer_name }}'
      - name: certificate_name
        value: '{{ certificate_name }}'
      - name: certificate_domain_name
        value: '{{ certificate_domain_name }}'
      - name: certificate_alternative_names
        value:
          - '{{ certificate_alternative_names[0] }}'
      - name: is_attached
        value: '{{ is_attached }}'
      - name: https_redirection_enabled
        value: '{{ https_redirection_enabled }}'

UPDATE example

Use the following StackQL query and manifest file to update a load_balancer_tls_certificate resource, using stack-deploy.

/*+ update */
UPDATE awscc.lightsail.load_balancer_tls_certificates
SET PatchDocument = string('{{ {
    "IsAttached": is_attached,
    "HttpsRedirectionEnabled": https_redirection_enabled
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ certificate_name }}|{{ load_balancer_name }}';

DELETE example

/*+ delete */
DELETE FROM awscc.lightsail.load_balancer_tls_certificates
WHERE
  Identifier = '{{ certificate_name }}|{{ load_balancer_name }}' AND
  region = 'us-east-1';

Permissions

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

Create

lightsail:CreateLoadBalancerTlsCertificate,
lightsail:GetLoadBalancerTlsCertificates,
lightsail:GetLoadBalancer,
lightsail:AttachLoadBalancerTlsCertificate,
lightsail:UpdateLoadBalancerAttribute

Read

lightsail:GetLoadBalancerTlsCertificates,
lightsail:GetLoadBalancer

Update

lightsail:AttachLoadBalancerTlsCertificate,
lightsail:GetLoadBalancerTlsCertificates,
lightsail:GetLoadBalancer,
lightsail:UpdateLoadBalancerAttribute

Delete

lightsail:DeleteLoadBalancerTlsCertificate,
lightsail:GetLoadBalancerTlsCertificates,
lightsail:GetLoadBalancer

List

lightsail:GetLoadBalancerTlsCertificates,
lightsail:GetLoadBalancer