Interface CreateTermsRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CognitoIdentityProviderRequest.Builder, CopyableBuilder<CreateTermsRequest.Builder,CreateTermsRequest>, SdkBuilder<CreateTermsRequest.Builder,CreateTermsRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateTermsRequest
@Mutable @NotThreadSafe public static interface CreateTermsRequest.Builder extends CognitoIdentityProviderRequest.Builder, SdkPojo, CopyableBuilder<CreateTermsRequest.Builder,CreateTermsRequest>

  • Method Details

    • userPoolId

      CreateTermsRequest.Builder userPoolId(String userPoolId)

      The ID of the user pool where you want to create terms documents.

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

    • clientId

      CreateTermsRequest.Builder clientId(String clientId)

      The ID of the app client where you want to create terms documents. Must be an app client in the requested user pool.

      Parameters:
      clientId - The ID of the app client where you want to create terms documents. Must be an app client in the requested user pool.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • termsName

      CreateTermsRequest.Builder termsName(String termsName)

      A friendly name for the document that you want to create in the current request. Must begin with terms-of-use or privacy-policy as identification of the document type. Provide URLs for both terms-of-use and privacy-policy in separate requests.

      Parameters:
      termsName - A friendly name for the document that you want to create in the current request. Must begin with terms-of-use or privacy-policy as identification of the document type. Provide URLs for both terms-of-use and privacy-policy in separate requests.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • termsSource

      CreateTermsRequest.Builder termsSource(String termsSource)

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

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

    • termsSource

      CreateTermsRequest.Builder termsSource(TermsSourceType termsSource)

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

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

    • enforcement

      CreateTermsRequest.Builder enforcement(String enforcement)

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

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

    • enforcement

      CreateTermsRequest.Builder enforcement(TermsEnforcementType enforcement)

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

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

    • links

      CreateTermsRequest.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.

    • overrideConfiguration

      CreateTermsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateTermsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.