custom_domain_associations

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

Overview

Name	custom_domain_associations
Type	Resource
Id	aws.redshift.custom_domain_associations

Fields

The following fields are returned by SELECT queries:

describe_custom_domain_associations

Name	Datatype	Description
certificate_associations	string	A list of all associated clusters and domain names tied to a specific certificate.
custom_domain_certificate_arn	string	The Amazon Resource Name (ARN) for the certificate associated with the custom domain.
custom_domain_certificate_expiry_date	string	The expiration date for the certificate.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_custom_domain_associations	select	region	CustomDomainName, CustomDomainCertificateArn, MaxRecords, Marker	Contains information about custom domain associations for a cluster.
create_custom_domain_association	insert	CustomDomainName, CustomDomainCertificateArn, ClusterIdentifier, region		Used to create a custom domain name for a cluster. Properties include the custom domain name, the cluster the custom domain is associated with, and the certificate Amazon Resource Name (ARN).
modify_custom_domain_association	update	CustomDomainName, CustomDomainCertificateArn, ClusterIdentifier, region		Contains information for changing a custom domain association.
delete_custom_domain_association	delete	ClusterIdentifier, CustomDomainName, region		Contains information about deleting a custom domain association for a cluster.

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
ClusterIdentifier	string	The identifier of the cluster to delete a custom domain association for.
CustomDomainCertificateArn	string	The certificate Amazon Resource Name (ARN) for the changed custom domain association.
CustomDomainName	string	The custom domain name for the custom domain association.
region	string	AWS region (default: us-east-1)
CustomDomainCertificateArn	string	The certificate Amazon Resource Name (ARN) for the custom domain association.
CustomDomainName	string	The custom domain name for the custom domain association.
Marker	string	The marker for the custom domain association.
MaxRecords	integer	The maximum records setting for the associated custom domain.

SELECT examples

describe_custom_domain_associations

Contains information about custom domain associations for a cluster.

SELECT
certificate_associations,
custom_domain_certificate_arn,
custom_domain_certificate_expiry_date
FROM aws.redshift.custom_domain_associations
WHERE region = '{{ region }}' -- required
AND CustomDomainName = '{{ CustomDomainName }}'
AND CustomDomainCertificateArn = '{{ CustomDomainCertificateArn }}'
AND MaxRecords = '{{ MaxRecords }}'
AND Marker = '{{ Marker }}'
;

INSERT examples

create_custom_domain_association

Used to create a custom domain name for a cluster. Properties include the custom domain name, the cluster the custom domain is associated with, and the certificate Amazon Resource Name (ARN).

INSERT INTO aws.redshift.custom_domain_associations (
CustomDomainName,
CustomDomainCertificateArn,
ClusterIdentifier,
region
)
SELECT 
'{{ CustomDomainName }}',
'{{ CustomDomainCertificateArn }}',
'{{ ClusterIdentifier }}',
'{{ region }}'
RETURNING
cluster_identifier,
custom_domain_cert_expiry_time,
custom_domain_certificate_arn,
custom_domain_name
;

Manifest

# Description fields are for documentation purposes
- name: custom_domain_associations
props:
  - name: CustomDomainName
    value: "{{ CustomDomainName }}"
    description: Required parameter for the custom_domain_associations resource.
  - name: CustomDomainCertificateArn
    value: "{{ CustomDomainCertificateArn }}"
    description: Required parameter for the custom_domain_associations resource.
  - name: ClusterIdentifier
    value: "{{ ClusterIdentifier }}"
    description: Required parameter for the custom_domain_associations resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the custom_domain_associations resource.

UPDATE examples

modify_custom_domain_association

Contains information for changing a custom domain association.

UPDATE aws.redshift.custom_domain_associations
SET 
-- No updatable properties
WHERE 
CustomDomainName = '{{ CustomDomainName }}' --required
AND CustomDomainCertificateArn = '{{ CustomDomainCertificateArn }}' --required
AND ClusterIdentifier = '{{ ClusterIdentifier }}' --required
AND region = '{{ region }}' --required
RETURNING
cluster_identifier,
custom_domain_cert_expiry_time,
custom_domain_certificate_arn,
custom_domain_name;

DELETE examples

delete_custom_domain_association

Contains information about deleting a custom domain association for a cluster.

DELETE FROM aws.redshift.custom_domain_associations
WHERE ClusterIdentifier = '{{ ClusterIdentifier }}' --required
AND CustomDomainName = '{{ CustomDomainName }}' --required
AND region = '{{ region }}' --required
;