|
NAMEPaws::ElasticBeanstalk - Perl Interface to AWS AWS Elastic BeanstalkSYNOPSISuse Paws; my $obj = Paws->service('ElasticBeanstalk')->new; 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' } ], ); DESCRIPTIONAWS Elastic BeanstalkThis is the AWS Elastic Beanstalk API Reference. This guide provides detailed information about AWS Elastic Beanstalk actions, data types, parameters, and errors. AWS Elastic Beanstalk is a tool that makes it easy for you to create, deploy, and manage scalable, fault-tolerant applications running on Amazon Web Services cloud resources. 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. METHODSAbortEnvironmentUpdate([EnvironmentId => Str, EnvironmentName => Str])Each argument is described in detail in: Paws::ElasticBeanstalk::AbortEnvironmentUpdateReturns: nothing Cancels in-progress environment configuration update or application version deployment. CheckDNSAvailability(CNAMEPrefix => Str)Each argument is described in detail in: Paws::ElasticBeanstalk::CheckDNSAvailabilityReturns: a Paws::ElasticBeanstalk::CheckDNSAvailabilityResultMessage instance Checks if the specified CNAME is available. CreateApplication(ApplicationName => Str, [Description => Str])Each argument is described in detail in: Paws::ElasticBeanstalk::CreateApplicationReturns: a Paws::ElasticBeanstalk::ApplicationDescriptionMessage instance Creates an application that has one configuration template named "default" and no application versions. CreateApplicationVersion(ApplicationName => Str, VersionLabel => Str, [AutoCreateApplication => Bool, Description => Str, SourceBundle => Paws::ElasticBeanstalk::S3Location])Each argument is described in detail in: Paws::ElasticBeanstalk::CreateApplicationVersionReturns: a Paws::ElasticBeanstalk::ApplicationVersionDescriptionMessage instance Creates an application version for the specified 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::CreateConfigurationTemplateReturns: 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
CreateEnvironment(ApplicationName => Str, EnvironmentName => Str, [CNAMEPrefix => Str, Description => 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::CreateEnvironmentReturns: 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::CreateStorageLocationReturns: 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::DeleteApplicationReturns: 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::DeleteApplicationVersionReturns: 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::DeleteConfigurationTemplateReturns: 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::DeleteEnvironmentConfigurationReturns: 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]])Each argument is described in detail in: Paws::ElasticBeanstalk::DescribeApplicationsReturns: a Paws::ElasticBeanstalk::ApplicationDescriptionsMessage instance Returns the descriptions of existing applications. DescribeApplicationVersions([ApplicationName => Str, VersionLabels => ArrayRef[Str]])Each argument is described in detail in: Paws::ElasticBeanstalk::DescribeApplicationVersionsReturns: a Paws::ElasticBeanstalk::ApplicationVersionDescriptionsMessage instance Returns descriptions for existing 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::DescribeConfigurationOptionsReturns: 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::DescribeConfigurationSettingsReturns: 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
DescribeEnvironmentResources([EnvironmentId => Str, EnvironmentName => Str])Each argument is described in detail in: Paws::ElasticBeanstalk::DescribeEnvironmentResourcesReturns: a Paws::ElasticBeanstalk::EnvironmentResourceDescriptionsMessage instance Returns AWS resources for this environment. DescribeEnvironments([ApplicationName => Str, EnvironmentIds => ArrayRef[Str], EnvironmentNames => ArrayRef[Str], IncludedDeletedBackTo => Str, IncludeDeleted => Bool, VersionLabel => Str])Each argument is described in detail in: Paws::ElasticBeanstalk::DescribeEnvironmentsReturns: 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::DescribeEventsReturns: 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". ListAvailableSolutionStacks( => )Each argument is described in detail in: Paws::ElasticBeanstalk::ListAvailableSolutionStacksReturns: 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::RebuildEnvironmentReturns: 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::RequestEnvironmentInfoReturns: 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
RestartAppServer([EnvironmentId => Str, EnvironmentName => Str])Each argument is described in detail in: Paws::ElasticBeanstalk::RestartAppServerReturns: 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::RetrieveEnvironmentInfoReturns: a Paws::ElasticBeanstalk::RetrieveEnvironmentInfoResultMessage instance Retrieves the compiled information from a RequestEnvironmentInfo request. Related Topics
SwapEnvironmentCNAMEs([DestinationEnvironmentId => Str, DestinationEnvironmentName => Str, SourceEnvironmentId => Str, SourceEnvironmentName => Str])Each argument is described in detail in: Paws::ElasticBeanstalk::SwapEnvironmentCNAMEsReturns: nothing Swaps the CNAMEs of two environments. TerminateEnvironment([EnvironmentId => Str, EnvironmentName => Str, TerminateResources => Bool])Each argument is described in detail in: Paws::ElasticBeanstalk::TerminateEnvironmentReturns: a Paws::ElasticBeanstalk::EnvironmentDescription instance Terminates the specified environment. UpdateApplication(ApplicationName => Str, [Description => Str])Each argument is described in detail in: Paws::ElasticBeanstalk::UpdateApplicationReturns: 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. UpdateApplicationVersion(ApplicationName => Str, VersionLabel => Str, [Description => Str])Each argument is described in detail in: Paws::ElasticBeanstalk::UpdateApplicationVersionReturns: 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::UpdateConfigurationTemplateReturns: 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
UpdateEnvironment([Description => Str, EnvironmentId => Str, EnvironmentName => 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::UpdateEnvironmentReturns: 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::ValidateConfigurationSettingsReturns: 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. SEE ALSOThis service class forms part of PawsBUGS and CONTRIBUTIONSThe source code is located here: https://github.com/pplu/aws-sdk-perlPlease report bugs to: https://github.com/pplu/aws-sdk-perl/issues
Visit the GSP FreeBSD Man Page Interface. |