certificates

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

Overview

Name	certificates
Type	Resource
Id	aws.dms.certificates

Fields

The following fields are returned by SELECT queries:

describe_certificates

Name	Datatype	Description
certificate_arn	string	The Amazon Resource Name (ARN) for the certificate.
certificate_creation_date	string (date-time)	The date that the certificate was created.
certificate_identifier	string	A customer-assigned name for the certificate. Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can't end with a hyphen or contain two consecutive hyphens.
certificate_owner	string	The owner of the certificate.
certificate_pem	string	The contents of a .pem file, which contains an X.509 certificate.
certificate_wallet	string (byte)	The location of an imported Oracle Wallet certificate for use with SSL. Example: filebase64("${path.root}/rds-ca-2019-root.sso")
key_length	integer	The key length of the cryptographic algorithm being used.
kms_key_id	string	An KMS key identifier that is used to encrypt the certificate. If you don't specify a value for the KmsKeyId parameter, then DMS uses your default encryption key. KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.
signing_algorithm	string	The signing algorithm for the certificate.
valid_from_date	string (date-time)	The beginning date that the certificate is valid.
valid_to_date	string (date-time)	The final date that the certificate is valid.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_certificates	select	region		Provides a description of the certificate.
delete_certificate	delete	region		Deletes the specified certificate.
import_certificate	exec	region, CertificateIdentifier		Uploads the specified certificate.

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

describe_certificates

Provides a description of the certificate.

SELECT
certificate_arn,
certificate_creation_date,
certificate_identifier,
certificate_owner,
certificate_pem,
certificate_wallet,
key_length,
kms_key_id,
signing_algorithm,
valid_from_date,
valid_to_date
FROM aws.dms.certificates
WHERE region = '{{ region }}' -- required
;

DELETE examples

delete_certificate

Deletes the specified certificate.

DELETE FROM aws.dms.certificates
WHERE region = '{{ region }}' --required
;

Lifecycle Methods

import_certificate

Uploads the specified certificate.

EXEC aws.dms.certificates.import_certificate 
@region='{{ region }}' --required 
@@json=
'{
"CertificateIdentifier": "{{ CertificateIdentifier }}", 
"CertificatePem": "{{ CertificatePem }}", 
"CertificateWallet": "{{ CertificateWallet }}", 
"Tags": "{{ Tags }}", 
"KmsKeyId": "{{ KmsKeyId }}"
}'
;