load_balancer_tls_certificates

Creates, updates, deletes, gets or lists a load_balancer_tls_certificates resource.

Overview

Name	load_balancer_tls_certificates
Type	Resource
Id	aws.lightsail.load_balancer_tls_certificates

Fields

The following fields are returned by SELECT queries:

get_load_balancer_tls_certificates

Name	Datatype	Description
tls_certificates	array	An array of LoadBalancerTlsCertificate objects describing your SSL/TLS certificates.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_load_balancer_tls_certificates	select	region		Returns information about the TLS certificates that are associated with the specified Lightsail load balancer. TLS is just an updated, more secure version of Secure Socket Layer (SSL). You can have a maximum of 2 certificates associated with a Lightsail load balancer. One is active and the other is inactive.
create_load_balancer_tls_certificate	insert	region, loadBalancerName, certificateName, certificateDomainName		Creates an SSL/TLS certificate for an Amazon Lightsail load balancer. TLS is just an updated, more secure version of Secure Socket Layer (SSL). The CreateLoadBalancerTlsCertificate operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Amazon Lightsail Developer Guide.
attach_load_balancer_tls_certificate	update	region, loadBalancerName, certificateName		Attaches a Transport Layer Security (TLS) certificate to your load balancer. TLS is just an updated, more secure version of Secure Socket Layer (SSL). Once you create and validate your certificate, you can attach it to your load balancer. You can also use this API to rotate the certificates on your account. Use the AttachLoadBalancerTlsCertificate action with the non-attached certificate, and it will replace the existing one and become the attached certificate. The AttachLoadBalancerTlsCertificate operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Amazon Lightsail Developer Guide.
delete_load_balancer_tls_certificate	delete	region		Deletes an SSL/TLS certificate associated with a Lightsail load balancer. The DeleteLoadBalancerTlsCertificate operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Amazon Lightsail Developer Guide.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_load_balancer_tls_certificates

Returns information about the TLS certificates that are associated with the specified Lightsail load balancer. TLS is just an updated, more secure version of Secure Socket Layer (SSL). You can have a maximum of 2 certificates associated with a Lightsail load balancer. One is active and the other is inactive.

SELECT
tls_certificates
FROM aws.lightsail.load_balancer_tls_certificates
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_load_balancer_tls_certificate

Creates an SSL/TLS certificate for an Amazon Lightsail load balancer. TLS is just an updated, more secure version of Secure Socket Layer (SSL). The CreateLoadBalancerTlsCertificate operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Amazon Lightsail Developer Guide.

INSERT INTO aws.lightsail.load_balancer_tls_certificates (
loadBalancerName,
certificateName,
certificateDomainName,
certificateAlternativeNames,
tags,
region
)
SELECT 
'{{ loadBalancerName }}' /* required */,
'{{ certificateName }}' /* required */,
'{{ certificateDomainName }}' /* required */,
'{{ certificateAlternativeNames }}',
'{{ tags }}',
'{{ region }}'
RETURNING
operations
;

Manifest

# Description fields are for documentation purposes
- name: load_balancer_tls_certificates
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the load_balancer_tls_certificates resource.
  - name: loadBalancerName
    value: "{{ loadBalancerName }}"
    description: |
      The load balancer name where you want to create the SSL/TLS certificate.
  - name: certificateName
    value: "{{ certificateName }}"
    description: |
      The SSL/TLS certificate name. You can have up to 10 certificates in your account at one time. Each Lightsail load balancer can have up to 2 certificates associated with it at one time. There is also an overall limit to the number of certificates that can be issue in a 365-day period. For more information, see Limits.
  - name: certificateDomainName
    value: "{{ certificateDomainName }}"
    description: |
      The domain name (example.com) for your SSL/TLS certificate.
  - name: certificateAlternativeNames
    value:
      - "{{ certificateAlternativeNames }}"
    description: |
      An array of strings listing alternative domains and subdomains for your SSL/TLS certificate. Lightsail will de-dupe the names for you. You can have a maximum of 9 alternative names (in addition to the 1 primary domain). We do not support wildcards (*.example.com).
  - name: tags
    description: |
      The tag keys and optional values to add to the resource during create. Use the TagResource action to tag a resource after it's created.
    value:
      - key: "{{ key }}"
        value: "{{ value }}"

UPDATE examples

attach_load_balancer_tls_certificate

Attaches a Transport Layer Security (TLS) certificate to your load balancer. TLS is just an updated, more secure version of Secure Socket Layer (SSL). Once you create and validate your certificate, you can attach it to your load balancer. You can also use this API to rotate the certificates on your account. Use the AttachLoadBalancerTlsCertificate action with the non-attached certificate, and it will replace the existing one and become the attached certificate. The AttachLoadBalancerTlsCertificate operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Amazon Lightsail Developer Guide.

UPDATE aws.lightsail.load_balancer_tls_certificates
SET 
loadBalancerName = '{{ loadBalancerName }}',
certificateName = '{{ certificateName }}'
WHERE 
region = '{{ region }}' --required
AND loadBalancerName = '{{ loadBalancerName }}' --required
AND certificateName = '{{ certificateName }}' --required
RETURNING
operations;

DELETE examples

delete_load_balancer_tls_certificate

Deletes an SSL/TLS certificate associated with a Lightsail load balancer. The DeleteLoadBalancerTlsCertificate operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Amazon Lightsail Developer Guide.

DELETE FROM aws.lightsail.load_balancer_tls_certificates
WHERE region = '{{ region }}' --required
;