Class CfnAppProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnAppProps>
- Enclosing interface:
CfnAppProps
CfnAppProps
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionappSource
(IResolvable appSource) Sets the value ofCfnAppProps.getAppSource()
appSource
(CfnApp.SourceProperty appSource) Sets the value ofCfnAppProps.getAppSource()
attributes
(Map<String, String> attributes) Sets the value ofCfnAppProps.getAttributes()
attributes
(IResolvable attributes) Sets the value ofCfnAppProps.getAttributes()
build()
Builds the configured instance.dataSources
(List<? extends Object> dataSources) Sets the value ofCfnAppProps.getDataSources()
dataSources
(IResolvable dataSources) Sets the value ofCfnAppProps.getDataSources()
description
(String description) Sets the value ofCfnAppProps.getDescription()
Sets the value ofCfnAppProps.getDomains()
Sets the value ofCfnAppProps.getEnableSsl()
enableSsl
(IResolvable enableSsl) Sets the value ofCfnAppProps.getEnableSsl()
environment
(List<? extends Object> environment) Sets the value ofCfnAppProps.getEnvironment()
environment
(IResolvable environment) Sets the value ofCfnAppProps.getEnvironment()
Sets the value ofCfnAppProps.getName()
Sets the value ofCfnAppProps.getShortname()
sslConfiguration
(IResolvable sslConfiguration) Sets the value ofCfnAppProps.getSslConfiguration()
sslConfiguration
(CfnApp.SslConfigurationProperty sslConfiguration) Sets the value ofCfnAppProps.getSslConfiguration()
Sets the value ofCfnAppProps.getStackId()
Sets the value ofCfnAppProps.getType()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
name
Sets the value ofCfnAppProps.getName()
- Parameters:
name
- The app name. This parameter is required.- Returns:
this
-
stackId
Sets the value ofCfnAppProps.getStackId()
- Parameters:
stackId
- The stack ID. This parameter is required.- Returns:
this
-
type
Sets the value ofCfnAppProps.getType()
- Parameters:
type
- The app type. This parameter is required. 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, specifyother
.- Returns:
this
-
appSource
Sets the value ofCfnAppProps.getAppSource()
- Parameters:
appSource
- ASource
object that specifies the app repository.- Returns:
this
-
appSource
Sets the value ofCfnAppProps.getAppSource()
- Parameters:
appSource
- ASource
object that specifies the app repository.- Returns:
this
-
attributes
Sets the value ofCfnAppProps.getAttributes()
- Parameters:
attributes
- One or more user-defined key/value pairs to be added to the stack attributes.- Returns:
this
-
attributes
Sets the value ofCfnAppProps.getAttributes()
- Parameters:
attributes
- One or more user-defined key/value pairs to be added to the stack attributes.- Returns:
this
-
dataSources
Sets the value ofCfnAppProps.getDataSources()
- Parameters:
dataSources
- The app's data source.- Returns:
this
-
dataSources
Sets the value ofCfnAppProps.getDataSources()
- Parameters:
dataSources
- The app's data source.- Returns:
this
-
description
Sets the value ofCfnAppProps.getDescription()
- Parameters:
description
- A description of the app.- Returns:
this
-
domains
Sets the value ofCfnAppProps.getDomains()
- Parameters:
domains
- The app virtual host settings, with multiple domains separated by commas. For example:'www.example.com, example.com'
- Returns:
this
-
enableSsl
Sets the value ofCfnAppProps.getEnableSsl()
- Parameters:
enableSsl
- Whether to enable SSL for the app.- Returns:
this
-
enableSsl
Sets the value ofCfnAppProps.getEnableSsl()
- Parameters:
enableSsl
- Whether to enable SSL for the app.- Returns:
this
-
environment
Sets the value ofCfnAppProps.getEnvironment()
- Parameters:
environment
- An array ofEnvironmentVariable
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.
- Returns:
this
-
environment
Sets the value ofCfnAppProps.getEnvironment()
- Parameters:
environment
- An array ofEnvironmentVariable
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.
- Returns:
this
-
shortname
Sets the value ofCfnAppProps.getShortname()
- Parameters:
shortname
- The app's short name.- Returns:
this
-
sslConfiguration
Sets the value ofCfnAppProps.getSslConfiguration()
- Parameters:
sslConfiguration
- AnSslConfiguration
object with the SSL configuration.- Returns:
this
-
sslConfiguration
@Stability(Stable) public CfnAppProps.Builder sslConfiguration(CfnApp.SslConfigurationProperty sslConfiguration) Sets the value ofCfnAppProps.getSslConfiguration()
- Parameters:
sslConfiguration
- AnSslConfiguration
object with the SSL configuration.- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnAppProps>
- Returns:
- a new instance of
CfnAppProps
- Throws:
NullPointerException
- if any required attribute was not provided
-