Class CreateConfigurationTemplateRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateConfigurationTemplateRequest.Builder,
CreateConfigurationTemplateRequest>
Request to create a configuration template.
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The name of the Elastic Beanstalk application to associate with this configuration template.builder()
final String
An optional description for this configuration.final String
The ID of an environment whose settings you want to use to create the configuration template.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 int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the OptionSettings property.final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final List
<ConfigurationOptionSetting> Option values for the Elastic Beanstalk configuration, such as the instance type.final String
The Amazon Resource Name (ARN) of the custom platform.static Class
<? extends CreateConfigurationTemplateRequest.Builder> final String
The name of an Elastic Beanstalk solution stack (platform version) that this configuration uses.final SourceConfiguration
An Elastic Beanstalk configuration template to base this one on.tags()
Specifies the tags applied to the configuration template.final String
The name of the configuration template.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.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
applicationName
The name of the Elastic Beanstalk application to associate with this configuration template.
- Returns:
- The name of the Elastic Beanstalk application to associate with this configuration template.
-
templateName
The name of the configuration template.
Constraint: This name must be unique per application.
- Returns:
- The name of the configuration template.
Constraint: This name must be unique per application.
-
solutionStackName
The name of an Elastic Beanstalk solution stack (platform version) that this configuration uses. For example,
64bit Amazon Linux 2013.09 running Tomcat 7 Java 7
. A solution stack specifies the operating system, runtime, and application server for a configuration template. It also determines the set of configuration options as well as the possible and default values. For more information, see Supported Platforms in the AWS Elastic Beanstalk Developer Guide.You must specify
SolutionStackName
if you don't specifyPlatformArn
,EnvironmentId
, orSourceConfiguration
.Use the
ListAvailableSolutionStacks
API to obtain a list of available solution stacks.- Returns:
- The name of an Elastic Beanstalk solution stack (platform version) that this configuration uses. For
example,
64bit Amazon Linux 2013.09 running Tomcat 7 Java 7
. A solution stack specifies the operating system, runtime, and application server for a configuration template. It also determines the set of configuration options as well as the possible and default values. For more information, see Supported Platforms in the AWS Elastic Beanstalk Developer Guide.You must specify
SolutionStackName
if you don't specifyPlatformArn
,EnvironmentId
, orSourceConfiguration
.Use the
ListAvailableSolutionStacks
API to obtain a list of available solution stacks.
-
platformArn
The Amazon Resource Name (ARN) of the custom platform. For more information, see Custom Platforms in the AWS Elastic Beanstalk Developer Guide.
If you specify
PlatformArn
, then don't specifySolutionStackName
.- Returns:
- The Amazon Resource Name (ARN) of the custom platform. For more information, see Custom Platforms
in the AWS Elastic Beanstalk Developer Guide.
If you specify
PlatformArn
, then don't specifySolutionStackName
.
-
sourceConfiguration
An Elastic Beanstalk configuration template to base this one on. If specified, Elastic Beanstalk uses the configuration values from the specified configuration template to create a new configuration.
Values specified in
OptionSettings
override any values obtained from theSourceConfiguration
.You must specify
SourceConfiguration
if you don't specifyPlatformArn
,EnvironmentId
, orSolutionStackName
.Constraint: If both solution stack name and source configuration are specified, the solution stack of the source configuration template must match the specified solution stack name.
- Returns:
- An Elastic Beanstalk configuration template to base this one on. If specified, Elastic Beanstalk uses the
configuration values from the specified configuration template to create a new configuration.
Values specified in
OptionSettings
override any values obtained from theSourceConfiguration
.You must specify
SourceConfiguration
if you don't specifyPlatformArn
,EnvironmentId
, orSolutionStackName
.Constraint: If both solution stack name and source configuration are specified, the solution stack of the source configuration template must match the specified solution stack name.
-
environmentId
The ID of an environment whose settings you want to use to create the configuration template. You must specify
EnvironmentId
if you don't specifyPlatformArn
,SolutionStackName
, orSourceConfiguration
.- Returns:
- The ID of an environment whose settings you want to use to create the configuration template. You must
specify
EnvironmentId
if you don't specifyPlatformArn
,SolutionStackName
, orSourceConfiguration
.
-
description
An optional description for this configuration.
- Returns:
- An optional description for this configuration.
-
hasOptionSettings
public final boolean hasOptionSettings()For responses, this returns true if the service returned a value for the OptionSettings 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. -
optionSettings
Option values for the Elastic Beanstalk configuration, such as the instance type. If specified, these values override the values obtained from the solution stack or the source configuration template. For a complete list of Elastic Beanstalk configuration options, see Option Values in the AWS Elastic Beanstalk Developer Guide.
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
hasOptionSettings()
method.- Returns:
- Option values for the Elastic Beanstalk configuration, such as the instance type. If specified, these values override the values obtained from the solution stack or the source configuration template. For a complete list of Elastic Beanstalk configuration options, see Option Values in the AWS Elastic Beanstalk Developer Guide.
-
hasTags
public final boolean hasTags()For responses, this returns true if the service returned a value for the Tags 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. -
tags
Specifies the tags applied to the configuration template.
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
hasTags()
method.- Returns:
- Specifies the tags applied to the configuration template.
-
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<CreateConfigurationTemplateRequest.Builder,
CreateConfigurationTemplateRequest> - Specified by:
toBuilder
in classElasticBeanstalkRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends CreateConfigurationTemplateRequest.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
-