Package software.amazon.awscdk.services.amplifyuibuilder

Class CfnTheme

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.amplifyuibuilder.CfnTheme
All Implemented Interfaces:
IInspectable, IThemeRef, IEnvironmentAware, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-05T22:26:27.555Z") @Stability(Stable) public class CfnTheme extends CfnResource implements IInspectable, IThemeRef, ITaggable
The AWS::AmplifyUIBuilder::Theme resource specifies a theme within an Amplify app.

A theme is a collection of style settings that apply globally to the components associated with the app.

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.amplifyuibuilder.*;
 ThemeValuesProperty themeValuesProperty_;
 CfnTheme cfnTheme = CfnTheme.Builder.create(this, "MyCfnTheme")
         .appId("appId")
         .environmentName("environmentName")
         .name("name")
         .overrides(List.of(ThemeValuesProperty.builder()
                 .key("key")
                 .value(ThemeValueProperty.builder()
                         .children(List.of(themeValuesProperty_))
                         .value("value")
                         .build())
                 .build()))
         .tags(Map.of(
                 "tagsKey", "tags"))
         .values(List.of(ThemeValuesProperty.builder()
                 .key("key")
                 .value(ThemeValueProperty.builder()
                         .children(List.of(themeValuesProperty_))
                         .value("value")
                         .build())
                 .build()))
         .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

    • CfnTheme

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

    • CfnTheme

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

    • CfnTheme

      @Stability(Stable) public CfnTheme(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnThemeProps props)
      Create a new AWS::AmplifyUIBuilder::Theme.

      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.

    • CfnTheme

      @Stability(Stable) public CfnTheme(@NotNull software.constructs.Construct scope, @NotNull String id)
      Create a new AWS::AmplifyUIBuilder::Theme.

      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.

  • Method Details

    • isCfnTheme

      @Stability(Stable) @NotNull public static Boolean isCfnTheme(@NotNull Object x)
      Checks whether the given object is a CfnTheme.

      Parameters:
      x - This parameter is required.

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

    • getAttrCreatedAt

      @Stability(Stable) @NotNull public String getAttrCreatedAt()
      The time that the theme was created.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The ID for the theme.

    • getAttrModifiedAt

      @Stability(Stable) @NotNull public String getAttrModifiedAt()
      The time that the theme was modified.

    • getCfnProperties

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

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getThemeRef

      @Stability(Stable) @NotNull public ThemeReference getThemeRef()
      A reference to a Theme resource.
      Specified by:
      getThemeRef in interface IThemeRef

    • getAppId

      @Stability(Stable) @Nullable public String getAppId()
      The unique ID for the Amplify app associated with the theme.

    • setAppId

      @Stability(Stable) public void setAppId(@Nullable String value)
      The unique ID for the Amplify app associated with the theme.

    • getEnvironmentName

      @Stability(Stable) @Nullable public String getEnvironmentName()
      The name of the backend environment that is a part of the Amplify app.

    • setEnvironmentName

      @Stability(Stable) public void setEnvironmentName(@Nullable String value)
      The name of the backend environment that is a part of the Amplify app.

    • getName

      @Stability(Stable) @Nullable public String getName()
      The name of the theme.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      The name of the theme.

    • getOverrides

      @Stability(Stable) @Nullable public Object getOverrides()
      Describes the properties that can be overriden to customize a theme.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnTheme.ThemeValuesProperty>

    • setOverrides

      @Stability(Stable) public void setOverrides(@Nullable IResolvable value)
      Describes the properties that can be overriden to customize a theme.

    • setOverrides

      @Stability(Stable) public void setOverrides(@Nullable List<Object> value)
      Describes the properties that can be overriden to customize a theme.

    • getTagsRaw

      @Stability(Stable) @Nullable public Map<String,String> getTagsRaw()
      One or more key-value pairs to use when tagging the theme.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable Map<String,String> value)
      One or more key-value pairs to use when tagging the theme.

    • getValues

      @Stability(Stable) @Nullable public Object getValues()
      A list of key-value pairs that defines the properties of the theme.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnTheme.ThemeValuesProperty>

    • setValues

      @Stability(Stable) public void setValues(@Nullable IResolvable value)
      A list of key-value pairs that defines the properties of the theme.

    • setValues

      @Stability(Stable) public void setValues(@Nullable List<Object> value)
      A list of key-value pairs that defines the properties of the theme.