public class AbstractAWSElasticBeanstalk extends Object implements AWSElasticBeanstalk
AWSElasticBeanstalk
. Convenient method
forms pass through to the corresponding overload that takes a request object,
which throws an UnsupportedOperationException
.Modifier and Type | Method and Description |
---|---|
void |
abortEnvironmentUpdate()
Simplified method form for invoking the AbortEnvironmentUpdate operation.
|
void |
abortEnvironmentUpdate(AbortEnvironmentUpdateRequest request)
Cancels in-progress environment configuration update or application
version deployment.
|
ApplyEnvironmentManagedActionResult |
applyEnvironmentManagedAction(ApplyEnvironmentManagedActionRequest request)
Applies a scheduled managed action immediately.
|
CheckDNSAvailabilityResult |
checkDNSAvailability(CheckDNSAvailabilityRequest request)
Checks if the specified CNAME is available.
|
ComposeEnvironmentsResult |
composeEnvironments(ComposeEnvironmentsRequest request)
Create or update a group of environments that each run a separate
component of a single application.
|
CreateApplicationResult |
createApplication(CreateApplicationRequest request)
Creates an application that has one configuration template named
default and no application versions. |
CreateApplicationVersionResult |
createApplicationVersion(CreateApplicationVersionRequest request)
Creates an application version for the specified application.
|
CreateConfigurationTemplateResult |
createConfigurationTemplate(CreateConfigurationTemplateRequest request)
Creates a configuration template.
|
CreateEnvironmentResult |
createEnvironment(CreateEnvironmentRequest request)
Launches an environment for the specified application using the specified
configuration.
|
CreateStorageLocationResult |
createStorageLocation()
Simplified method form for invoking the CreateStorageLocation operation.
|
CreateStorageLocationResult |
createStorageLocation(CreateStorageLocationRequest request)
Creates the Amazon S3 storage location for the account.
|
void |
deleteApplication(DeleteApplicationRequest request)
Deletes the specified application along with all associated versions and
configurations.
|
void |
deleteApplicationVersion(DeleteApplicationVersionRequest request)
Deletes the specified version from the specified application.
|
void |
deleteConfigurationTemplate(DeleteConfigurationTemplateRequest request)
Deletes the specified configuration template.
|
void |
deleteEnvironmentConfiguration(DeleteEnvironmentConfigurationRequest request)
Deletes the draft configuration associated with the running environment.
|
DescribeApplicationsResult |
describeApplications()
Simplified method form for invoking the DescribeApplications operation.
|
DescribeApplicationsResult |
describeApplications(DescribeApplicationsRequest request)
Returns the descriptions of existing applications.
|
DescribeApplicationVersionsResult |
describeApplicationVersions()
Simplified method form for invoking the DescribeApplicationVersions
operation.
|
DescribeApplicationVersionsResult |
describeApplicationVersions(DescribeApplicationVersionsRequest request)
Retrieve a list of application versions stored in your AWS Elastic
Beanstalk storage bucket.
|
DescribeConfigurationOptionsResult |
describeConfigurationOptions(DescribeConfigurationOptionsRequest request)
Describes the configuration options that are used in a particular
configuration template or environment, or that a specified solution stack
defines.
|
DescribeConfigurationSettingsResult |
describeConfigurationSettings(DescribeConfigurationSettingsRequest request)
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.
|
DescribeEnvironmentHealthResult |
describeEnvironmentHealth(DescribeEnvironmentHealthRequest request)
Returns information about the overall health of the specified
environment.
|
DescribeEnvironmentManagedActionHistoryResult |
describeEnvironmentManagedActionHistory(DescribeEnvironmentManagedActionHistoryRequest request)
Lists an environment's completed and failed managed actions.
|
DescribeEnvironmentManagedActionsResult |
describeEnvironmentManagedActions(DescribeEnvironmentManagedActionsRequest request)
Lists an environment's upcoming and in-progress managed actions.
|
DescribeEnvironmentResourcesResult |
describeEnvironmentResources(DescribeEnvironmentResourcesRequest request)
Returns AWS resources for this environment.
|
DescribeEnvironmentsResult |
describeEnvironments()
Simplified method form for invoking the DescribeEnvironments operation.
|
DescribeEnvironmentsResult |
describeEnvironments(DescribeEnvironmentsRequest request)
Returns descriptions for existing environments.
|
DescribeEventsResult |
describeEvents()
Simplified method form for invoking the DescribeEvents operation.
|
DescribeEventsResult |
describeEvents(DescribeEventsRequest request)
Returns list of event descriptions matching criteria up to the last 6
weeks.
|
DescribeInstancesHealthResult |
describeInstancesHealth(DescribeInstancesHealthRequest request)
Returns more detailed information about the health of the specified
instances (for example, CPU utilization, load average, and causes).
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request,
typically used for debugging issues where a service isn't acting as
expected.
|
ListAvailableSolutionStacksResult |
listAvailableSolutionStacks()
Simplified method form for invoking the ListAvailableSolutionStacks
operation.
|
ListAvailableSolutionStacksResult |
listAvailableSolutionStacks(ListAvailableSolutionStacksRequest request)
Returns a list of the available solution stack names.
|
void |
rebuildEnvironment(RebuildEnvironmentRequest request)
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.
|
void |
requestEnvironmentInfo(RequestEnvironmentInfoRequest request)
Initiates a request to compile the specified type of information of the
deployed environment.
|
void |
restartAppServer(RestartAppServerRequest request)
Causes the environment to restart the application container server
running on each Amazon EC2 instance.
|
RetrieveEnvironmentInfoResult |
retrieveEnvironmentInfo(RetrieveEnvironmentInfoRequest request)
Retrieves the compiled information from a RequestEnvironmentInfo
request.
|
void |
setEndpoint(String endpoint)
Overrides the default endpoint for this client
("https://elasticbeanstalk.us-east-1.amazonaws.com").
|
void |
setRegion(Region region)
An alternative to
AWSElasticBeanstalk.setEndpoint(String) , sets
the regional endpoint for this client's service calls. |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held
open.
|
void |
swapEnvironmentCNAMEs()
Simplified method form for invoking the SwapEnvironmentCNAMEs operation.
|
void |
swapEnvironmentCNAMEs(SwapEnvironmentCNAMEsRequest request)
Swaps the CNAMEs of two environments.
|
TerminateEnvironmentResult |
terminateEnvironment(TerminateEnvironmentRequest request)
Terminates the specified environment.
|
UpdateApplicationResult |
updateApplication(UpdateApplicationRequest request)
Updates the specified application to have the specified properties.
|
UpdateApplicationVersionResult |
updateApplicationVersion(UpdateApplicationVersionRequest request)
Updates the specified application version to have the specified
properties.
|
UpdateConfigurationTemplateResult |
updateConfigurationTemplate(UpdateConfigurationTemplateRequest request)
Updates the specified configuration template to have the specified
properties or configuration option values.
|
UpdateEnvironmentResult |
updateEnvironment(UpdateEnvironmentRequest request)
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.
|
ValidateConfigurationSettingsResult |
validateConfigurationSettings(ValidateConfigurationSettingsRequest request)
Takes a set of configuration settings and either a configuration template
or environment, and determines whether those values are valid.
|
public void setEndpoint(String endpoint)
AWSElasticBeanstalk
Callers can pass in just the endpoint (ex:
"elasticbeanstalk.us-east-1.amazonaws.com") or a full URL, including the
protocol (ex: "https://elasticbeanstalk.us-east-1.amazonaws.com"). If the
protocol is not specified here, the default protocol from this client's
ClientConfiguration
will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= 3912
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setEndpoint
in interface AWSElasticBeanstalk
endpoint
- The endpoint (ex: "elasticbeanstalk.us-east-1.amazonaws.com") or a
full URL, including the protocol (ex:
"https://elasticbeanstalk.us-east-1.amazonaws.com") of the region
specific AWS endpoint this client will communicate with.public void setRegion(Region region)
AWSElasticBeanstalk
AWSElasticBeanstalk.setEndpoint(String)
, sets
the regional endpoint for this client's service calls. Callers can use
this method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol.
To use http instead, specify it in the ClientConfiguration
supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setRegion
in interface AWSElasticBeanstalk
region
- The region this client will communicate with. See
Region.getRegion(com.amazonaws.regions.Regions)
for
accessing a given region. Must not be null and must be a region
where the service is available.Region.getRegion(com.amazonaws.regions.Regions)
,
Region.createClient(Class,
com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
,
Region.isServiceSupported(String)
public void abortEnvironmentUpdate(AbortEnvironmentUpdateRequest request)
AWSElasticBeanstalk
Cancels in-progress environment configuration update or application version deployment.
abortEnvironmentUpdate
in interface AWSElasticBeanstalk
public void abortEnvironmentUpdate()
AWSElasticBeanstalk
abortEnvironmentUpdate
in interface AWSElasticBeanstalk
AWSElasticBeanstalk.abortEnvironmentUpdate(AbortEnvironmentUpdateRequest)
public ApplyEnvironmentManagedActionResult applyEnvironmentManagedAction(ApplyEnvironmentManagedActionRequest request)
AWSElasticBeanstalk
Applies a scheduled managed action immediately. A managed action can be
applied only if its status is Scheduled
. Get the status and
action ID of a managed action with
DescribeEnvironmentManagedActions.
applyEnvironmentManagedAction
in interface AWSElasticBeanstalk
request
- Request to execute a scheduled managed action immediately.public CheckDNSAvailabilityResult checkDNSAvailability(CheckDNSAvailabilityRequest request)
AWSElasticBeanstalk
Checks if the specified CNAME is available.
checkDNSAvailability
in interface AWSElasticBeanstalk
request
- Results message indicating whether a CNAME is available.public ComposeEnvironmentsResult composeEnvironments(ComposeEnvironmentsRequest request)
AWSElasticBeanstalk
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
env.yaml
. See Compose Environments for details.
composeEnvironments
in interface AWSElasticBeanstalk
request
- Request to create or update a group of environments.public CreateApplicationResult createApplication(CreateApplicationRequest request)
AWSElasticBeanstalk
Creates an application that has one configuration template named
default
and no application versions.
createApplication
in interface AWSElasticBeanstalk
request
- Request to create an application.public CreateApplicationVersionResult createApplicationVersion(CreateApplicationVersionRequest request)
AWSElasticBeanstalk
Creates an application version for the specified application.
createApplicationVersion
in interface AWSElasticBeanstalk
public CreateConfigurationTemplateResult createConfigurationTemplate(CreateConfigurationTemplateRequest request)
AWSElasticBeanstalk
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
createConfigurationTemplate
in interface AWSElasticBeanstalk
request
- Request to create a configuration template.public CreateEnvironmentResult createEnvironment(CreateEnvironmentRequest request)
AWSElasticBeanstalk
Launches an environment for the specified application using the specified configuration.
createEnvironment
in interface AWSElasticBeanstalk
public CreateStorageLocationResult createStorageLocation(CreateStorageLocationRequest request)
AWSElasticBeanstalk
Creates the Amazon S3 storage location for the account.
This location is used to store user log files.
createStorageLocation
in interface AWSElasticBeanstalk
public CreateStorageLocationResult createStorageLocation()
AWSElasticBeanstalk
createStorageLocation
in interface AWSElasticBeanstalk
AWSElasticBeanstalk.createStorageLocation(CreateStorageLocationRequest)
public void deleteApplication(DeleteApplicationRequest request)
AWSElasticBeanstalk
Deletes the specified application along with all associated versions and configurations. The application versions will not be deleted from your Amazon S3 bucket.
deleteApplication
in interface AWSElasticBeanstalk
request
- Request to delete an application.public void deleteApplicationVersion(DeleteApplicationVersionRequest request)
AWSElasticBeanstalk
Deletes the specified version from the specified application.
deleteApplicationVersion
in interface AWSElasticBeanstalk
request
- Request to delete an application version.public void deleteConfigurationTemplate(DeleteConfigurationTemplateRequest request)
AWSElasticBeanstalk
Deletes the specified configuration template.
deleteConfigurationTemplate
in interface AWSElasticBeanstalk
request
- Request to delete a configuration template.public void deleteEnvironmentConfiguration(DeleteEnvironmentConfigurationRequest request)
AWSElasticBeanstalk
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.
deleteEnvironmentConfiguration
in interface AWSElasticBeanstalk
request
- Request to delete a draft environment configuration.public DescribeApplicationVersionsResult describeApplicationVersions(DescribeApplicationVersionsRequest request)
AWSElasticBeanstalk
Retrieve a list of application versions stored in your AWS Elastic Beanstalk storage bucket.
describeApplicationVersions
in interface AWSElasticBeanstalk
request
- Result message containing a list of configuration descriptions.public DescribeApplicationVersionsResult describeApplicationVersions()
AWSElasticBeanstalk
describeApplicationVersions
in interface AWSElasticBeanstalk
AWSElasticBeanstalk.describeApplicationVersions(DescribeApplicationVersionsRequest)
public DescribeApplicationsResult describeApplications(DescribeApplicationsRequest request)
AWSElasticBeanstalk
Returns the descriptions of existing applications.
describeApplications
in interface AWSElasticBeanstalk
request
- Request to describe one or more applications.public DescribeApplicationsResult describeApplications()
AWSElasticBeanstalk
describeApplications
in interface AWSElasticBeanstalk
AWSElasticBeanstalk.describeApplications(DescribeApplicationsRequest)
public DescribeConfigurationOptionsResult describeConfigurationOptions(DescribeConfigurationOptionsRequest request)
AWSElasticBeanstalk
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.
describeConfigurationOptions
in interface AWSElasticBeanstalk
request
- Result message containig a list of application version
descriptions.public DescribeConfigurationSettingsResult describeConfigurationSettings(DescribeConfigurationSettingsRequest request)
AWSElasticBeanstalk
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
describeConfigurationSettings
in interface AWSElasticBeanstalk
request
- Result message containing all of the configuration settings for a
specified solution stack or configuration template.public DescribeEnvironmentHealthResult describeEnvironmentHealth(DescribeEnvironmentHealthRequest request)
AWSElasticBeanstalk
Returns information about the overall health of the specified environment. The DescribeEnvironmentHealth operation is only available with AWS Elastic Beanstalk Enhanced Health.
describeEnvironmentHealth
in interface AWSElasticBeanstalk
request
- See the example below to learn how to create a request body.public DescribeEnvironmentManagedActionHistoryResult describeEnvironmentManagedActionHistory(DescribeEnvironmentManagedActionHistoryRequest request)
AWSElasticBeanstalk
Lists an environment's completed and failed managed actions.
describeEnvironmentManagedActionHistory
in interface AWSElasticBeanstalk
request
- Request to list completed and failed managed actions.public DescribeEnvironmentManagedActionsResult describeEnvironmentManagedActions(DescribeEnvironmentManagedActionsRequest request)
AWSElasticBeanstalk
Lists an environment's upcoming and in-progress managed actions.
describeEnvironmentManagedActions
in interface AWSElasticBeanstalk
request
- Request to list an environment's upcoming and in-progress managed
actions.public DescribeEnvironmentResourcesResult describeEnvironmentResources(DescribeEnvironmentResourcesRequest request)
AWSElasticBeanstalk
Returns AWS resources for this environment.
describeEnvironmentResources
in interface AWSElasticBeanstalk
request
- Request to describe the resources in an environment.public DescribeEnvironmentsResult describeEnvironments(DescribeEnvironmentsRequest request)
AWSElasticBeanstalk
Returns descriptions for existing environments.
describeEnvironments
in interface AWSElasticBeanstalk
request
- Request to describe one or more environments.public DescribeEnvironmentsResult describeEnvironments()
AWSElasticBeanstalk
describeEnvironments
in interface AWSElasticBeanstalk
AWSElasticBeanstalk.describeEnvironments(DescribeEnvironmentsRequest)
public DescribeEventsResult describeEvents(DescribeEventsRequest request)
AWSElasticBeanstalk
Returns list of event descriptions matching criteria up to the last 6 weeks.
NextToken
.describeEvents
in interface AWSElasticBeanstalk
request
- Request to retrieve a list of events for an environment.public DescribeEventsResult describeEvents()
AWSElasticBeanstalk
describeEvents
in interface AWSElasticBeanstalk
AWSElasticBeanstalk.describeEvents(DescribeEventsRequest)
public DescribeInstancesHealthResult describeInstancesHealth(DescribeInstancesHealthRequest request)
AWSElasticBeanstalk
Returns more detailed information about the health of the specified instances (for example, CPU utilization, load average, and causes). The DescribeInstancesHealth operation is only available with AWS Elastic Beanstalk Enhanced Health.
describeInstancesHealth
in interface AWSElasticBeanstalk
request
- See the example below to learn how to create a request body.public ListAvailableSolutionStacksResult listAvailableSolutionStacks(ListAvailableSolutionStacksRequest request)
AWSElasticBeanstalk
Returns a list of the available solution stack names.
listAvailableSolutionStacks
in interface AWSElasticBeanstalk
public ListAvailableSolutionStacksResult listAvailableSolutionStacks()
AWSElasticBeanstalk
listAvailableSolutionStacks
in interface AWSElasticBeanstalk
AWSElasticBeanstalk.listAvailableSolutionStacks(ListAvailableSolutionStacksRequest)
public void rebuildEnvironment(RebuildEnvironmentRequest request)
AWSElasticBeanstalk
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.
rebuildEnvironment
in interface AWSElasticBeanstalk
public void requestEnvironmentInfo(RequestEnvironmentInfoRequest request)
AWSElasticBeanstalk
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
requestEnvironmentInfo
in interface AWSElasticBeanstalk
request
- Request to retrieve logs from an environment and store them in
your Elastic Beanstalk storage bucket.public void restartAppServer(RestartAppServerRequest request)
AWSElasticBeanstalk
Causes the environment to restart the application container server running on each Amazon EC2 instance.
restartAppServer
in interface AWSElasticBeanstalk
public RetrieveEnvironmentInfoResult retrieveEnvironmentInfo(RetrieveEnvironmentInfoRequest request)
AWSElasticBeanstalk
Retrieves the compiled information from a RequestEnvironmentInfo request.
Related Topics
retrieveEnvironmentInfo
in interface AWSElasticBeanstalk
request
- Request to download logs retrieved with
RequestEnvironmentInfo.public void swapEnvironmentCNAMEs(SwapEnvironmentCNAMEsRequest request)
AWSElasticBeanstalk
Swaps the CNAMEs of two environments.
swapEnvironmentCNAMEs
in interface AWSElasticBeanstalk
request
- Swaps the CNAMEs of two environments.public void swapEnvironmentCNAMEs()
AWSElasticBeanstalk
swapEnvironmentCNAMEs
in interface AWSElasticBeanstalk
AWSElasticBeanstalk.swapEnvironmentCNAMEs(SwapEnvironmentCNAMEsRequest)
public TerminateEnvironmentResult terminateEnvironment(TerminateEnvironmentRequest request)
AWSElasticBeanstalk
Terminates the specified environment.
terminateEnvironment
in interface AWSElasticBeanstalk
request
- Request to terminate an environment.public UpdateApplicationResult updateApplication(UpdateApplicationRequest request)
AWSElasticBeanstalk
Updates the specified application to have the specified properties.
description
) is not
provided, the value remains unchanged. To clear these properties, specify
an empty string. updateApplication
in interface AWSElasticBeanstalk
request
- Request to update an application.public UpdateApplicationVersionResult updateApplicationVersion(UpdateApplicationVersionRequest request)
AWSElasticBeanstalk
Updates the specified application version to have the specified properties.
description
) is not
provided, the value remains unchanged. To clear properties, specify an
empty string. updateApplicationVersion
in interface AWSElasticBeanstalk
public UpdateConfigurationTemplateResult updateConfigurationTemplate(UpdateConfigurationTemplateRequest request)
AWSElasticBeanstalk
Updates the specified configuration template to have the specified properties or configuration option values.
ApplicationName
) is not
provided, its value remains unchanged. To clear such properties, specify
an empty string. Related Topics
updateConfigurationTemplate
in interface AWSElasticBeanstalk
request
- The result message containing the options for the specified
solution stack.public UpdateEnvironmentResult updateEnvironment(UpdateEnvironmentRequest request)
AWSElasticBeanstalk
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.
updateEnvironment
in interface AWSElasticBeanstalk
request
- Request to update an environment.public ValidateConfigurationSettingsResult validateConfigurationSettings(ValidateConfigurationSettingsRequest request)
AWSElasticBeanstalk
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.
validateConfigurationSettings
in interface AWSElasticBeanstalk
request
- A list of validation messages for a specified configuration
template.public void shutdown()
AWSElasticBeanstalk
shutdown
in interface AWSElasticBeanstalk
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AWSElasticBeanstalk
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
getCachedResponseMetadata
in interface AWSElasticBeanstalk
request
- The originally executed request.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.