custom_domain_associations

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

Overview

Name	custom_domain_associations
Type	Resource
Id	aws.redshift_serverless.custom_domain_associations

Fields

The following fields are returned by SELECT queries:

get_custom_domain_association

Name	Datatype	Description
custom_domain_certificate_arn	string	The custom domain name’s certificate Amazon resource name (ARN). (pattern: <code>arn:[\w+=/,.@-]+:acm:[\w+=/,.@-]:[0-9]+:[\w+=,.@-]+(/[\w+=,.@-]+)</code>)
custom_domain_certificate_expiry_time	string (date-time)	The expiration time for the certificate.
custom_domain_name	string	The custom domain name associated with the workgroup. (pattern: <code>^(((?!-)[A-Za-z0-9-]{0,62}[A-Za-z0-9]).)+((?!-)[A-Za-z0-9-]{1,62}[A-Za-z0-9])$</code>)
workgroup_name	string	The name of the workgroup associated with the database. (pattern: <code>^[a-z0-9-]+$</code>)

list_custom_domain_associations

Name	Datatype	Description
custom_domain_certificate_arn	string	The custom domain name’s certificate Amazon resource name (ARN). (pattern: <code>arn:[\w+=/,.@-]+:acm:[\w+=/,.@-]:[0-9]+:[\w+=,.@-]+(/[\w+=,.@-]+)</code>)
custom_domain_certificate_expiry_time	string (date-time)	The expiration time for the certificate.
custom_domain_name	string	The custom domain name associated with the workgroup. (pattern: <code>^(((?!-)[A-Za-z0-9-]{0,62}[A-Za-z0-9]).)+((?!-)[A-Za-z0-9-]{1,62}[A-Za-z0-9])$</code>)
workgroup_name	string	The name of the workgroup associated with the database. (pattern: <code>^[a-z0-9-]+$</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_custom_domain_association	select	region		Gets information about a specific custom domain association.
list_custom_domain_associations	select	region		Lists custom domain associations for Amazon Redshift Serverless.
create_custom_domain_association	insert	region, customDomainCertificateArn, customDomainName, workgroupName		Creates a custom domain association for Amazon Redshift Serverless.
update_custom_domain_association	update	region, customDomainCertificateArn, customDomainName, workgroupName		Updates an Amazon Redshift Serverless certificate associated with a custom domain.
delete_custom_domain_association	delete	region		Deletes a custom domain association for Amazon Redshift Serverless.

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_custom_domain_association

Gets information about a specific custom domain association.

SELECT
custom_domain_certificate_arn,
custom_domain_certificate_expiry_time,
custom_domain_name,
workgroup_name
FROM aws.redshift_serverless.custom_domain_associations
WHERE region = '{{ region }}' -- required
;

list_custom_domain_associations

Lists custom domain associations for Amazon Redshift Serverless.

SELECT
custom_domain_certificate_arn,
custom_domain_certificate_expiry_time,
custom_domain_name,
workgroup_name
FROM aws.redshift_serverless.custom_domain_associations
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_custom_domain_association

Creates a custom domain association for Amazon Redshift Serverless.

INSERT INTO aws.redshift_serverless.custom_domain_associations (
customDomainCertificateArn,
customDomainName,
workgroupName,
region
)
SELECT 
'{{ customDomainCertificateArn }}' /* required */,
'{{ customDomainName }}' /* required */,
'{{ workgroupName }}' /* required */,
'{{ region }}'
RETURNING
custom_domain_certificate_arn,
custom_domain_certificate_expiry_time,
custom_domain_name,
workgroup_name
;

Manifest

# Description fields are for documentation purposes
- name: custom_domain_associations
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the custom_domain_associations resource.
  - name: customDomainCertificateArn
    value: "{{ customDomainCertificateArn }}"
    description: |
      The custom domain name’s certificate Amazon resource name (ARN).
  - name: customDomainName
    value: "{{ customDomainName }}"
    description: |
      The custom domain name to associate with the workgroup.
  - name: workgroupName
    value: "{{ workgroupName }}"
    description: |
      The name of the workgroup associated with the database.

UPDATE examples

update_custom_domain_association

Updates an Amazon Redshift Serverless certificate associated with a custom domain.

UPDATE aws.redshift_serverless.custom_domain_associations
SET 
customDomainCertificateArn = '{{ customDomainCertificateArn }}',
customDomainName = '{{ customDomainName }}',
workgroupName = '{{ workgroupName }}'
WHERE 
region = '{{ region }}' --required
AND customDomainCertificateArn = '{{ customDomainCertificateArn }}' --required
AND customDomainName = '{{ customDomainName }}' --required
AND workgroupName = '{{ workgroupName }}' --required
RETURNING
custom_domain_certificate_arn,
custom_domain_certificate_expiry_time,
custom_domain_name,
workgroup_name;

DELETE examples

delete_custom_domain_association

Deletes a custom domain association for Amazon Redshift Serverless.

DELETE FROM aws.redshift_serverless.custom_domain_associations
WHERE region = '{{ region }}' --required
;