CreatePlatformVersionCommand

Suggest an Edit

Create a new version of your custom platform.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { ElasticBeanstalkClient, CreatePlatformVersionCommand } from "@aws-sdk/client-elastic-beanstalk"; // ES Modules import
// const { ElasticBeanstalkClient, CreatePlatformVersionCommand } = require("@aws-sdk/client-elastic-beanstalk"); // CommonJS import
const client = new ElasticBeanstalkClient(config);
const input = { // CreatePlatformVersionRequest
  PlatformName: "STRING_VALUE", // required
  PlatformVersion: "STRING_VALUE", // required
  PlatformDefinitionBundle: { // S3Location
    S3Bucket: "STRING_VALUE",
    S3Key: "STRING_VALUE",
  },
  EnvironmentName: "STRING_VALUE",
  OptionSettings: [ // ConfigurationOptionSettingsList
    { // ConfigurationOptionSetting
      ResourceName: "STRING_VALUE",
      Namespace: "STRING_VALUE",
      OptionName: "STRING_VALUE",
      Value: "STRING_VALUE",
    },
  ],
  Tags: [ // Tags
    { // Tag
      Key: "STRING_VALUE",
      Value: "STRING_VALUE",
    },
  ],
};
const command = new CreatePlatformVersionCommand(input);
const response = await client.send(command);
// { // CreatePlatformVersionResult
//   PlatformSummary: { // PlatformSummary
//     PlatformArn: "STRING_VALUE",
//     PlatformOwner: "STRING_VALUE",
//     PlatformStatus: "Creating" || "Failed" || "Ready" || "Deleting" || "Deleted",
//     PlatformCategory: "STRING_VALUE",
//     OperatingSystemName: "STRING_VALUE",
//     OperatingSystemVersion: "STRING_VALUE",
//     SupportedTierList: [ // SupportedTierList
//       "STRING_VALUE",
//     ],
//     SupportedAddonList: [ // SupportedAddonList
//       "STRING_VALUE",
//     ],
//     PlatformLifecycleState: "STRING_VALUE",
//     PlatformVersion: "STRING_VALUE",
//     PlatformBranchName: "STRING_VALUE",
//     PlatformBranchLifecycleState: "STRING_VALUE",
//   },
//   Builder: { // Builder
//     ARN: "STRING_VALUE",
//   },
// };

CreatePlatformVersionCommand Input

See CreatePlatformVersionCommandInput for more details

Parameter
Type
Description
PlatformDefinitionBundle
Required
S3Location | undefined

The location of the platform definition archive in Amazon S3.

PlatformName
Required
string | undefined

The name of your custom platform.

PlatformVersion
Required
string | undefined

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

EnvironmentName
string | undefined

The name of the builder environment.

OptionSettings
ConfigurationOptionSetting[] | undefined

The configuration option settings to apply to the builder environment.

Tags
Tag[] | undefined

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.

CreatePlatformVersionCommand Output

See CreatePlatformVersionCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
Builder
Builder | undefined

The builder used to create the custom platform.

PlatformSummary
PlatformSummary | undefined

Detailed information about the new version of the custom platform.

Throws

Name
Fault
Details
ElasticBeanstalkServiceException
client
Base exception class for all service exceptions from ElasticBeanstalk service.
InsufficientPrivilegesException
client

The specified account does not have sufficient privileges for one or more AWS services.

TooManyPlatformsException
client

You have exceeded the maximum number of allowed platforms associated with the account.

ElasticBeanstalkServiceException
client
Base exception class for all service exceptions from ElasticBeanstalk service.