/AWS1/CL_EBN=>CREATEENVIRONMENT()
¶
About CreateEnvironment¶
Launches an AWS Elastic Beanstalk environment for the specified application using the specified configuration.
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_APPLICATIONNAME
TYPE /AWS1/EBNAPPLICATIONNAME
/AWS1/EBNAPPLICATIONNAME
¶
The name of the application that is associated with this environment.
Optional arguments:¶
IV_ENVIRONMENTNAME
TYPE /AWS1/EBNENVIRONMENTNAME
/AWS1/EBNENVIRONMENTNAME
¶
A unique name for the environment.
Constraint: Must be from 4 to 40 characters in length. The name can contain only letters, numbers, and hyphens. It can't 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, Elastic Beanstalk returns an
InvalidParameterValue
error.If you don't specify the
CNAMEPrefix
parameter, the environment name becomes part of the CNAME, and therefore part of the visible URL for your application.
IV_GROUPNAME
TYPE /AWS1/EBNGROUPNAME
/AWS1/EBNGROUPNAME
¶
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.
IV_DESCRIPTION
TYPE /AWS1/EBNDESCRIPTION
/AWS1/EBNDESCRIPTION
¶
Your description for this environment.
IV_CNAMEPREFIX
TYPE /AWS1/EBNDNSCNAMEPREFIX
/AWS1/EBNDNSCNAMEPREFIX
¶
If specified, the environment attempts to use this value as the prefix for the CNAME in your Elastic Beanstalk environment URL. If not specified, the CNAME is generated automatically by appending a random alphanumeric string to the environment name.
IO_TIER
TYPE REF TO /AWS1/CL_EBNENVIRONMENTTIER
/AWS1/CL_EBNENVIRONMENTTIER
¶
Specifies the tier to use in creating this environment. The environment tier that you choose determines whether Elastic Beanstalk provisions resources to support a web application that handles HTTP(S) requests or a web application that handles background-processing tasks.
IT_TAGS
TYPE /AWS1/CL_EBNTAG=>TT_TAGS
TT_TAGS
¶
Specifies the tags applied to resources in the environment.
IV_VERSIONLABEL
TYPE /AWS1/EBNVERSIONLABEL
/AWS1/EBNVERSIONLABEL
¶
The name of the application version to deploy.
Default: If not specified, Elastic Beanstalk attempts to deploy the sample application.
IV_TEMPLATENAME
TYPE /AWS1/EBNCONFTEMPLATENAME
/AWS1/EBNCONFTEMPLATENAME
¶
The name of the Elastic Beanstalk configuration template to use with the environment.
If you specify
TemplateName
, then don't specifySolutionStackName
.
IV_SOLUTIONSTACKNAME
TYPE /AWS1/EBNSOLUTIONSTACKNAME
/AWS1/EBNSOLUTIONSTACKNAME
¶
The name of an Elastic Beanstalk solution stack (platform version) to use with the environment. If specified, Elastic Beanstalk sets the configuration values to the default values associated with the specified solution stack. For a list of current solution stacks, see Elastic Beanstalk Supported Platforms in the AWS Elastic Beanstalk Platforms guide.
If you specify
SolutionStackName
, don't specifyPlatformArn
orTemplateName
.
IV_PLATFORMARN
TYPE /AWS1/EBNPLATFORMARN
/AWS1/EBNPLATFORMARN
¶
The Amazon Resource Name (ARN) of the custom platform to use with the environment. For more information, see Custom Platforms in the AWS Elastic Beanstalk Developer Guide.
If you specify
PlatformArn
, don't specifySolutionStackName
.
IT_OPTIONSETTINGS
TYPE /AWS1/CL_EBNCONFOPTIONSETTING=>TT_CONFOPTIONSETTINGSLIST
TT_CONFOPTIONSETTINGSLIST
¶
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.
IT_OPTIONSTOREMOVE
TYPE /AWS1/CL_EBNOPTIONSPEC=>TT_OPTIONSSPECIFIERLIST
TT_OPTIONSSPECIFIERLIST
¶
A list of custom user-defined configuration options to remove from the configuration set for this new environment.
IV_OPERATIONSROLE
TYPE /AWS1/EBNOPERATIONSROLE
/AWS1/EBNOPERATIONSROLE
¶
The Amazon Resource Name (ARN) of an existing IAM role to be used as the environment's operations role. If specified, Elastic Beanstalk uses the operations role for permissions to downstream services during this call and during subsequent calls acting on this environment. To specify an operations role, you must have the
iam:PassRole
permission for the role. For more information, see Operations roles in the AWS Elastic Beanstalk Developer Guide.