AWS SDK for .NET Documentation
Amazon.ElasticBeanstalk.Model Namespace
AmazonAmazon.ElasticBeanstalk.Model Did this page help you?   Yes   No    Tell us about it...
 
Declaration Syntax
C#
namespace Amazon.ElasticBeanstalk.Model
Types
All TypesClasses
IconTypeDescription
ApplicationDescription
Describes the properties of an application.

ApplicationVersionDescription
Describes the properties of an application version.

AutoScalingGroup
Describes an Auto Scaling launch configuration.

CheckDNSAvailabilityRequest
Container for the parameters to the CheckDNSAvailability operation. Checks if the specified CNAME is available.

CheckDNSAvailabilityResponse
Returns information about the CheckDNSAvailabilityResult response and response metadata.

CheckDNSAvailabilityResult
Indicates if the specified CNAME is available.

ConfigurationOptionDescription
Describes the possible values for a configuration option.

ConfigurationOptionSetting
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.

ConfigurationSettingsDescription
Describes the settings for a configuration set.

CreateApplicationRequest
Container for the parameters to the CreateApplication operation. Creates an application that has one configuration template named
CopyC#
default
and no application versions. The <code>default</code> configuration template is for a 32-bit version of the Amazon Linux operating system running the Tomcat 6 application container.

CreateApplicationResponse
Returns information about the CreateApplicationResult response and response metadata.

CreateApplicationResult
Result message containing a single description of an application.

CreateApplicationVersionRequest
Container for the parameters to the CreateApplicationVersion operation. Creates an application version for the specified 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.

CreateApplicationVersionResponse
Returns information about the CreateApplicationVersionResult response and response metadata.

CreateApplicationVersionResult
Result message wrapping a single description of an application version.

CreateConfigurationTemplateRequest
Container for the parameters to the CreateConfigurationTemplate operation. 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


CreateConfigurationTemplateResponse
Returns information about the CreateConfigurationTemplateResult response and response metadata.

CreateConfigurationTemplateResult
Describes the settings for a configuration set.

CreateEnvironmentRequest
Container for the parameters to the CreateEnvironment operation. Launches an environment for the specified application using the specified configuration.

CreateEnvironmentResponse
Returns information about the CreateEnvironmentResult response and response metadata.

CreateEnvironmentResult
Describes the properties of an environment.

CreateStorageLocationRequest
Container for the parameters to the CreateStorageLocation operation. Creates the Amazon S3 storage location for the account.

This location is used to store user log files.


CreateStorageLocationResponse
Returns information about the CreateStorageLocationResult response and response metadata.

CreateStorageLocationResult
Results of a CreateStorageLocationResult call.

DeleteApplicationRequest
Container for the parameters to the DeleteApplication operation. Deletes the specified application along with all associated versions and configurations. The application versions will not be deleted from your Amazon S3 bucket.
Note:
You cannot delete an application that has a running environment.

DeleteApplicationResponse
Returns information about the DeleteApplicationResult response and response metadata.

DeleteApplicationVersionRequest
Container for the parameters to the DeleteApplicationVersion operation. Deletes the specified version from the specified application.
Note:
You cannot delete an application version that is associated with a running environment.

DeleteApplicationVersionResponse
Returns information about the DeleteApplicationVersionResult response and response metadata.

DeleteConfigurationTemplateRequest
Container for the parameters to the DeleteConfigurationTemplate operation. Deletes the specified configuration template.
Note:
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.

DeleteConfigurationTemplateResponse
Returns information about the DeleteConfigurationTemplateResult response and response metadata.

DeleteEnvironmentConfigurationRequest
Container for the parameters to the DeleteEnvironmentConfiguration operation. 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

CopyC#
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.


DeleteEnvironmentConfigurationResponse
Returns information about the DeleteEnvironmentConfigurationResult response and response metadata.

DescribeApplicationsRequest
Container for the parameters to the DescribeApplications operation. Returns the descriptions of existing applications.

DescribeApplicationsResponse
Returns information about the DescribeApplicationsResult response and response metadata.

DescribeApplicationsResult
Result message containing a list of application descriptions.

DescribeApplicationVersionsRequest
Container for the parameters to the DescribeApplicationVersions operation. Returns descriptions for existing application versions.

DescribeApplicationVersionsResponse
Returns information about the DescribeApplicationVersionsResult response and response metadata.

DescribeApplicationVersionsResult
Result message wrapping a list of application version descriptions.

DescribeConfigurationOptionsRequest
Container for the parameters to the DescribeConfigurationOptions operation. 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.

DescribeConfigurationOptionsResponse
Returns information about the DescribeConfigurationOptionsResult response and response metadata.

DescribeConfigurationOptionsResult
Describes the settings for a specified configuration set.

DescribeConfigurationSettingsRequest
Container for the parameters to the DescribeConfigurationSettings operation. 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


DescribeConfigurationSettingsResponse
Returns information about the DescribeConfigurationSettingsResult response and response metadata.

DescribeConfigurationSettingsResult
The results from a request to change the configuration settings of an environment.

DescribeEnvironmentResourcesRequest
Container for the parameters to the DescribeEnvironmentResources operation. Returns AWS resources for this environment.

DescribeEnvironmentResourcesResponse
Returns information about the DescribeEnvironmentResourcesResult response and response metadata.

DescribeEnvironmentResourcesResult
Result message containing a list of environment resource descriptions.

DescribeEnvironmentsRequest
Container for the parameters to the DescribeEnvironments operation. Returns descriptions for existing environments.

DescribeEnvironmentsResponse
Returns information about the DescribeEnvironmentsResult response and response metadata.

DescribeEnvironmentsResult
Result message containing a list of environment descriptions.

DescribeEventsRequest
Container for the parameters to the DescribeEvents operation. Returns list of event descriptions matching criteria up to the last 6 weeks.
Note:
This action returns the most recent 1,000 events from the specified
CopyC#
NextToken
.

DescribeEventsResponse
Returns information about the DescribeEventsResult response and response metadata.

DescribeEventsResult
Result message wrapping a list of event descriptions.

EnvironmentDescription
Describes the properties of an environment.

EnvironmentInfoDescription
The information retrieved from the Amazon EC2 instances.

EnvironmentResourceDescription
Describes the AWS resources in use by this environment. This data is live.

EnvironmentResourcesDescription
Describes the AWS resources in use by this environment. This data is not live data.

EnvironmentTier
Describes the properties of an environment tier

EventDescription
Describes an event.

Instance
The description of an Amazon EC2 instance.

InsufficientPrivilegesException
ElasticBeanstalk exception

InvalidParameterCombinationException
AmazonElasticBeanstalk exception

InvalidParameterValueException
AmazonElasticBeanstalk exception

LaunchConfiguration
Describes an Auto Scaling launch configuration.

ListAvailableSolutionStacksRequest
Container for the parameters to the ListAvailableSolutionStacks operation. Returns a list of the available solution stack names.

ListAvailableSolutionStacksResponse
Returns information about the ListAvailableSolutionStacksResult response and response metadata.

ListAvailableSolutionStacksResult
A list of available AWS Elastic Beanstalk solution stacks.

Listener
Describes the properties of a Listener for the LoadBalancer.

LoadBalancer
Describes a LoadBalancer.

LoadBalancerDescription
Describes the details of a LoadBalancer.

MissingRequiredParameterException
AmazonElasticBeanstalk exception

OperationInProgressException
ElasticBeanstalk exception

OptionRestrictionRegex
A regular expression representing a restriction on a string configuration option value.

OptionSpecification
A specification identifying an individual configuration option.

Queue
Describes a queue.

RebuildEnvironmentRequest
Container for the parameters to the RebuildEnvironment operation. 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.

RebuildEnvironmentResponse
Returns information about the RebuildEnvironmentResult response and response metadata.

RequestEnvironmentInfoRequest
Container for the parameters to the RequestEnvironmentInfo operation. Initiates a request to compile the specified type of information of the deployed environment.

Setting the

CopyC#
InfoType
to
CopyC#
tail
compiles the last lines from the application server log files of every Amazon EC2 instance in your environment. Use RetrieveEnvironmentInfo to access the compiled information.

Related Topics


RequestEnvironmentInfoResponse
Returns information about the RequestEnvironmentInfoResult response and response metadata.

RestartAppServerRequest
Container for the parameters to the RestartAppServer operation. Causes the environment to restart the application container server running on each Amazon EC2 instance.

RestartAppServerResponse
Returns information about the RestartAppServerResult response and response metadata.

RetrieveEnvironmentInfoRequest
Container for the parameters to the RetrieveEnvironmentInfo operation. Retrieves the compiled information from a RequestEnvironmentInfo request.

Related Topics


RetrieveEnvironmentInfoResponse
Returns information about the RetrieveEnvironmentInfoResult response and response metadata.

RetrieveEnvironmentInfoResult
Result message containing a description of the requested environment info.

S3Location
A specification of a location in Amazon S3.

S3LocationNotInServiceRegionException
ElasticBeanstalk exception

S3SubscriptionRequiredException
ElasticBeanstalk exception

SolutionStackDescription
Describes the solution stack.

SourceBundleDeletionException
ElasticBeanstalk exception

SourceConfiguration
A specification for an environment configuration

SwapEnvironmentCNAMEsRequest
Container for the parameters to the SwapEnvironmentCNAMEs operation. Swaps the CNAMEs of two environments.

SwapEnvironmentCNAMEsResponse
Returns information about the SwapEnvironmentCNAMEsResult response and response metadata.

Tag

TerminateEnvironmentRequest
Container for the parameters to the TerminateEnvironment operation. Terminates the specified environment.

TerminateEnvironmentResponse
Returns information about the TerminateEnvironmentResult response and response metadata.

TerminateEnvironmentResult
Describes the properties of an environment.

TooManyApplicationsException
ElasticBeanstalk exception

TooManyApplicationVersionsException
ElasticBeanstalk exception

TooManyBucketsException
ElasticBeanstalk exception

TooManyConfigurationTemplatesException
ElasticBeanstalk exception

TooManyEnvironmentsException
ElasticBeanstalk exception

Trigger
Describes a trigger.

UpdateApplicationRequest
Container for the parameters to the UpdateApplication operation. Updates the specified application to have the specified properties.
Note:
If a property (for example,
CopyC#
description
) is not provided, the value remains unchanged. To clear these properties, specify an empty string.

UpdateApplicationResponse
Returns information about the UpdateApplicationResult response and response metadata.

UpdateApplicationResult
Result message containing a single description of an application.

UpdateApplicationVersionRequest
Container for the parameters to the UpdateApplicationVersion operation. Updates the specified application version to have the specified properties.
Note:
If a property (for example,
CopyC#
description
) is not provided, the value remains unchanged. To clear properties, specify an empty string.

UpdateApplicationVersionResponse
Returns information about the UpdateApplicationVersionResult response and response metadata.

UpdateApplicationVersionResult
Result message wrapping a single description of an application version.

UpdateConfigurationTemplateRequest
Container for the parameters to the UpdateConfigurationTemplate operation. Updates the specified configuration template to have the specified properties or configuration option values.
Note:
If a property (for example,
CopyC#
ApplicationName
) is not provided, its value remains unchanged. To clear such properties, specify an empty string.

Related Topics


UpdateConfigurationTemplateResponse
Returns information about the UpdateConfigurationTemplateResult response and response metadata.

UpdateConfigurationTemplateResult
Describes the settings for a configuration set.

UpdateEnvironmentRequest
Container for the parameters to the UpdateEnvironment operation. 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

CopyC#
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

CopyC#
DeploymentStatus
values.


UpdateEnvironmentResponse
Returns information about the UpdateEnvironmentResult response and response metadata.

UpdateEnvironmentResult
Describes the properties of an environment.

ValidateConfigurationSettingsRequest
Container for the parameters to the ValidateConfigurationSettings operation. 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.


ValidateConfigurationSettingsResponse
Returns information about the ValidateConfigurationSettingsResult response and response metadata.

ValidateConfigurationSettingsResult
Provides a list of validation messages.

ValidationErrorException
AmazonElasticBeanstalk exception

ValidationMessage
An error or warning for a desired configuration option value.