Copyright | (c) 2013-2017 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 |
Language | Haskell2010 |
Creates a configuration template. Templates are associated with a specific application and are used to deploy different versions of the application with the same configuration settings.
Related Topics
DescribeConfigurationOptions
DescribeConfigurationSettings
ListAvailableSolutionStacks
- createConfigurationTemplate :: Text -> Text -> CreateConfigurationTemplate
- data CreateConfigurationTemplate
- cctOptionSettings :: Lens' CreateConfigurationTemplate [ConfigurationOptionSetting]
- cctPlatformARN :: Lens' CreateConfigurationTemplate (Maybe Text)
- cctSourceConfiguration :: Lens' CreateConfigurationTemplate (Maybe SourceConfiguration)
- cctSolutionStackName :: Lens' CreateConfigurationTemplate (Maybe Text)
- cctEnvironmentId :: Lens' CreateConfigurationTemplate (Maybe Text)
- cctDescription :: Lens' CreateConfigurationTemplate (Maybe Text)
- cctApplicationName :: Lens' CreateConfigurationTemplate Text
- cctTemplateName :: Lens' CreateConfigurationTemplate Text
- configurationSettingsDescription :: ConfigurationSettingsDescription
- data ConfigurationSettingsDescription
- csdTemplateName :: Lens' ConfigurationSettingsDescription (Maybe Text)
- csdOptionSettings :: Lens' ConfigurationSettingsDescription [ConfigurationOptionSetting]
- csdDateUpdated :: Lens' ConfigurationSettingsDescription (Maybe UTCTime)
- csdDateCreated :: Lens' ConfigurationSettingsDescription (Maybe UTCTime)
- csdPlatformARN :: Lens' ConfigurationSettingsDescription (Maybe Text)
- csdEnvironmentName :: Lens' ConfigurationSettingsDescription (Maybe Text)
- csdApplicationName :: Lens' ConfigurationSettingsDescription (Maybe Text)
- csdDeploymentStatus :: Lens' ConfigurationSettingsDescription (Maybe ConfigurationDeploymentStatus)
- csdSolutionStackName :: Lens' ConfigurationSettingsDescription (Maybe Text)
- csdDescription :: Lens' ConfigurationSettingsDescription (Maybe Text)
Creating a Request
createConfigurationTemplate Source #
Creates a value of CreateConfigurationTemplate
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cctOptionSettings
- 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.cctPlatformARN
- The ARN of the custome platform.cctSourceConfiguration
- If specified, AWS Elastic Beanstalk uses the configuration values from the specified configuration template to create a new configuration. Values specified in theOptionSettings
parameter of this call overrides any values obtained from theSourceConfiguration
. If no configuration template is found, returns anInvalidParameterValue
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 anInvalidParameterCombination
error.cctSolutionStackName
- 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. UseListAvailableSolutionStacks
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 anInvalidParameterValue
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.cctEnvironmentId
- The ID of the environment used with this configuration template.cctDescription
- Describes this configuration.cctApplicationName
- The name of the application to associate with this configuration template. If no application is found with this name, AWS Elastic Beanstalk returns anInvalidParameterValue
error.cctTemplateName
- 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 anInvalidParameterValue
error.
data CreateConfigurationTemplate Source #
Request to create a configuration template.
See: createConfigurationTemplate
smart constructor.
Request Lenses
cctOptionSettings :: Lens' CreateConfigurationTemplate [ConfigurationOptionSetting] Source #
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.
cctPlatformARN :: Lens' CreateConfigurationTemplate (Maybe Text) Source #
The ARN of the custome platform.
cctSourceConfiguration :: Lens' CreateConfigurationTemplate (Maybe SourceConfiguration) Source #
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.
cctSolutionStackName :: Lens' CreateConfigurationTemplate (Maybe Text) Source #
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.
cctEnvironmentId :: Lens' CreateConfigurationTemplate (Maybe Text) Source #
The ID of the environment used with this configuration template.
cctDescription :: Lens' CreateConfigurationTemplate (Maybe Text) Source #
Describes this configuration.
cctApplicationName :: Lens' CreateConfigurationTemplate Text Source #
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.
cctTemplateName :: Lens' CreateConfigurationTemplate Text Source #
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.
Destructuring the Response
configurationSettingsDescription :: ConfigurationSettingsDescription Source #
Creates a value of ConfigurationSettingsDescription
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
csdTemplateName
- If notnull
, the name of the configuration template for this configuration set.csdOptionSettings
- A list of the configuration options and their values in this configuration set.csdDateUpdated
- The date (in UTC time) when this configuration set was last modified.csdDateCreated
- The date (in UTC time) when this configuration set was created.csdPlatformARN
- The ARN of the platform.csdEnvironmentName
- If notnull
, the name of the environment for this configuration set.csdApplicationName
- The name of the application associated with this configuration set.csdDeploymentStatus
- If this configuration set is associated with an environment, theDeploymentStatus
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.csdSolutionStackName
- The name of the solution stack this configuration set uses.csdDescription
- Describes this configuration set.
data ConfigurationSettingsDescription Source #
Describes the settings for a configuration set.
See: configurationSettingsDescription
smart constructor.
Response Lenses
csdTemplateName :: Lens' ConfigurationSettingsDescription (Maybe Text) Source #
If not null
, the name of the configuration template for this configuration set.
csdOptionSettings :: Lens' ConfigurationSettingsDescription [ConfigurationOptionSetting] Source #
A list of the configuration options and their values in this configuration set.
csdDateUpdated :: Lens' ConfigurationSettingsDescription (Maybe UTCTime) Source #
The date (in UTC time) when this configuration set was last modified.
csdDateCreated :: Lens' ConfigurationSettingsDescription (Maybe UTCTime) Source #
The date (in UTC time) when this configuration set was created.
csdPlatformARN :: Lens' ConfigurationSettingsDescription (Maybe Text) Source #
The ARN of the platform.
csdEnvironmentName :: Lens' ConfigurationSettingsDescription (Maybe Text) Source #
If not null
, the name of the environment for this configuration set.
csdApplicationName :: Lens' ConfigurationSettingsDescription (Maybe Text) Source #
The name of the application associated with this configuration set.
csdDeploymentStatus :: 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.
csdSolutionStackName :: Lens' ConfigurationSettingsDescription (Maybe Text) Source #
The name of the solution stack this configuration set uses.
csdDescription :: Lens' ConfigurationSettingsDescription (Maybe Text) Source #
Describes this configuration set.