Package software.amazon.awssdk.services.transfer.model

Interface DescribedCertificate.Builder

    • Method Detail

      • arn

        DescribedCertificate.Builder arn​(String arn)

        The unique Amazon Resource Name (ARN) for the certificate.

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

      • certificateId

        DescribedCertificate.Builder certificateId​(String certificateId)

        An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.

        Parameters:
        certificateId - An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • usage

        DescribedCertificate.Builder usage​(String usage)

        Specifies how this certificate is used. It can be used in the following ways:

        • SIGNING: For signing AS2 messages

        • ENCRYPTION: For encrypting AS2 messages

        • TLS: For securing AS2 communications sent over HTTPS

        Parameters:
        usage - Specifies how this certificate is used. It can be used in the following ways:

        • SIGNING: For signing AS2 messages

        • ENCRYPTION: For encrypting AS2 messages

        • TLS: For securing AS2 communications sent over HTTPS

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

      • usage

        DescribedCertificate.Builder usage​(CertificateUsageType usage)

        Specifies how this certificate is used. It can be used in the following ways:

        • SIGNING: For signing AS2 messages

        • ENCRYPTION: For encrypting AS2 messages

        • TLS: For securing AS2 communications sent over HTTPS

        Parameters:
        usage - Specifies how this certificate is used. It can be used in the following ways:

        • SIGNING: For signing AS2 messages

        • ENCRYPTION: For encrypting AS2 messages

        • TLS: For securing AS2 communications sent over HTTPS

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

      • status

        DescribedCertificate.Builder status​(String status)

        Currently, the only available status is ACTIVE: all other values are reserved for future use.

        Parameters:
        status - Currently, the only available status is ACTIVE: all other values are reserved for future use.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        CertificateStatusType, CertificateStatusType

      • certificate

        DescribedCertificate.Builder certificate​(String certificate)

        The file name for the certificate.

        Parameters:
        certificate - The file name for the certificate.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • certificateChain

        DescribedCertificate.Builder certificateChain​(String certificateChain)

        The list of certificates that make up the chain for the certificate.

        Parameters:
        certificateChain - The list of certificates that make up the chain for the certificate.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • activeDate

        DescribedCertificate.Builder activeDate​(Instant activeDate)

        An optional date that specifies when the certificate becomes active.

        Parameters:
        activeDate - An optional date that specifies when the certificate becomes active.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • inactiveDate

        DescribedCertificate.Builder inactiveDate​(Instant inactiveDate)

        An optional date that specifies when the certificate becomes inactive.

        Parameters:
        inactiveDate - An optional date that specifies when the certificate becomes inactive.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • serial

        DescribedCertificate.Builder serial​(String serial)

        The serial number for the certificate.

        Parameters:
        serial - The serial number for the certificate.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • notBeforeDate

        DescribedCertificate.Builder notBeforeDate​(Instant notBeforeDate)

        The earliest date that the certificate is valid.

        Parameters:
        notBeforeDate - The earliest date that the certificate is valid.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • notAfterDate

        DescribedCertificate.Builder notAfterDate​(Instant notAfterDate)

        The final date that the certificate is valid.

        Parameters:
        notAfterDate - The final date that the certificate is valid.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • type

        DescribedCertificate.Builder type​(String type)

        If a private key has been specified for the certificate, its type is CERTIFICATE_WITH_PRIVATE_KEY. If there is no private key, the type is CERTIFICATE.

        Parameters:
        type - If a private key has been specified for the certificate, its type is CERTIFICATE_WITH_PRIVATE_KEY. If there is no private key, the type is CERTIFICATE.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        CertificateType, CertificateType

      • type

        DescribedCertificate.Builder type​(CertificateType type)

        If a private key has been specified for the certificate, its type is CERTIFICATE_WITH_PRIVATE_KEY. If there is no private key, the type is CERTIFICATE.

        Parameters:
        type - If a private key has been specified for the certificate, its type is CERTIFICATE_WITH_PRIVATE_KEY. If there is no private key, the type is CERTIFICATE.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        CertificateType, CertificateType

      • description

        DescribedCertificate.Builder description​(String description)

        The name or description that's used to identity the certificate.

        Parameters:
        description - The name or description that's used to identity the certificate.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        DescribedCertificate.Builder tags​(Collection<Tag> tags)

        Key-value pairs that can be used to group and search for certificates.

        Parameters:
        tags - Key-value pairs that can be used to group and search for certificates.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        DescribedCertificate.Builder tags​(Tag... tags)

        Key-value pairs that can be used to group and search for certificates.

        Parameters:
        tags - Key-value pairs that can be used to group and search for certificates.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        DescribedCertificate.Builder tags​(Consumer<Tag.Builder>... tags)

        Key-value pairs that can be used to group and search for certificates.

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

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

        Parameters:
        tags - a consumer that will call methods on Tag.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #tags(java.util.Collection)