Package software.amazon.awssdk.services.elasticbeanstalk.model

Class CreateConfigurationTemplateRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.elasticbeanstalk.model.CreateConfigurationTemplateRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<CreateConfigurationTemplateRequest.Builder,CreateConfigurationTemplateRequest>

@Generated("software.amazon.awssdk:codegen")
public class CreateConfigurationTemplateRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<CreateConfigurationTemplateRequest.Builder,CreateConfigurationTemplateRequest>

Request to create a configuration template.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateConfigurationTemplateRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
String	applicationName()	The name of the application to associate with this configuration template.
static CreateConfigurationTemplateRequest.Builder	builder()
String	description()	Describes this configuration.
String	environmentId()	The ID of the environment used with this configuration template.
boolean	equals(Object obj)
int	hashCode()
List<ConfigurationOptionSetting>	optionSettings()	If specified, AWS Elastic Beanstalk sets the specified configuration option to the requested value.
String	platformArn()	The ARN of the custome platform.
static Class<? extends CreateConfigurationTemplateRequest.Builder>	serializableBuilderClass()
String	solutionStackName()	The name of the solution stack used by this configuration.
SourceConfiguration	sourceConfiguration()	If specified, AWS Elastic Beanstalk uses the configuration values from the specified configuration template to create a new configuration.
String	templateName()	The name of the configuration template.
CreateConfigurationTemplateRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

applicationName

public String applicationName()

The name of the application to associate with this configuration template. If no application is found with this name, AWS Elastic Beanstalk returns an InvalidParameterValue error.

Returns:

The name of the application to associate with this configuration template. If no application is found with this name, AWS Elastic Beanstalk returns an InvalidParameterValue error.

templateName

public String templateName()

The name of the configuration template.

Constraint: This name must be unique per application.

Default: If a configuration template already exists with this name, AWS Elastic Beanstalk returns an InvalidParameterValue error.

Returns:

The name of the configuration template.

Constraint: This name must be unique per application.

Default: If a configuration template already exists with this name, AWS Elastic Beanstalk returns an InvalidParameterValue error.

solutionStackName

public String solutionStackName()

The name of the solution stack used by this configuration. The solution stack specifies the operating system, architecture, and application server for a configuration template. It determines the set of configuration options as well as the possible and default values.

Use ListAvailableSolutionStacks to obtain a list of available solution stacks.

A solution stack name or a source configuration parameter must be specified, otherwise AWS Elastic Beanstalk returns an InvalidParameterValue error.

If a solution stack name is not specified and the source configuration parameter is specified, AWS Elastic Beanstalk uses the same solution stack as the source configuration template.

Returns:

The name of the solution stack used by this configuration. The solution stack specifies the operating system, architecture, and application server for a configuration template. It determines the set of configuration options as well as the possible and default values.

Use ListAvailableSolutionStacks to obtain a list of available solution stacks.

A solution stack name or a source configuration parameter must be specified, otherwise AWS Elastic Beanstalk returns an InvalidParameterValue error.

If a solution stack name is not specified and the source configuration parameter is specified, AWS Elastic Beanstalk uses the same solution stack as the source configuration template.

platformArn

public String platformArn()

The ARN of the custome platform.

Returns:

The ARN of the custome platform.

sourceConfiguration

public SourceConfiguration sourceConfiguration()

If specified, AWS Elastic Beanstalk uses the configuration values from the specified configuration template to create a new configuration.

Values specified in the OptionSettings parameter of this call overrides any values obtained from the SourceConfiguration.

If no configuration template is found, returns an InvalidParameterValue error.

Constraint: If both the solution stack name parameter and the source configuration parameters are specified, the solution stack of the source configuration template must match the specified solution stack name or else AWS Elastic Beanstalk returns an InvalidParameterCombination error.

Returns:

If specified, AWS Elastic Beanstalk uses the configuration values from the specified configuration template to create a new configuration.

Values specified in the OptionSettings parameter of this call overrides any values obtained from the SourceConfiguration.

If no configuration template is found, returns an InvalidParameterValue error.

Constraint: If both the solution stack name parameter and the source configuration parameters are specified, the solution stack of the source configuration template must match the specified solution stack name or else AWS Elastic Beanstalk returns an InvalidParameterCombination error.

environmentId

public String environmentId()

The ID of the environment used with this configuration template.

Returns:

The ID of the environment used with this configuration template.

description

public String description()

Describes this configuration.

Returns:

Describes this configuration.

optionSettings

public List<ConfigurationOptionSetting> optionSettings()

If specified, AWS Elastic Beanstalk sets the specified configuration option to the requested value. The new value overrides the value obtained from the solution stack or the source configuration template.

Returns:

If specified, AWS Elastic Beanstalk sets the specified configuration option to the requested value. The new value overrides the value obtained from the solution stack or the source configuration template.

toBuilder

public CreateConfigurationTemplateRequest.Builder 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 interface ToCopyableBuilder<CreateConfigurationTemplateRequest.Builder,CreateConfigurationTemplateRequest>

Returns:

a builder for type T

builder

public static CreateConfigurationTemplateRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateConfigurationTemplateRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object