amazonka-elasticbeanstalk-1.6.0: Amazon Elastic Beanstalk SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.ElasticBeanstalk.CreateEnvironment

Contents

Description

Launches an environment for the specified application using the specified configuration.

Synopsis

Creating a Request

createEnvironment Source #

Creates a value of CreateEnvironment with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • cCNAMEPrefix - If specified, the environment attempts to use this value as the prefix for the CNAME. If not specified, the CNAME is generated automatically by appending a random alphanumeric string to the environment name.
  • cTemplateName - The name of the configuration template to use in deployment. If no configuration template is found with this name, AWS Elastic Beanstalk returns an InvalidParameterValue error.
  • cOptionsToRemove - A list of custom user-defined configuration options to remove from the configuration set for this new environment.
  • cOptionSettings - If specified, AWS Elastic Beanstalk sets the specified configuration options to the requested value in the configuration set for the new environment. These override the values obtained from the solution stack or the configuration template.
  • cVersionLabel - The name of the application version to deploy. If the specified application has no associated application versions, AWS Elastic Beanstalk UpdateEnvironment returns an InvalidParameterValue error. Default: If not specified, AWS Elastic Beanstalk attempts to launch the sample application in the container.
  • cPlatformARN - The ARN of the platform.
  • cTier - This specifies the tier to use for creating this environment.
  • cEnvironmentName - A unique name for the deployment environment. Used in the application URL. Constraint: Must be from 4 to 40 characters in length. The name can contain only letters, numbers, and hyphens. It cannot start or end with a hyphen. This name must be unique within a region in your account. If the specified name already exists in the region, AWS Elastic Beanstalk returns an InvalidParameterValue error. Default: If the CNAME parameter is not specified, the environment name becomes part of the CNAME, and therefore part of the visible URL for your application.
  • cSolutionStackName - This is an alternative to specifying a template name. If specified, AWS Elastic Beanstalk sets the configuration values to the default values associated with the specified solution stack.
  • cGroupName - The name of the group to which the target environment belongs. Specify a group name only if the environment's name is specified in an environment manifest and not with the environment name parameter. See Environment Manifest (env.yaml) for details.
  • cDescription - Describes this environment.
  • cTags - This specifies the tags applied to resources in the environment.
  • cApplicationName - The name of the application that contains the version to be deployed. If no application is found with this name, CreateEnvironment returns an InvalidParameterValue error.

data CreateEnvironment Source #

See: createEnvironment smart constructor.

Instances

Eq CreateEnvironment Source # 
Data CreateEnvironment Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateEnvironment -> c CreateEnvironment #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateEnvironment #

toConstr :: CreateEnvironment -> Constr #

dataTypeOf :: CreateEnvironment -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateEnvironment) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateEnvironment) #

gmapT :: (forall b. Data b => b -> b) -> CreateEnvironment -> CreateEnvironment #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateEnvironment -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateEnvironment -> r #

gmapQ :: (forall d. Data d => d -> u) -> CreateEnvironment -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateEnvironment -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateEnvironment -> m CreateEnvironment #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateEnvironment -> m CreateEnvironment #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateEnvironment -> m CreateEnvironment #

Read CreateEnvironment Source # 
Show CreateEnvironment Source # 
Generic CreateEnvironment Source # 
Hashable CreateEnvironment Source # 
NFData CreateEnvironment Source # 

Methods

rnf :: CreateEnvironment -> () #

AWSRequest CreateEnvironment Source # 
ToHeaders CreateEnvironment Source # 
ToPath CreateEnvironment Source # 
ToQuery CreateEnvironment Source # 
type Rep CreateEnvironment Source # 
type Rep CreateEnvironment = D1 * (MetaData "CreateEnvironment" "Network.AWS.ElasticBeanstalk.CreateEnvironment" "amazonka-elasticbeanstalk-1.6.0-4Kt4TpxAtj66tluiSbk4fC" False) (C1 * (MetaCons "CreateEnvironment'" PrefixI True) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_cCNAMEPrefix") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_cTemplateName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_cOptionsToRemove") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [OptionSpecification]))))) ((:*:) * (S1 * (MetaSel (Just Symbol "_cOptionSettings") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [ConfigurationOptionSetting]))) ((:*:) * (S1 * (MetaSel (Just Symbol "_cVersionLabel") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_cPlatformARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_cTier") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe EnvironmentTier))) ((:*:) * (S1 * (MetaSel (Just Symbol "_cEnvironmentName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_cSolutionStackName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_cGroupName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_cDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_cTags") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Tag]))) (S1 * (MetaSel (Just Symbol "_cApplicationName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)))))))
type Rs CreateEnvironment Source # 

Request Lenses

cCNAMEPrefix :: Lens' CreateEnvironment (Maybe Text) Source #

If specified, the environment attempts to use this value as the prefix for the CNAME. If not specified, the CNAME is generated automatically by appending a random alphanumeric string to the environment name.

cTemplateName :: Lens' CreateEnvironment (Maybe Text) Source #

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

cOptionsToRemove :: Lens' CreateEnvironment [OptionSpecification] Source #

A list of custom user-defined configuration options to remove from the configuration set for this new environment.

cOptionSettings :: Lens' CreateEnvironment [ConfigurationOptionSetting] Source #

If specified, AWS Elastic Beanstalk sets the specified configuration options to the requested value in the configuration set for the new environment. These override the values obtained from the solution stack or the configuration template.

cVersionLabel :: Lens' CreateEnvironment (Maybe Text) Source #

The name of the application version to deploy. If the specified application has no associated application versions, AWS Elastic Beanstalk UpdateEnvironment returns an InvalidParameterValue error. Default: If not specified, AWS Elastic Beanstalk attempts to launch the sample application in the container.

cPlatformARN :: Lens' CreateEnvironment (Maybe Text) Source #

The ARN of the platform.

cTier :: Lens' CreateEnvironment (Maybe EnvironmentTier) Source #

This specifies the tier to use for creating this environment.

cEnvironmentName :: Lens' CreateEnvironment (Maybe Text) Source #

A unique name for the deployment environment. Used in the application URL. Constraint: Must be from 4 to 40 characters in length. The name can contain only letters, numbers, and hyphens. It cannot start or end with a hyphen. This name must be unique within a region in your account. If the specified name already exists in the region, AWS Elastic Beanstalk returns an InvalidParameterValue error. Default: If the CNAME parameter is not specified, the environment name becomes part of the CNAME, and therefore part of the visible URL for your application.

cSolutionStackName :: Lens' CreateEnvironment (Maybe Text) Source #

This is an alternative to specifying a template name. If specified, AWS Elastic Beanstalk sets the configuration values to the default values associated with the specified solution stack.

cGroupName :: Lens' CreateEnvironment (Maybe Text) Source #

The name of the group to which the target environment belongs. Specify a group name only if the environment's name is specified in an environment manifest and not with the environment name parameter. See Environment Manifest (env.yaml) for details.

cDescription :: Lens' CreateEnvironment (Maybe Text) Source #

Describes this environment.

cTags :: Lens' CreateEnvironment [Tag] Source #

This specifies the tags applied to resources in the environment.

cApplicationName :: Lens' CreateEnvironment Text Source #

The name of the application that contains the version to be deployed. If no application is found with this name, CreateEnvironment returns an InvalidParameterValue error.

Destructuring the Response

environmentDescription :: EnvironmentDescription Source #

Creates a value of EnvironmentDescription with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • eStatus - The current operational status of the environment: * Launching : Environment is in the process of initial deployment. * Updating : Environment is in the process of updating its configuration settings or application version. * Ready : Environment is available to have an action performed on it, such as update or terminate. * Terminating : Environment is in the shut-down process. * Terminated : Environment is not running.
  • eCNAME - The URL to the CNAME for this environment.
  • eTemplateName - The name of the configuration template used to originally launch this environment.
  • eAbortableOperationInProgress - Indicates if there is an in-progress environment configuration update or application version deployment that you can cancel. true: There is an update in progress. false: There are no updates currently in progress.
  • eEndpointURL - For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.
  • eResources - The description of the AWS resources used by this environment.
  • eDateUpdated - The last modified date for this environment.
  • eDateCreated - The creation date for this environment.
  • eHealth - Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment: * Red : Indicates the environment is not responsive. Occurs when three or more consecutive failures occur for an environment. * Yellow : Indicates that something is wrong. Occurs when two consecutive failures occur for an environment. * Green : Indicates the environment is healthy and fully functional. * Grey : Default health for a new environment. The environment is not fully launched and health checks have not started or health checks are suspended during an UpdateEnvironment or RestartEnvironement request. Default: Grey
  • eVersionLabel - The application version deployed in this environment.
  • ePlatformARN - The ARN of the platform.
  • eTier - Describes the current tier of this environment.
  • eEnvironmentName - The name of this environment.
  • eApplicationName - The name of the application associated with this environment.
  • eEnvironmentARN - The environment's Amazon Resource Name (ARN), which can be used in other API requests that require an ARN.
  • eSolutionStackName - The name of the SolutionStack deployed with this environment.
  • eEnvironmentId - The ID of this environment.
  • eHealthStatus - Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses .
  • eEnvironmentLinks - A list of links to other environments in the same group.
  • eDescription - Describes this environment.

data EnvironmentDescription Source #

Describes the properties of an environment.

See: environmentDescription smart constructor.

Instances

Eq EnvironmentDescription Source # 
Data EnvironmentDescription Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> EnvironmentDescription -> c EnvironmentDescription #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c EnvironmentDescription #

toConstr :: EnvironmentDescription -> Constr #

dataTypeOf :: EnvironmentDescription -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c EnvironmentDescription) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c EnvironmentDescription) #

gmapT :: (forall b. Data b => b -> b) -> EnvironmentDescription -> EnvironmentDescription #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> EnvironmentDescription -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> EnvironmentDescription -> r #

gmapQ :: (forall d. Data d => d -> u) -> EnvironmentDescription -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> EnvironmentDescription -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> EnvironmentDescription -> m EnvironmentDescription #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> EnvironmentDescription -> m EnvironmentDescription #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> EnvironmentDescription -> m EnvironmentDescription #

Read EnvironmentDescription Source # 
Show EnvironmentDescription Source # 
Generic EnvironmentDescription Source # 
Hashable EnvironmentDescription Source # 
NFData EnvironmentDescription Source # 

Methods

rnf :: EnvironmentDescription -> () #

FromXML EnvironmentDescription Source # 
type Rep EnvironmentDescription Source # 
type Rep EnvironmentDescription = D1 * (MetaData "EnvironmentDescription" "Network.AWS.ElasticBeanstalk.Types.Product" "amazonka-elasticbeanstalk-1.6.0-4Kt4TpxAtj66tluiSbk4fC" False) (C1 * (MetaCons "EnvironmentDescription'" PrefixI True) ((:*:) * ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_eStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe EnvironmentStatus))) (S1 * (MetaSel (Just Symbol "_eCNAME") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_eTemplateName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_eAbortableOperationInProgress") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))) (S1 * (MetaSel (Just Symbol "_eEndpointURL") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_eResources") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe EnvironmentResourcesDescription))) (S1 * (MetaSel (Just Symbol "_eDateUpdated") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe ISO8601)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_eDateCreated") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe ISO8601))) ((:*:) * (S1 * (MetaSel (Just Symbol "_eHealth") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe EnvironmentHealth))) (S1 * (MetaSel (Just Symbol "_eVersionLabel") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))))) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_ePlatformARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_eTier") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe EnvironmentTier)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_eEnvironmentName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_eApplicationName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_eEnvironmentARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_eSolutionStackName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_eEnvironmentId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_eHealthStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe EnvironmentHealthStatus))) ((:*:) * (S1 * (MetaSel (Just Symbol "_eEnvironmentLinks") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [EnvironmentLink]))) (S1 * (MetaSel (Just Symbol "_eDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))))))))

Response Lenses

eStatus :: Lens' EnvironmentDescription (Maybe EnvironmentStatus) Source #

The current operational status of the environment: * Launching : Environment is in the process of initial deployment. * Updating : Environment is in the process of updating its configuration settings or application version. * Ready : Environment is available to have an action performed on it, such as update or terminate. * Terminating : Environment is in the shut-down process. * Terminated : Environment is not running.

eCNAME :: Lens' EnvironmentDescription (Maybe Text) Source #

The URL to the CNAME for this environment.

eTemplateName :: Lens' EnvironmentDescription (Maybe Text) Source #

The name of the configuration template used to originally launch this environment.

eAbortableOperationInProgress :: Lens' EnvironmentDescription (Maybe Bool) Source #

Indicates if there is an in-progress environment configuration update or application version deployment that you can cancel. true: There is an update in progress. false: There are no updates currently in progress.

eEndpointURL :: Lens' EnvironmentDescription (Maybe Text) Source #

For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.

eResources :: Lens' EnvironmentDescription (Maybe EnvironmentResourcesDescription) Source #

The description of the AWS resources used by this environment.

eDateUpdated :: Lens' EnvironmentDescription (Maybe UTCTime) Source #

The last modified date for this environment.

eDateCreated :: Lens' EnvironmentDescription (Maybe UTCTime) Source #

The creation date for this environment.

eHealth :: Lens' EnvironmentDescription (Maybe EnvironmentHealth) Source #

Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment: * Red : Indicates the environment is not responsive. Occurs when three or more consecutive failures occur for an environment. * Yellow : Indicates that something is wrong. Occurs when two consecutive failures occur for an environment. * Green : Indicates the environment is healthy and fully functional. * Grey : Default health for a new environment. The environment is not fully launched and health checks have not started or health checks are suspended during an UpdateEnvironment or RestartEnvironement request. Default: Grey

eVersionLabel :: Lens' EnvironmentDescription (Maybe Text) Source #

The application version deployed in this environment.

eTier :: Lens' EnvironmentDescription (Maybe EnvironmentTier) Source #

Describes the current tier of this environment.

eEnvironmentName :: Lens' EnvironmentDescription (Maybe Text) Source #

The name of this environment.

eApplicationName :: Lens' EnvironmentDescription (Maybe Text) Source #

The name of the application associated with this environment.

eEnvironmentARN :: Lens' EnvironmentDescription (Maybe Text) Source #

The environment's Amazon Resource Name (ARN), which can be used in other API requests that require an ARN.

eSolutionStackName :: Lens' EnvironmentDescription (Maybe Text) Source #

The name of the SolutionStack deployed with this environment.

eEnvironmentId :: Lens' EnvironmentDescription (Maybe Text) Source #

The ID of this environment.

eHealthStatus :: Lens' EnvironmentDescription (Maybe EnvironmentHealthStatus) Source #

Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses .

eEnvironmentLinks :: Lens' EnvironmentDescription [EnvironmentLink] Source #

A list of links to other environments in the same group.

eDescription :: Lens' EnvironmentDescription (Maybe Text) Source #

Describes this environment.