1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. cognito
  5. getTerms

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.59.0
published on Monday, Mar 30, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

aws-native.cognito.getTerms

aws-native logo

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.59.0
published on Monday, Mar 30, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

    Resource Type definition for AWS::Cognito::Terms

    Using getTerms

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getTerms(args: GetTermsArgs, opts?: InvokeOptions): Promise<GetTermsResult>
function getTermsOutput(args: GetTermsOutputArgs, opts?: InvokeOptions): Output<GetTermsResult>
    def get_terms(terms_id: Optional[str] = None,
              user_pool_id: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetTermsResult
def get_terms_output(terms_id: Optional[pulumi.Input[str]] = None,
              user_pool_id: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetTermsResult]
    func LookupTerms(ctx *Context, args *LookupTermsArgs, opts ...InvokeOption) (*LookupTermsResult, error)
func LookupTermsOutput(ctx *Context, args *LookupTermsOutputArgs, opts ...InvokeOption) LookupTermsResultOutput

    > Note: This function is named LookupTerms in the Go SDK.

    public static class GetTerms 
{
    public static Task<GetTermsResult> InvokeAsync(GetTermsArgs args, InvokeOptions? opts = null)
    public static Output<GetTermsResult> Invoke(GetTermsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetTermsResult> getTerms(GetTermsArgs args, InvokeOptions options)
public static Output<GetTermsResult> getTerms(GetTermsArgs args, InvokeOptions options)

    fn::invoke:
  function: aws-native:cognito:getTerms
  arguments:
    # arguments dictionary

    The following arguments are supported:

    TermsId string
    The ID of the terms documents.
    UserPoolId string
    The ID of the user pool that contains the terms documents.
    TermsId string
    The ID of the terms documents.
    UserPoolId string
    The ID of the user pool that contains the terms documents.
    termsId String
    The ID of the terms documents.
    userPoolId String
    The ID of the user pool that contains the terms documents.
    termsId string
    The ID of the terms documents.
    userPoolId string
    The ID of the user pool that contains the terms documents.
    terms_id str
    The ID of the terms documents.
    user_pool_id str
    The ID of the user pool that contains the terms documents.
    termsId String
    The ID of the terms documents.
    userPoolId String
    The ID of the user pool that contains the terms documents.

    getTerms Result

    The following output properties are available:

    Enforcement Pulumi.AwsNative.Cognito.TermsEnforcementType
    This parameter is reserved for future use and currently accepts one value.
    Links Dictionary<string, string>

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

    TermsId string
    The ID of the terms documents.
    TermsName string
    The type and friendly name of the terms documents.
    TermsSource Pulumi.AwsNative.Cognito.TermsSourceType
    This parameter is reserved for future use and currently accepts one value.
    Enforcement TermsEnforcementType
    This parameter is reserved for future use and currently accepts one value.
    Links map[string]string

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

    TermsId string
    The ID of the terms documents.
    TermsName string
    The type and friendly name of the terms documents.
    TermsSource TermsSourceType
    This parameter is reserved for future use and currently accepts one value.
    enforcement TermsEnforcementType
    This parameter is reserved for future use and currently accepts one value.
    links Map<String,String>

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

    termsId String
    The ID of the terms documents.
    termsName String
    The type and friendly name of the terms documents.
    termsSource TermsSourceType
    This parameter is reserved for future use and currently accepts one value.
    enforcement TermsEnforcementType
    This parameter is reserved for future use and currently accepts one value.
    links {[key: string]: string}

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

    termsId string
    The ID of the terms documents.
    termsName string
    The type and friendly name of the terms documents.
    termsSource TermsSourceType
    This parameter is reserved for future use and currently accepts one value.
    enforcement TermsEnforcementType
    This parameter is reserved for future use and currently accepts one value.
    links Mapping[str, str]

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

    terms_id str
    The ID of the terms documents.
    terms_name str
    The type and friendly name of the terms documents.
    terms_source TermsSourceType
    This parameter is reserved for future use and currently accepts one value.
    enforcement "NONE"
    This parameter is reserved for future use and currently accepts one value.
    links Map<String>

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

    termsId String
    The ID of the terms documents.
    termsName String
    The type and friendly name of the terms documents.
    termsSource "LINK"
    This parameter is reserved for future use and currently accepts one value.

    Supporting Types

    TermsEnforcementType

    TermsSourceType

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    Viewing docs for AWS Cloud Control v1.59.0
    published on Monday, Mar 30, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws-native
      Try Pulumi Cloud free. Your team will thank you.