platform_versions

Creates, updates, deletes, gets or lists a platform_versions resource.

Overview

Name	platform_versions
Type	Resource
Id	aws.elasticbeanstalk.platform_versions

Fields

The following fields are returned by SELECT queries:

describe_platform_version

Name	Datatype	Description
custom_ami_list	string	The custom AMIs supported by the platform version.
date_created	string	The date when the platform version was created.
date_updated	string	The date when the platform version was last updated.
description	string	The description of the platform version.
frameworks	string	The frameworks supported by the platform version.
maintainer	string	Information about the maintainer of the platform version.
operating_system_name	string	The operating system used by the platform version.
operating_system_version	string	The version of the operating system used by the platform version.
platform_arn	string	The ARN of the platform version.
platform_branch_lifecycle_state	string	The state of the platform version's branch in its lifecycle. Possible values: Beta | Supported | Deprecated | Retired
platform_branch_name	string	The platform branch to which the platform version belongs.
platform_category	string	The category of the platform version.
platform_lifecycle_state	string	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.
platform_name	string	The name of the platform version.
platform_owner	string	The AWS account ID of the person who created the platform version.
platform_status	string	The status of the platform version.
platform_version	string	The version of the platform version.
programming_languages	string	The programming languages supported by the platform version.
solution_stack_name	string	The name of the solution stack used by the platform version.
supported_addon_list	string	The additions supported by the platform version.
supported_tier_list	string	The tiers supported by the platform version.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_platform_version	select	region	PlatformArn	Describes a platform version. Provides full details. Compare to ListPlatformVersions, which provides summary information about a list of platform versions. For definitions of platform version and other platform-related terms, see AWS Elastic Beanstalk Platforms Glossary.
create_platform_version	insert	PlatformName, PlatformVersion, PlatformDefinitionBundle, region	EnvironmentName, OptionSettings, Tags	Create a new version of your custom platform.
delete_platform_version	delete	region	PlatformArn	Deletes the specified version of a custom platform.
list_platform_versions	exec	region	Filters, MaxRecords, NextToken	Lists the platform versions available for your account in an AWS Region. Provides summary information about each platform version. Compare to DescribePlatformVersion, which provides full details about a single platform version. For definitions of platform version 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
PlatformDefinitionBundle	object	The location of the platform definition archive in Amazon S3.
PlatformName	string	The name of your custom platform.
PlatformVersion	string	The number, such as 1.0.2, for the new platform version.
region	string	AWS region (default: us-east-1)
EnvironmentName	string	The name of the builder environment.
Filters	array	Criteria for restricting the resulting list of platform versions. The filter is interpreted as a logical conjunction (AND) of the separate PlatformFilter terms.
MaxRecords	integer	The maximum number of platform version 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.
OptionSettings	array	The configuration option settings to apply to the builder environment.
PlatformArn	string	The ARN of the version of the custom platform.
Tags	array	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.

SELECT examples

describe_platform_version

Describes a platform version. Provides full details. Compare to ListPlatformVersions, which provides summary information about a list of platform versions. For definitions of platform version and other platform-related terms, see AWS Elastic Beanstalk Platforms Glossary.

SELECT
custom_ami_list,
date_created,
date_updated,
description,
frameworks,
maintainer,
operating_system_name,
operating_system_version,
platform_arn,
platform_branch_lifecycle_state,
platform_branch_name,
platform_category,
platform_lifecycle_state,
platform_name,
platform_owner,
platform_status,
platform_version,
programming_languages,
solution_stack_name,
supported_addon_list,
supported_tier_list
FROM aws.elasticbeanstalk.platform_versions
WHERE region = '{{ region }}' -- required
AND PlatformArn = '{{ PlatformArn }}'
;

INSERT examples

create_platform_version

Create a new version of your custom platform.

INSERT INTO aws.elasticbeanstalk.platform_versions (
PlatformName,
PlatformVersion,
PlatformDefinitionBundle,
region,
EnvironmentName,
OptionSettings,
Tags
)
SELECT 
'{{ PlatformName }}',
'{{ PlatformVersion }}',
'{{ PlatformDefinitionBundle }}',
'{{ region }}',
'{{ EnvironmentName }}',
'{{ OptionSettings }}',
'{{ Tags }}'
RETURNING
builder,
platform_summary
;

Manifest

# Description fields are for documentation purposes
- name: platform_versions
props:
  - name: PlatformName
    value: "{{ PlatformName }}"
    description: Required parameter for the platform_versions resource.
  - name: PlatformVersion
    value: "{{ PlatformVersion }}"
    description: Required parameter for the platform_versions resource.
  - name: PlatformDefinitionBundle
    value: "{{ PlatformDefinitionBundle }}"
    description: Required parameter for the platform_versions resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the platform_versions resource.
  - name: EnvironmentName
    value: "{{ EnvironmentName }}"
    description: The name of the builder environment.
    description: The name of the builder environment.
  - name: OptionSettings
    value: "{{ OptionSettings }}"
    description: The configuration option settings to apply to the builder environment.
    description: The configuration option settings to apply to the builder environment.
  - name: Tags
    value: "{{ Tags }}"
    description: 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.
    description: 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.

DELETE examples

delete_platform_version

Deletes the specified version of a custom platform.

DELETE FROM aws.elasticbeanstalk.platform_versions
WHERE region = '{{ region }}' --required
AND PlatformArn = '{{ PlatformArn }}'
;

Lifecycle Methods

list_platform_versions

Lists the platform versions available for your account in an AWS Region. Provides summary information about each platform version. Compare to DescribePlatformVersion, which provides full details about a single platform version. For definitions of platform version and other platform-related terms, see AWS Elastic Beanstalk Platforms Glossary.

EXEC aws.elasticbeanstalk.platform_versions.list_platform_versions 
@region='{{ region }}' --required, 
@Filters='{{ Filters }}', 
@MaxRecords='{{ MaxRecords }}', 
@NextToken='{{ NextToken }}'
;