Package software.amazon.awscdk.services.amplifyuibuilder

Class CfnTheme

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.amplifyuibuilder.CfnTheme
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:55.443Z") @Stability(Stable) public class CfnTheme extends CfnResource implements IInspectable
A CloudFormation AWS::AmplifyUIBuilder::Theme.

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")
         .name("name")
         .values(List.of(ThemeValuesProperty.builder()
                 .key("key")
                 .value(ThemeValueProperty.builder()
                         .children(List.of(themeValuesProperty_))
                         .value("value")
                         .build())
                 .build()))
         // the properties below are optional
         .appId("appId")
         .environmentName("environmentName")
         .overrides(List.of(ThemeValuesProperty.builder()
                 .key("key")
                 .value(ThemeValueProperty.builder()
                         .children(List.of(themeValuesProperty_))
                         .value("value")
                         .build())
                 .build()))
         .tags(Map.of(
                 "tagsKey", "tags"))
         .build();

  • 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 Construct scope, @NotNull String id, @NotNull CfnThemeProps props)
      Create a new AWS::AmplifyUIBuilder::Theme.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      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.

    • getAttrId

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

    • getCfnProperties

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

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      One or more key-value pairs to use when tagging the theme.

    • getName

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

    • setName

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

    • getValues

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

    • setValues

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

    • setValues

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

    • getAppId

      @Stability(Stable) @Nullable public String getAppId()
      AWS::AmplifyUIBuilder::Theme.AppId.

    • setAppId

      @Stability(Stable) public void setAppId(@Nullable String value)
      AWS::AmplifyUIBuilder::Theme.AppId.

    • getEnvironmentName

      @Stability(Stable) @Nullable public String getEnvironmentName()
      AWS::AmplifyUIBuilder::Theme.EnvironmentName.

    • setEnvironmentName

      @Stability(Stable) public void setEnvironmentName(@Nullable String value)
      AWS::AmplifyUIBuilder::Theme.EnvironmentName.

    • getOverrides

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

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