listener_certificates

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

Overview

Name	listener_certificates
Type	Resource
Id	aws.elbv2.listener_certificates

Fields

The following fields are returned by SELECT queries:

describe_listener_certificates

Name	Datatype	Description
certificate_arn	string	The Amazon Resource Name (ARN) of the certificate.
is_default	boolean	Indicates whether the certificate is the default certificate. Do not set this value when specifying a certificate as an input. This value is not included in the output when describing a listener, but is included when describing listener certificates.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_listener_certificates	select	ListenerArn, region	Marker, PageSize	Describes the default certificate and the certificate list for the specified HTTPS or TLS listener. If the default certificate is also in the certificate list, it appears twice in the results (once with IsDefault set to true and once with IsDefault set to false). For more information, see SSL certificates in the Application Load Balancers Guide or Server certificates in the Network Load Balancers Guide.
add_listener_certificates	update	ListenerArn, region	Certificates	Adds the specified SSL server certificate to the certificate list for the specified HTTPS or TLS listener. If the certificate in already in the certificate list, the call is successful but the certificate is not added again. For more information, see SSL certificates in the Application Load Balancers Guide or Server certificates in the Network Load Balancers Guide.
remove_listener_certificates	exec	ListenerArn, region	Certificates	Removes the specified certificate from the certificate list for the specified HTTPS or TLS listener.

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
ListenerArn	string	The Amazon Resource Name (ARN) of the listener.
region	string	AWS region (default: us-east-1)
Certificates	array	The certificate to remove. You can specify one certificate per call. Set CertificateArn to the certificate ARN but do not set IsDefault.
Marker	string	The marker for the next set of results. (You received this marker from a previous call.)
PageSize	integer	The maximum number of results to return with this call.

SELECT examples

describe_listener_certificates

Describes the default certificate and the certificate list for the specified HTTPS or TLS listener. If the default certificate is also in the certificate list, it appears twice in the results (once with IsDefault set to true and once with IsDefault set to false). For more information, see SSL certificates in the Application Load Balancers Guide or Server certificates in the Network Load Balancers Guide.

SELECT
certificate_arn,
is_default
FROM aws.elbv2.listener_certificates
WHERE ListenerArn = '{{ ListenerArn }}' -- required
AND region = '{{ region }}' -- required
AND Marker = '{{ Marker }}'
AND PageSize = '{{ PageSize }}'
;

UPDATE examples

add_listener_certificates

Adds the specified SSL server certificate to the certificate list for the specified HTTPS or TLS listener. If the certificate in already in the certificate list, the call is successful but the certificate is not added again. For more information, see SSL certificates in the Application Load Balancers Guide or Server certificates in the Network Load Balancers Guide.

UPDATE aws.elbv2.listener_certificates
SET 
-- No updatable properties
WHERE 
ListenerArn = '{{ ListenerArn }}' --required
AND region = '{{ region }}' --required
AND Certificates = '{{ Certificates}}'
RETURNING
line_items;

Lifecycle Methods

remove_listener_certificates

Removes the specified certificate from the certificate list for the specified HTTPS or TLS listener.

EXEC aws.elbv2.listener_certificates.remove_listener_certificates 
@ListenerArn='{{ ListenerArn }}' --required, 
@region='{{ region }}' --required, 
@Certificates='{{ Certificates }}'
;