2019/03/11 - AWS Elastic Beanstalk - 4 updated api methods
Changes Elastic Beanstalk added support for tagging, and tag-based access control, of all Elastic Beanstalk resources.
{'Tags': [{'Key': 'string', 'Value': 'string'}]}
Creates an application that has one configuration template named default and no application versions.
See also: AWS API Documentation
Request Syntax
client.create_application(
ApplicationName='string',
Description='string',
ResourceLifecycleConfig={
'ServiceRole': 'string',
'VersionLifecycleConfig': {
'MaxCountRule': {
'Enabled': True|False,
'MaxCount': 123,
'DeleteSourceFromS3': True|False
},
'MaxAgeRule': {
'Enabled': True|False,
'MaxAgeInDays': 123,
'DeleteSourceFromS3': True|False
}
}
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The name of the application.
Constraint: This name must be unique within your account. If the specified name already exists, the action returns an InvalidParameterValue error.
string
Describes the application.
dict
Specify an application resource lifecycle configuration to prevent your application from accumulating too many versions.
ServiceRole (string) --
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.
VersionLifecycleConfig (dict) --
The application version lifecycle configuration.
MaxCountRule (dict) --
Specify a max count rule to restrict the number of application versions that are retained for an application.
Enabled (boolean) -- [REQUIRED]
Specify true to apply the rule, or false to disable it.
MaxCount (integer) --
Specify the maximum number of application versions to retain.
DeleteSourceFromS3 (boolean) --
Set to true to delete a version's source bundle from Amazon S3 when Elastic Beanstalk deletes the application version.
MaxAgeRule (dict) --
Specify a max age rule to restrict the length of time that application versions are retained for an application.
Enabled (boolean) -- [REQUIRED]
Specify true to apply the rule, or false to disable it.
MaxAgeInDays (integer) --
Specify the number of days to retain an application versions.
DeleteSourceFromS3 (boolean) --
Set to true to delete a version's source bundle from Amazon S3 when Elastic Beanstalk deletes the application version.
list
Specifies the tags applied to the application.
Elastic Beanstalk applies these tags only to the application. Environments that you create in the application 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.
dict
Response Syntax
{
'Application': {
'ApplicationArn': 'string',
'ApplicationName': 'string',
'Description': 'string',
'DateCreated': datetime(2015, 1, 1),
'DateUpdated': datetime(2015, 1, 1),
'Versions': [
'string',
],
'ConfigurationTemplates': [
'string',
],
'ResourceLifecycleConfig': {
'ServiceRole': 'string',
'VersionLifecycleConfig': {
'MaxCountRule': {
'Enabled': True|False,
'MaxCount': 123,
'DeleteSourceFromS3': True|False
},
'MaxAgeRule': {
'Enabled': True|False,
'MaxAgeInDays': 123,
'DeleteSourceFromS3': True|False
}
}
}
}
}
Response Structure
(dict) --
Result message containing a single description of an application.
Application (dict) --
The ApplicationDescription of the application.
ApplicationArn (string) --
The Amazon Resource Name (ARN) of the application.
ApplicationName (string) --
The name of the application.
Description (string) --
User-defined description of the application.
DateCreated (datetime) --
The date when the application was created.
DateUpdated (datetime) --
The date when the application was last modified.
Versions (list) --
The names of the versions for this application.
(string) --
ConfigurationTemplates (list) --
The names of the configuration templates associated with this application.
(string) --
ResourceLifecycleConfig (dict) --
The lifecycle settings for the application.
ServiceRole (string) --
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.
VersionLifecycleConfig (dict) --
The application version lifecycle configuration.
MaxCountRule (dict) --
Specify a max count rule to restrict the number of application versions that are retained for an application.
Enabled (boolean) --
Specify true to apply the rule, or false to disable it.
MaxCount (integer) --
Specify the maximum number of application versions to retain.
DeleteSourceFromS3 (boolean) --
Set to true to delete a version's source bundle from Amazon S3 when Elastic Beanstalk deletes the application version.
MaxAgeRule (dict) --
Specify a max age rule to restrict the length of time that application versions are retained for an application.
Enabled (boolean) --
Specify true to apply the rule, or false to disable it.
MaxAgeInDays (integer) --
Specify the number of days to retain an application versions.
DeleteSourceFromS3 (boolean) --
Set to true to delete a version's source bundle from Amazon S3 when Elastic Beanstalk deletes the application version.
{'Tags': [{'Key': 'string', 'Value': 'string'}]}
Creates an application version for the specified application. You can create an application version from a source bundle in Amazon S3, a commit in AWS CodeCommit, or the output of an AWS CodeBuild build as follows:
Specify a commit in an AWS CodeCommit repository with SourceBuildInformation .
Specify a build in an AWS CodeBuild with SourceBuildInformation and BuildConfiguration .
Specify a source bundle in S3 with SourceBundle
Omit both SourceBuildInformation and SourceBundle to use the default sample application.
Note
Once you create an application version with a specified Amazon S3 bucket and key location, you cannot change that Amazon S3 location. If you change the Amazon S3 location, you receive an exception when you attempt to launch an environment from the application version.
See also: AWS API Documentation
Request Syntax
client.create_application_version(
ApplicationName='string',
VersionLabel='string',
Description='string',
SourceBuildInformation={
'SourceType': 'Git'|'Zip',
'SourceRepository': 'CodeCommit'|'S3',
'SourceLocation': 'string'
},
SourceBundle={
'S3Bucket': 'string',
'S3Key': 'string'
},
BuildConfiguration={
'ArtifactName': 'string',
'CodeBuildServiceRole': 'string',
'ComputeType': 'BUILD_GENERAL1_SMALL'|'BUILD_GENERAL1_MEDIUM'|'BUILD_GENERAL1_LARGE',
'Image': 'string',
'TimeoutInMinutes': 123
},
AutoCreateApplication=True|False,
Process=True|False,
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The name of the application. If no application is found with this name, and AutoCreateApplication is false , returns an InvalidParameterValue error.
string
[REQUIRED]
A label identifying this version.
Constraint: Must be unique per application. If an application version already exists with this label for the specified application, AWS Elastic Beanstalk returns an InvalidParameterValue error.
string
Describes this version.
dict
Specify a commit in an AWS CodeCommit Git repository to use as the source code for the application version.
SourceType (string) -- [REQUIRED]
The type of repository.
Git
Zip
SourceRepository (string) -- [REQUIRED]
Location where the repository is stored.
CodeCommit
S3
SourceLocation (string) -- [REQUIRED]
The location of the source code, as a formatted string, depending on the value of SourceRepository
For CodeCommit , the format is the repository name and commit ID, separated by a forward slash. For example, my-git-repo/265cfa0cf6af46153527f55d6503ec030551f57a .
For S3 , the format is the S3 bucket name and object key, separated by a forward slash. For example, my-s3-bucket/Folders/my-source-file .
dict
The Amazon S3 bucket and key that identify the location of the source bundle for this version.
Note
The Amazon S3 bucket must be in the same region as the environment.
Specify a source bundle in S3 or a commit in an AWS CodeCommit repository (with SourceBuildInformation ), but not both. If neither SourceBundle nor SourceBuildInformation are provided, Elastic Beanstalk uses a sample application.
S3Bucket (string) --
The Amazon S3 bucket where the data is located.
S3Key (string) --
The Amazon S3 key where the data is located.
dict
Settings for an AWS CodeBuild build.
ArtifactName (string) --
The name of the artifact of the CodeBuild build. If provided, Elastic Beanstalk stores the build artifact in the S3 location S3-bucket /resources/application-name /codebuild/codebuild-version-label -artifact-name .zip. If not provided, Elastic Beanstalk stores the build artifact in the S3 location S3-bucket /resources/application-name /codebuild/codebuild-version-label .zip.
CodeBuildServiceRole (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.
ComputeType (string) --
Information about the compute resources the build project will use.
BUILD_GENERAL1_SMALL: Use up to 3 GB memory and 2 vCPUs for builds
BUILD_GENERAL1_MEDIUM: Use up to 7 GB memory and 4 vCPUs for builds
BUILD_GENERAL1_LARGE: Use up to 15 GB memory and 8 vCPUs for builds
Image (string) -- [REQUIRED]
The ID of the Docker image to use for this build project.
TimeoutInMinutes (integer) --
How long in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait until timing out any related build that does not get marked as completed. The default is 60 minutes.
boolean
Set to true to create an application with the specified name if it doesn't already exist.
boolean
Pre-processes and validates the environment manifest ( env.yaml ) and configuration files ( *.config files in the .ebextensions folder) in the source bundle. Validating configuration files can identify issues prior to deploying the application version to an environment.
You must turn processing on for application versions that you create using AWS CodeBuild or AWS CodeCommit. For application versions built from a source bundle in Amazon S3, processing is optional.
Note
The Process option validates Elastic Beanstalk configuration files. It doesn't validate your application's configuration files, like proxy server or Docker configuration.
list
Specifies the tags applied to the application version.
Elastic Beanstalk applies these tags only to the application version. Environments that use the application 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.
dict
Response Syntax
{
'ApplicationVersion': {
'ApplicationVersionArn': 'string',
'ApplicationName': 'string',
'Description': 'string',
'VersionLabel': 'string',
'SourceBuildInformation': {
'SourceType': 'Git'|'Zip',
'SourceRepository': 'CodeCommit'|'S3',
'SourceLocation': 'string'
},
'BuildArn': 'string',
'SourceBundle': {
'S3Bucket': 'string',
'S3Key': 'string'
},
'DateCreated': datetime(2015, 1, 1),
'DateUpdated': datetime(2015, 1, 1),
'Status': 'Processed'|'Unprocessed'|'Failed'|'Processing'|'Building'
}
}
Response Structure
(dict) --
Result message wrapping a single description of an application version.
ApplicationVersion (dict) --
The ApplicationVersionDescription of the application version.
ApplicationVersionArn (string) --
The Amazon Resource Name (ARN) of the application version.
ApplicationName (string) --
The name of the application to which the application version belongs.
Description (string) --
The description of the application version.
VersionLabel (string) --
A unique identifier for the application version.
SourceBuildInformation (dict) --
If the version's source code was retrieved from AWS CodeCommit, the location of the source code for the application version.
SourceType (string) --
The type of repository.
Git
Zip
SourceRepository (string) --
Location where the repository is stored.
CodeCommit
S3
SourceLocation (string) --
The location of the source code, as a formatted string, depending on the value of SourceRepository
For CodeCommit , the format is the repository name and commit ID, separated by a forward slash. For example, my-git-repo/265cfa0cf6af46153527f55d6503ec030551f57a .
For S3 , the format is the S3 bucket name and object key, separated by a forward slash. For example, my-s3-bucket/Folders/my-source-file .
BuildArn (string) --
Reference to the artifact from the AWS CodeBuild build.
SourceBundle (dict) --
The storage location of the application version's source bundle 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.
DateCreated (datetime) --
The creation date of the application version.
DateUpdated (datetime) --
The last modified date of the application version.
Status (string) --
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.
{'Tags': [{'Key': 'string', 'Value': 'string'}]}
Creates a configuration template. Templates are associated with a specific application and are used to deploy different versions of the application with the same configuration settings.
Templates aren't associated with any environment. The EnvironmentName response element is always null .
Related Topics
DescribeConfigurationOptions
DescribeConfigurationSettings
ListAvailableSolutionStacks
See also: AWS API Documentation
Request Syntax
client.create_configuration_template(
ApplicationName='string',
TemplateName='string',
SolutionStackName='string',
PlatformArn='string',
SourceConfiguration={
'ApplicationName': 'string',
'TemplateName': 'string'
},
EnvironmentId='string',
Description='string',
OptionSettings=[
{
'ResourceName': 'string',
'Namespace': 'string',
'OptionName': 'string',
'Value': 'string'
},
],
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The name of the application to associate with this configuration template. If no application is found with this name, AWS Elastic Beanstalk returns an InvalidParameterValue error.
string
[REQUIRED]
The name of the configuration template.
Constraint: This name must be unique per application.
Default: If a configuration template already exists with this name, AWS Elastic Beanstalk returns an InvalidParameterValue error.
string
The name of the solution stack used by this configuration. The solution stack specifies the operating system, architecture, and application server for a configuration template. It determines the set of configuration options as well as the possible and default values.
Use ListAvailableSolutionStacks to obtain a list of available solution stacks.
A solution stack name or a source configuration parameter must be specified, otherwise AWS Elastic Beanstalk returns an InvalidParameterValue error.
If a solution stack name is not specified and the source configuration parameter is specified, AWS Elastic Beanstalk uses the same solution stack as the source configuration template.
string
The ARN of the custom platform.
dict
If specified, AWS Elastic Beanstalk uses the configuration values from the specified configuration template to create a new configuration.
Values specified in the OptionSettings parameter of this call overrides any values obtained from the SourceConfiguration .
If no configuration template is found, returns an InvalidParameterValue error.
Constraint: If both the solution stack name parameter and the source configuration parameters are specified, the solution stack of the source configuration template must match the specified solution stack name or else AWS Elastic Beanstalk returns an InvalidParameterCombination error.
ApplicationName (string) --
The name of the application associated with the configuration.
TemplateName (string) --
The name of the configuration template.
string
The ID of the environment used with this configuration template.
string
Describes this configuration.
list
If specified, AWS Elastic Beanstalk sets the specified configuration option to the requested value. The new value overrides the value obtained from the solution stack or the source configuration template.
(dict) --
A specification identifying an individual configuration option along with its current value. For a list of possible option values, go to Option Values in the AWS Elastic Beanstalk Developer Guide .
ResourceName (string) --
A unique resource name for a time-based scaling configuration option.
Namespace (string) --
A unique namespace identifying the option's associated AWS resource.
OptionName (string) --
The name of the configuration option.
Value (string) --
The current value for the configuration option.
list
Specifies the tags applied to the configuration template.
(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.
dict
Response Syntax
{
'SolutionStackName': 'string',
'PlatformArn': 'string',
'ApplicationName': 'string',
'TemplateName': 'string',
'Description': 'string',
'EnvironmentName': 'string',
'DeploymentStatus': 'deployed'|'pending'|'failed',
'DateCreated': datetime(2015, 1, 1),
'DateUpdated': datetime(2015, 1, 1),
'OptionSettings': [
{
'ResourceName': 'string',
'Namespace': 'string',
'OptionName': 'string',
'Value': 'string'
},
]
}
Response Structure
(dict) --
Describes the settings for a configuration set.
SolutionStackName (string) --
The name of the solution stack this configuration set uses.
PlatformArn (string) --
The ARN of the platform.
ApplicationName (string) --
The name of the application associated with this configuration set.
TemplateName (string) --
If not null , the name of the configuration template for this configuration set.
Description (string) --
Describes this configuration set.
EnvironmentName (string) --
If not null , the name of the environment for this configuration set.
DeploymentStatus (string) --
If this configuration set is associated with an environment, the DeploymentStatus parameter indicates the deployment status of this configuration set:
null : This configuration is not associated with a running environment.
pending : This is a draft configuration that is not deployed to the associated environment but is in the process of deploying.
deployed : This is the configuration that is currently deployed to the associated running environment.
failed : This is a draft configuration that failed to successfully deploy.
DateCreated (datetime) --
The date (in UTC time) when this configuration set was created.
DateUpdated (datetime) --
The date (in UTC time) when this configuration set was last modified.
OptionSettings (list) --
A list of the configuration options and their values in this configuration set.
(dict) --
A specification identifying an individual configuration option along with its current value. For a list of possible option values, go to Option Values in the AWS Elastic Beanstalk Developer Guide .
ResourceName (string) --
A unique resource name for a time-based scaling configuration option.
Namespace (string) --
A unique namespace identifying the option's associated AWS resource.
OptionName (string) --
The name of the configuration option.
Value (string) --
The current value for the configuration option.
{'Tags': [{'Key': 'string', 'Value': 'string'}]}
Create a new version of your custom platform.
See also: AWS API Documentation
Request Syntax
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'
},
]
)
string
[REQUIRED]
The name of your custom platform.
string
[REQUIRED]
The number, such as 1.0.2, for the new platform version.
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.
string
The name of the builder environment.
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 option values, go to Option Values in the AWS Elastic Beanstalk Developer Guide .
ResourceName (string) --
A unique resource name for a time-based scaling configuration option.
Namespace (string) --
A unique namespace identifying the option's associated AWS resource.
OptionName (string) --
The name of the configuration option.
Value (string) --
The current value for the configuration option.
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.
dict
Response Syntax
{
'PlatformSummary': {
'PlatformArn': 'string',
'PlatformOwner': 'string',
'PlatformStatus': 'Creating'|'Failed'|'Ready'|'Deleting'|'Deleted',
'PlatformCategory': 'string',
'OperatingSystemName': 'string',
'OperatingSystemVersion': 'string',
'SupportedTierList': [
'string',
],
'SupportedAddonList': [
'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.
PlatformOwner (string) --
The AWS account ID of the person who created the platform.
PlatformStatus (string) --
The status of the platform. You can create an environment from the platform once it is ready.
PlatformCategory (string) --
The category of platform.
OperatingSystemName (string) --
The operating system used by the platform.
OperatingSystemVersion (string) --
The version of the operating system used by the platform.
SupportedTierList (list) --
The tiers in which the platform runs.
(string) --
SupportedAddonList (list) --
The additions associated with the platform.
(string) --
Builder (dict) --
The builder used to create the custom platform.
ARN (string) --
The ARN of the builder.