Package software.amazon.awssdk.services.cognitoidentityprovider.model

Interface TermsType.Builder

    • Method Detail

      • termsId

        TermsType.Builder termsId​(String termsId)

        The ID of the terms documents.

        Parameters:
        termsId - The ID of the terms documents.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • userPoolId

        TermsType.Builder userPoolId​(String userPoolId)

        The ID of the user pool that contains the terms documents.

        Parameters:
        userPoolId - The ID of the user pool that contains the terms documents.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • clientId

        TermsType.Builder clientId​(String clientId)

        The ID of the app client that the terms documents are assigned to.

        Parameters:
        clientId - The ID of the app client that the terms documents are assigned to.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • termsName

        TermsType.Builder termsName​(String termsName)

        The type and friendly name of the terms documents.

        Parameters:
        termsName - The type and friendly name of the terms documents.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • termsSource

        TermsType.Builder termsSource​(String termsSource)

        This parameter is reserved for future use and currently accepts one value.

        Parameters:
        termsSource - This parameter is reserved for future use and currently accepts one value.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        TermsSourceType, TermsSourceType

      • termsSource

        TermsType.Builder termsSource​(TermsSourceType termsSource)

        This parameter is reserved for future use and currently accepts one value.

        Parameters:
        termsSource - This parameter is reserved for future use and currently accepts one value.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        TermsSourceType, TermsSourceType

      • enforcement

        TermsType.Builder enforcement​(String enforcement)

        This parameter is reserved for future use and currently accepts one value.

        Parameters:
        enforcement - This parameter is reserved for future use and currently accepts one value.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        TermsEnforcementType, TermsEnforcementType

      • enforcement

        TermsType.Builder enforcement​(TermsEnforcementType enforcement)

        This parameter is reserved for future use and currently accepts one value.

        Parameters:
        enforcement - This parameter is reserved for future use and currently accepts one value.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        TermsEnforcementType, TermsEnforcementType

      • links

        TermsType.Builder links​(Map<String,​String> links)

        A map of URLs to languages. For each localized language that will view the requested TermsName, assign a URL. A selection of cognito:default displays for all languages that don't have a language-specific URL.

        For example, "cognito:default": "https://terms.example.com", "cognito:spanish": "https://terms.example.com/es" .

        Parameters:
        links - A map of URLs to languages. For each localized language that will view the requested TermsName, assign a URL. A selection of cognito:default displays for all languages that don't have a language-specific URL.

        For example, "cognito:default": "https://terms.example.com", "cognito:spanish": "https://terms.example.com/es".

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

      • creationDate

        TermsType.Builder creationDate​(Instant creationDate)

        The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.

        Parameters:
        creationDate - The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • lastModifiedDate

        TermsType.Builder lastModifiedDate​(Instant lastModifiedDate)

        The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.

        Parameters:
        lastModifiedDate - The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.