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

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

AWS Cloud Control v1.45.0 published on Monday, Dec 22, 2025 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

aws-native.cognito.Terms

aws-native logo

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

AWS Cloud Control v1.45.0 published on Monday, Dec 22, 2025 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

    Resource Type definition for AWS::Cognito::Terms

    Create Terms Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Terms(name: string, args: TermsArgs, opts?: CustomResourceOptions);
    @overload
def Terms(resource_name: str,
          args: TermsArgs,
          opts: Optional[ResourceOptions] = None)

@overload
def Terms(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          enforcement: Optional[TermsEnforcementType] = None,
          links: Optional[Mapping[str, str]] = None,
          terms_source: Optional[TermsSourceType] = None,
          user_pool_id: Optional[str] = None,
          client_id: Optional[str] = None,
          terms_name: Optional[str] = None)
    func NewTerms(ctx *Context, name string, args TermsArgs, opts ...ResourceOption) (*Terms, error)
    public Terms(string name, TermsArgs args, CustomResourceOptions? opts = null)
    public Terms(String name, TermsArgs args)
public Terms(String name, TermsArgs args, CustomResourceOptions options)

    type: aws-native:cognito:Terms
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args TermsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args TermsArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args TermsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TermsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TermsArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Terms Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Terms resource accepts the following input properties:

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

    TermsSource Pulumi.AwsNative.Cognito.TermsSourceType
    This parameter is reserved for future use and currently accepts one value.
    UserPoolId string
    The ID of the user pool that contains the terms documents.
    ClientId string
    The ID of the app client that the terms documents are assigned to.
    TermsName string
    The type and friendly name of the terms documents.
    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" .

    TermsSource TermsSourceType
    This parameter is reserved for future use and currently accepts one value.
    UserPoolId string
    The ID of the user pool that contains the terms documents.
    ClientId string
    The ID of the app client that the terms documents are assigned to.
    TermsName string
    The type and friendly name of the terms documents.
    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" .

    termsSource TermsSourceType
    This parameter is reserved for future use and currently accepts one value.
    userPoolId String
    The ID of the user pool that contains the terms documents.
    clientId String
    The ID of the app client that the terms documents are assigned to.
    termsName String
    The type and friendly name of the terms documents.
    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" .

    termsSource TermsSourceType
    This parameter is reserved for future use and currently accepts one value.
    userPoolId string
    The ID of the user pool that contains the terms documents.
    clientId string
    The ID of the app client that the terms documents are assigned to.
    termsName string
    The type and friendly name of the terms documents.
    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_source TermsSourceType
    This parameter is reserved for future use and currently accepts one value.
    user_pool_id str
    The ID of the user pool that contains the terms documents.
    client_id str
    The ID of the app client that the terms documents are assigned to.
    terms_name str
    The type and friendly name of the terms documents.
    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" .

    termsSource "LINK"
    This parameter is reserved for future use and currently accepts one value.
    userPoolId String
    The ID of the user pool that contains the terms documents.
    clientId String
    The ID of the app client that the terms documents are assigned to.
    termsName String
    The type and friendly name of the terms documents.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Terms resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    TermsId string
    The ID of the terms documents.
    Id string
    The provider-assigned unique ID for this managed resource.
    TermsId string
    The ID of the terms documents.
    id String
    The provider-assigned unique ID for this managed resource.
    termsId String
    The ID of the terms documents.
    id string
    The provider-assigned unique ID for this managed resource.
    termsId string
    The ID of the terms documents.
    id str
    The provider-assigned unique ID for this managed resource.
    terms_id str
    The ID of the terms documents.
    id String
    The provider-assigned unique ID for this managed resource.
    termsId String
    The ID of the terms documents.

    Supporting Types

    TermsEnforcementType, TermsEnforcementTypeArgs

    None
    NONE
    TermsEnforcementTypeNone
    NONE
    None
    NONE
    None
    NONE
    NONE
    NONE
    "NONE"
    NONE

    TermsSourceType, TermsSourceTypeArgs

    Link
    LINK
    TermsSourceTypeLink
    LINK
    Link
    LINK
    Link
    LINK
    LINK
    LINK
    "LINK"
    LINK

    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.

    AWS Cloud Control v1.45.0 published on Monday, Dec 22, 2025 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws-native
      Meet Neo: Your AI Platform Teammate