The AWS Elastic Beanstalk API contains several data types that various actions use. This section describes each data type in detail.
NoteThe order of each element in a data type structure is not guaranteed. Applications should not assume a particular order.
The following data types are supported:
• ApplicationDescription (p. 154)
• ApplicationMetrics (p. 156)
• ApplicationResourceLifecycleConfig (p. 157)
• ApplicationVersionDescription (p. 158)
• ApplicationVersionLifecycleConfig (p. 160)
• AutoScalingGroup (p. 161)
• BuildConfiguration (p. 162)
• Builder (p. 164)
• ConfigurationOptionDescription (p. 165)
• ConfigurationOptionSetting (p. 168)
• ConfigurationSettingsDescription (p. 169)
• CPUUtilization (p. 171)
• CustomAmi (p. 173)
• Deployment (p. 174)
• EnvironmentDescription (p. 175)
• EnvironmentInfoDescription (p. 179)
• EnvironmentLink (p. 180)
• EnvironmentResourceDescription (p. 181)
• EnvironmentResourcesDescription (p. 183)
• EnvironmentTier (p. 184)
• EventDescription (p. 185)
• Instance (p. 187)
• InstanceHealthSummary (p. 188)
• Latency (p. 190)
• LaunchConfiguration (p. 192)
• LaunchTemplate (p. 193)
• Listener (p. 194)
• LoadBalancer (p. 195)
• LoadBalancerDescription (p. 196)
• ManagedAction (p. 197)
• ManagedActionHistoryItem (p. 199)
• MaxAgeRule (p. 201)
• MaxCountRule (p. 202)
• OptionRestrictionRegex (p. 203)
• OptionSpecification (p. 204)
• PlatformBranchSummary (p. 205)
• PlatformDescription (p. 207)
• PlatformFilter (p. 210)
• PlatformFramework (p. 211)
• PlatformProgrammingLanguage (p. 212)
• PlatformSummary (p. 213)
• Queue (p. 215)
• ResourceQuota (p. 216)
• ResourceQuotas (p. 217)
• S3Location (p. 218)
• SearchFilter (p. 219)
• SingleInstanceHealth (p. 220)
• SolutionStackDescription (p. 222)
• SourceBuildInformation (p. 223)
• SourceConfiguration (p. 225)
• StatusCodes (p. 226)
• SystemStatus (p. 227)
• Tag (p. 228)
• Trigger (p. 229)
• ValidationMessage (p. 230)
ApplicationDescription
ApplicationDescription
Describes the properties of an application.
Contents
ApplicationArn
The Amazon Resource Name (ARN) of the application.
Type: String Required: No ApplicationName
The name of the application.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: No
ConfigurationTemplates.member.N
The names of the configuration templates associated with this application.
Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: No DateCreated
The date when the application was created.
Type: Timestamp Required: No DateUpdated
The date when the application was last modified.
Type: Timestamp Required: No Description
User-defined description of the application.
Type: String
Length Constraints: Maximum length of 200.
Required: No ResourceLifecycleConfig
The lifecycle settings for the application.
See Also
Type: ApplicationResourceLifecycleConfig (p. 157) object Required: No
Versions.member.N
The names of the versions for this application.
Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ApplicationMetrics
ApplicationMetrics
Application request metrics for an AWS Elastic Beanstalk environment.
Contents
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).
Type: Integer Required: No 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.
Type: Latency (p. 190) object Required: No
RequestCount
Average number of requests handled by the web server per second over the last 10 seconds.
Type: Integer Required: No StatusCodes
Represents the percentage of requests over the last 10 seconds that resulted in each type of status code response.
Type: StatusCodes (p. 226) object Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ApplicationResourceLifecycleConfig
ApplicationResourceLifecycleConfig
The resource lifecycle configuration for an application. Defines lifecycle settings for resources that belong to the application, and the service role that AWS Elastic Beanstalk assumes in order to apply lifecycle settings. The version lifecycle configuration defines lifecycle settings for application versions.
Contents
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.
Type: String Required: No VersionLifecycleConfig
Defines lifecycle settings for application versions.
Type: ApplicationVersionLifecycleConfig (p. 160) object Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ApplicationVersionDescription
ApplicationVersionDescription
Describes the properties of an application version.
Contents
ApplicationName
The name of the application to which the application version belongs.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: No ApplicationVersionArn
The Amazon Resource Name (ARN) of the application version.
Type: String Required: No BuildArn
Reference to the artifact from the AWS CodeBuild build.
Type: String Required: No DateCreated
The creation date of the application version.
Type: Timestamp Required: No DateUpdated
The last modified date of the application version.
Type: Timestamp Required: No Description
The description of the application version.
Type: String
Length Constraints: Maximum length of 200.
Required: No SourceBuildInformation
If the version's source code was retrieved from AWS CodeCommit, the location of the source code for the application version.
Type: SourceBuildInformation (p. 223) object
See Also
Required: No SourceBundle
The storage location of the application version's source bundle in Amazon S3.
Type: S3Location (p. 218) object Required: No
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.
Type: String
Valid Values: Processed | Unprocessed | Failed | Processing | Building Required: No
VersionLabel
A unique identifier for the application version.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ApplicationVersionLifecycleConfig
ApplicationVersionLifecycleConfig
The application version lifecycle settings for an application. Defines the rules that Elastic Beanstalk applies to an application's versions in order to avoid hitting the per-region limit for application versions.
When Elastic Beanstalk deletes an application version from its database, you can no longer deploy that version to an environment. The source bundle remains in S3 unless you configure the rule to delete it.
Contents
MaxAgeRule
Specify a max age rule to restrict the length of time that application versions are retained for an application.
Type: MaxAgeRule (p. 201) object Required: No
MaxCountRule
Specify a max count rule to restrict the number of application versions that are retained for an application.
Type: MaxCountRule (p. 202) object Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
AutoScalingGroup
AutoScalingGroup
Describes an Auto Scaling launch configuration.
Contents
Name
The name of the AutoScalingGroup . Type: String
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3