Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.ElasticBeanstalk.CreateConfigurationTemplate

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates an AWS Elastic Beanstalk configuration template, associated with a specific Elastic Beanstalk application. You define application configuration settings in a configuration template. You can then use the configuration template to deploy different versions of the application with the same configuration settings.

Templates aren't associated with any environment. The EnvironmentName response element is always null.

Creating a Request

data CreateConfigurationTemplate Source #

Request to create a configuration template.

See: newCreateConfigurationTemplate smart constructor.

Constructors

CreateConfigurationTemplate'

Fields

optionSettings :: Maybe [ConfigurationOptionSetting]
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.
platformArn :: Maybe Text
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 specify SolutionStackName.
sourceConfiguration :: Maybe 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 the SourceConfiguration.
You must specify SourceConfiguration if you don't specify PlatformArn, EnvironmentId, or SolutionStackName.
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.
solutionStackName :: Maybe Text
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 specify PlatformArn, EnvironmentId, or SourceConfiguration.
Use the ListAvailableSolutionStacks API to obtain a list of available solution stacks.
environmentId :: Maybe Text
The ID of an environment whose settings you want to use to create the configuration template. You must specify EnvironmentId if you don't specify PlatformArn, SolutionStackName, or SourceConfiguration.
description :: Maybe Text
An optional description for this configuration.
tags :: Maybe [Tag]
Specifies the tags applied to the configuration template.
applicationName :: Text
The name of the Elastic Beanstalk application to associate with this configuration template.
templateName :: Text
The name of the configuration template.
Constraint: This name must be unique per application.

Instances

Instances details

Eq CreateConfigurationTemplate Source #
Instance details Defined in Amazonka.ElasticBeanstalk.CreateConfigurationTemplate Methods (==) :: CreateConfigurationTemplate -> CreateConfigurationTemplate -> Bool # (/=) :: CreateConfigurationTemplate -> CreateConfigurationTemplate -> Bool #
Read CreateConfigurationTemplate Source #
Instance details Defined in Amazonka.ElasticBeanstalk.CreateConfigurationTemplate Methods readsPrec :: Int -> ReadS CreateConfigurationTemplate # readList :: ReadS [CreateConfigurationTemplate] # readPrec :: ReadPrec CreateConfigurationTemplate # readListPrec :: ReadPrec [CreateConfigurationTemplate] #
Show CreateConfigurationTemplate Source #
Instance details Defined in Amazonka.ElasticBeanstalk.CreateConfigurationTemplate Methods showsPrec :: Int -> CreateConfigurationTemplate -> ShowS # show :: CreateConfigurationTemplate -> String # showList :: [CreateConfigurationTemplate] -> ShowS #
Generic CreateConfigurationTemplate Source #
Instance details Defined in Amazonka.ElasticBeanstalk.CreateConfigurationTemplate Associated Types type Rep CreateConfigurationTemplate :: Type -> Type # Methods from :: CreateConfigurationTemplate -> Rep CreateConfigurationTemplate x # to :: Rep CreateConfigurationTemplate x -> CreateConfigurationTemplate #
NFData CreateConfigurationTemplate Source #
Instance details Defined in Amazonka.ElasticBeanstalk.CreateConfigurationTemplate Methods rnf :: CreateConfigurationTemplate -> () #
Hashable CreateConfigurationTemplate Source #
Instance details Defined in Amazonka.ElasticBeanstalk.CreateConfigurationTemplate Methods hashWithSalt :: Int -> CreateConfigurationTemplate -> Int # hash :: CreateConfigurationTemplate -> Int #
AWSRequest CreateConfigurationTemplate Source #
Instance details Defined in Amazonka.ElasticBeanstalk.CreateConfigurationTemplate Associated Types type AWSResponse CreateConfigurationTemplate # Methods request :: CreateConfigurationTemplate -> Request CreateConfigurationTemplate # response :: MonadResource m => Logger -> Service -> Proxy CreateConfigurationTemplate -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateConfigurationTemplate))) #
ToHeaders CreateConfigurationTemplate Source #
Instance details Defined in Amazonka.ElasticBeanstalk.CreateConfigurationTemplate Methods toHeaders :: CreateConfigurationTemplate -> [Header] #
ToPath CreateConfigurationTemplate Source #
Instance details Defined in Amazonka.ElasticBeanstalk.CreateConfigurationTemplate Methods toPath :: CreateConfigurationTemplate -> ByteString #
ToQuery CreateConfigurationTemplate Source #
Instance details Defined in Amazonka.ElasticBeanstalk.CreateConfigurationTemplate Methods toQuery :: CreateConfigurationTemplate -> QueryString #
type Rep CreateConfigurationTemplate Source #
Instance details Defined in Amazonka.ElasticBeanstalk.CreateConfigurationTemplate type Rep CreateConfigurationTemplate = D1 ('MetaData "CreateConfigurationTemplate" "Amazonka.ElasticBeanstalk.CreateConfigurationTemplate" "libZSservicesZSamazonka-elasticbeanstalkZSamazonka-elasticbeanstalk" 'False) (C1 ('MetaCons "CreateConfigurationTemplate'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "optionSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ConfigurationOptionSetting])) :: S1 ('MetaSel ('Just "platformArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "sourceConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SourceConfiguration)) :: S1 ('MetaSel ('Just "solutionStackName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "environmentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :: (S1 ('MetaSel ('Just "applicationName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "templateName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))
type AWSResponse CreateConfigurationTemplate Source #
Instance details Defined in Amazonka.ElasticBeanstalk.CreateConfigurationTemplate type AWSResponse CreateConfigurationTemplate = ConfigurationSettingsDescription

newCreateConfigurationTemplate Source #

Arguments

:: Text	`$sel:applicationName:CreateConfigurationTemplate'`
-> Text	`$sel:templateName:CreateConfigurationTemplate'`
-> CreateConfigurationTemplate

Create a value of CreateConfigurationTemplate with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:optionSettings:CreateConfigurationTemplate', createConfigurationTemplate_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.

$sel:platformArn:CreateConfigurationTemplate', createConfigurationTemplate_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 specify SolutionStackName.

$sel:sourceConfiguration:CreateConfigurationTemplate', createConfigurationTemplate_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 the SourceConfiguration.

You must specify SourceConfiguration if you don't specify PlatformArn, EnvironmentId, or SolutionStackName.

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.

$sel:solutionStackName:CreateConfigurationTemplate', createConfigurationTemplate_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 specify PlatformArn, EnvironmentId, or SourceConfiguration.

Use the ListAvailableSolutionStacks API to obtain a list of available solution stacks.

$sel:environmentId:CreateConfigurationTemplate', createConfigurationTemplate_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 specify PlatformArn, SolutionStackName, or SourceConfiguration.

$sel:description:CreateConfigurationTemplate', createConfigurationTemplate_description - An optional description for this configuration.

$sel:tags:CreateConfigurationTemplate', createConfigurationTemplate_tags - Specifies the tags applied to the configuration template.

$sel:applicationName:CreateConfigurationTemplate', createConfigurationTemplate_applicationName - The name of the Elastic Beanstalk application to associate with this configuration template.

$sel:templateName:CreateConfigurationTemplate', createConfigurationTemplate_templateName - The name of the configuration template.

Constraint: This name must be unique per application.

Request Lenses

createConfigurationTemplate_optionSettings :: Lens' CreateConfigurationTemplate (Maybe [ConfigurationOptionSetting]) Source #

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.

createConfigurationTemplate_platformArn :: Lens' CreateConfigurationTemplate (Maybe Text) Source #

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 specify SolutionStackName.

createConfigurationTemplate_sourceConfiguration :: Lens' CreateConfigurationTemplate (Maybe SourceConfiguration) Source #

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 the SourceConfiguration.

You must specify SourceConfiguration if you don't specify PlatformArn, EnvironmentId, or SolutionStackName.

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.

createConfigurationTemplate_solutionStackName :: Lens' CreateConfigurationTemplate (Maybe Text) Source #

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 specify PlatformArn, EnvironmentId, or SourceConfiguration.

Use the ListAvailableSolutionStacks API to obtain a list of available solution stacks.

createConfigurationTemplate_environmentId :: Lens' CreateConfigurationTemplate (Maybe Text) Source #

The ID of an environment whose settings you want to use to create the configuration template. You must specify EnvironmentId if you don't specify PlatformArn, SolutionStackName, or SourceConfiguration.

createConfigurationTemplate_description :: Lens' CreateConfigurationTemplate (Maybe Text) Source #

An optional description for this configuration.

createConfigurationTemplate_tags :: Lens' CreateConfigurationTemplate (Maybe [Tag]) Source #

Specifies the tags applied to the configuration template.

createConfigurationTemplate_applicationName :: Lens' CreateConfigurationTemplate Text Source #

The name of the Elastic Beanstalk application to associate with this configuration template.

createConfigurationTemplate_templateName :: Lens' CreateConfigurationTemplate Text Source #

The name of the configuration template.

Constraint: This name must be unique per application.

Destructuring the Response

data ConfigurationSettingsDescription Source #

Describes the settings for a configuration set.

See: newConfigurationSettingsDescription smart constructor.

Constructors

ConfigurationSettingsDescription'

Fields

templateName :: Maybe Text
If not null, the name of the configuration template for this configuration set.
optionSettings :: Maybe [ConfigurationOptionSetting]
A list of the configuration options and their values in this configuration set.
dateUpdated :: Maybe ISO8601
The date (in UTC time) when this configuration set was last modified.
dateCreated :: Maybe ISO8601
The date (in UTC time) when this configuration set was created.
platformArn :: Maybe Text
The ARN of the platform version.
environmentName :: Maybe Text
If not null, the name of the environment for this configuration set.
applicationName :: Maybe Text
The name of the application associated with this configuration set.
deploymentStatus :: Maybe ConfigurationDeploymentStatus
If this configuration set is associated with an environment, the DeploymentStatus parameter indicates the deployment status of this configuration set:
- null: This configuration is not associated with a running environment.
- pending: This is a draft configuration that is not deployed to the associated environment but is in the process of deploying.
- deployed: This is the configuration that is currently deployed to the associated running environment.
- failed: This is a draft configuration that failed to successfully deploy.
solutionStackName :: Maybe Text
The name of the solution stack this configuration set uses.
description :: Maybe Text
Describes this configuration set.

Instances

Instances details

Eq ConfigurationSettingsDescription Source #
Instance details Defined in Amazonka.ElasticBeanstalk.Types.ConfigurationSettingsDescription Methods (==) :: ConfigurationSettingsDescription -> ConfigurationSettingsDescription -> Bool # (/=) :: ConfigurationSettingsDescription -> ConfigurationSettingsDescription -> Bool #
Read ConfigurationSettingsDescription Source #
Instance details Defined in Amazonka.ElasticBeanstalk.Types.ConfigurationSettingsDescription Methods readsPrec :: Int -> ReadS ConfigurationSettingsDescription # readList :: ReadS [ConfigurationSettingsDescription] # readPrec :: ReadPrec ConfigurationSettingsDescription # readListPrec :: ReadPrec [ConfigurationSettingsDescription] #
Show ConfigurationSettingsDescription Source #
Instance details Defined in Amazonka.ElasticBeanstalk.Types.ConfigurationSettingsDescription Methods showsPrec :: Int -> ConfigurationSettingsDescription -> ShowS # show :: ConfigurationSettingsDescription -> String # showList :: [ConfigurationSettingsDescription] -> ShowS #
Generic ConfigurationSettingsDescription Source #
Instance details Defined in Amazonka.ElasticBeanstalk.Types.ConfigurationSettingsDescription Associated Types type Rep ConfigurationSettingsDescription :: Type -> Type # Methods from :: ConfigurationSettingsDescription -> Rep ConfigurationSettingsDescription x # to :: Rep ConfigurationSettingsDescription x -> ConfigurationSettingsDescription #
NFData ConfigurationSettingsDescription Source #
Instance details Defined in Amazonka.ElasticBeanstalk.Types.ConfigurationSettingsDescription Methods rnf :: ConfigurationSettingsDescription -> () #
Hashable ConfigurationSettingsDescription Source #
Instance details Defined in Amazonka.ElasticBeanstalk.Types.ConfigurationSettingsDescription Methods hashWithSalt :: Int -> ConfigurationSettingsDescription -> Int # hash :: ConfigurationSettingsDescription -> Int #
FromXML ConfigurationSettingsDescription Source #
Instance details Defined in Amazonka.ElasticBeanstalk.Types.ConfigurationSettingsDescription Methods parseXML :: [Node] -> Either String ConfigurationSettingsDescription #
type Rep ConfigurationSettingsDescription Source #
Instance details Defined in Amazonka.ElasticBeanstalk.Types.ConfigurationSettingsDescription type Rep ConfigurationSettingsDescription = D1 ('MetaData "ConfigurationSettingsDescription" "Amazonka.ElasticBeanstalk.Types.ConfigurationSettingsDescription" "libZSservicesZSamazonka-elasticbeanstalkZSamazonka-elasticbeanstalk" 'False) (C1 ('MetaCons "ConfigurationSettingsDescription'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "templateName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "optionSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ConfigurationOptionSetting]))) :: (S1 ('MetaSel ('Just "dateUpdated") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :: (S1 ('MetaSel ('Just "dateCreated") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :: S1 ('MetaSel ('Just "platformArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "environmentName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "applicationName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "deploymentStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConfigurationDeploymentStatus)) :: (S1 ('MetaSel ('Just "solutionStackName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newConfigurationSettingsDescription :: ConfigurationSettingsDescription Source #

Create a value of ConfigurationSettingsDescription with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:templateName:ConfigurationSettingsDescription', configurationSettingsDescription_templateName - If not null, the name of the configuration template for this configuration set.

$sel:optionSettings:ConfigurationSettingsDescription', configurationSettingsDescription_optionSettings - A list of the configuration options and their values in this configuration set.

$sel:dateUpdated:ConfigurationSettingsDescription', configurationSettingsDescription_dateUpdated - The date (in UTC time) when this configuration set was last modified.

$sel:dateCreated:ConfigurationSettingsDescription', configurationSettingsDescription_dateCreated - The date (in UTC time) when this configuration set was created.

$sel:platformArn:ConfigurationSettingsDescription', configurationSettingsDescription_platformArn - The ARN of the platform version.

$sel:environmentName:ConfigurationSettingsDescription', configurationSettingsDescription_environmentName - If not null, the name of the environment for this configuration set.

$sel:applicationName:ConfigurationSettingsDescription', configurationSettingsDescription_applicationName - The name of the application associated with this configuration set.

$sel:deploymentStatus:ConfigurationSettingsDescription', configurationSettingsDescription_deploymentStatus - If this configuration set is associated with an environment, the DeploymentStatus parameter indicates the deployment status of this configuration set:

null: This configuration is not associated with a running environment.
pending: This is a draft configuration that is not deployed to the associated environment but is in the process of deploying.
deployed: This is the configuration that is currently deployed to the associated running environment.
failed: This is a draft configuration that failed to successfully deploy.

$sel:solutionStackName:ConfigurationSettingsDescription', configurationSettingsDescription_solutionStackName - The name of the solution stack this configuration set uses.

$sel:description:ConfigurationSettingsDescription', configurationSettingsDescription_description - Describes this configuration set.

Response Lenses

configurationSettingsDescription_templateName :: Lens' ConfigurationSettingsDescription (Maybe Text) Source #

If not null, the name of the configuration template for this configuration set.

configurationSettingsDescription_optionSettings :: Lens' ConfigurationSettingsDescription (Maybe [ConfigurationOptionSetting]) Source #

A list of the configuration options and their values in this configuration set.

configurationSettingsDescription_dateUpdated :: Lens' ConfigurationSettingsDescription (Maybe UTCTime) Source #

The date (in UTC time) when this configuration set was last modified.

configurationSettingsDescription_dateCreated :: Lens' ConfigurationSettingsDescription (Maybe UTCTime) Source #

The date (in UTC time) when this configuration set was created.

configurationSettingsDescription_platformArn :: Lens' ConfigurationSettingsDescription (Maybe Text) Source #

The ARN of the platform version.

configurationSettingsDescription_environmentName :: Lens' ConfigurationSettingsDescription (Maybe Text) Source #

If not null, the name of the environment for this configuration set.

configurationSettingsDescription_applicationName :: Lens' ConfigurationSettingsDescription (Maybe Text) Source #

The name of the application associated with this configuration set.

configurationSettingsDescription_deploymentStatus :: Lens' ConfigurationSettingsDescription (Maybe ConfigurationDeploymentStatus) Source #

If this configuration set is associated with an environment, the DeploymentStatus parameter indicates the deployment status of this configuration set:

null: This configuration is not associated with a running environment.
pending: This is a draft configuration that is not deployed to the associated environment but is in the process of deploying.
deployed: This is the configuration that is currently deployed to the associated running environment.
failed: This is a draft configuration that failed to successfully deploy.

configurationSettingsDescription_solutionStackName :: Lens' ConfigurationSettingsDescription (Maybe Text) Source #

The name of the solution stack this configuration set uses.

configurationSettingsDescription_description :: Lens' ConfigurationSettingsDescription (Maybe Text) Source #

Describes this configuration set.