Interface App.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<App.Builder,
,App> SdkBuilder<App.Builder,
,App> SdkPojo
- Enclosing class:
App
-
Method Summary
Modifier and TypeMethodDescriptionThe app ID.default App.Builder
appSource
(Consumer<Source.Builder> appSource) ASource
object that describes the app repository.ASource
object that describes the app repository.attributes
(Map<AppAttributesKeys, String> attributes) The stack attributes.attributesWithStrings
(Map<String, String> attributes) The stack attributes.When the app was created.dataSources
(Collection<DataSource> dataSources) The app's data sources.dataSources
(Consumer<DataSource.Builder>... dataSources) The app's data sources.dataSources
(DataSource... dataSources) The app's data sources.description
(String description) A description of the app.The app vhost settings with multiple domains separated by commas.domains
(Collection<String> domains) The app vhost settings with multiple domains separated by commas.Whether to enable SSL for the app.environment
(Collection<EnvironmentVariable> environment) An array ofEnvironmentVariable
objects that specify environment variables to be associated with the app.environment
(Consumer<EnvironmentVariable.Builder>... environment) An array ofEnvironmentVariable
objects that specify environment variables to be associated with the app.environment
(EnvironmentVariable... environment) An array ofEnvironmentVariable
objects that specify environment variables to be associated with the app.The app name.The app's short name.default App.Builder
sslConfiguration
(Consumer<SslConfiguration.Builder> sslConfiguration) AnSslConfiguration
object with the SSL configuration.sslConfiguration
(SslConfiguration sslConfiguration) AnSslConfiguration
object with the SSL configuration.The app stack ID.The app type.The app type.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
appId
The app ID.
- Parameters:
appId
- The app ID.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
stackId
The app stack ID.
- Parameters:
stackId
- The app stack ID.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
shortname
The app's short name.
- Parameters:
shortname
- The app's short name.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
name
The app name.
- Parameters:
name
- The app name.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
description
A description of the app.
- Parameters:
description
- A description of the app.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dataSources
The app's data sources.
- Parameters:
dataSources
- The app's data sources.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dataSources
The app's data sources.
- Parameters:
dataSources
- The app's data sources.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dataSources
The app's data sources.
This is a convenience method that creates an instance of theDataSource.Builder
avoiding the need to create one manually viaDataSource.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todataSources(List<DataSource>)
.- Parameters:
dataSources
- a consumer that will call methods onDataSource.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
type
The app type.
- Parameters:
type
- The app type.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
type
The app type.
- Parameters:
type
- The app type.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
appSource
A
Source
object that describes the app repository.- Parameters:
appSource
- ASource
object that describes the app repository.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
appSource
A
This is a convenience method that creates an instance of theSource
object that describes the app repository.Source.Builder
avoiding the need to create one manually viaSource.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toappSource(Source)
.- Parameters:
appSource
- a consumer that will call methods onSource.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
domains
The app vhost settings with multiple domains separated by commas. For example:
'www.example.com, example.com'
- Parameters:
domains
- The app vhost settings with multiple domains separated by commas. For example:'www.example.com, example.com'
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
domains
The app vhost settings with multiple domains separated by commas. For example:
'www.example.com, example.com'
- Parameters:
domains
- The app vhost settings with multiple domains separated by commas. For example:'www.example.com, example.com'
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
enableSsl
Whether to enable SSL for the app.
- Parameters:
enableSsl
- Whether to enable SSL for the app.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sslConfiguration
An
SslConfiguration
object with the SSL configuration.- Parameters:
sslConfiguration
- AnSslConfiguration
object with the SSL configuration.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sslConfiguration
An
This is a convenience method that creates an instance of theSslConfiguration
object with the SSL configuration.SslConfiguration.Builder
avoiding the need to create one manually viaSslConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosslConfiguration(SslConfiguration)
.- Parameters:
sslConfiguration
- a consumer that will call methods onSslConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
attributesWithStrings
The stack attributes.
- Parameters:
attributes
- The stack attributes.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
attributes
The stack attributes.
- Parameters:
attributes
- The stack attributes.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
createdAt
When the app was created.
- Parameters:
createdAt
- When the app was created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 instances. 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 variable names, values, and protected flag values - cannot exceed 20 KB. This limit should accommodate most if not all use cases, but if you do exceed it, you will cause an exception (API) with an "Environment: is too large (maximum is 20 KB)" message.
- 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 instances. 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 variable names, values, and protected flag values - cannot exceed 20 KB. This limit should accommodate most if not all use cases, but if you do exceed it, you will cause an exception (API) with an "Environment: is too large (maximum is 20 KB)" message.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 instances. 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 variable names, values, and protected flag values - cannot exceed 20 KB. This limit should accommodate most if not all use cases, but if you do exceed it, you will cause an exception (API) with an "Environment: is too large (maximum is 20 KB)" message.
- 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 instances. 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 variable names, values, and protected flag values - cannot exceed 20 KB. This limit should accommodate most if not all use cases, but if you do exceed it, you will cause an exception (API) with an "Environment: is too large (maximum is 20 KB)" message.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 instances. 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 variable names, values, and protected flag values - cannot exceed 20 KB. This limit should accommodate most if not all use cases, but if you do exceed it, you will cause an exception (API) with an "Environment: is too large (maximum is 20 KB)" message.
EnvironmentVariable.Builder
avoiding the need to create one manually viaEnvironmentVariable.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toenvironment(List<EnvironmentVariable>)
.- Parameters:
environment
- a consumer that will call methods onEnvironmentVariable.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-