Package software.amazon.awscdk.services.opsworks

Class CfnApp.Builder

java.lang.Object

software.amazon.awscdk.services.opsworks.CfnApp.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnApp>

Enclosing class:

CfnApp

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

A fluent builder for CfnApp.

Method Summary

Modifier and Type	Method	Description
CfnApp.Builder	appSource(IResolvable appSource)	A Source object that specifies the app repository.
CfnApp.Builder	appSource(CfnApp.SourceProperty appSource)	A Source object that specifies the app repository.
CfnApp.Builder	attributes(Map<String,String> attributes)	One or more user-defined key/value pairs to be added to the stack attributes.
CfnApp.Builder	attributes(IResolvable attributes)	One or more user-defined key/value pairs to be added to the stack attributes.
CfnApp	build()
static CfnApp.Builder	create(software.constructs.Construct scope, String id)
CfnApp.Builder	dataSources(List<? extends Object> dataSources)	The app's data source.
CfnApp.Builder	dataSources(IResolvable dataSources)	The app's data source.
CfnApp.Builder	description(String description)	A description of the app.
CfnApp.Builder	domains(List<String> domains)	The app virtual host settings, with multiple domains separated by commas.
CfnApp.Builder	enableSsl(Boolean enableSsl)	Whether to enable SSL for the app.
CfnApp.Builder	enableSsl(IResolvable enableSsl)	Whether to enable SSL for the app.
CfnApp.Builder	environment(List<? extends Object> environment)	An array of EnvironmentVariable objects that specify environment variables to be associated with the app.
CfnApp.Builder	environment(IResolvable environment)	An array of EnvironmentVariable objects that specify environment variables to be associated with the app.
CfnApp.Builder	name(String name)	The app name.
CfnApp.Builder	shortname(String shortname)	The app's short name.
CfnApp.Builder	sslConfiguration(IResolvable sslConfiguration)	An SslConfiguration object with the SSL configuration.
CfnApp.Builder	sslConfiguration(CfnApp.SslConfigurationProperty sslConfiguration)	An SslConfiguration object with the SSL configuration.
CfnApp.Builder	stackId(String stackId)	The stack ID.
CfnApp.Builder	type(String type)	The app type.

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 CfnApp.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 CfnApp.Builder.

name

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

The app name.

Parameters:

name - The app name. This parameter is required.

Returns:

this

See Also:

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

stackId

@Stability(Stable)
public CfnApp.Builder stackId(String stackId)

The stack ID.

Parameters:

stackId - The stack ID. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-stackid

type

@Stability(Stable)
public CfnApp.Builder type(String type)

The app type.

Each supported type is associated with a particular layer. For example, PHP applications are associated with a PHP layer. AWS OpsWorks Stacks deploys an application to those instances that are members of the corresponding layer. If your app isn't one of the standard types, or you prefer to implement your own Deploy recipes, specify other .

Parameters:

type - The app type. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-type

appSource

@Stability(Stable)
public CfnApp.Builder appSource(IResolvable appSource)

A Source object that specifies the app repository.

Parameters:

appSource - A Source object that specifies the app repository. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-appsource

appSource

@Stability(Stable)
public CfnApp.Builder appSource(CfnApp.SourceProperty appSource)

A Source object that specifies the app repository.

Parameters:

appSource - A Source object that specifies the app repository. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-appsource

attributes

@Stability(Stable)
public CfnApp.Builder attributes(IResolvable attributes)

One or more user-defined key/value pairs to be added to the stack attributes.

Parameters:

attributes - One or more user-defined key/value pairs to be added to the stack attributes. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-attributes

attributes

@Stability(Stable)
public CfnApp.Builder attributes(Map<String,String> attributes)

One or more user-defined key/value pairs to be added to the stack attributes.

Parameters:

attributes - One or more user-defined key/value pairs to be added to the stack attributes. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-attributes

dataSources

@Stability(Stable)
public CfnApp.Builder dataSources(IResolvable dataSources)

The app's data source.

Parameters:

dataSources - The app's data source. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-datasources

dataSources

@Stability(Stable)
public CfnApp.Builder dataSources(List<? extends Object> dataSources)

The app's data source.

Parameters:

dataSources - The app's data source. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-datasources

description

@Stability(Stable)
public CfnApp.Builder description(String description)

A description of the app.

Parameters:

description - A description of the app. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-description

domains

@Stability(Stable)
public CfnApp.Builder domains(List<String> domains)

The app virtual host settings, with multiple domains separated by commas.

For example: 'www.example.com, example.com'

Parameters:

domains - The app virtual host settings, with multiple domains separated by commas. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-domains

enableSsl

@Stability(Stable)
public CfnApp.Builder enableSsl(Boolean enableSsl)

Whether to enable SSL for the app.

Parameters:

enableSsl - Whether to enable SSL for the app. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-enablessl

enableSsl

@Stability(Stable)
public CfnApp.Builder enableSsl(IResolvable enableSsl)

Whether to enable SSL for the app.

Parameters:

enableSsl - Whether to enable SSL for the app. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-enablessl

environment

@Stability(Stable)
public CfnApp.Builder environment(IResolvable environment)

An array of EnvironmentVariable objects that specify environment variables to be associated with the app.

After you deploy the app, these variables are defined on the associated app server instance. For more information, see Environment Variables .

There is no specific limit on the number of environment variables. However, the size of the associated data structure - which includes the variables' names, values, and protected flag values - cannot exceed 20 KB. This limit should accommodate most if not all use cases. Exceeding it will cause an exception with the message, "Environment: is too large (maximum is 20KB)."

If you have specified one or more environment variables, you cannot modify the stack's Chef version.

Parameters:

environment - An array of EnvironmentVariable objects that specify environment variables to be associated with the app. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-environment

environment

@Stability(Stable)
public CfnApp.Builder environment(List<? extends Object> environment)

An array of EnvironmentVariable objects that specify environment variables to be associated with the app.

After you deploy the app, these variables are defined on the associated app server instance. For more information, see Environment Variables .

There is no specific limit on the number of environment variables. However, the size of the associated data structure - which includes the variables' names, values, and protected flag values - cannot exceed 20 KB. This limit should accommodate most if not all use cases. Exceeding it will cause an exception with the message, "Environment: is too large (maximum is 20KB)."

If you have specified one or more environment variables, you cannot modify the stack's Chef version.

Parameters:

environment - An array of EnvironmentVariable objects that specify environment variables to be associated with the app. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-environment

shortname

@Stability(Stable)
public CfnApp.Builder shortname(String shortname)

The app's short name.

Parameters:

shortname - The app's short name. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-shortname

sslConfiguration

@Stability(Stable)
public CfnApp.Builder sslConfiguration(IResolvable sslConfiguration)

An SslConfiguration object with the SSL configuration.

Parameters:

sslConfiguration - An SslConfiguration object with the SSL configuration. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-sslconfiguration

sslConfiguration

@Stability(Stable)
public CfnApp.Builder sslConfiguration(CfnApp.SslConfigurationProperty sslConfiguration)

An SslConfiguration object with the SSL configuration.

Parameters:

sslConfiguration - An SslConfiguration object with the SSL configuration. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-sslconfiguration

build

@Stability(Stable)
public CfnApp build()

Specified by:

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

Returns:

a newly built instance of CfnApp.