String applicationArn
The Amazon Resource Name (ARN) of the application.
String applicationName
The name of the application.
String description
User-defined description of the application.
Date dateCreated
The date when the application was created.
Date dateUpdated
The date when the application was last modified.
SdkInternalList<T> versions
The names of the versions for this application.
SdkInternalList<T> configurationTemplates
The names of the configuration templates associated with this application.
ApplicationResourceLifecycleConfig resourceLifecycleConfig
The lifecycle settings for the application.
Integer duration
The amount of time that the metrics cover (usually 10 seconds). For example, you might have 5 requests (
request_count
) within the most recent time slice of 10 seconds (duration
).
Integer requestCount
Average number of requests handled by the web server per second over the last 10 seconds.
StatusCodes statusCodes
Represents the percentage of requests over the last 10 seconds that resulted in each type of status code response.
Latency latency
Represents the average latency for the slowest X percent of requests over the last 10 seconds. Latencies are in seconds with one millisecond resolution.
String serviceRole
The ARN of an IAM service role that Elastic Beanstalk has permission to assume.
The ServiceRole
property is required the first time that you provide a
VersionLifecycleConfig
for the application in one of the supporting calls (
CreateApplication
or UpdateApplicationResourceLifecycle
). After you provide it once, in
either one of the calls, Elastic Beanstalk persists the Service Role with the application, and you don't need to
specify it again in subsequent UpdateApplicationResourceLifecycle
calls. You can, however, specify
it in subsequent calls to change the Service Role to another value.
ApplicationVersionLifecycleConfig versionLifecycleConfig
Defines lifecycle settings for application versions.
String applicationVersionArn
The Amazon Resource Name (ARN) of the application version.
String applicationName
The name of the application to which the application version belongs.
String description
The description of the application version.
String versionLabel
A unique identifier for the application version.
SourceBuildInformation sourceBuildInformation
If the version's source code was retrieved from AWS CodeCommit, the location of the source code for the application version.
String buildArn
Reference to the artifact from the AWS CodeBuild build.
S3Location sourceBundle
The storage location of the application version's source bundle in Amazon S3.
Date dateCreated
The creation date of the application version.
Date dateUpdated
The last modified date of the application version.
String status
The processing status of the application version. Reflects the state of the application version during its
creation. Many of the values are only applicable if you specified True
for the Process
parameter of the CreateApplicationVersion
action. The following list describes the possible values.
Unprocessed
– Application version wasn't pre-processed or validated. Elastic Beanstalk will validate
configuration files during deployment of the application version to an environment.
Processing
– Elastic Beanstalk is currently processing the application version.
Building
– Application version is currently undergoing an AWS CodeBuild build.
Processed
– Elastic Beanstalk was successfully pre-processed and validated.
Failed
– Either the AWS CodeBuild build failed or configuration files didn't pass validation. This
application version isn't usable.
MaxCountRule maxCountRule
Specify a max count rule to restrict the number of application versions that are retained for an application.
MaxAgeRule maxAgeRule
Specify a max age rule to restrict the length of time that application versions are retained for an application.
String name
The name of the AutoScalingGroup
.
String artifactName
The name of the artifact of the CodeBuild build. If provided, Elastic Beanstalk stores the build artifact in the S3 location S3-bucket/resources/application-name/codebuild/codebuild-version-label-artifact -name.zip. If not provided, Elastic Beanstalk stores the build artifact in the S3 location S3-bucket/resources/application-name/codebuild/codebuild-version-label.zip.
String codeBuildServiceRole
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.
String computeType
Information about the compute resources the build project will use.
BUILD_GENERAL1_SMALL: Use up to 3 GB memory and 2 vCPUs for builds
BUILD_GENERAL1_MEDIUM: Use up to 7 GB memory and 4 vCPUs for builds
BUILD_GENERAL1_LARGE: Use up to 15 GB memory and 8 vCPUs for builds
String image
The ID of the Docker image to use for this build project.
Integer timeoutInMinutes
How long in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait until timing out any related build that does not get marked as completed. The default is 60 minutes.
String aRN
The ARN of the builder.
String cNAMEPrefix
The prefix used when this CNAME is reserved.
Boolean available
Indicates if the specified CNAME is available:
true
: The CNAME is available.
false
: The CNAME is not available.
String fullyQualifiedCNAME
The fully qualified CNAME to reserve when CreateEnvironment is called with the provided prefix.
String applicationName
The name of the application to which the specified source bundles belong.
String groupName
The name of the group to which the target environments belong. Specify a group name only if the environment name defined in each target environment's manifest ends with a + (plus) character. See Environment Manifest (env.yaml) for details.
SdkInternalList<T> versionLabels
A list of version labels, specifying one or more application source bundles that belong to the target application. Each source bundle must include an environment manifest that specifies the name of the environment and the name of the solution stack to use, and optionally can specify environment links to create.
SdkInternalList<T> environments
Returns an EnvironmentDescription list.
String nextToken
In a paginated request, the token that you can pass in a subsequent request to get the next response page.
String namespace
A unique namespace identifying the option's associated AWS resource.
String name
The name of the configuration option.
String defaultValue
The default value for this configuration option.
String changeSeverity
An indication of which action is required if the value for this configuration option changes:
NoInterruption
: There is no interruption to the environment or application availability.
RestartEnvironment
: The environment is entirely restarted, all AWS resources are deleted and
recreated, and the environment is unavailable during the process.
RestartApplicationServer
: The environment is available the entire time. However, a short
application outage occurs when the application servers on the running Amazon EC2 instances are restarted.
Boolean userDefined
An indication of whether the user defined this configuration option:
true
: This configuration option was defined by the user. It is a valid choice for specifying if
this as an Option to Remove
when updating configuration settings.
false
: This configuration was not defined by the user.
Constraint: You can remove only UserDefined
options from a configuration.
Valid Values: true
| false
String valueType
An indication of which type of values this option has and whether it is allowable to select one or more than one of the possible values:
Scalar
: Values for this option are a single selection from the possible values, or an unformatted
string, or numeric value governed by the MIN/MAX/Regex
constraints.
List
: Values for this option are multiple selections from the possible values.
Boolean
: Values for this option are either true
or false
.
Json
: Values for this option are a JSON representation of a ConfigDocument
.
SdkInternalList<T> valueOptions
If specified, values for the configuration option are selected from this list.
Integer minValue
If specified, the configuration option must be a numeric value greater than this value.
Integer maxValue
If specified, the configuration option must be a numeric value less than this value.
Integer maxLength
If specified, the configuration option must be a string value no longer than this value.
OptionRestrictionRegex regex
If specified, the configuration option must be a string value that satisfies this regular expression.
String resourceName
A unique resource name for the option setting. Use it for a time–based scaling configuration option.
String namespace
A unique namespace that identifies the option's associated AWS resource.
String optionName
The name of the configuration option.
String value
The current value for the configuration option.
String solutionStackName
The name of the solution stack this configuration set uses.
String platformArn
The ARN of the platform version.
String applicationName
The name of the application associated with this configuration set.
String templateName
If not null
, the name of the configuration template for this configuration set.
String description
Describes this configuration set.
String environmentName
If not null
, the name of the environment for this configuration set.
String 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.
Date dateCreated
The date (in UTC time) when this configuration set was created.
Date dateUpdated
The date (in UTC time) when this configuration set was last modified.
SdkInternalList<T> optionSettings
A list of the configuration options and their values in this configuration set.
Double user
Percentage of time that the CPU has spent in the User
state over the last 10 seconds.
Double nice
Available on Linux environments only.
Percentage of time that the CPU has spent in the Nice
state over the last 10 seconds.
Double system
Available on Linux environments only.
Percentage of time that the CPU has spent in the System
state over the last 10 seconds.
Double idle
Percentage of time that the CPU has spent in the Idle
state over the last 10 seconds.
Double iOWait
Available on Linux environments only.
Percentage of time that the CPU has spent in the I/O Wait
state over the last 10 seconds.
Double iRQ
Available on Linux environments only.
Percentage of time that the CPU has spent in the IRQ
state over the last 10 seconds.
Double softIRQ
Available on Linux environments only.
Percentage of time that the CPU has spent in the SoftIRQ
state over the last 10 seconds.
Double privileged
Available on Windows environments only.
Percentage of time that the CPU has spent in the Privileged
state over the last 10 seconds.
String applicationName
The name of the application. Must be unique within your account.
String description
Your description of the application.
ApplicationResourceLifecycleConfig resourceLifecycleConfig
Specifies an application resource lifecycle configuration to prevent your application from accumulating too many versions.
SdkInternalList<T> tags
Specifies the tags applied to the application.
Elastic Beanstalk applies these tags only to the application. Environments that you create in the application don't inherit the tags.
ApplicationDescription application
The ApplicationDescription of the application.
String applicationName
The name of the application. If no application is found with this name, and AutoCreateApplication
is
false
, returns an InvalidParameterValue
error.
String versionLabel
A label identifying this version.
Constraint: Must be unique per application. If an application version already exists with this label for the
specified application, AWS Elastic Beanstalk returns an InvalidParameterValue
error.
String description
A description of this application version.
SourceBuildInformation sourceBuildInformation
Specify a commit in an AWS CodeCommit Git repository to use as the source code for the application version.
S3Location sourceBundle
The Amazon S3 bucket and key that identify the location of the source bundle for this version.
The Amazon S3 bucket must be in the same region as the environment.
Specify a source bundle in S3 or a commit in an AWS CodeCommit repository (with
SourceBuildInformation
), but not both. If neither SourceBundle
nor
SourceBuildInformation
are provided, Elastic Beanstalk uses a sample application.
BuildConfiguration buildConfiguration
Settings for an AWS CodeBuild build.
Boolean autoCreateApplication
Set to true
to create an application with the specified name if it doesn't already exist.
Boolean process
Pre-processes and validates the environment manifest (env.yaml
) and configuration files (
*.config
files in the .ebextensions
folder) in the source bundle. Validating
configuration files can identify issues prior to deploying the application version to an environment.
You must turn processing on for application versions that you create using AWS CodeBuild or AWS CodeCommit. For application versions built from a source bundle in Amazon S3, processing is optional.
The Process
option validates Elastic Beanstalk configuration files. It doesn't validate your
application's configuration files, like proxy server or Docker configuration.
SdkInternalList<T> tags
Specifies the tags applied to the application version.
Elastic Beanstalk applies these tags only to the application version. Environments that use the application version don't inherit the tags.
ApplicationVersionDescription applicationVersion
The ApplicationVersionDescription of the application version.
String applicationName
The name of the Elastic Beanstalk application to associate with this configuration template.
String templateName
The name of the configuration template.
Constraint: This name must be unique per application.
String solutionStackName
The name of an Elastic Beanstalk solution stack (platform version) that this configuration uses. For example,
64bit Amazon Linux 2013.09 running Tomcat 7 Java 7
. A solution stack specifies the operating system,
runtime, and application server for a configuration template. It also determines the set of configuration options
as well as the possible and default values. For more information, see Supported Platforms in
the AWS Elastic Beanstalk Developer Guide.
You must specify SolutionStackName
if you don't specify PlatformArn
,
EnvironmentId
, or SourceConfiguration
.
Use the
ListAvailableSolutionStacks
API to obtain a list of available solution stacks.
String platformArn
The Amazon Resource Name (ARN) of the custom platform. For more information, see Custom Platforms in the AWS Elastic Beanstalk Developer Guide.
If you specify PlatformArn
, then don't specify SolutionStackName
.
SourceConfiguration sourceConfiguration
An Elastic Beanstalk configuration template to base this one on. If specified, Elastic Beanstalk uses the configuration values from the specified configuration template to create a new configuration.
Values specified in OptionSettings
override any values obtained from the
SourceConfiguration
.
You must specify SourceConfiguration
if you don't specify PlatformArn
,
EnvironmentId
, or SolutionStackName
.
Constraint: If both solution stack name and source configuration are specified, the solution stack of the source configuration template must match the specified solution stack name.
String environmentId
The ID of an environment whose settings you want to use to create the configuration template. You must specify
EnvironmentId
if you don't specify PlatformArn
, SolutionStackName
, or
SourceConfiguration
.
String description
An optional description for this configuration.
SdkInternalList<T> optionSettings
Option values for the Elastic Beanstalk configuration, such as the instance type. If specified, these values override the values obtained from the solution stack or the source configuration template. For a complete list of Elastic Beanstalk configuration options, see Option Values in the AWS Elastic Beanstalk Developer Guide.
SdkInternalList<T> tags
Specifies the tags applied to the configuration template.
String solutionStackName
The name of the solution stack this configuration set uses.
String platformArn
The ARN of the platform version.
String applicationName
The name of the application associated with this configuration set.
String templateName
If not null
, the name of the configuration template for this configuration set.
String description
Describes this configuration set.
String environmentName
If not null
, the name of the environment for this configuration set.
String 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.
Date dateCreated
The date (in UTC time) when this configuration set was created.
Date dateUpdated
The date (in UTC time) when this configuration set was last modified.
SdkInternalList<T> optionSettings
A list of the configuration options and their values in this configuration set.
String applicationName
The name of the application that is associated with this environment.
String environmentName
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.
String groupName
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.
String description
Your description for this environment.
String cNAMEPrefix
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.
EnvironmentTier tier
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.
SdkInternalList<T> tags
Specifies the tags applied to resources in the environment.
String versionLabel
The name of the application version to deploy.
Default: If not specified, Elastic Beanstalk attempts to deploy the sample application.
String templateName
The name of the Elastic Beanstalk configuration template to use with the environment.
If you specify TemplateName
, then don't specify SolutionStackName
.
String solutionStackName
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 specify PlatformArn
or
TemplateName
.
String platformArn
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 specify SolutionStackName
.
SdkInternalList<T> optionSettings
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.
SdkInternalList<T> optionsToRemove
A list of custom user-defined configuration options to remove from the configuration set for this new environment.
String operationsRole
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.
String environmentName
The name of this environment.
String environmentId
The ID of this environment.
String applicationName
The name of the application associated with this environment.
String versionLabel
The application version deployed in this environment.
String solutionStackName
The name of the SolutionStack
deployed with this environment.
String platformArn
The ARN of the platform version.
String templateName
The name of the configuration template used to originally launch this environment.
String description
Describes this environment.
String endpointURL
For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.
String cNAME
The URL to the CNAME for this environment.
Date dateCreated
The creation date for this environment.
Date dateUpdated
The last modified date for this environment.
String status
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.
Boolean abortableOperationInProgress
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.
String health
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
RestartEnvironment
request.
Default: Grey
String healthStatus
Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.
EnvironmentResourcesDescription resources
The description of the AWS resources used by this environment.
EnvironmentTier tier
Describes the current tier of this environment.
SdkInternalList<T> environmentLinks
A list of links to other environments in the same group.
String environmentArn
The environment's Amazon Resource Name (ARN), which can be used in other API requests that require an ARN.
String operationsRole
The Amazon Resource Name (ARN) of the environment's operations role. For more information, see Operations roles in the AWS Elastic Beanstalk Developer Guide.
String platformName
The name of your custom platform.
String platformVersion
The number, such as 1.0.2, for the new platform version.
S3Location platformDefinitionBundle
The location of the platform definition archive in Amazon S3.
String environmentName
The name of the builder environment.
SdkInternalList<T> optionSettings
The configuration option settings to apply to the builder environment.
SdkInternalList<T> tags
Specifies the tags applied to the new platform version.
Elastic Beanstalk applies these tags only to the platform version. Environments that you create using the platform version don't inherit the tags.
PlatformSummary platformSummary
Detailed information about the new version of the custom platform.
Builder builder
The builder used to create the custom platform.
String s3Bucket
The name of the Amazon S3 bucket created.
String applicationName
The name of the application to which the version belongs.
String versionLabel
The label of the version to delete.
Boolean deleteSourceBundle
Set to true
to delete the source bundle from your storage bucket. Otherwise, the application version
is deleted only from Elastic Beanstalk and the source bundle remains in Amazon S3.
String platformArn
The ARN of the version of the custom platform.
PlatformSummary platformSummary
Detailed information about the version of the custom platform.
String versionLabel
The version label of the application version in the deployment.
Long deploymentId
The ID of the deployment. This number increases by one each time that you deploy source code or change instance configuration settings.
String status
The status of the deployment:
In Progress
: The deployment is in progress.
Deployed
: The deployment succeeded.
Failed
: The deployment failed.
Date deploymentTime
For in-progress deployments, the time that the deployment started.
For completed deployments, the time that the deployment ended.
ResourceQuotas resourceQuotas
The Elastic Beanstalk resource quotas associated with the calling AWS account.
SdkInternalList<T> applicationNames
If specified, AWS Elastic Beanstalk restricts the returned descriptions to only include those with the specified names.
SdkInternalList<T> applications
This parameter contains a list of ApplicationDescription.
String applicationName
Specify an application name to show only application versions for that application.
SdkInternalList<T> versionLabels
Specify a version label to show a specific application version.
Integer maxRecords
For a paginated request. Specify a maximum number of application versions to include in each response.
If no MaxRecords
is specified, all available application versions are retrieved in a single
response.
String nextToken
For a paginated request. Specify a token from a previous response page to retrieve the next response page. All other parameter values must be identical to the ones specified in the initial request.
If no NextToken
is specified, the first page is retrieved.
SdkInternalList<T> applicationVersions
List of ApplicationVersionDescription
objects sorted in order of creation.
String nextToken
In a paginated request, the token that you can pass in a subsequent request to get the next response page.
String 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.
String templateName
The name of the configuration template whose configuration options you want to describe.
String environmentName
The name of the environment whose configuration options you want to describe.
String solutionStackName
The name of the solution stack whose configuration options you want to describe.
String platformArn
The ARN of the custom platform.
SdkInternalList<T> options
If specified, restricts the descriptions to only the specified options.
String solutionStackName
The name of the solution stack these configuration options belong to.
String platformArn
The ARN of the platform version.
SdkInternalList<T> options
A list of ConfigurationOptionDescription.
String applicationName
The application for the environment or configuration template.
String templateName
The name of the configuration template to describe.
Conditional: You must specify either this parameter or an EnvironmentName, but not both. If you specify both, AWS
Elastic Beanstalk returns an InvalidParameterCombination
error. If you do not specify either, AWS
Elastic Beanstalk returns a MissingRequiredParameter
error.
String environmentName
The name of the environment to describe.
Condition: You must specify either this or a TemplateName, but not both. If you specify both, AWS Elastic
Beanstalk returns an InvalidParameterCombination
error. If you do not specify either, AWS Elastic
Beanstalk returns MissingRequiredParameter
error.
SdkInternalList<T> configurationSettings
A list of ConfigurationSettingsDescription.
String environmentName
Specify the environment by name.
You must specify either this or an EnvironmentName, or both.
String environmentId
Specify the environment by ID.
You must specify either this or an EnvironmentName, or both.
SdkInternalList<T> attributeNames
Specify the response elements to return. To retrieve all attributes, set to All
. If no attribute
names are specified, returns the name of the environment.
String environmentName
The environment's name.
String healthStatus
The health
status of the environment. For example, Ok
.
String status
The environment's operational status. Ready
, Launching
, Updating
,
Terminating
, or Terminated
.
String color
The health color of the environment.
SdkInternalList<T> causes
Descriptions of the data that contributed to the environment's current health status.
ApplicationMetrics applicationMetrics
Application request metrics for the environment.
InstanceHealthSummary instancesHealth
Summary health information for the instances in the environment.
Date refreshedAt
The date and time that the health information was retrieved.
String environmentId
The environment ID of the target environment.
String environmentName
The name of the target environment.
String nextToken
The pagination token returned by a previous request.
Integer maxItems
The maximum number of items to return for a single request.
SdkInternalList<T> managedActionHistoryItems
A list of completed and failed managed actions.
String nextToken
A pagination token that you pass to DescribeEnvironmentManagedActionHistory to get the next page of results.
SdkInternalList<T> managedActions
A list of upcoming and in-progress managed actions.
String environmentId
The ID of the environment to retrieve AWS resource usage data.
Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic
Beanstalk returns MissingRequiredParameter
error.
String environmentName
The name of the environment to retrieve AWS resource usage data.
Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic
Beanstalk returns MissingRequiredParameter
error.
EnvironmentResourceDescription environmentResources
A list of EnvironmentResourceDescription.
String applicationName
If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.
String versionLabel
If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.
SdkInternalList<T> environmentIds
If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.
SdkInternalList<T> environmentNames
If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.
Boolean includeDeleted
Indicates whether to include deleted environments:
true
: Environments that have been deleted after IncludedDeletedBackTo
are displayed.
false
: Do not include deleted environments.
Date includedDeletedBackTo
If specified when IncludeDeleted
is set to true
, then environments deleted after this
date are displayed.
Integer maxRecords
For a paginated request. Specify a maximum number of environments to include in each response.
If no MaxRecords
is specified, all available environments are retrieved in a single response.
String nextToken
For a paginated request. Specify a token from a previous response page to retrieve the next response page. All other parameter values must be identical to the ones specified in the initial request.
If no NextToken
is specified, the first page is retrieved.
SdkInternalList<T> environments
Returns an EnvironmentDescription list.
String nextToken
In a paginated request, the token that you can pass in a subsequent request to get the next response page.
String applicationName
If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those associated with this application.
String versionLabel
If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this application version.
String templateName
If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that are associated with this environment configuration.
String environmentId
If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.
String environmentName
If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.
String platformArn
The ARN of a custom platform version. If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this custom platform version.
String requestId
If specified, AWS Elastic Beanstalk restricts the described events to include only those associated with this request ID.
String severity
If specified, limits the events returned from this call to include only those with the specified severity or higher.
Date startTime
If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur on or after this time.
Date endTime
If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur up to, but not
including, the EndTime
.
Integer maxRecords
Specifies the maximum number of events that can be returned, beginning with the most recent event.
String nextToken
Pagination token. If specified, the events return the next batch of results.
SdkInternalList<T> events
A list of EventDescription.
String nextToken
If returned, this indicates that there are more results to obtain. Use this token in the next DescribeEvents call to get the next batch of events.
String environmentName
Specify the AWS Elastic Beanstalk environment by name.
String environmentId
Specify the AWS Elastic Beanstalk environment by ID.
SdkInternalList<T> attributeNames
Specifies the response elements you wish to receive. To retrieve all attributes, set to All
. If no
attribute names are specified, returns a list of instances.
String nextToken
Specify the pagination token returned by a previous call.
SdkInternalList<T> instanceHealthList
Detailed health information about each instance.
The output differs slightly between Linux and Windows environments. There is a difference in the members that are
supported under the <CPUUtilization>
type.
Date refreshedAt
The date and time that the health information was retrieved.
String nextToken
Pagination token for the next page of results, if available.
String platformArn
The ARN of the platform version.
PlatformDescription platformDescription
Detailed information about the platform version.
String environmentName
The name of the environment from which to disassociate the operations role.
String environmentName
The name of this environment.
String environmentId
The ID of this environment.
String applicationName
The name of the application associated with this environment.
String versionLabel
The application version deployed in this environment.
String solutionStackName
The name of the SolutionStack
deployed with this environment.
String platformArn
The ARN of the platform version.
String templateName
The name of the configuration template used to originally launch this environment.
String description
Describes this environment.
String endpointURL
For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.
String cNAME
The URL to the CNAME for this environment.
Date dateCreated
The creation date for this environment.
Date dateUpdated
The last modified date for this environment.
String status
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.
Boolean abortableOperationInProgress
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.
String health
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
RestartEnvironment
request.
Default: Grey
String healthStatus
Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.
EnvironmentResourcesDescription resources
The description of the AWS resources used by this environment.
EnvironmentTier tier
Describes the current tier of this environment.
SdkInternalList<T> environmentLinks
A list of links to other environments in the same group.
String environmentArn
The environment's Amazon Resource Name (ARN), which can be used in other API requests that require an ARN.
String operationsRole
The Amazon Resource Name (ARN) of the environment's operations role. For more information, see Operations roles in the AWS Elastic Beanstalk Developer Guide.
String infoType
The type of information retrieved.
String ec2InstanceId
The Amazon EC2 Instance ID for this information.
Date sampleTimestamp
The time stamp when this information was retrieved.
String message
The retrieved information. Currently contains a presigned Amazon S3 URL. The files are deleted after 15 minutes.
Anyone in possession of this URL can access the files before they are deleted. Make the URL available only to trusted parties.
String environmentName
The name of the environment.
SdkInternalList<T> autoScalingGroups
The AutoScalingGroups
used by this environment.
SdkInternalList<T> instances
The Amazon EC2 instances used by this environment.
SdkInternalList<T> launchConfigurations
The Auto Scaling launch configurations in use by this environment.
SdkInternalList<T> launchTemplates
The Amazon EC2 launch templates in use by this environment.
SdkInternalList<T> loadBalancers
The LoadBalancers in use by this environment.
SdkInternalList<T> triggers
The AutoScaling
triggers in use by this environment.
SdkInternalList<T> queues
The queues used by this environment.
LoadBalancerDescription loadBalancer
Describes the LoadBalancer.
String name
The name of this environment tier.
Valid values:
For Web server tier – WebServer
For Worker tier – Worker
String type
The type of this environment tier.
Valid values:
For Web server tier – Standard
For Worker tier – SQS/HTTP
String version
The version of this environment tier. When you don't set a value to it, Elastic Beanstalk uses the latest compatible worker tier version.
This member is deprecated. Any specific version that you set may become out of date. We recommend leaving it unspecified.
Date eventDate
The date when the event occurred.
String message
The event message.
String applicationName
The application associated with the event.
String versionLabel
The release label for the application version associated with this event.
String templateName
The name of the configuration associated with this event.
String environmentName
The name of the environment associated with this event.
String platformArn
The ARN of the platform version.
String requestId
The web service request ID for the activity of this event.
String severity
The severity level of this event.
String id
The ID of the Amazon EC2 instance.
Integer noData
Grey. AWS Elastic Beanstalk and the health agent are reporting no data on an instance.
Integer unknown
Grey. AWS Elastic Beanstalk and the health agent are reporting an insufficient amount of data on an instance.
Integer pending
Grey. An operation is in progress on an instance within the command timeout.
Integer ok
Green. An instance is passing health checks and the health agent is not reporting any problems.
Integer info
Green. An operation is in progress on an instance.
Integer warning
Yellow. The health agent is reporting a moderate number of request failures or other issues for an instance or environment.
Integer degraded
Red. The health agent is reporting a high number of request failures or other issues for an instance or environment.
Integer severe
Red. The health agent is reporting a very high number of request failures or other issues for an instance or environment.
Double p999
The average latency for the slowest 0.1 percent of requests over the last 10 seconds.
Double p99
The average latency for the slowest 1 percent of requests over the last 10 seconds.
Double p95
The average latency for the slowest 5 percent of requests over the last 10 seconds.
Double p90
The average latency for the slowest 10 percent of requests over the last 10 seconds.
Double p85
The average latency for the slowest 15 percent of requests over the last 10 seconds.
Double p75
The average latency for the slowest 25 percent of requests over the last 10 seconds.
Double p50
The average latency for the slowest 50 percent of requests over the last 10 seconds.
Double p10
The average latency for the slowest 90 percent of requests over the last 10 seconds.
String name
The name of the launch configuration.
String id
The ID of the launch template.
SdkInternalList<T> solutionStacks
A list of available solution stacks.
SdkInternalList<T> solutionStackDetails
A list of available solution stacks and their SolutionStackDescription.
SdkInternalList<T> filters
Criteria for restricting the resulting list of platform branches. The filter is evaluated as a logical
conjunction (AND) of the separate SearchFilter
terms.
The following list shows valid attribute values for each of the SearchFilter
terms. Most operators
take a single value. The in
and not_in
operators can take multiple values.
Attribute = BranchName
:
Operator
: =
| !=
| begins_with
| ends_with
|
contains
| in
| not_in
Attribute = LifecycleState
:
Operator
: =
| !=
| in
| not_in
Values
: beta
| supported
| deprecated
| retired
Attribute = PlatformName
:
Operator
: =
| !=
| begins_with
| ends_with
|
contains
| in
| not_in
Attribute = TierType
:
Operator
: =
| !=
Values
: WebServer/Standard
| Worker/SQS/HTTP
Array size: limited to 10 SearchFilter
objects.
Within each SearchFilter
item, the Values
array is limited to 10 items.
Integer maxRecords
The maximum number of platform branch values returned in one call.
String nextToken
For a paginated request. Specify a token from a previous response page to retrieve the next response page. All other parameter values must be identical to the ones specified in the initial request.
If no NextToken
is specified, the first page is retrieved.
SdkInternalList<T> platformBranchSummaryList
Summary information about the platform branches.
String nextToken
In a paginated request, if this value isn't null
, it's the token that you can pass in a subsequent
request to get the next response page.
SdkInternalList<T> filters
Criteria for restricting the resulting list of platform versions. The filter is interpreted as a logical
conjunction (AND) of the separate PlatformFilter
terms.
Integer maxRecords
The maximum number of platform version values returned in one call.
String nextToken
For a paginated request. Specify a token from a previous response page to retrieve the next response page. All other parameter values must be identical to the ones specified in the initial request.
If no NextToken
is specified, the first page is retrieved.
SdkInternalList<T> platformSummaryList
Summary information about the platform versions.
String nextToken
In a paginated request, if this value isn't null
, it's the token that you can pass in a subsequent
request to get the next response page.
String resourceArn
The Amazon Resource Name (ARN) of the resouce for which a tag list is requested.
Must be the ARN of an Elastic Beanstalk resource.
String resourceArn
The Amazon Resource Name (ARN) of the resource for which a tag list was requested.
SdkInternalList<T> resourceTags
A list of tag key-value pairs.
String name
The name of the LoadBalancer.
String loadBalancerName
The name of the LoadBalancer.
String domain
The domain name of the LoadBalancer.
SdkInternalList<T> listeners
A list of Listeners used by the LoadBalancer.
String actionId
A unique identifier for the managed action.
String actionDescription
A description of the managed action.
String actionType
The type of managed action.
String status
The status of the managed action. If the action is Scheduled
, you can apply it immediately with
ApplyEnvironmentManagedAction.
Date windowStartTime
The start time of the maintenance window in which the managed action will execute.
String actionId
A unique identifier for the managed action.
String actionType
The type of the managed action.
String actionDescription
A description of the managed action.
String failureType
If the action failed, the type of failure.
String status
The status of the action.
String failureDescription
If the action failed, a description of the failure.
Date executedTime
The date and time that the action started executing.
Date finishedTime
The date and time that the action finished executing.
Boolean enabled
Specify true
to apply the rule, or false
to disable it.
Integer maxAgeInDays
Specify the number of days to retain an application versions.
Boolean deleteSourceFromS3
Set to true
to delete a version's source bundle from Amazon S3 when Elastic Beanstalk deletes the
application version.
Boolean enabled
Specify true
to apply the rule, or false
to disable it.
Integer maxCount
Specify the maximum number of application versions to retain.
Boolean deleteSourceFromS3
Set to true
to delete a version's source bundle from Amazon S3 when Elastic Beanstalk deletes the
application version.
String platformName
The name of the platform to which this platform branch belongs.
String branchName
The name of the platform branch.
String lifecycleState
The support life cycle state of the platform branch.
Possible values: beta
| supported
| deprecated
| retired
Integer branchOrder
An ordinal number that designates the order in which platform branches have been added to a platform. This can be
helpful, for example, if your code calls the ListPlatformBranches
action and then displays a list of
platform branches.
A larger BranchOrder
value designates a newer platform branch within the platform.
SdkInternalList<T> supportedTierList
The environment tiers that platform versions in this branch support.
Possible values: WebServer/Standard
| Worker/SQS/HTTP
String platformArn
The ARN of the platform version.
String platformOwner
The AWS account ID of the person who created the platform version.
String platformName
The name of the platform version.
String platformVersion
The version of the platform version.
String solutionStackName
The name of the solution stack used by the platform version.
String platformStatus
The status of the platform version.
Date dateCreated
The date when the platform version was created.
Date dateUpdated
The date when the platform version was last updated.
String platformCategory
The category of the platform version.
String description
The description of the platform version.
String maintainer
Information about the maintainer of the platform version.
String operatingSystemName
The operating system used by the platform version.
String operatingSystemVersion
The version of the operating system used by the platform version.
SdkInternalList<T> programmingLanguages
The programming languages supported by the platform version.
SdkInternalList<T> frameworks
The frameworks supported by the platform version.
SdkInternalList<T> customAmiList
The custom AMIs supported by the platform version.
SdkInternalList<T> supportedTierList
The tiers supported by the platform version.
SdkInternalList<T> supportedAddonList
The additions supported by the platform version.
String platformLifecycleState
The state of the platform version in its lifecycle.
Possible values: Recommended
| null
If a null value is returned, the platform version isn't the recommended one for its branch. Each platform branch has a single recommended platform version, typically the most recent one.
String platformBranchName
The platform branch to which the platform version belongs.
String platformBranchLifecycleState
The state of the platform version's branch in its lifecycle.
Possible values: Beta
| Supported
| Deprecated
| Retired
String type
The platform version attribute to which the filter values are applied.
Valid values: PlatformName
| PlatformVersion
| PlatformStatus
|
PlatformBranchName
| PlatformLifecycleState
| PlatformOwner
|
SupportedTier
| SupportedAddon
| ProgrammingLanguageName
|
OperatingSystemName
String operator
The operator to apply to the Type
with each of the Values
.
Valid values: =
| !=
| <
| <=
| >
|
>=
| contains
| begins_with
| ends_with
SdkInternalList<T> values
The list of values applied to the filtering platform version attribute. Only one value is supported for all current operators.
The following list shows valid filter values for some filter attributes.
PlatformStatus
: Creating
| Failed
| Ready
|
Deleting
| Deleted
PlatformLifecycleState
: recommended
SupportedTier
: WebServer/Standard
| Worker/SQS/HTTP
SupportedAddon
: Log/S3
| Monitoring/Healthd
|
WorkerDaemon/SQSD
String platformArn
The ARN of the platform version.
String platformOwner
The AWS account ID of the person who created the platform version.
String platformStatus
The status of the platform version. You can create an environment from the platform version once it is ready.
String platformCategory
The category of platform version.
String operatingSystemName
The operating system used by the platform version.
String operatingSystemVersion
The version of the operating system used by the platform version.
SdkInternalList<T> supportedTierList
The tiers in which the platform version runs.
SdkInternalList<T> supportedAddonList
The additions associated with the platform version.
String platformLifecycleState
The state of the platform version in its lifecycle.
Possible values: recommended
| empty
If an empty value is returned, the platform version is supported but isn't the recommended one for its branch.
String platformVersion
The version string of the platform version.
String platformBranchName
The platform branch to which the platform version belongs.
String platformBranchLifecycleState
The state of the platform version's branch in its lifecycle.
Possible values: beta
| supported
| deprecated
| retired
String environmentId
The ID of the environment to rebuild.
Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic
Beanstalk returns MissingRequiredParameter
error.
String environmentName
The name of the environment to rebuild.
Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic
Beanstalk returns MissingRequiredParameter
error.
String environmentId
The ID of the environment of the requested data.
If no such environment is found, RequestEnvironmentInfo
returns an
InvalidParameterValue
error.
Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic
Beanstalk returns MissingRequiredParameter
error.
String environmentName
The name of the environment of the requested data.
If no such environment is found, RequestEnvironmentInfo
returns an
InvalidParameterValue
error.
Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic
Beanstalk returns MissingRequiredParameter
error.
String infoType
The type of information to request.
Integer maximum
The maximum number of instances of this Elastic Beanstalk resource type that an AWS account can use.
ResourceQuota applicationQuota
The quota for applications in the AWS account.
ResourceQuota applicationVersionQuota
The quota for application versions in the AWS account.
ResourceQuota environmentQuota
The quota for environments in the AWS account.
ResourceQuota configurationTemplateQuota
The quota for configuration templates in the AWS account.
ResourceQuota customPlatformQuota
The quota for custom platforms in the AWS account.
String environmentId
The ID of the environment to restart the server for.
Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic
Beanstalk returns MissingRequiredParameter
error.
String environmentName
The name of the environment to restart the server for.
Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic
Beanstalk returns MissingRequiredParameter
error.
String environmentId
The ID of the data's environment.
If no such environment is found, returns an InvalidParameterValue
error.
Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic
Beanstalk returns MissingRequiredParameter
error.
String environmentName
The name of the data's environment.
If no such environment is found, returns an InvalidParameterValue
error.
Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic
Beanstalk returns MissingRequiredParameter
error.
String infoType
The type of information to retrieve.
SdkInternalList<T> environmentInfo
The EnvironmentInfoDescription of the environment.
String attribute
The result attribute to which the filter values are applied. Valid values vary by API action.
String operator
The operator to apply to the Attribute
with each of the Values
. Valid values vary by
Attribute
.
SdkInternalList<T> values
The list of values applied to the Attribute
and Operator
attributes. Number of values
and valid values vary by Attribute
.
String instanceId
The ID of the Amazon EC2 instance.
String healthStatus
Returns the health status of the specified instance. For more information, see Health Colors and Statuses.
String color
Represents the color indicator that gives you information about the health of the EC2 instance. For more information, see Health Colors and Statuses.
SdkInternalList<T> causes
Represents the causes, which provide more information about the current health status.
Date launchedAt
The time at which the EC2 instance was launched.
ApplicationMetrics applicationMetrics
Request metrics from your application.
SystemStatus system
Operating system metrics from the instance.
Deployment deployment
Information about the most recent deployment to an instance.
String availabilityZone
The availability zone in which the instance runs.
String instanceType
The instance's type.
String solutionStackName
The name of the solution stack.
SdkInternalList<T> permittedFileTypes
The permitted file types allowed for a solution stack.
String sourceType
The type of repository.
Git
Zip
String sourceRepository
Location where the repository is stored.
CodeCommit
S3
String sourceLocation
The location of the source code, as a formatted string, depending on the value of SourceRepository
For CodeCommit
, the format is the repository name and commit ID, separated by a forward slash. For
example, my-git-repo/265cfa0cf6af46153527f55d6503ec030551f57a
.
For S3
, the format is the S3 bucket name and object key, separated by a forward slash. For example,
my-s3-bucket/Folders/my-source-file
.
Integer status2xx
The percentage of requests over the last 10 seconds that resulted in a 2xx (200, 201, etc.) status code.
Integer status3xx
The percentage of requests over the last 10 seconds that resulted in a 3xx (300, 301, etc.) status code.
Integer status4xx
The percentage of requests over the last 10 seconds that resulted in a 4xx (400, 401, etc.) status code.
Integer status5xx
The percentage of requests over the last 10 seconds that resulted in a 5xx (500, 501, etc.) status code.
String sourceEnvironmentId
The ID of the source environment.
Condition: You must specify at least the SourceEnvironmentID
or the
SourceEnvironmentName
. You may also specify both. If you specify the
SourceEnvironmentId
, you must specify the DestinationEnvironmentId
.
String sourceEnvironmentName
The name of the source environment.
Condition: You must specify at least the SourceEnvironmentID
or the
SourceEnvironmentName
. You may also specify both. If you specify the
SourceEnvironmentName
, you must specify the DestinationEnvironmentName
.
String destinationEnvironmentId
The ID of the destination environment.
Condition: You must specify at least the DestinationEnvironmentID
or the
DestinationEnvironmentName
. You may also specify both. You must specify the
SourceEnvironmentId
with the DestinationEnvironmentId
.
String destinationEnvironmentName
The name of the destination environment.
Condition: You must specify at least the DestinationEnvironmentID
or the
DestinationEnvironmentName
. You may also specify both. You must specify the
SourceEnvironmentName
with the DestinationEnvironmentName
.
CPUUtilization cPUUtilization
CPU utilization metrics for the instance.
SdkInternalList<T> loadAverage
Load average in the last 1-minute, 5-minute, and 15-minute periods. For more information, see Operating System Metrics.
String environmentId
The ID of the environment to terminate.
Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic
Beanstalk returns MissingRequiredParameter
error.
String environmentName
The name of the environment to terminate.
Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic
Beanstalk returns MissingRequiredParameter
error.
Boolean terminateResources
Indicates whether the associated AWS resources should shut down when the environment is terminated:
true
: The specified environment as well as the associated AWS resources, such as Auto Scaling group
and LoadBalancer, are terminated.
false
: AWS Elastic Beanstalk resource management is removed from the environment, but the AWS
resources continue to operate.
For more information, see the AWS Elastic Beanstalk User Guide.
Default: true
Valid Values: true
| false
Boolean forceTerminate
Terminates the target environment even if another environment in the same group is dependent on it.
String environmentName
The name of this environment.
String environmentId
The ID of this environment.
String applicationName
The name of the application associated with this environment.
String versionLabel
The application version deployed in this environment.
String solutionStackName
The name of the SolutionStack
deployed with this environment.
String platformArn
The ARN of the platform version.
String templateName
The name of the configuration template used to originally launch this environment.
String description
Describes this environment.
String endpointURL
For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.
String cNAME
The URL to the CNAME for this environment.
Date dateCreated
The creation date for this environment.
Date dateUpdated
The last modified date for this environment.
String status
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.
Boolean abortableOperationInProgress
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.
String health
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
RestartEnvironment
request.
Default: Grey
String healthStatus
Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.
EnvironmentResourcesDescription resources
The description of the AWS resources used by this environment.
EnvironmentTier tier
Describes the current tier of this environment.
SdkInternalList<T> environmentLinks
A list of links to other environments in the same group.
String environmentArn
The environment's Amazon Resource Name (ARN), which can be used in other API requests that require an ARN.
String operationsRole
The Amazon Resource Name (ARN) of the environment's operations role. For more information, see Operations roles in the AWS Elastic Beanstalk Developer Guide.
String name
The name of the trigger.
String applicationName
The name of the application to update. If no such application is found, UpdateApplication
returns an
InvalidParameterValue
error.
String description
A new description for the application.
Default: If not specified, AWS Elastic Beanstalk does not update the description.
String applicationName
The name of the application.
ApplicationResourceLifecycleConfig resourceLifecycleConfig
The lifecycle configuration.
String applicationName
The name of the application.
ApplicationResourceLifecycleConfig resourceLifecycleConfig
The lifecycle configuration.
ApplicationDescription application
The ApplicationDescription of the application.
String applicationName
The name of the application associated with this version.
If no application is found with this name, UpdateApplication
returns an
InvalidParameterValue
error.
String versionLabel
The name of the version to update.
If no application version is found with this label, UpdateApplication
returns an
InvalidParameterValue
error.
String description
A new description for this version.
ApplicationVersionDescription applicationVersion
The ApplicationVersionDescription of the application version.
String 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.
String templateName
The name of the configuration template to update.
If no configuration template is found with this name, UpdateConfigurationTemplate
returns an
InvalidParameterValue
error.
String description
A new description for the configuration.
SdkInternalList<T> optionSettings
A list of configuration option settings to update with the new specified option value.
SdkInternalList<T> optionsToRemove
A list of configuration options to remove from the configuration set.
Constraint: You can remove only UserDefined
configuration options.
String solutionStackName
The name of the solution stack this configuration set uses.
String platformArn
The ARN of the platform version.
String applicationName
The name of the application associated with this configuration set.
String templateName
If not null
, the name of the configuration template for this configuration set.
String description
Describes this configuration set.
String environmentName
If not null
, the name of the environment for this configuration set.
String 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.
Date dateCreated
The date (in UTC time) when this configuration set was created.
Date dateUpdated
The date (in UTC time) when this configuration set was last modified.
SdkInternalList<T> optionSettings
A list of the configuration options and their values in this configuration set.
String applicationName
The name of the application with which the environment is associated.
String environmentId
The ID of the environment to update.
If no environment with this ID exists, AWS Elastic Beanstalk returns an InvalidParameterValue
error.
Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic
Beanstalk returns MissingRequiredParameter
error.
String environmentName
The name of the environment to update. If no environment with this name exists, AWS Elastic Beanstalk returns an
InvalidParameterValue
error.
Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic
Beanstalk returns MissingRequiredParameter
error.
String groupName
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 or environment ID parameters. See Environment Manifest (env.yaml) for details.
String description
If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment.
EnvironmentTier tier
This specifies the tier to use to update the environment.
Condition: At this time, if you change the tier version, name, or type, AWS Elastic Beanstalk returns
InvalidParameterValue
error.
String versionLabel
If this parameter is specified, AWS Elastic Beanstalk deploys the named application version to the environment.
If no such application version is found, returns an InvalidParameterValue
error.
String templateName
If this parameter is specified, AWS Elastic Beanstalk deploys this configuration template to the environment. If
no such configuration template is found, AWS Elastic Beanstalk returns an InvalidParameterValue
error.
String solutionStackName
This specifies the platform version that the environment will run after the environment is updated.
String platformArn
The ARN of the platform, if used.
SdkInternalList<T> optionSettings
If specified, AWS Elastic Beanstalk updates the configuration set associated with the running environment and sets the specified configuration options to the requested value.
SdkInternalList<T> optionsToRemove
A list of custom user-defined configuration options to remove from the configuration set for this environment.
String environmentName
The name of this environment.
String environmentId
The ID of this environment.
String applicationName
The name of the application associated with this environment.
String versionLabel
The application version deployed in this environment.
String solutionStackName
The name of the SolutionStack
deployed with this environment.
String platformArn
The ARN of the platform version.
String templateName
The name of the configuration template used to originally launch this environment.
String description
Describes this environment.
String endpointURL
For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.
String cNAME
The URL to the CNAME for this environment.
Date dateCreated
The creation date for this environment.
Date dateUpdated
The last modified date for this environment.
String status
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.
Boolean abortableOperationInProgress
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.
String health
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
RestartEnvironment
request.
Default: Grey
String healthStatus
Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.
EnvironmentResourcesDescription resources
The description of the AWS resources used by this environment.
EnvironmentTier tier
Describes the current tier of this environment.
SdkInternalList<T> environmentLinks
A list of links to other environments in the same group.
String environmentArn
The environment's Amazon Resource Name (ARN), which can be used in other API requests that require an ARN.
String operationsRole
The Amazon Resource Name (ARN) of the environment's operations role. For more information, see Operations roles in the AWS Elastic Beanstalk Developer Guide.
String resourceArn
The Amazon Resource Name (ARN) of the resouce to be updated.
Must be the ARN of an Elastic Beanstalk resource.
SdkInternalList<T> tagsToAdd
A list of tags to add or update. If a key of an existing tag is added, the tag's value is updated.
Specify at least one of these parameters: TagsToAdd
, TagsToRemove
.
SdkInternalList<T> tagsToRemove
A list of tag keys to remove. If a tag key doesn't exist, it is silently ignored.
Specify at least one of these parameters: TagsToAdd
, TagsToRemove
.
String applicationName
The name of the application that the configuration template or environment belongs to.
String templateName
The name of the configuration template to validate the settings against.
Condition: You cannot specify both this and an environment name.
String environmentName
The name of the environment to validate the settings against.
Condition: You cannot specify both this and a configuration template name.
SdkInternalList<T> optionSettings
A list of the options and desired values to evaluate.
SdkInternalList<T> messages
A list of ValidationMessage.
String message
A message describing the error or warning.
String severity
An indication of the severity of this message:
error
: This message indicates that this is not a valid setting for an option.
warning
: This message is providing information you should take into account.
String namespace
The namespace to which the option belongs.
String optionName
The name of the option.
Copyright © 2023. All rights reserved.