Skip to content

modify_custom_domain_association

modify_custom_domain_association(
    *,
    config_overrides: Optional[RedshiftClientConfig] = None,
    custom_domain_name: Optional[CustomDomainNameString] = None,
    custom_domain_certificate_arn: Optional[CustomDomainCertificateArnString] = None,
    cluster_identifier: Optional[String] = None,
) -> ModifyCustomDomainAssociationResult

Contains information for changing a custom domain association.

Parameters:

  • custom_domain_name (Optional[CustomDomainNameString], default: None ) –

    The custom domain name for a changed custom domain association.

  • custom_domain_certificate_arn (Optional[CustomDomainCertificateArnString], default: None ) –

    The certificate Amazon Resource Name (ARN) for the changed custom domain association.

  • cluster_identifier (Optional[String], default: None ) –

    The identifier of the cluster to change a custom domain association for.

Raises:

Source code in docs_src/capo_redshift/_services/redshift.py
def modify_custom_domain_association(
    self,
    *,
    config_overrides: Optional[RedshiftClientConfig] = None,
    custom_domain_name: Optional[
        "capo_redshift.types.custom_domain_name_string.CustomDomainNameString"
    ] = None,
    custom_domain_certificate_arn: Optional[
        "capo_redshift.types.custom_domain_certificate_arn_string.CustomDomainCertificateArnString"
    ] = None,
    cluster_identifier: Optional["capo_redshift.types.string.String"] = None,
) -> "capo_redshift.types.modify_custom_domain_association_result.ModifyCustomDomainAssociationResult":
    """<p>Contains information for changing a custom domain association.</p>

    Args:
        custom_domain_name: <p>The custom domain name for a changed custom domain association.</p>
        custom_domain_certificate_arn: <p>The certificate Amazon Resource Name (ARN) for the changed custom domain association.</p>
        cluster_identifier: <p>The identifier of the cluster to change a custom domain association for.</p>

    Raises:
        capo_redshift.errors.cluster_not_found_fault.ClusterNotFoundFault: <p>The <code>ClusterIdentifier</code> parameter does not refer to an existing cluster. </p>
        capo_redshift.errors.custom_cname_association_fault.CustomCnameAssociationFault: <p>An error occurred when an attempt was made to change the custom domain association.</p>
        capo_redshift.errors.custom_domain_association_not_found_fault.CustomDomainAssociationNotFoundFault: <p>An error occurred. The custom domain name couldn't be found.</p>
        capo_redshift.errors.unsupported_operation_fault.UnsupportedOperationFault: <p>The requested operation isn't supported.</p>
        capo_redshift.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_redshift.types.modify_custom_domain_association_message.ModifyCustomDomainAssociationMessage]",
    ) -> OperationResponse[
        "capo_redshift.types.modify_custom_domain_association_result.ModifyCustomDomainAssociationResult"
    ]:
        import capo_redshift._operations.redshift_service_version20121201.modify_custom_domain_association

        output, http_response = (
            capo_redshift._operations.redshift_service_version20121201.modify_custom_domain_association.modify_custom_domain_association(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ModifyCustomDomainAssociation")
    )
    input_: capo_redshift.types.modify_custom_domain_association_message.ModifyCustomDomainAssociationMessage = {}
    if custom_domain_name is not None:
        input_["custom_domain_name"] = custom_domain_name
    if custom_domain_certificate_arn is not None:
        input_["custom_domain_certificate_arn"] = custom_domain_certificate_arn
    if cluster_identifier is not None:
        input_["cluster_identifier"] = cluster_identifier

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