NAME

Paws::ElasticBeanstalk - Perl Interface to AWS AWS Elastic Beanstalk

SYNOPSIS

  use Paws;

  my $obj = Paws->service('ElasticBeanstalk');
  my $res = $obj->Method(
    Arg1 => $val1,
    Arg2 => [ 'V1', 'V2' ],
    # if Arg3 is an object, the HashRef will be used as arguments to the constructor
    # of the arguments type
    Arg3 => { Att1 => 'Val1' },
    # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
    # the constructor of the arguments type
    Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
  );

DESCRIPTION

AWS Elastic Beanstalk

AWS Elastic Beanstalk makes it easy for you to create, deploy, and manage scalable, fault-tolerant applications running on the Amazon Web Services cloud.

For more information about this product, go to the AWS Elastic Beanstalk details page. The location of the latest AWS Elastic Beanstalk WSDL is http://elasticbeanstalk.s3.amazonaws.com/doc/2010-12-01/AWSElasticBeanstalk.wsdl. To install the Software Development Kits (SDKs), Integrated Development Environment (IDE) Toolkits, and command line tools that enable you to access the API, go to Tools for Amazon Web Services.

Endpoints

For a list of region-specific endpoints that AWS Elastic Beanstalk supports, go to Regions and Endpoints in the Amazon Web Services Glossary.

METHODS

AbortEnvironmentUpdate([EnvironmentId => Str, EnvironmentName => Str])

Each argument is described in detail in: Paws::ElasticBeanstalk::AbortEnvironmentUpdate

Returns: nothing

  Cancels in-progress environment configuration update or application
version deployment.

ApplyEnvironmentManagedAction(ActionId => Str, [EnvironmentId => Str, EnvironmentName => Str])

Each argument is described in detail in: Paws::ElasticBeanstalk::ApplyEnvironmentManagedAction

Returns: a Paws::ElasticBeanstalk::ApplyEnvironmentManagedActionResult instance

  Applies a scheduled managed action immediately. A managed action can be
applied only if its status is C<Scheduled>. Get the status and action
ID of a managed action with DescribeEnvironmentManagedActions.

CheckDNSAvailability(CNAMEPrefix => Str)

Each argument is described in detail in: Paws::ElasticBeanstalk::CheckDNSAvailability

Returns: a Paws::ElasticBeanstalk::CheckDNSAvailabilityResultMessage instance

  Checks if the specified CNAME is available.

ComposeEnvironments([ApplicationName => Str, GroupName => Str, VersionLabels => ArrayRef[Str|Undef]])

Each argument is described in detail in: Paws::ElasticBeanstalk::ComposeEnvironments

Returns: a Paws::ElasticBeanstalk::EnvironmentDescriptionsMessage instance

  Create or update a group of environments that each run a separate
component of a single application. Takes a list of version labels that
specify application source bundles for each of the environments to
create or update. The name of each environment and other required
information must be included in the source bundles in an environment
manifest named C<env.yaml>. See Compose Environments for details.

CreateApplication(ApplicationName => Str, [Description => Str, ResourceLifecycleConfig => Paws::ElasticBeanstalk::ApplicationResourceLifecycleConfig])

Each argument is described in detail in: Paws::ElasticBeanstalk::CreateApplication

Returns: a Paws::ElasticBeanstalk::ApplicationDescriptionMessage instance

  Creates an application that has one configuration template named
C<default> and no application versions.

CreateApplicationVersion(ApplicationName => Str, VersionLabel => Str, [AutoCreateApplication => Bool, BuildConfiguration => Paws::ElasticBeanstalk::BuildConfiguration, Description => Str, Process => Bool, SourceBuildInformation => Paws::ElasticBeanstalk::SourceBuildInformation, SourceBundle => Paws::ElasticBeanstalk::S3Location])

Each argument is described in detail in: Paws::ElasticBeanstalk::CreateApplicationVersion

Returns: a Paws::ElasticBeanstalk::ApplicationVersionDescriptionMessage instance

  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.

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.

CreateConfigurationTemplate(ApplicationName => Str, TemplateName => Str, [Description => Str, EnvironmentId => Str, OptionSettings => ArrayRef[Paws::ElasticBeanstalk::ConfigurationOptionSetting], SolutionStackName => Str, SourceConfiguration => Paws::ElasticBeanstalk::SourceConfiguration])

Each argument is described in detail in: Paws::ElasticBeanstalk::CreateConfigurationTemplate

Returns: a Paws::ElasticBeanstalk::ConfigurationSettingsDescription instance

  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.

Related Topics

  • DescribeConfigurationOptions

  • DescribeConfigurationSettings

  • ListAvailableSolutionStacks

CreateEnvironment(ApplicationName => Str, [CNAMEPrefix => Str, Description => Str, EnvironmentName => Str, GroupName => Str, OptionSettings => ArrayRef[Paws::ElasticBeanstalk::ConfigurationOptionSetting], OptionsToRemove => ArrayRef[Paws::ElasticBeanstalk::OptionSpecification], SolutionStackName => Str, Tags => ArrayRef[Paws::ElasticBeanstalk::Tag], TemplateName => Str, Tier => Paws::ElasticBeanstalk::EnvironmentTier, VersionLabel => Str])

Each argument is described in detail in: Paws::ElasticBeanstalk::CreateEnvironment

Returns: a Paws::ElasticBeanstalk::EnvironmentDescription instance

  Launches an environment for the specified application using the
specified configuration.

CreateStorageLocation( => )

Each argument is described in detail in: Paws::ElasticBeanstalk::CreateStorageLocation

Returns: a Paws::ElasticBeanstalk::CreateStorageLocationResultMessage instance

  Creates the Amazon S3 storage location for the account.

This location is used to store user log files.

DeleteApplication(ApplicationName => Str, [TerminateEnvByForce => Bool])

Each argument is described in detail in: Paws::ElasticBeanstalk::DeleteApplication

Returns: nothing

  Deletes the specified application along with all associated versions
and configurations. The application versions will not be deleted from
your Amazon S3 bucket.

You cannot delete an application that has a running environment.

DeleteApplicationVersion(ApplicationName => Str, VersionLabel => Str, [DeleteSourceBundle => Bool])

Each argument is described in detail in: Paws::ElasticBeanstalk::DeleteApplicationVersion

Returns: nothing

  Deletes the specified version from the specified application.

You cannot delete an application version that is associated with a running environment.

DeleteConfigurationTemplate(ApplicationName => Str, TemplateName => Str)

Each argument is described in detail in: Paws::ElasticBeanstalk::DeleteConfigurationTemplate

Returns: nothing

  Deletes the specified configuration template.

When you launch an environment using a configuration template, the environment gets a copy of the template. You can delete or modify the environment's copy of the template without affecting the running environment.

DeleteEnvironmentConfiguration(ApplicationName => Str, EnvironmentName => Str)

Each argument is described in detail in: Paws::ElasticBeanstalk::DeleteEnvironmentConfiguration

Returns: nothing

  Deletes the draft configuration associated with the running
environment.

Updating a running environment with any configuration changes creates a draft configuration set. You can get the draft configuration using DescribeConfigurationSettings while the update is in progress or if the update fails. The DeploymentStatus for the draft configuration indicates whether the deployment is in process or has failed. The draft configuration remains in existence until it is deleted with this action.

DescribeApplications([ApplicationNames => ArrayRef[Str|Undef]])

Each argument is described in detail in: Paws::ElasticBeanstalk::DescribeApplications

Returns: a Paws::ElasticBeanstalk::ApplicationDescriptionsMessage instance

  Returns the descriptions of existing applications.

DescribeApplicationVersions([ApplicationName => Str, MaxRecords => Int, NextToken => Str, VersionLabels => ArrayRef[Str|Undef]])

Each argument is described in detail in: Paws::ElasticBeanstalk::DescribeApplicationVersions

Returns: a Paws::ElasticBeanstalk::ApplicationVersionDescriptionsMessage instance

  Retrieve a list of application versions.

DescribeConfigurationOptions([ApplicationName => Str, EnvironmentName => Str, Options => ArrayRef[Paws::ElasticBeanstalk::OptionSpecification], SolutionStackName => Str, TemplateName => Str])

Each argument is described in detail in: Paws::ElasticBeanstalk::DescribeConfigurationOptions

Returns: a Paws::ElasticBeanstalk::ConfigurationOptionsDescription instance

  Describes the configuration options that are used in a particular
configuration template or environment, or that a specified solution
stack defines. The description includes the values the options, their
default values, and an indication of the required action on a running
environment if an option value is changed.

DescribeConfigurationSettings(ApplicationName => Str, [EnvironmentName => Str, TemplateName => Str])

Each argument is described in detail in: Paws::ElasticBeanstalk::DescribeConfigurationSettings

Returns: a Paws::ElasticBeanstalk::ConfigurationSettingsDescriptions instance

  Returns a description of the settings for the specified configuration
set, that is, either a configuration template or the configuration set
associated with a running environment.

When describing the settings for the configuration set associated with a running environment, it is possible to receive two sets of setting descriptions. One is the deployed configuration set, and the other is a draft configuration of an environment that is either in the process of deployment or that failed to deploy.

Related Topics

  • DeleteEnvironmentConfiguration

DescribeEnvironmentHealth([AttributeNames => ArrayRef[Str|Undef], EnvironmentId => Str, EnvironmentName => Str])

Each argument is described in detail in: Paws::ElasticBeanstalk::DescribeEnvironmentHealth

Returns: a Paws::ElasticBeanstalk::DescribeEnvironmentHealthResult instance

  Returns information about the overall health of the specified
environment. The B<DescribeEnvironmentHealth> operation is only
available with AWS Elastic Beanstalk Enhanced Health.

DescribeEnvironmentManagedActionHistory([EnvironmentId => Str, EnvironmentName => Str, MaxItems => Int, NextToken => Str])

Each argument is described in detail in: Paws::ElasticBeanstalk::DescribeEnvironmentManagedActionHistory

Returns: a Paws::ElasticBeanstalk::DescribeEnvironmentManagedActionHistoryResult instance

  Lists an environment's completed and failed managed actions.

DescribeEnvironmentManagedActions([EnvironmentId => Str, EnvironmentName => Str, Status => Str])

Each argument is described in detail in: Paws::ElasticBeanstalk::DescribeEnvironmentManagedActions

Returns: a Paws::ElasticBeanstalk::DescribeEnvironmentManagedActionsResult instance

  Lists an environment's upcoming and in-progress managed actions.

DescribeEnvironmentResources([EnvironmentId => Str, EnvironmentName => Str])

Each argument is described in detail in: Paws::ElasticBeanstalk::DescribeEnvironmentResources

Returns: a Paws::ElasticBeanstalk::EnvironmentResourceDescriptionsMessage instance

  Returns AWS resources for this environment.

DescribeEnvironments([ApplicationName => Str, EnvironmentIds => ArrayRef[Str|Undef], EnvironmentNames => ArrayRef[Str|Undef], IncludedDeletedBackTo => Str, IncludeDeleted => Bool, VersionLabel => Str])

Each argument is described in detail in: Paws::ElasticBeanstalk::DescribeEnvironments

Returns: a Paws::ElasticBeanstalk::EnvironmentDescriptionsMessage instance

  Returns descriptions for existing environments.

DescribeEvents([ApplicationName => Str, EndTime => Str, EnvironmentId => Str, EnvironmentName => Str, MaxRecords => Int, NextToken => Str, RequestId => Str, Severity => Str, StartTime => Str, TemplateName => Str, VersionLabel => Str])

Each argument is described in detail in: Paws::ElasticBeanstalk::DescribeEvents

Returns: a Paws::ElasticBeanstalk::EventDescriptionsMessage instance

  Returns list of event descriptions matching criteria up to the last 6
weeks.

This action returns the most recent 1,000 events from the specified NextToken.

DescribeInstancesHealth([AttributeNames => ArrayRef[Str|Undef], EnvironmentId => Str, EnvironmentName => Str, NextToken => Str])

Each argument is described in detail in: Paws::ElasticBeanstalk::DescribeInstancesHealth

Returns: a Paws::ElasticBeanstalk::DescribeInstancesHealthResult instance

  Retrives detailed information about the health of instances in your AWS
Elastic Beanstalk. This operation requires enhanced health reporting.

ListAvailableSolutionStacks( => )

Each argument is described in detail in: Paws::ElasticBeanstalk::ListAvailableSolutionStacks

Returns: a Paws::ElasticBeanstalk::ListAvailableSolutionStacksResultMessage instance

  Returns a list of the available solution stack names.

RebuildEnvironment([EnvironmentId => Str, EnvironmentName => Str])

Each argument is described in detail in: Paws::ElasticBeanstalk::RebuildEnvironment

Returns: nothing

  Deletes and recreates all of the AWS resources (for example: the Auto
Scaling group, load balancer, etc.) for a specified environment and
forces a restart.

RequestEnvironmentInfo(InfoType => Str, [EnvironmentId => Str, EnvironmentName => Str])

Each argument is described in detail in: Paws::ElasticBeanstalk::RequestEnvironmentInfo

Returns: nothing

  Initiates a request to compile the specified type of information of the
deployed environment.

Setting the InfoType to tail compiles the last lines from the application server log files of every Amazon EC2 instance in your environment.

Setting the InfoType to bundle compresses the application server log files for every Amazon EC2 instance into a .zip file. Legacy and .NET containers do not support bundle logs.

Use RetrieveEnvironmentInfo to obtain the set of logs.

Related Topics

  • RetrieveEnvironmentInfo

RestartAppServer([EnvironmentId => Str, EnvironmentName => Str])

Each argument is described in detail in: Paws::ElasticBeanstalk::RestartAppServer

Returns: nothing

  Causes the environment to restart the application container server
running on each Amazon EC2 instance.

RetrieveEnvironmentInfo(InfoType => Str, [EnvironmentId => Str, EnvironmentName => Str])

Each argument is described in detail in: Paws::ElasticBeanstalk::RetrieveEnvironmentInfo

Returns: a Paws::ElasticBeanstalk::RetrieveEnvironmentInfoResultMessage instance

  Retrieves the compiled information from a RequestEnvironmentInfo
request.

Related Topics

  • RequestEnvironmentInfo

SwapEnvironmentCNAMEs([DestinationEnvironmentId => Str, DestinationEnvironmentName => Str, SourceEnvironmentId => Str, SourceEnvironmentName => Str])

Each argument is described in detail in: Paws::ElasticBeanstalk::SwapEnvironmentCNAMEs

Returns: nothing

  Swaps the CNAMEs of two environments.

TerminateEnvironment([EnvironmentId => Str, EnvironmentName => Str, ForceTerminate => Bool, TerminateResources => Bool])

Each argument is described in detail in: Paws::ElasticBeanstalk::TerminateEnvironment

Returns: a Paws::ElasticBeanstalk::EnvironmentDescription instance

  Terminates the specified environment.

UpdateApplication(ApplicationName => Str, [Description => Str])

Each argument is described in detail in: Paws::ElasticBeanstalk::UpdateApplication

Returns: a Paws::ElasticBeanstalk::ApplicationDescriptionMessage instance

  Updates the specified application to have the specified properties.

If a property (for example, description) is not provided, the value remains unchanged. To clear these properties, specify an empty string.

UpdateApplicationResourceLifecycle(ApplicationName => Str, ResourceLifecycleConfig => Paws::ElasticBeanstalk::ApplicationResourceLifecycleConfig)

Each argument is described in detail in: Paws::ElasticBeanstalk::UpdateApplicationResourceLifecycle

Returns: a Paws::ElasticBeanstalk::ApplicationResourceLifecycleDescriptionMessage instance

  Modifies lifecycle settings for an application.

UpdateApplicationVersion(ApplicationName => Str, VersionLabel => Str, [Description => Str])

Each argument is described in detail in: Paws::ElasticBeanstalk::UpdateApplicationVersion

Returns: a Paws::ElasticBeanstalk::ApplicationVersionDescriptionMessage instance

  Updates the specified application version to have the specified
properties.

If a property (for example, description) is not provided, the value remains unchanged. To clear properties, specify an empty string.

UpdateConfigurationTemplate(ApplicationName => Str, TemplateName => Str, [Description => Str, OptionSettings => ArrayRef[Paws::ElasticBeanstalk::ConfigurationOptionSetting], OptionsToRemove => ArrayRef[Paws::ElasticBeanstalk::OptionSpecification]])

Each argument is described in detail in: Paws::ElasticBeanstalk::UpdateConfigurationTemplate

Returns: a Paws::ElasticBeanstalk::ConfigurationSettingsDescription instance

  Updates the specified configuration template to have the specified
properties or configuration option values.

If a property (for example, ApplicationName) is not provided, its value remains unchanged. To clear such properties, specify an empty string.

Related Topics

  • DescribeConfigurationOptions

UpdateEnvironment([ApplicationName => Str, Description => Str, EnvironmentId => Str, EnvironmentName => Str, GroupName => Str, OptionSettings => ArrayRef[Paws::ElasticBeanstalk::ConfigurationOptionSetting], OptionsToRemove => ArrayRef[Paws::ElasticBeanstalk::OptionSpecification], SolutionStackName => Str, TemplateName => Str, Tier => Paws::ElasticBeanstalk::EnvironmentTier, VersionLabel => Str])

Each argument is described in detail in: Paws::ElasticBeanstalk::UpdateEnvironment

Returns: a Paws::ElasticBeanstalk::EnvironmentDescription instance

  Updates the environment description, deploys a new application version,
updates the configuration settings to an entirely new configuration
template, or updates select configuration option values in the running
environment.

Attempting to update both the release and configuration is not allowed and AWS Elastic Beanstalk returns an InvalidParameterCombination error.

When updating the configuration settings to a new template or individual settings, a draft configuration is created and DescribeConfigurationSettings for this environment returns two setting descriptions with different DeploymentStatus values.

ValidateConfigurationSettings(ApplicationName => Str, OptionSettings => ArrayRef[Paws::ElasticBeanstalk::ConfigurationOptionSetting], [EnvironmentName => Str, TemplateName => Str])

Each argument is described in detail in: Paws::ElasticBeanstalk::ValidateConfigurationSettings

Returns: a Paws::ElasticBeanstalk::ConfigurationSettingsValidationMessages instance

  Takes a set of configuration settings and either a configuration
template or environment, and determines whether those values are valid.

This action returns a list of messages indicating any errors or warnings associated with the selection of option values.

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results

DescribeAllEvents(sub { },[ApplicationName => Str, EndTime => Str, EnvironmentId => Str, EnvironmentName => Str, MaxRecords => Int, NextToken => Str, RequestId => Str, Severity => Str, StartTime => Str, TemplateName => Str, VersionLabel => Str])

DescribeAllEvents([ApplicationName => Str, EndTime => Str, EnvironmentId => Str, EnvironmentName => Str, MaxRecords => Int, NextToken => Str, RequestId => Str, Severity => Str, StartTime => Str, TemplateName => Str, VersionLabel => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - Events, passing the object as the first parameter, and the string 'Events' as the second parameter 

If not, it will return a a Paws::ElasticBeanstalk::EventDescriptionsMessage instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

SEE ALSO

This service class forms part of Paws

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues