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	aws.lightsail.load_balancer_tls_certificates

Fields

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.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	LoadBalancerName, CertificateName, CertificateDomainName, 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 load_balancer_tls_certificates in a region.

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 aws.lightsail.load_balancer_tls_certificates
WHERE region = 'us-east-1';

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 aws.lightsail.load_balancer_tls_certificates
WHERE region = 'us-east-1' AND data__Identifier = '<CertificateName>|<LoadBalancerName>';

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 aws.lightsail.load_balancer_tls_certificates (
 LoadBalancerName,
 CertificateName,
 CertificateDomainName,
 region
)
SELECT 
'{{ LoadBalancerName }}',
 '{{ CertificateName }}',
 '{{ CertificateDomainName }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.lightsail.load_balancer_tls_certificates (
 LoadBalancerName,
 CertificateName,
 CertificateDomainName,
 CertificateAlternativeNames,
 IsAttached,
 HttpsRedirectionEnabled,
 region
)
SELECT 
 '{{ LoadBalancerName }}',
 '{{ CertificateName }}',
 '{{ CertificateDomainName }}',
 '{{ CertificateAlternativeNames }}',
 '{{ IsAttached }}',
 '{{ HttpsRedirectionEnabled }}',
 '{{ 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: LoadBalancerName
        value: '{{ LoadBalancerName }}'
      - name: CertificateName
        value: '{{ CertificateName }}'
      - name: CertificateDomainName
        value: '{{ CertificateDomainName }}'
      - name: CertificateAlternativeNames
        value:
          - '{{ CertificateAlternativeNames[0] }}'
      - name: IsAttached
        value: '{{ IsAttached }}'
      - name: HttpsRedirectionEnabled
        value: '{{ HttpsRedirectionEnabled }}'

DELETE example

/*+ delete */
DELETE FROM aws.lightsail.load_balancer_tls_certificates
WHERE data__Identifier = '<CertificateName|LoadBalancerName>'
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