Interface App.Builder
-
- All Superinterfaces:
Buildable,CopyableBuilder<App.Builder,App>,SdkBuilder<App.Builder,App>,SdkPojo
- Enclosing class:
- App
public static interface App.Builder extends SdkPojo, CopyableBuilder<App.Builder,App>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description App.BuilderappId(String appId)The app ID.default App.BuilderappSource(Consumer<Source.Builder> appSource)ASourceobject that describes the app repository.App.BuilderappSource(Source appSource)ASourceobject that describes the app repository.App.Builderattributes(Map<AppAttributesKeys,String> attributes)The stack attributes.App.BuilderattributesWithStrings(Map<String,String> attributes)The stack attributes.App.BuildercreatedAt(String createdAt)When the app was created.App.BuilderdataSources(Collection<DataSource> dataSources)The app's data sources.App.BuilderdataSources(Consumer<DataSource.Builder>... dataSources)The app's data sources.App.BuilderdataSources(DataSource... dataSources)The app's data sources.App.Builderdescription(String description)A description of the app.App.Builderdomains(String... domains)The app vhost settings with multiple domains separated by commas.App.Builderdomains(Collection<String> domains)The app vhost settings with multiple domains separated by commas.App.BuilderenableSsl(Boolean enableSsl)Whether to enable SSL for the app.App.Builderenvironment(Collection<EnvironmentVariable> environment)An array ofEnvironmentVariableobjects that specify environment variables to be associated with the app.App.Builderenvironment(Consumer<EnvironmentVariable.Builder>... environment)An array ofEnvironmentVariableobjects that specify environment variables to be associated with the app.App.Builderenvironment(EnvironmentVariable... environment)An array ofEnvironmentVariableobjects that specify environment variables to be associated with the app.App.Buildername(String name)The app name.App.Buildershortname(String shortname)The app's short name.default App.BuildersslConfiguration(Consumer<SslConfiguration.Builder> sslConfiguration)AnSslConfigurationobject with the SSL configuration.App.BuildersslConfiguration(SslConfiguration sslConfiguration)AnSslConfigurationobject with the SSL configuration.App.BuilderstackId(String stackId)The app stack ID.App.Buildertype(String type)The app type.App.Buildertype(AppType 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 Detail
-
appId
App.Builder appId(String 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
App.Builder stackId(String 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
App.Builder shortname(String 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
App.Builder name(String 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
App.Builder description(String 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
App.Builder dataSources(Collection<DataSource> 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
App.Builder dataSources(DataSource... 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
App.Builder dataSources(Consumer<DataSource.Builder>... dataSources)
The app's data sources.
This is a convenience method that creates an instance of theDataSource.Builderavoiding the need to create one manually viaDataSource.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed to#dataSources(List.) - 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:
#dataSources(java.util.Collection)
-
type
App.Builder type(String type)
The app type.
-
type
App.Builder type(AppType type)
The app type.
-
appSource
App.Builder appSource(Source appSource)
A
Sourceobject that describes the app repository.- Parameters:
appSource- ASourceobject that describes the app repository.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
appSource
default App.Builder appSource(Consumer<Source.Builder> appSource)
A
This is a convenience method that creates an instance of theSourceobject that describes the app repository.Source.Builderavoiding the need to create one manually viaSource.builder().When the
Consumercompletes,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:
appSource(Source)
-
domains
App.Builder domains(Collection<String> 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
App.Builder domains(String... 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
App.Builder enableSsl(Boolean 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
App.Builder sslConfiguration(SslConfiguration sslConfiguration)
An
SslConfigurationobject with the SSL configuration.- Parameters:
sslConfiguration- AnSslConfigurationobject with the SSL configuration.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sslConfiguration
default App.Builder sslConfiguration(Consumer<SslConfiguration.Builder> sslConfiguration)
An
This is a convenience method that creates an instance of theSslConfigurationobject with the SSL configuration.SslConfiguration.Builderavoiding the need to create one manually viaSslConfiguration.builder().When the
Consumercompletes,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:
sslConfiguration(SslConfiguration)
-
attributesWithStrings
App.Builder attributesWithStrings(Map<String,String> attributes)
The stack attributes.
- Parameters:
attributes- The stack attributes.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
attributes
App.Builder attributes(Map<AppAttributesKeys,String> 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
App.Builder createdAt(String 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
App.Builder environment(Collection<EnvironmentVariable> environment)
An array of
EnvironmentVariableobjects 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 ofEnvironmentVariableobjects 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
App.Builder environment(EnvironmentVariable... environment)
An array of
EnvironmentVariableobjects 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 ofEnvironmentVariableobjects 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
App.Builder environment(Consumer<EnvironmentVariable.Builder>... environment)
An array of
EnvironmentVariableobjects 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. This is a convenience method that creates an instance of theThere 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.Builderavoiding the need to create one manually viaEnvironmentVariable.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed to#environment(List.) - 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:
#environment(java.util.Collection)
-
-