ElasticBeanstalk / Client / create_platform_version

create_platform_version#

ElasticBeanstalk.Client.create_platform_version(**kwargs)#

Create a new version of your custom platform.

See also: AWS API Documentation

Request Syntax

response = client.create_platform_version(
    PlatformName='string',
    PlatformVersion='string',
    PlatformDefinitionBundle={
        'S3Bucket': 'string',
        'S3Key': 'string'
    },
    EnvironmentName='string',
    OptionSettings=[
        {
            'ResourceName': 'string',
            'Namespace': 'string',
            'OptionName': 'string',
            'Value': 'string'
        },
    ],
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters:

  • PlatformName (string) –

    [REQUIRED]

    The name of your custom platform.

  • PlatformVersion (string) –

    [REQUIRED]

    The number, such as 1.0.2, for the new platform version.

  • PlatformDefinitionBundle (dict) –

    [REQUIRED]

    The location of the platform definition archive in Amazon S3.

    • S3Bucket (string) –

      The Amazon S3 bucket where the data is located.

    • S3Key (string) –

      The Amazon S3 key where the data is located.

  • EnvironmentName (string) – The name of the builder environment.

  • OptionSettings (list) –

    The configuration option settings to apply to the builder environment.

    • (dict) –

      A specification identifying an individual configuration option along with its current value. For a list of possible namespaces and option values, see Option Values in the AWS Elastic Beanstalk Developer Guide.

      • ResourceName (string) –

        A unique resource name for the option setting. Use it for a time–based scaling configuration option.

      • Namespace (string) –

        A unique namespace that identifies the option’s associated AWS resource.

      • OptionName (string) –

        The name of the configuration option.

      • Value (string) –

        The current value for the configuration option.

  • Tags (list) –

    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.

    • (dict) –

      Describes a tag applied to a resource in an environment.

      • Key (string) –

        The key of the tag.

      • Value (string) –

        The value of the tag.

Return type:

dict

Returns:

Response Syntax

{
    'PlatformSummary': {
        'PlatformArn': 'string',
        'PlatformOwner': 'string',
        'PlatformStatus': 'Creating'|'Failed'|'Ready'|'Deleting'|'Deleted',
        'PlatformCategory': 'string',
        'OperatingSystemName': 'string',
        'OperatingSystemVersion': 'string',
        'SupportedTierList': [
            'string',
        ],
        'SupportedAddonList': [
            'string',
        ],
        'PlatformLifecycleState': 'string',
        'PlatformVersion': 'string',
        'PlatformBranchName': 'string',
        'PlatformBranchLifecycleState': 'string'
    },
    'Builder': {
        'ARN': 'string'
    }
}

Response Structure

  • (dict) –

    • PlatformSummary (dict) –

      Detailed information about the new version of the custom platform.

      • PlatformArn (string) –

        The ARN of the platform version.

      • PlatformOwner (string) –

        The AWS account ID of the person who created the platform version.

      • PlatformStatus (string) –

        The status of the platform version. You can create an environment from the platform version once it is ready.

      • PlatformCategory (string) –

        The category of platform version.

      • OperatingSystemName (string) –

        The operating system used by the platform version.

      • OperatingSystemVersion (string) –

        The version of the operating system used by the platform version.

      • SupportedTierList (list) –

        The tiers in which the platform version runs.

        • (string) –

      • SupportedAddonList (list) –

        The additions associated with the platform version.

        • (string) –

      • PlatformLifecycleState (string) –

        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.

      • PlatformVersion (string) –

        The version string of the platform version.

      • PlatformBranchName (string) –

        The platform branch to which the platform version belongs.

      • PlatformBranchLifecycleState (string) –

        The state of the platform version’s branch in its lifecycle.

        Possible values: beta | supported | deprecated | retired

    • Builder (dict) –

      The builder used to create the custom platform.

      • ARN (string) –

        The ARN of the builder.

Exceptions