platform_branches
Creates, updates, deletes, gets or lists a platform_branches resource.
Overview
| Name | platform_branches |
| Type | Resource |
| Id | aws.elasticbeanstalk.platform_branches |
Fields
The following fields are returned by SELECT queries:
- list_platform_branches
| Name | Datatype | Description |
|---|---|---|
branch_name | string | The name of the platform branch. |
branch_order | integer | 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. |
lifecycle_state | string | The support life cycle state of the platform branch. Possible values: beta | supported | deprecated | retired |
platform_name | string | The name of the platform to which this platform branch belongs. |
supported_tier_list | string | The environment tiers that platform versions in this branch support. Possible values: WebServer/Standard | Worker/SQS/HTTP |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_platform_branches | select | region | Filters, MaxRecords, NextToken | Lists the platform branches available for your account in an AWS Region. Provides summary information about each platform branch. For definitions of platform branch and other platform-related terms, see AWS Elastic Beanstalk Platforms Glossary. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
region | string | AWS region (default: us-east-1) |
Filters | array | 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. |
MaxRecords | integer | The maximum number of platform branch values returned in one call. |
NextToken | string | 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. |
SELECT examples
- list_platform_branches
Lists the platform branches available for your account in an AWS Region. Provides summary information about each platform branch. For definitions of platform branch and other platform-related terms, see AWS Elastic Beanstalk Platforms Glossary.
SELECT
branch_name,
branch_order,
lifecycle_state,
platform_name,
supported_tier_list
FROM aws.elasticbeanstalk.platform_branches
WHERE region = '{{ region }}' -- required
AND Filters = '{{ Filters }}'
AND MaxRecords = '{{ MaxRecords }}'
AND NextToken = '{{ NextToken }}'
;