Package software.amazon.awssdk.services.amplify.model

Interface DomainAssociation.Builder

    • Method Detail

      • domainAssociationArn

        DomainAssociation.Builder domainAssociationArn​(String domainAssociationArn)

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

        Parameters:
        domainAssociationArn - The Amazon Resource Name (ARN) for the domain association.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • domainName

        DomainAssociation.Builder domainName​(String domainName)

        The name of the domain.

        Parameters:
        domainName - The name of the domain.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • enableAutoSubDomain

        DomainAssociation.Builder enableAutoSubDomain​(Boolean enableAutoSubDomain)

        Enables the automated creation of subdomains for branches.

        Parameters:
        enableAutoSubDomain - Enables the automated creation of subdomains for branches.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • autoSubDomainCreationPatterns

        DomainAssociation.Builder autoSubDomainCreationPatterns​(Collection<String> autoSubDomainCreationPatterns)

        Sets branch patterns for automatic subdomain creation.

        Parameters:
        autoSubDomainCreationPatterns - Sets branch patterns for automatic subdomain creation.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • autoSubDomainCreationPatterns

        DomainAssociation.Builder autoSubDomainCreationPatterns​(String... autoSubDomainCreationPatterns)

        Sets branch patterns for automatic subdomain creation.

        Parameters:
        autoSubDomainCreationPatterns - Sets branch patterns for automatic subdomain creation.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • autoSubDomainIAMRole

        DomainAssociation.Builder autoSubDomainIAMRole​(String autoSubDomainIAMRole)

        The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.

        Parameters:
        autoSubDomainIAMRole - The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • domainStatus

        DomainAssociation.Builder domainStatus​(String domainStatus)

        The current status of the domain association.

        Parameters:
        domainStatus - The current status of the domain association.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        DomainStatus, DomainStatus

      • domainStatus

        DomainAssociation.Builder domainStatus​(DomainStatus domainStatus)

        The current status of the domain association.

        Parameters:
        domainStatus - The current status of the domain association.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        DomainStatus, DomainStatus

      • updateStatus

        DomainAssociation.Builder updateStatus​(String updateStatus)

        The status of the domain update operation that is currently in progress. The following list describes the valid update states.

        REQUESTING_CERTIFICATE

        The certificate is in the process of being updated.

        PENDING_VERIFICATION

        Indicates that an Amplify managed certificate is in the process of being verified. This occurs during the creation of a custom domain or when a custom domain is updated to use a managed certificate.

        IMPORTING_CUSTOM_CERTIFICATE

        Indicates that an Amplify custom certificate is in the process of being imported. This occurs during the creation of a custom domain or when a custom domain is updated to use a custom certificate.

        PENDING_DEPLOYMENT

        Indicates that the subdomain or certificate changes are being propagated.

        AWAITING_APP_CNAME

        Amplify is waiting for CNAME records corresponding to subdomains to be propagated. If your custom domain is on Route 53, Amplify handles this for you automatically. For more information about custom domains, see Setting up custom domains in the Amplify Hosting User Guide.

        UPDATE_COMPLETE

        The certificate has been associated with a domain.

        UPDATE_FAILED

        The certificate has failed to be provisioned or associated, and there is no existing active certificate to roll back to.

        Parameters:
        updateStatus - The status of the domain update operation that is currently in progress. The following list describes the valid update states.

        REQUESTING_CERTIFICATE

        The certificate is in the process of being updated.

        PENDING_VERIFICATION

        Indicates that an Amplify managed certificate is in the process of being verified. This occurs during the creation of a custom domain or when a custom domain is updated to use a managed certificate.

        IMPORTING_CUSTOM_CERTIFICATE

        Indicates that an Amplify custom certificate is in the process of being imported. This occurs during the creation of a custom domain or when a custom domain is updated to use a custom certificate.

        PENDING_DEPLOYMENT

        Indicates that the subdomain or certificate changes are being propagated.

        AWAITING_APP_CNAME

        Amplify is waiting for CNAME records corresponding to subdomains to be propagated. If your custom domain is on Route 53, Amplify handles this for you automatically. For more information about custom domains, see Setting up custom domains in the Amplify Hosting User Guide.

        UPDATE_COMPLETE

        The certificate has been associated with a domain.

        UPDATE_FAILED

        The certificate has failed to be provisioned or associated, and there is no existing active certificate to roll back to.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        UpdateStatus, UpdateStatus

      • updateStatus

        DomainAssociation.Builder updateStatus​(UpdateStatus updateStatus)

        The status of the domain update operation that is currently in progress. The following list describes the valid update states.

        REQUESTING_CERTIFICATE

        The certificate is in the process of being updated.

        PENDING_VERIFICATION

        Indicates that an Amplify managed certificate is in the process of being verified. This occurs during the creation of a custom domain or when a custom domain is updated to use a managed certificate.

        IMPORTING_CUSTOM_CERTIFICATE

        Indicates that an Amplify custom certificate is in the process of being imported. This occurs during the creation of a custom domain or when a custom domain is updated to use a custom certificate.

        PENDING_DEPLOYMENT

        Indicates that the subdomain or certificate changes are being propagated.

        AWAITING_APP_CNAME

        Amplify is waiting for CNAME records corresponding to subdomains to be propagated. If your custom domain is on Route 53, Amplify handles this for you automatically. For more information about custom domains, see Setting up custom domains in the Amplify Hosting User Guide.

        UPDATE_COMPLETE

        The certificate has been associated with a domain.

        UPDATE_FAILED

        The certificate has failed to be provisioned or associated, and there is no existing active certificate to roll back to.

        Parameters:
        updateStatus - The status of the domain update operation that is currently in progress. The following list describes the valid update states.

        REQUESTING_CERTIFICATE

        The certificate is in the process of being updated.

        PENDING_VERIFICATION

        Indicates that an Amplify managed certificate is in the process of being verified. This occurs during the creation of a custom domain or when a custom domain is updated to use a managed certificate.

        IMPORTING_CUSTOM_CERTIFICATE

        Indicates that an Amplify custom certificate is in the process of being imported. This occurs during the creation of a custom domain or when a custom domain is updated to use a custom certificate.

        PENDING_DEPLOYMENT

        Indicates that the subdomain or certificate changes are being propagated.

        AWAITING_APP_CNAME

        Amplify is waiting for CNAME records corresponding to subdomains to be propagated. If your custom domain is on Route 53, Amplify handles this for you automatically. For more information about custom domains, see Setting up custom domains in the Amplify Hosting User Guide.

        UPDATE_COMPLETE

        The certificate has been associated with a domain.

        UPDATE_FAILED

        The certificate has failed to be provisioned or associated, and there is no existing active certificate to roll back to.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        UpdateStatus, UpdateStatus

      • statusReason

        DomainAssociation.Builder statusReason​(String statusReason)

        Additional information that describes why the domain association is in the current state.

        Parameters:
        statusReason - Additional information that describes why the domain association is in the current state.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • certificateVerificationDNSRecord

        DomainAssociation.Builder certificateVerificationDNSRecord​(String certificateVerificationDNSRecord)

        The DNS record for certificate verification.

        Parameters:
        certificateVerificationDNSRecord - The DNS record for certificate verification.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • subDomains

        DomainAssociation.Builder subDomains​(Collection<SubDomain> subDomains)

        The subdomains for the domain association.

        Parameters:
        subDomains - The subdomains for the domain association.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • subDomains

        DomainAssociation.Builder subDomains​(SubDomain... subDomains)

        The subdomains for the domain association.

        Parameters:
        subDomains - The subdomains for the domain association.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • certificate

        DomainAssociation.Builder certificate​(Certificate certificate)

        Describes the SSL/TLS certificate for the domain association. This can be your own custom certificate or the default certificate that Amplify provisions for you.

        If you are updating your domain to use a different certificate, certificate points to the new certificate that is being created instead of the current active certificate. Otherwise, certificate points to the current active certificate.

        Parameters:
        certificate - Describes the SSL/TLS certificate for the domain association. This can be your own custom certificate or the default certificate that Amplify provisions for you.

        If you are updating your domain to use a different certificate, certificate points to the new certificate that is being created instead of the current active certificate. Otherwise, certificate points to the current active certificate.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • certificate

        default DomainAssociation.Builder certificate​(Consumer<Certificate.Builder> certificate)

        Describes the SSL/TLS certificate for the domain association. This can be your own custom certificate or the default certificate that Amplify provisions for you.

        If you are updating your domain to use a different certificate, certificate points to the new certificate that is being created instead of the current active certificate. Otherwise, certificate points to the current active certificate.

        This is a convenience method that creates an instance of the Certificate.Builder avoiding the need to create one manually via Certificate.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to certificate(Certificate).

        Parameters:
        certificate - a consumer that will call methods on Certificate.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        certificate(Certificate)