Class CreateAppRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateAppRequest.Builder,
CreateAppRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal Source
ASource
object that specifies the app repository.final Map
<AppAttributesKeys, String> One or more user-defined key/value pairs to be added to the stack attributes.One or more user-defined key/value pairs to be added to the stack attributes.static CreateAppRequest.Builder
builder()
final List
<DataSource> The app's data source.final String
A description of the app.domains()
The app virtual host settings, with multiple domains separated by commas.final Boolean
Whether to enable SSL for the app.final List
<EnvironmentVariable> An array ofEnvironmentVariable
objects that specify environment variables to be associated with the app.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the Attributes property.final boolean
For responses, this returns true if the service returned a value for the DataSources property.final boolean
For responses, this returns true if the service returned a value for the Domains property.final boolean
For responses, this returns true if the service returned a value for the Environment property.final int
hashCode()
final String
name()
The app name.static Class
<? extends CreateAppRequest.Builder> final String
The app's short name.final SslConfiguration
AnSslConfiguration
object with the SSL configuration.final String
stackId()
The stack ID.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final AppType
type()
The app type.final String
The app type.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
stackId
The stack ID.
- Returns:
- The stack ID.
-
shortname
The app's short name.
- Returns:
- The app's short name.
-
name
The app name.
- Returns:
- The app name.
-
description
A description of the app.
- Returns:
- A description of the app.
-
hasDataSources
public final boolean hasDataSources()For responses, this returns true if the service returned a value for the DataSources property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
dataSources
The app's data source.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasDataSources()
method.- Returns:
- The app's data source.
-
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 returnAppType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- 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
. - See Also:
-
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 returnAppType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- 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
. - See Also:
-
appSource
A
Source
object that specifies the app repository.- Returns:
- A
Source
object that specifies the app repository.
-
hasDomains
public final boolean hasDomains()For responses, this returns true if the service returned a value for the Domains property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasDomains()
method.- Returns:
- The app virtual host settings, with multiple domains separated by commas. For example:
'www.example.com, example.com'
-
enableSsl
Whether to enable SSL for the app.
- Returns:
- Whether to enable SSL for the app.
-
sslConfiguration
An
SslConfiguration
object with the SSL configuration.- Returns:
- An
SslConfiguration
object with the SSL configuration.
-
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.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasAttributes()
method.- Returns:
- One or more user-defined key/value pairs to be added to the stack attributes.
-
hasAttributes
public final boolean hasAttributes()For responses, this returns true if the service returned a value for the Attributes property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasAttributes()
method.- Returns:
- One or more user-defined key/value pairs to be added to the stack attributes.
-
hasEnvironment
public final boolean hasEnvironment()For responses, this returns true if the service returned a value for the Environment property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasEnvironment()
method.- Returns:
- 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.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<CreateAppRequest.Builder,
CreateAppRequest> - Specified by:
toBuilder
in classOpsWorksRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-