Skip to content

create_conditional_forwarder 

create_conditional_forwarder(
    directory_id: DirectoryId,
    remote_domain_name: RemoteDomainName,
    *,
    config_overrides: Optional[DirectoryServiceClientConfig] = None,
    dns_ip_addrs: Optional[DnsIpAddrs] = None,
    dns_ipv6_addrs: Optional[DnsIpv6Addrs] = None,
) -> CreateConditionalForwarderResult

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.

Parameters:

  • directory_id (DirectoryId) –

    The directory ID of the Amazon Web Services directory for which you are creating the conditional forwarder.

  • remote_domain_name (RemoteDomainName) –

    The fully qualified domain name (FQDN) of the remote domain with which you will set up a trust relationship.

  • dns_ip_addrs (Optional[DnsIpAddrs], default: None ) –

    The IP addresses of the remote DNS server associated with RemoteDomainName.

  • dns_ipv6_addrs (Optional[DnsIpv6Addrs], default: None ) –

    The IPv6 addresses of the remote DNS server associated with RemoteDomainName.

Raises:

Examples:

To create a conditional forwarder The following example creates a conditional forwarder associated with your AWS directory.

>>> client.create_conditional_forwarder(directory_id='d-92654abfed', remote_domain_name='sales.example.com', dns_ip_addrs=['172.30.21.228'])
Source code in docs_src/capo_directory_service/_services/directory_service.py 
 943
 944
 945
 946
 947
 948
 949
 950
 951
 952
 953
 954
 955
 956
 957
 958
 959
 960
 961
 962
 963
 964
 965
 966
 967
 968
 969
 970
 971
 972
 973
 974
 975
 976
 977
 978
 979
 980
 981
 982
 983
 984
 985
 986
 987
 988
 989
 990
 991
 992
 993
 994
 995
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
def create_conditional_forwarder(
    self,
    directory_id: "capo_directory_service.types.directory_id.DirectoryId",
    remote_domain_name: "capo_directory_service.types.remote_domain_name.RemoteDomainName",
    *,
    config_overrides: Optional[DirectoryServiceClientConfig] = None,
    dns_ip_addrs: Optional[
        "capo_directory_service.types.dns_ip_addrs.DnsIpAddrs"
    ] = None,
    dns_ipv6_addrs: Optional[
        "capo_directory_service.types.dns_ipv6_addrs.DnsIpv6Addrs"
    ] = None,
) -> "capo_directory_service.types.create_conditional_forwarder_result.CreateConditionalForwarderResult":
    """<p>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.</p>

    Args:
        directory_id: <p>The directory ID of the Amazon Web Services directory for which you are creating the conditional forwarder.</p>
        remote_domain_name: <p>The fully qualified domain name (FQDN) of the remote domain with which you will set up a trust relationship.</p>
        dns_ip_addrs: <p>The IP addresses of the remote DNS server associated with RemoteDomainName.</p>
        dns_ipv6_addrs: <p>The IPv6 addresses of the remote DNS server associated with RemoteDomainName.</p>

    Raises:
        capo_directory_service.errors.client_exception.ClientException: <p>A client exception has occurred.</p>
        capo_directory_service.errors.directory_unavailable_exception.DirectoryUnavailableException: <p>The specified directory is unavailable.</p>
        capo_directory_service.errors.entity_already_exists_exception.EntityAlreadyExistsException: <p>The specified entity already exists.</p>
        capo_directory_service.errors.entity_does_not_exist_exception.EntityDoesNotExistException: <p>The specified entity could not be found.</p>
        capo_directory_service.errors.invalid_parameter_exception.InvalidParameterException: <p>One or more parameters are not valid.</p>
        capo_directory_service.errors.service_exception.ServiceException: <p>An exception has occurred in Directory Service.</p>
        capo_directory_service.errors.unsupported_operation_exception.UnsupportedOperationException: <p>The operation is not supported.</p>
        capo_directory_service.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To create a conditional forwarder
        The following example creates a conditional forwarder associated with your AWS directory.

        >>> client.create_conditional_forwarder(directory_id='d-92654abfed', remote_domain_name='sales.example.com', dns_ip_addrs=['172.30.21.228'])
    """

    def _handler(
        req: "OperationRequest[capo_directory_service.types.create_conditional_forwarder_request.CreateConditionalForwarderRequest]",
    ) -> OperationResponse[
        "capo_directory_service.types.create_conditional_forwarder_result.CreateConditionalForwarderResult"
    ]:
        import capo_directory_service._operations.directory_service_20150416.create_conditional_forwarder

        output, http_response = (
            capo_directory_service._operations.directory_service_20150416.create_conditional_forwarder.create_conditional_forwarder(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateConditionalForwarder")
    )
    input_: capo_directory_service.types.create_conditional_forwarder_request.CreateConditionalForwarderRequest = {
        "directory_id": directory_id,
        "remote_domain_name": remote_domain_name,
    }
    if dns_ip_addrs is not None:
        input_["dns_ip_addrs"] = dns_ip_addrs
    if dns_ipv6_addrs is not None:
        input_["dns_ipv6_addrs"] = dns_ipv6_addrs

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output