conditional_forwarders

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

Overview

Name	conditional_forwarders
Type	Resource
Id	aws.ds.conditional_forwarders

Fields

The following fields are returned by SELECT queries:

describe_conditional_forwarders

Name	Datatype	Description
conditional_forwarders	array	The list of conditional forwarders that have been created.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_conditional_forwarders	select	region		Obtains information about the conditional forwarders for this account. If no input parameters are provided for RemoteDomainNames, this request describes all conditional forwarders for the specified directory ID.
create_conditional_forwarder	insert	region, DirectoryId, RemoteDomainName		Creates a conditional forwarder associated with your Amazon Web Services directory. Conditional forwarders are required in order to set up a trust relationship with another domain. The conditional forwarder points to the trusted domain.
update_conditional_forwarder	update	region, DirectoryId, RemoteDomainName		Updates a conditional forwarder that has been set up for your Amazon Web Services directory.
delete_conditional_forwarder	delete	region		Deletes a conditional forwarder that has been set up for your Amazon Web Services directory.

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_conditional_forwarders

Obtains information about the conditional forwarders for this account. If no input parameters are provided for RemoteDomainNames, this request describes all conditional forwarders for the specified directory ID.

SELECT
conditional_forwarders
FROM aws.ds.conditional_forwarders
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_conditional_forwarder

Creates a conditional forwarder associated with your Amazon Web Services directory. Conditional forwarders are required in order to set up a trust relationship with another domain. The conditional forwarder points to the trusted domain.

INSERT INTO aws.ds.conditional_forwarders (
DirectoryId,
RemoteDomainName,
DnsIpAddrs,
DnsIpv6Addrs,
region
)
SELECT 
'{{ DirectoryId }}' /* required */,
'{{ RemoteDomainName }}' /* required */,
'{{ DnsIpAddrs }}',
'{{ DnsIpv6Addrs }}',
'{{ region }}'
;

Manifest

# Description fields are for documentation purposes
- name: conditional_forwarders
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the conditional_forwarders resource.
  - name: DirectoryId
    value: "{{ DirectoryId }}"
    description: |
      The directory ID of the Amazon Web Services directory for which you are creating the conditional forwarder.
  - name: RemoteDomainName
    value: "{{ RemoteDomainName }}"
    description: |
      The fully qualified domain name (FQDN) of the remote domain with which you will set up a trust relationship.
  - name: DnsIpAddrs
    value:
      - "{{ DnsIpAddrs }}"
    description: |
      The IP addresses of the remote DNS server associated with RemoteDomainName.
  - name: DnsIpv6Addrs
    value:
      - "{{ DnsIpv6Addrs }}"
    description: |
      The IPv6 addresses of the remote DNS server associated with RemoteDomainName.

UPDATE examples

update_conditional_forwarder

Updates a conditional forwarder that has been set up for your Amazon Web Services directory.

UPDATE aws.ds.conditional_forwarders
SET 
DirectoryId = '{{ DirectoryId }}',
RemoteDomainName = '{{ RemoteDomainName }}',
DnsIpAddrs = '{{ DnsIpAddrs }}',
DnsIpv6Addrs = '{{ DnsIpv6Addrs }}'
WHERE 
region = '{{ region }}' --required
AND DirectoryId = '{{ DirectoryId }}' --required
AND RemoteDomainName = '{{ RemoteDomainName }}' --required;

DELETE examples

delete_conditional_forwarder

Deletes a conditional forwarder that has been set up for your Amazon Web Services directory.

DELETE FROM aws.ds.conditional_forwarders
WHERE region = '{{ region }}' --required
;