Interface CreateAppRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateAppRequest.Builder,
,CreateAppRequest> OpsWorksRequest.Builder
,SdkBuilder<CreateAppRequest.Builder,
,CreateAppRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateAppRequest
-
Method Summary
Modifier and TypeMethodDescriptiondefault CreateAppRequest.Builder
appSource
(Consumer<Source.Builder> appSource) ASource
object that specifies the app repository.ASource
object that specifies the app repository.attributes
(Map<AppAttributesKeys, String> attributes) One or more user-defined key/value pairs to be added to the stack attributes.attributesWithStrings
(Map<String, String> attributes) One or more user-defined key/value pairs to be added to the stack attributes.dataSources
(Collection<DataSource> dataSources) The app's data source.dataSources
(Consumer<DataSource.Builder>... dataSources) The app's data source.dataSources
(DataSource... dataSources) The app's data source.description
(String description) A description of the app.The app virtual host settings, with multiple domains separated by commas.domains
(Collection<String> domains) The app virtual host 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.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.The app's short name.default CreateAppRequest.Builder
sslConfiguration
(Consumer<SslConfiguration.Builder> sslConfiguration) AnSslConfiguration
object with the SSL configuration.sslConfiguration
(SslConfiguration sslConfiguration) AnSslConfiguration
object with the SSL configuration.The stack ID.The app type.The app type.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.opsworks.model.OpsWorksRequest.Builder
build
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
-
stackId
The stack ID.
- Parameters:
stackId
- The 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 source.
- Parameters:
dataSources
- The app's data source.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dataSources
The app's data source.
- Parameters:
dataSources
- The app's data source.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dataSources
The app's data source.
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. 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. 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:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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. 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:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
appSource
A
Source
object that specifies the app repository.- Parameters:
appSource
- ASource
object that specifies 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 specifies 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 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. 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 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. 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
default CreateAppRequest.Builder sslConfiguration(Consumer<SslConfiguration.Builder> 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
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.- 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 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 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:
- 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 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 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:
- 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 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.
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:
-
overrideConfiguration
CreateAppRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
CreateAppRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-