Package software.amazon.awscdk.services.cognito

Class CfnTerms

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.cognito.CfnTerms
All Implemented Interfaces:
IInspectable, ITermsRef, IEnvironmentAware, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-11-13T16:10:01.484Z") @Stability(Stable) public class CfnTerms extends CfnResource implements IInspectable, ITermsRef
Resource Type definition for AWS::Cognito::Terms.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cognito.*;
 CfnTerms cfnTerms = CfnTerms.Builder.create(this, "MyCfnTerms")
         .enforcement("enforcement")
         .links(Map.of(
                 "linksKey", "links"))
         .termsName("termsName")
         .termsSource("termsSource")
         .userPoolId("userPoolId")
         // the properties below are optional
         .clientId("clientId")
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnTerms

      protected CfnTerms(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnTerms

      protected CfnTerms(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnTerms

      @Stability(Stable) public CfnTerms(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnTermsProps props)
      Create a new AWS::Cognito::Terms.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrTermsId

      @Stability(Stable) @NotNull public String getAttrTermsId()

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTermsRef

      @Stability(Stable) @NotNull public TermsReference getTermsRef()
      A reference to a Terms resource.
      Specified by:
      getTermsRef in interface ITermsRef

    • getEnforcement

      @Stability(Stable) @NotNull public String getEnforcement()

    • setEnforcement

      @Stability(Stable) public void setEnforcement(@NotNull String value)

    • getLinks

      @Stability(Stable) @NotNull public Object getLinks()
      Returns union: either Mapinvalid input: '<'String, String> or IResolvable

    • setLinks

      @Stability(Stable) public void setLinks(@NotNull Map<String,String> value)

    • setLinks

      @Stability(Stable) public void setLinks(@NotNull IResolvable value)

    • getTermsName

      @Stability(Stable) @NotNull public String getTermsName()

    • setTermsName

      @Stability(Stable) public void setTermsName(@NotNull String value)

    • getTermsSource

      @Stability(Stable) @NotNull public String getTermsSource()

    • setTermsSource

      @Stability(Stable) public void setTermsSource(@NotNull String value)

    • getUserPoolId

      @Stability(Stable) @NotNull public String getUserPoolId()

    • setUserPoolId

      @Stability(Stable) public void setUserPoolId(@NotNull String value)

    • getClientId

      @Stability(Stable) @Nullable public String getClientId()

    • setClientId

      @Stability(Stable) public void setClientId(@Nullable String value)