Package software.amazon.awscdk.services.cognito

Class CfnTermsProps.Builder

java.lang.Object
software.amazon.awscdk.services.cognito.CfnTermsProps.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnTermsProps>
Enclosing interface:
CfnTermsProps
@Stability(Stable) public static final class CfnTermsProps.Builder extends Object implements software.amazon.jsii.Builder<CfnTermsProps>
A builder for CfnTermsProps

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • enforcement

      @Stability(Stable) public CfnTermsProps.Builder enforcement(String enforcement)
      Sets the value of CfnTermsProps.getEnforcement()
      Parameters:
      enforcement - This parameter is reserved for future use and currently accepts one value. This parameter is required.
      Returns:
      this

    • links

      @Stability(Stable) public CfnTermsProps.Builder links(Map<String,String> links)
      Sets the value of CfnTermsProps.getLinks()
      Parameters:
      links - A map of URLs to languages. This parameter is required. 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:
      this

    • links

      @Stability(Stable) public CfnTermsProps.Builder links(IResolvable links)
      Sets the value of CfnTermsProps.getLinks()
      Parameters:
      links - A map of URLs to languages. This parameter is required. 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:
      this

    • termsName

      @Stability(Stable) public CfnTermsProps.Builder termsName(String termsName)
      Sets the value of CfnTermsProps.getTermsName()
      Parameters:
      termsName - The type and friendly name of the terms documents. This parameter is required.
      Returns:
      this

    • termsSource

      @Stability(Stable) public CfnTermsProps.Builder termsSource(String termsSource)
      Sets the value of CfnTermsProps.getTermsSource()
      Parameters:
      termsSource - This parameter is reserved for future use and currently accepts one value. This parameter is required.
      Returns:
      this

    • userPoolId

      @Stability(Stable) public CfnTermsProps.Builder userPoolId(String userPoolId)
      Sets the value of CfnTermsProps.getUserPoolId()
      Parameters:
      userPoolId - The ID of the user pool that contains the terms documents. This parameter is required.
      Returns:
      this

    • clientId

      @Stability(Stable) public CfnTermsProps.Builder clientId(String clientId)
      Sets the value of CfnTermsProps.getClientId()
      Parameters:
      clientId - The ID of the app client that the terms documents are assigned to.
      Returns:
      this

    • build

      @Stability(Stable) public CfnTermsProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnTermsProps>
      Returns:
      a new instance of CfnTermsProps
      Throws:
      NullPointerException - if any required attribute was not provided