software.amazon.awscdk.services.amplifyuibuilder

Class CfnTheme

java.lang.Object

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

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:35.290Z")
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();
 

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 interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnTheme(Construct scope, java.lang.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
java.lang.String	getAppId() The unique ID for the Amplify app associated with the theme.
java.lang.String	getAttrId() The ID for the theme.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getEnvironmentName() The name of the backend environment that is a part of the Amplify app.
java.lang.String	getName() The name of the theme.
java.lang.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.
java.lang.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 java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setAppId(java.lang.String value) The unique ID for the Amplify app associated with the theme.
void	setEnvironmentName(java.lang.String value) The name of the backend environment that is a part of the Amplify app.
void	setName(java.lang.String value) The name of the theme.
void	setOverrides(IResolvable value) Describes the properties that can be overriden to customize a theme.
void	setOverrides(java.util.List<java.lang.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(java.util.List<java.lang.Object> value) A list of key-value pairs that defines the properties of the theme.

Methods inherited from class software.amazon.awscdk.core.CfnResource

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

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.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

public CfnTheme(Construct scope,
                java.lang.String id,
                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

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrId

public java.lang.String getAttrId()

The ID for the theme.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

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

getName

public java.lang.String getName()

The name of the theme.

setName

public void setName(java.lang.String value)

The name of the theme.

getValues

public java.lang.Object getValues()

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

setValues

public void setValues(IResolvable value)

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

setValues

public void setValues(java.util.List<java.lang.Object> value)

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

getAppId

public java.lang.String getAppId()

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

setAppId

public void setAppId(java.lang.String value)

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

getEnvironmentName

public java.lang.String getEnvironmentName()

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

setEnvironmentName

public void setEnvironmentName(java.lang.String value)

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

getOverrides

public java.lang.Object getOverrides()

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

setOverrides

public void setOverrides(IResolvable value)

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

setOverrides

public void setOverrides(java.util.List<java.lang.Object> value)

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