Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.ElasticBeanstalk.DescribeConfigurationOptions

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes the configuration options that are used in a particular configuration template or environment, or that a specified solution stack defines. The description includes the values the options, their default values, and an indication of the required action on a running environment if an option value is changed.

Synopsis

Creating a Request

data DescribeConfigurationOptions Source #

Result message containing a list of application version descriptions.

See: newDescribeConfigurationOptions smart constructor.

Constructors

DescribeConfigurationOptions'

Fields

applicationName :: Maybe Text
The name of the application associated with the configuration template or environment. Only needed if you want to describe the configuration options associated with either the configuration template or environment.
environmentName :: Maybe Text
The name of the environment whose configuration options you want to describe.
options :: Maybe [OptionSpecification]
If specified, restricts the descriptions to only the specified options.
platformArn :: Maybe Text
The ARN of the custom platform.
solutionStackName :: Maybe Text
The name of the solution stack whose configuration options you want to describe.
templateName :: Maybe Text
The name of the configuration template whose configuration options you want to describe.

Instances

Instances details

ToHeaders DescribeConfigurationOptions Source #
Instance details Defined in Amazonka.ElasticBeanstalk.DescribeConfigurationOptions Methods toHeaders :: DescribeConfigurationOptions -> [Header] #
ToPath DescribeConfigurationOptions Source #
Instance details Defined in Amazonka.ElasticBeanstalk.DescribeConfigurationOptions Methods toPath :: DescribeConfigurationOptions -> ByteString #
ToQuery DescribeConfigurationOptions Source #
Instance details Defined in Amazonka.ElasticBeanstalk.DescribeConfigurationOptions Methods toQuery :: DescribeConfigurationOptions -> QueryString #
AWSRequest DescribeConfigurationOptions Source #
Instance details Defined in Amazonka.ElasticBeanstalk.DescribeConfigurationOptions Associated Types type AWSResponse DescribeConfigurationOptions # Methods request :: (Service -> Service) -> DescribeConfigurationOptions -> Request DescribeConfigurationOptions # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeConfigurationOptions -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeConfigurationOptions))) #
Generic DescribeConfigurationOptions Source #
Instance details Defined in Amazonka.ElasticBeanstalk.DescribeConfigurationOptions Associated Types type Rep DescribeConfigurationOptions :: Type -> Type # Methods from :: DescribeConfigurationOptions -> Rep DescribeConfigurationOptions x # to :: Rep DescribeConfigurationOptions x -> DescribeConfigurationOptions #
Read DescribeConfigurationOptions Source #
Instance details Defined in Amazonka.ElasticBeanstalk.DescribeConfigurationOptions Methods readsPrec :: Int -> ReadS DescribeConfigurationOptions # readList :: ReadS [DescribeConfigurationOptions] # readPrec :: ReadPrec DescribeConfigurationOptions # readListPrec :: ReadPrec [DescribeConfigurationOptions] #
Show DescribeConfigurationOptions Source #
Instance details Defined in Amazonka.ElasticBeanstalk.DescribeConfigurationOptions Methods showsPrec :: Int -> DescribeConfigurationOptions -> ShowS # show :: DescribeConfigurationOptions -> String # showList :: [DescribeConfigurationOptions] -> ShowS #
NFData DescribeConfigurationOptions Source #
Instance details Defined in Amazonka.ElasticBeanstalk.DescribeConfigurationOptions Methods rnf :: DescribeConfigurationOptions -> () #
Eq DescribeConfigurationOptions Source #
Instance details Defined in Amazonka.ElasticBeanstalk.DescribeConfigurationOptions Methods (==) :: DescribeConfigurationOptions -> DescribeConfigurationOptions -> Bool # (/=) :: DescribeConfigurationOptions -> DescribeConfigurationOptions -> Bool #
Hashable DescribeConfigurationOptions Source #
Instance details Defined in Amazonka.ElasticBeanstalk.DescribeConfigurationOptions Methods hashWithSalt :: Int -> DescribeConfigurationOptions -> Int # hash :: DescribeConfigurationOptions -> Int #
type AWSResponse DescribeConfigurationOptions Source #
Instance details Defined in Amazonka.ElasticBeanstalk.DescribeConfigurationOptions type AWSResponse DescribeConfigurationOptions = DescribeConfigurationOptionsResponse
type Rep DescribeConfigurationOptions Source #
Instance details Defined in Amazonka.ElasticBeanstalk.DescribeConfigurationOptions type Rep DescribeConfigurationOptions = D1 ('MetaData "DescribeConfigurationOptions" "Amazonka.ElasticBeanstalk.DescribeConfigurationOptions" "amazonka-elasticbeanstalk-2.0-HLGGuY0kjXTIKSbM7JuMHy" 'False) (C1 ('MetaCons "DescribeConfigurationOptions'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "applicationName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "environmentName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "options") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [OptionSpecification])))) :: (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))))))

newDescribeConfigurationOptions :: DescribeConfigurationOptions Source #

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

DescribeConfigurationOptions, describeConfigurationOptions_applicationName - The name of the application associated with the configuration template or environment. Only needed if you want to describe the configuration options associated with either the configuration template or environment.

DescribeConfigurationOptions, describeConfigurationOptions_environmentName - The name of the environment whose configuration options you want to describe.

DescribeConfigurationOptions, describeConfigurationOptions_options - If specified, restricts the descriptions to only the specified options.

DescribeConfigurationOptions, describeConfigurationOptions_platformArn - The ARN of the custom platform.

DescribeConfigurationOptions, describeConfigurationOptions_solutionStackName - The name of the solution stack whose configuration options you want to describe.

DescribeConfigurationOptions, describeConfigurationOptions_templateName - The name of the configuration template whose configuration options you want to describe.

Request Lenses

describeConfigurationOptions_applicationName :: Lens' DescribeConfigurationOptions (Maybe Text) Source #

The name of the application associated with the configuration template or environment. Only needed if you want to describe the configuration options associated with either the configuration template or environment.

describeConfigurationOptions_environmentName :: Lens' DescribeConfigurationOptions (Maybe Text) Source #

The name of the environment whose configuration options you want to describe.

describeConfigurationOptions_options :: Lens' DescribeConfigurationOptions (Maybe [OptionSpecification]) Source #

If specified, restricts the descriptions to only the specified options.

describeConfigurationOptions_platformArn :: Lens' DescribeConfigurationOptions (Maybe Text) Source #

The ARN of the custom platform.

describeConfigurationOptions_solutionStackName :: Lens' DescribeConfigurationOptions (Maybe Text) Source #

The name of the solution stack whose configuration options you want to describe.

describeConfigurationOptions_templateName :: Lens' DescribeConfigurationOptions (Maybe Text) Source #

The name of the configuration template whose configuration options you want to describe.

Destructuring the Response

data DescribeConfigurationOptionsResponse Source #

Describes the settings for a specified configuration set.

See: newDescribeConfigurationOptionsResponse smart constructor.

Constructors

DescribeConfigurationOptionsResponse'
Fields options :: Maybe [ConfigurationOptionDescription] A list of ConfigurationOptionDescription. platformArn :: Maybe Text The ARN of the platform version. solutionStackName :: Maybe Text The name of the solution stack these configuration options belong to. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DescribeConfigurationOptionsResponse Source #
Instance details Defined in Amazonka.ElasticBeanstalk.DescribeConfigurationOptions Associated Types type Rep DescribeConfigurationOptionsResponse :: Type -> Type # Methods from :: DescribeConfigurationOptionsResponse -> Rep DescribeConfigurationOptionsResponse x # to :: Rep DescribeConfigurationOptionsResponse x -> DescribeConfigurationOptionsResponse #
Read DescribeConfigurationOptionsResponse Source #
Instance details Defined in Amazonka.ElasticBeanstalk.DescribeConfigurationOptions Methods readsPrec :: Int -> ReadS DescribeConfigurationOptionsResponse # readList :: ReadS [DescribeConfigurationOptionsResponse] # readPrec :: ReadPrec DescribeConfigurationOptionsResponse # readListPrec :: ReadPrec [DescribeConfigurationOptionsResponse] #
Show DescribeConfigurationOptionsResponse Source #
Instance details Defined in Amazonka.ElasticBeanstalk.DescribeConfigurationOptions Methods showsPrec :: Int -> DescribeConfigurationOptionsResponse -> ShowS # show :: DescribeConfigurationOptionsResponse -> String # showList :: [DescribeConfigurationOptionsResponse] -> ShowS #
NFData DescribeConfigurationOptionsResponse Source #
Instance details Defined in Amazonka.ElasticBeanstalk.DescribeConfigurationOptions Methods rnf :: DescribeConfigurationOptionsResponse -> () #
Eq DescribeConfigurationOptionsResponse Source #
Instance details Defined in Amazonka.ElasticBeanstalk.DescribeConfigurationOptions Methods (==) :: DescribeConfigurationOptionsResponse -> DescribeConfigurationOptionsResponse -> Bool # (/=) :: DescribeConfigurationOptionsResponse -> DescribeConfigurationOptionsResponse -> Bool #
type Rep DescribeConfigurationOptionsResponse Source #
Instance details Defined in Amazonka.ElasticBeanstalk.DescribeConfigurationOptions type Rep DescribeConfigurationOptionsResponse = D1 ('MetaData "DescribeConfigurationOptionsResponse" "Amazonka.ElasticBeanstalk.DescribeConfigurationOptions" "amazonka-elasticbeanstalk-2.0-HLGGuY0kjXTIKSbM7JuMHy" 'False) (C1 ('MetaCons "DescribeConfigurationOptionsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "options") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ConfigurationOptionDescription])) :: S1 ('MetaSel ('Just "platformArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "solutionStackName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeConfigurationOptionsResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeConfigurationOptionsResponse'`
-> DescribeConfigurationOptionsResponse

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

DescribeConfigurationOptions, describeConfigurationOptionsResponse_options - A list of ConfigurationOptionDescription.

DescribeConfigurationOptions, describeConfigurationOptionsResponse_platformArn - The ARN of the platform version.

DescribeConfigurationOptions, describeConfigurationOptionsResponse_solutionStackName - The name of the solution stack these configuration options belong to.

$sel:httpStatus:DescribeConfigurationOptionsResponse', describeConfigurationOptionsResponse_httpStatus - The response's http status code.

Response Lenses

describeConfigurationOptionsResponse_options :: Lens' DescribeConfigurationOptionsResponse (Maybe [ConfigurationOptionDescription]) Source #

A list of ConfigurationOptionDescription.

describeConfigurationOptionsResponse_platformArn :: Lens' DescribeConfigurationOptionsResponse (Maybe Text) Source #

The ARN of the platform version.

describeConfigurationOptionsResponse_solutionStackName :: Lens' DescribeConfigurationOptionsResponse (Maybe Text) Source #

The name of the solution stack these configuration options belong to.

describeConfigurationOptionsResponse_httpStatus :: Lens' DescribeConfigurationOptionsResponse Int Source #

The response's http status code.