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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.056Z")
 @Stability(value=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
         .overrides(List.of(ThemeValuesProperty.builder()
                 .key("key")
                 .value(ThemeValueProperty.builder()
                         .children(List.of(themeValuesProperty_))
                         .value("value")
                         .build())
                 .build()))
         .tags(Map.of(
                 "tagsKey", "tags"))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnTheme.Builder A fluent builder for CfnTheme.
static interface	CfnTheme.ThemeValueProperty The `ThemeValue` property specifies the configuration of a theme's properties.
static interface	CfnTheme.ThemeValuesProperty The `ThemeValues` property specifies key-value pair that defines a property of a theme.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnTheme(software.constructs.Construct scope, String id, CfnThemeProps props) Create a new `AWS::AmplifyUIBuilder::Theme`.
protected	CfnTheme(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnTheme(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrAppId() The unique ID for the Amplify app associated with the theme.
String	getAttrCreatedAt() The time that the theme was created.
String	getAttrEnvironmentName() The name of the backend environment that is a part of the Amplify app.
String	getAttrId() The ID for the theme.
String	getAttrModifiedAt() The time that the theme was modified.
protected Map<String,Object>	getCfnProperties()
String	getName() The name of the theme.
Object	getOverrides() Describes the properties that can be overriden to customize a theme.
TagManager	getTags() One or more key-value pairs to use when tagging the theme.
Object	getValues() A list of key-value pairs that defines the properties of the theme.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setName(String value) The name of the theme.
void	setOverrides(IResolvable value) Describes the properties that can be overriden to customize a theme.
void	setOverrides(List<Object> value) Describes the properties that can be overriden to customize a theme.
void	setValues(IResolvable value) A list of key-value pairs that defines the properties of the theme.
void	setValues(List<Object> value) A list of key-value pairs that defines the properties of the theme.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnTheme

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

CfnTheme

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

CfnTheme

@Stability(value=Stable)
public CfnTheme(@NotNull
                                         software.constructs.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 Detail

inspect

@Stability(value=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(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrAppId

@Stability(value=Stable)
 @NotNull
public String getAttrAppId()

The unique ID for the Amplify app associated with the theme.

getAttrCreatedAt

@Stability(value=Stable)
 @NotNull
public String getAttrCreatedAt()

The time that the theme was created.

getAttrEnvironmentName

@Stability(value=Stable)
 @NotNull
public String getAttrEnvironmentName()

The name of the backend environment that is a part of the Amplify app.

getAttrId

@Stability(value=Stable)
 @NotNull
public String getAttrId()

The ID for the theme.

getAttrModifiedAt

@Stability(value=Stable)
 @NotNull
public String getAttrModifiedAt()

The time that the theme was modified.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

One or more key-value pairs to use when tagging the theme.

getName

@Stability(value=Stable)
 @NotNull
public String getName()

The name of the theme.

setName

@Stability(value=Stable)
public void setName(@NotNull
                                             String value)

The name of the theme.

getValues

@Stability(value=Stable)
 @NotNull
public Object getValues()

A list of key-value pairs that defines the properties of the theme.

setValues

@Stability(value=Stable)
public void setValues(@NotNull
                                               IResolvable value)

A list of key-value pairs that defines the properties of the theme.

setValues

@Stability(value=Stable)
public void setValues(@NotNull
                                               List<Object> value)

A list of key-value pairs that defines the properties of the theme.

getOverrides

@Stability(value=Stable)
 @Nullable
public Object getOverrides()

Describes the properties that can be overriden to customize a theme.

setOverrides

@Stability(value=Stable)
public void setOverrides(@Nullable
                                                  IResolvable value)

Describes the properties that can be overriden to customize a theme.

setOverrides

@Stability(value=Stable)
public void setOverrides(@Nullable
                                                  List<Object> value)

Describes the properties that can be overriden to customize a theme.