@Generated(value="software.amazon.awssdk:codegen") public final class CreateAppRequest extends OpsWorksRequest implements ToCopyableBuilder<CreateAppRequest.Builder,CreateAppRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
CreateAppRequest.Builder |
Modifier and Type | Method and Description |
---|---|
Source |
appSource()
A
Source object that specifies the app repository. |
Map<AppAttributesKeys,String> |
attributes()
One or more user-defined key/value pairs to be added to the stack attributes.
|
Map<String,String> |
attributesAsStrings()
One or more user-defined key/value pairs to be added to the stack attributes.
|
static CreateAppRequest.Builder |
builder() |
List<DataSource> |
dataSources()
The app's data source.
|
String |
description()
A description of the app.
|
List<String> |
domains()
The app virtual host settings, with multiple domains separated by commas.
|
Boolean |
enableSsl()
Whether to enable SSL for the app.
|
List<EnvironmentVariable> |
environment()
An array of
EnvironmentVariable objects that specify environment variables to be associated with the
app. |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
boolean |
hasAttributes()
Returns true if the Attributes property was specified by the sender (it may be empty), or false if the sender did
not specify the value (it will be empty).
|
boolean |
hasDataSources()
Returns true if the DataSources property was specified by the sender (it may be empty), or false if the sender
did not specify the value (it will be empty).
|
boolean |
hasDomains()
Returns true if the Domains property was specified by the sender (it may be empty), or false if the sender did
not specify the value (it will be empty).
|
boolean |
hasEnvironment()
Returns true if the Environment property was specified by the sender (it may be empty), or false if the sender
did not specify the value (it will be empty).
|
int |
hashCode() |
String |
name()
The app name.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends CreateAppRequest.Builder> |
serializableBuilderClass() |
String |
shortname()
The app's short name.
|
SslConfiguration |
sslConfiguration()
An
SslConfiguration object with the SSL configuration. |
String |
stackId()
The stack ID.
|
CreateAppRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
AppType |
type()
The app type.
|
String |
typeAsString()
The app type.
|
overrideConfiguration
copy
public final String stackId()
The stack ID.
public final String shortname()
The app's short name.
public final String name()
The app name.
public final String description()
A description of the app.
public final boolean hasDataSources()
public final List<DataSource> dataSources()
The app's data source.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasDataSources()
to see if a value was sent in this field.
public final AppType 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
.
If the service returns an enum value that is not available in the current SDK version, type
will return
AppType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
typeAsString()
.
other
.AppType
public final String typeAsString()
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
.
If the service returns an enum value that is not available in the current SDK version, type
will return
AppType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
typeAsString()
.
other
.AppType
public final Source appSource()
A Source
object that specifies the app repository.
Source
object that specifies the app repository.public final boolean hasDomains()
public final List<String> domains()
The app virtual host settings, with multiple domains separated by commas. For example:
'www.example.com, example.com'
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasDomains()
to see if a value was sent in this field.
'www.example.com, example.com'
public final Boolean enableSsl()
Whether to enable SSL for the app.
public final SslConfiguration sslConfiguration()
An SslConfiguration
object with the SSL configuration.
SslConfiguration
object with the SSL configuration.public final Map<AppAttributesKeys,String> attributes()
One or more user-defined key/value pairs to be added to the stack attributes.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasAttributes()
to see if a value was sent in this field.
public final boolean hasAttributes()
public final Map<String,String> attributesAsStrings()
One or more user-defined key/value pairs to be added to the stack attributes.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasAttributes()
to see if a value was sent in this field.
public final boolean hasEnvironment()
public final List<EnvironmentVariable> 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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasEnvironment()
to see if a value was sent in this field.
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.
public CreateAppRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<CreateAppRequest.Builder,CreateAppRequest>
toBuilder
in class OpsWorksRequest
public static CreateAppRequest.Builder builder()
public static Class<? extends CreateAppRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
SdkPojo
SdkPojo
class,
and is generated based on a service model.
If an SdkPojo
class does not have any inherited fields, equalsBySdkFields
and equals
are essentially the same.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.