Package software.amazon.awscdk.services.amplifyuibuilder

Class CfnForm.Builder

java.lang.Object

software.amazon.awscdk.services.amplifyuibuilder.CfnForm.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnForm>

Enclosing class:

CfnForm

@Stability(Stable)
public static final class CfnForm.Builder
extends Object
implements software.amazon.jsii.Builder<CfnForm>

A fluent builder for CfnForm.

Method Summary

Modifier and Type	Method	Description
CfnForm.Builder	appId(String appId)	The unique ID of the Amplify app associated with the form.
CfnForm	build()
static CfnForm.Builder	create(software.constructs.Construct scope, String id)
CfnForm.Builder	cta(IResolvable cta)	The FormCTA object that stores the call to action configuration for the form.
CfnForm.Builder	cta(CfnForm.FormCTAProperty cta)	The FormCTA object that stores the call to action configuration for the form.
CfnForm.Builder	dataType(IResolvable dataType)	The type of data source to use to create the form.
CfnForm.Builder	dataType(CfnForm.FormDataTypeConfigProperty dataType)	The type of data source to use to create the form.
CfnForm.Builder	environmentName(String environmentName)	The name of the backend environment that is a part of the Amplify app.
CfnForm.Builder	fields(Map<String,? extends Object> fields)	The configuration information for the form's fields.
CfnForm.Builder	fields(IResolvable fields)	The configuration information for the form's fields.
CfnForm.Builder	formActionType(String formActionType)	Specifies whether to perform a create or update action on the form.
CfnForm.Builder	labelDecorator(String labelDecorator)	Specifies an icon or decoration to display on the form.
CfnForm.Builder	name(String name)	The name of the form.
CfnForm.Builder	schemaVersion(String schemaVersion)	The schema version of the form.
CfnForm.Builder	sectionalElements(Map<String,? extends Object> sectionalElements)	The configuration information for the visual helper elements for the form.
CfnForm.Builder	sectionalElements(IResolvable sectionalElements)	The configuration information for the visual helper elements for the form.
CfnForm.Builder	style(IResolvable style)	The configuration for the form's style.
CfnForm.Builder	style(CfnForm.FormStyleProperty style)	The configuration for the form's style.
CfnForm.Builder	tags(Map<String,String> tags)	One or more key-value pairs to use when tagging the form data.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnForm.Builder create(software.constructs.Construct scope,
 String id)

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.

Returns:

a new instance of CfnForm.Builder.

appId

@Stability(Stable)
public CfnForm.Builder appId(String appId)

The unique ID of the Amplify app associated with the form.

Parameters:

appId - The unique ID of the Amplify app associated with the form. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-form.html#cfn-amplifyuibuilder-form-appid

cta

@Stability(Stable)
public CfnForm.Builder cta(IResolvable cta)

The FormCTA object that stores the call to action configuration for the form.

Parameters:

cta - The FormCTA object that stores the call to action configuration for the form. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-form.html#cfn-amplifyuibuilder-form-cta

cta

@Stability(Stable)
public CfnForm.Builder cta(CfnForm.FormCTAProperty cta)

The FormCTA object that stores the call to action configuration for the form.

Parameters:

cta - The FormCTA object that stores the call to action configuration for the form. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-form.html#cfn-amplifyuibuilder-form-cta

dataType

@Stability(Stable)
public CfnForm.Builder dataType(IResolvable dataType)

The type of data source to use to create the form.

Parameters:

dataType - The type of data source to use to create the form. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-form.html#cfn-amplifyuibuilder-form-datatype

dataType

@Stability(Stable)
public CfnForm.Builder dataType(CfnForm.FormDataTypeConfigProperty dataType)

The type of data source to use to create the form.

Parameters:

dataType - The type of data source to use to create the form. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-form.html#cfn-amplifyuibuilder-form-datatype

environmentName

@Stability(Stable)
public CfnForm.Builder environmentName(String environmentName)

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

Parameters:

environmentName - The name of the backend environment that is a part of the Amplify app. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-form.html#cfn-amplifyuibuilder-form-environmentname

fields

@Stability(Stable)
public CfnForm.Builder fields(IResolvable fields)

The configuration information for the form's fields.

Parameters:

fields - The configuration information for the form's fields. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-form.html#cfn-amplifyuibuilder-form-fields

fields

@Stability(Stable)
public CfnForm.Builder fields(Map<String,? extends Object> fields)

The configuration information for the form's fields.

Parameters:

fields - The configuration information for the form's fields. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-form.html#cfn-amplifyuibuilder-form-fields

formActionType

@Stability(Stable)
public CfnForm.Builder formActionType(String formActionType)

Specifies whether to perform a create or update action on the form.

Parameters:

formActionType - Specifies whether to perform a create or update action on the form. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-form.html#cfn-amplifyuibuilder-form-formactiontype

labelDecorator

@Stability(Stable)
public CfnForm.Builder labelDecorator(String labelDecorator)

Specifies an icon or decoration to display on the form.

Parameters:

labelDecorator - Specifies an icon or decoration to display on the form. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-form.html#cfn-amplifyuibuilder-form-labeldecorator

name

@Stability(Stable)
public CfnForm.Builder name(String name)

The name of the form.

Parameters:

name - The name of the form. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-form.html#cfn-amplifyuibuilder-form-name

schemaVersion

@Stability(Stable)
public CfnForm.Builder schemaVersion(String schemaVersion)

The schema version of the form.

Parameters:

schemaVersion - The schema version of the form. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-form.html#cfn-amplifyuibuilder-form-schemaversion

sectionalElements

@Stability(Stable)
public CfnForm.Builder sectionalElements(IResolvable sectionalElements)

The configuration information for the visual helper elements for the form.

These elements are not associated with any data.

Parameters:

sectionalElements - The configuration information for the visual helper elements for the form. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-form.html#cfn-amplifyuibuilder-form-sectionalelements

sectionalElements

@Stability(Stable)
public CfnForm.Builder sectionalElements(Map<String,? extends Object> sectionalElements)

The configuration information for the visual helper elements for the form.

These elements are not associated with any data.

Parameters:

sectionalElements - The configuration information for the visual helper elements for the form. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-form.html#cfn-amplifyuibuilder-form-sectionalelements

style

@Stability(Stable)
public CfnForm.Builder style(IResolvable style)

The configuration for the form's style.

Parameters:

style - The configuration for the form's style. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-form.html#cfn-amplifyuibuilder-form-style

style

@Stability(Stable)
public CfnForm.Builder style(CfnForm.FormStyleProperty style)

The configuration for the form's style.

Parameters:

style - The configuration for the form's style. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-form.html#cfn-amplifyuibuilder-form-style

tags

@Stability(Stable)
public CfnForm.Builder tags(Map<String,String> tags)

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

Parameters:

tags - One or more key-value pairs to use when tagging the form data. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-form.html#cfn-amplifyuibuilder-form-tags

build

@Stability(Stable)
public CfnForm build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnForm>

Returns:

a newly built instance of CfnForm.