Amazonka.ElasticBeanstalk.UpdateConfigurationTemplate

Updates the specified configuration template to have the specified properties or configuration option values.

If a property (for example, ApplicationName) is not provided, its value remains unchanged. To clear such properties, specify an empty string.

Related Topics

• DescribeConfigurationOptions

Creating a Request

data UpdateConfigurationTemplate

The result message containing the options for the specified solution stack.

See: newUpdateConfigurationTemplate smart constructor.

Constructors

UpdateConfigurationTemplate'

Fields

• description :: Maybe Text

  A new description for the configuration.

• optionSettings :: Maybe [ConfigurationOptionSetting]

  A list of configuration option settings to update with the new specified option value.

• optionsToRemove :: Maybe [OptionSpecification]

  A list of configuration options to remove from the configuration set.

  Constraint: You can remove only UserDefined configuration options.

• applicationName :: Text

  The name of the application associated with the configuration template to update.

  If no application is found with this name, UpdateConfigurationTemplate returns an InvalidParameterValue error.

• templateName :: Text

  The name of the configuration template to update.

  If no configuration template is found with this name, UpdateConfigurationTemplate returns an InvalidParameterValue error.

Instances

ToHeaders UpdateConfigurationTemplate

Defined in Amazonka.ElasticBeanstalk.UpdateConfigurationTemplate

Methods

toHeaders :: UpdateConfigurationTemplate -> [Header]

ToPath UpdateConfigurationTemplate

Defined in Amazonka.ElasticBeanstalk.UpdateConfigurationTemplate

Methods

toPath :: UpdateConfigurationTemplate -> ByteString

ToQuery UpdateConfigurationTemplate

Defined in Amazonka.ElasticBeanstalk.UpdateConfigurationTemplate

Methods

toQuery :: UpdateConfigurationTemplate -> QueryString

AWSRequest UpdateConfigurationTemplate

Defined in Amazonka.ElasticBeanstalk.UpdateConfigurationTemplate

Associated Types

type AWSResponse UpdateConfigurationTemplate

Methods

request :: (Service -> Service) -> UpdateConfigurationTemplate -> Request UpdateConfigurationTemplate

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateConfigurationTemplate -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateConfigurationTemplate)))

Generic UpdateConfigurationTemplate

Defined in Amazonka.ElasticBeanstalk.UpdateConfigurationTemplate

Associated Types

type Rep UpdateConfigurationTemplate :: Type -> Type

Methods

from :: UpdateConfigurationTemplate -> Rep UpdateConfigurationTemplate x

to :: Rep UpdateConfigurationTemplate x -> UpdateConfigurationTemplate

Read UpdateConfigurationTemplate

Defined in Amazonka.ElasticBeanstalk.UpdateConfigurationTemplate

Methods

readsPrec :: Int -> ReadS UpdateConfigurationTemplate

readList :: ReadS [UpdateConfigurationTemplate]

readPrec :: ReadPrec UpdateConfigurationTemplate

readListPrec :: ReadPrec [UpdateConfigurationTemplate]

Show UpdateConfigurationTemplate

Defined in Amazonka.ElasticBeanstalk.UpdateConfigurationTemplate

Methods

showsPrec :: Int -> UpdateConfigurationTemplate -> ShowS

show :: UpdateConfigurationTemplate -> String

showList :: [UpdateConfigurationTemplate] -> ShowS

NFData UpdateConfigurationTemplate

Defined in Amazonka.ElasticBeanstalk.UpdateConfigurationTemplate

Methods

rnf :: UpdateConfigurationTemplate -> ()

Eq UpdateConfigurationTemplate

Defined in Amazonka.ElasticBeanstalk.UpdateConfigurationTemplate

Methods

(==) :: UpdateConfigurationTemplate -> UpdateConfigurationTemplate -> Bool

(/=) :: UpdateConfigurationTemplate -> UpdateConfigurationTemplate -> Bool

Hashable UpdateConfigurationTemplate

Defined in Amazonka.ElasticBeanstalk.UpdateConfigurationTemplate

Methods

hashWithSalt :: Int -> UpdateConfigurationTemplate -> Int

hash :: UpdateConfigurationTemplate -> Int

type AWSResponse UpdateConfigurationTemplate

Defined in Amazonka.ElasticBeanstalk.UpdateConfigurationTemplate

type AWSResponse UpdateConfigurationTemplate = ConfigurationSettingsDescription

type Rep UpdateConfigurationTemplate

Defined in Amazonka.ElasticBeanstalk.UpdateConfigurationTemplate

type Rep UpdateConfigurationTemplate = D1 ('MetaData "UpdateConfigurationTemplate" "Amazonka.ElasticBeanstalk.UpdateConfigurationTemplate" "amazonka-elasticbeanstalk-2.0-HLGGuY0kjXTIKSbM7JuMHy" 'False) (C1 ('MetaCons "UpdateConfigurationTemplate'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "optionSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ConfigurationOptionSetting]))) :*: (S1 ('MetaSel ('Just "optionsToRemove") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [OptionSpecification])) :*: (S1 ('MetaSel ('Just "applicationName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "templateName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newUpdateConfigurationTemplate

Arguments

:: Text

UpdateConfigurationTemplate

-> Text

UpdateConfigurationTemplate

-> UpdateConfigurationTemplate

Create a value of UpdateConfigurationTemplate 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:

UpdateConfigurationTemplate, updateConfigurationTemplate_description - A new description for the configuration.

UpdateConfigurationTemplate, updateConfigurationTemplate_optionSettings - A list of configuration option settings to update with the new specified option value.

$sel:optionsToRemove:UpdateConfigurationTemplate', updateConfigurationTemplate_optionsToRemove - A list of configuration options to remove from the configuration set.

Constraint: You can remove only UserDefined configuration options.

UpdateConfigurationTemplate, updateConfigurationTemplate_applicationName - The name of the application associated with the configuration template to update.

If no application is found with this name, UpdateConfigurationTemplate returns an InvalidParameterValue error.

UpdateConfigurationTemplate, updateConfigurationTemplate_templateName - The name of the configuration template to update.

If no configuration template is found with this name, UpdateConfigurationTemplate returns an InvalidParameterValue error.

Request Lenses

updateConfigurationTemplate_description :: Lens' UpdateConfigurationTemplate (Maybe Text)

A new description for the configuration.

updateConfigurationTemplate_optionSettings :: Lens' UpdateConfigurationTemplate (Maybe [ConfigurationOptionSetting])

A list of configuration option settings to update with the new specified option value.

updateConfigurationTemplate_optionsToRemove :: Lens' UpdateConfigurationTemplate (Maybe [OptionSpecification])

A list of configuration options to remove from the configuration set.

Constraint: You can remove only UserDefined configuration options.

updateConfigurationTemplate_applicationName :: Lens' UpdateConfigurationTemplate Text

The name of the application associated with the configuration template to update.

If no application is found with this name, UpdateConfigurationTemplate returns an InvalidParameterValue error.

updateConfigurationTemplate_templateName :: Lens' UpdateConfigurationTemplate Text

The name of the configuration template to update.

If no configuration template is found with this name, UpdateConfigurationTemplate returns an InvalidParameterValue error.

Destructuring the Response

data ConfigurationSettingsDescription

Describes the settings for a configuration set.

See: newConfigurationSettingsDescription smart constructor.

Constructors

ConfigurationSettingsDescription'

Fields

• applicationName :: Maybe Text

  The name of the application associated with this configuration set.

• dateCreated :: Maybe ISO8601

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

• dateUpdated :: Maybe ISO8601

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

• 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.
• description :: Maybe Text

  Describes this configuration set.

• environmentName :: Maybe Text

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

• optionSettings :: Maybe [ConfigurationOptionSetting]

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

• platformArn :: Maybe Text

  The ARN of the platform version.

• solutionStackName :: Maybe Text

  The name of the solution stack this configuration set uses.

• templateName :: Maybe Text

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

Instances

FromXML ConfigurationSettingsDescription

Defined in Amazonka.ElasticBeanstalk.Types.ConfigurationSettingsDescription

Methods

parseXML :: [Node] -> Either String ConfigurationSettingsDescription

Generic ConfigurationSettingsDescription

Defined in Amazonka.ElasticBeanstalk.Types.ConfigurationSettingsDescription

Associated Types

type Rep ConfigurationSettingsDescription :: Type -> Type

Methods

from :: ConfigurationSettingsDescription -> Rep ConfigurationSettingsDescription x

to :: Rep ConfigurationSettingsDescription x -> ConfigurationSettingsDescription

Read ConfigurationSettingsDescription

Defined in Amazonka.ElasticBeanstalk.Types.ConfigurationSettingsDescription

Methods

readsPrec :: Int -> ReadS ConfigurationSettingsDescription

readList :: ReadS [ConfigurationSettingsDescription]

readPrec :: ReadPrec ConfigurationSettingsDescription

readListPrec :: ReadPrec [ConfigurationSettingsDescription]

Show ConfigurationSettingsDescription

Defined in Amazonka.ElasticBeanstalk.Types.ConfigurationSettingsDescription

Methods

showsPrec :: Int -> ConfigurationSettingsDescription -> ShowS

show :: ConfigurationSettingsDescription -> String

showList :: [ConfigurationSettingsDescription] -> ShowS

NFData ConfigurationSettingsDescription

Defined in Amazonka.ElasticBeanstalk.Types.ConfigurationSettingsDescription

Methods

rnf :: ConfigurationSettingsDescription -> ()

Eq ConfigurationSettingsDescription

Defined in Amazonka.ElasticBeanstalk.Types.ConfigurationSettingsDescription

Methods

(==) :: ConfigurationSettingsDescription -> ConfigurationSettingsDescription -> Bool

(/=) :: ConfigurationSettingsDescription -> ConfigurationSettingsDescription -> Bool

Hashable ConfigurationSettingsDescription

Defined in Amazonka.ElasticBeanstalk.Types.ConfigurationSettingsDescription

Methods

hashWithSalt :: Int -> ConfigurationSettingsDescription -> Int

hash :: ConfigurationSettingsDescription -> Int

type Rep ConfigurationSettingsDescription

Defined in Amazonka.ElasticBeanstalk.Types.ConfigurationSettingsDescription

type Rep ConfigurationSettingsDescription = D1 ('MetaData "ConfigurationSettingsDescription" "Amazonka.ElasticBeanstalk.Types.ConfigurationSettingsDescription" "amazonka-elasticbeanstalk-2.0-HLGGuY0kjXTIKSbM7JuMHy" 'False) (C1 ('MetaCons "ConfigurationSettingsDescription'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "applicationName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "dateCreated") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601))) :*: (S1 ('MetaSel ('Just "dateUpdated") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :*: (S1 ('MetaSel ('Just "deploymentStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConfigurationDeploymentStatus)) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "environmentName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "optionSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ConfigurationOptionSetting]))) :*: (S1 ('MetaSel ('Just "platformArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "solutionStackName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "templateName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newConfigurationSettingsDescription :: ConfigurationSettingsDescription

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:applicationName:ConfigurationSettingsDescription', configurationSettingsDescription_applicationName - The name of the application associated with this configuration set.

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

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

$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:description:ConfigurationSettingsDescription', configurationSettingsDescription_description - Describes this configuration set.

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

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

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

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

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

Response Lenses

configurationSettingsDescription_applicationName :: Lens' ConfigurationSettingsDescription (Maybe Text)

The name of the application associated with this configuration set.

configurationSettingsDescription_dateCreated :: Lens' ConfigurationSettingsDescription (Maybe UTCTime)

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

configurationSettingsDescription_dateUpdated :: Lens' ConfigurationSettingsDescription (Maybe UTCTime)

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

configurationSettingsDescription_deploymentStatus :: Lens' ConfigurationSettingsDescription (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.

configurationSettingsDescription_description :: Lens' ConfigurationSettingsDescription (Maybe Text)

Describes this configuration set.

configurationSettingsDescription_environmentName :: Lens' ConfigurationSettingsDescription (Maybe Text)

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

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

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

configurationSettingsDescription_platformArn :: Lens' ConfigurationSettingsDescription (Maybe Text)

The ARN of the platform version.

configurationSettingsDescription_solutionStackName :: Lens' ConfigurationSettingsDescription (Maybe Text)

The name of the solution stack this configuration set uses.

configurationSettingsDescription_templateName :: Lens' ConfigurationSettingsDescription (Maybe Text)

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