ElasticBeanstalk class

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

Constructors

ElasticBeanstalk({@_s.required String region, AwsClientCredentials credentials, Client client})

Properties

hashCode int
The hash code for this object. [...]
read-only, inherited
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited

Methods

abortEnvironmentUpdate({String environmentId, String environmentName}) Future<void>
Cancels in-progress environment configuration update or application version deployment. [...]
applyEnvironmentManagedAction({String actionId, String environmentId, String environmentName}) Future<ApplyEnvironmentManagedActionResult>
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. [...]
checkDNSAvailability({String cNAMEPrefix}) Future<CheckDNSAvailabilityResultMessage>
Checks if the specified CNAME is available. [...]
composeEnvironments({String applicationName, String groupName, List<String> versionLabels}) Future<EnvironmentDescriptionsMessage>
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. [...]
createApplication({String applicationName, String description, ApplicationResourceLifecycleConfig resourceLifecycleConfig, List<Tag> tags}) Future<ApplicationDescriptionMessage>
Creates an application that has one configuration template named default and no application versions. [...]
createApplicationVersion({String applicationName, String versionLabel, bool autoCreateApplication, BuildConfiguration buildConfiguration, String description, bool process, SourceBuildInformation sourceBuildInformation, S3Location sourceBundle, List<Tag> tags}) Future<ApplicationVersionDescriptionMessage>
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: [...]
createConfigurationTemplate({String applicationName, String templateName, String description, String environmentId, List<ConfigurationOptionSetting> optionSettings, String platformArn, String solutionStackName, SourceConfiguration sourceConfiguration, List<Tag> tags}) Future<ConfigurationSettingsDescription>
Creates an AWS Elastic Beanstalk configuration template, associated with a specific Elastic Beanstalk application. You define application configuration settings in a configuration template. You can then use the configuration template to deploy different versions of the application with the same configuration settings. [...]
createEnvironment({String applicationName, String cNAMEPrefix, String description, String environmentName, String groupName, List<ConfigurationOptionSetting> optionSettings, List<OptionSpecification> optionsToRemove, String platformArn, String solutionStackName, List<Tag> tags, String templateName, EnvironmentTier tier, String versionLabel}) Future<EnvironmentDescription>
Launches an AWS Elastic Beanstalk environment for the specified application using the specified configuration. [...]
createPlatformVersion({S3Location platformDefinitionBundle, String platformName, String platformVersion, String environmentName, List<ConfigurationOptionSetting> optionSettings, List<Tag> tags}) Future<CreatePlatformVersionResult>
Create a new version of your custom platform. [...]
createStorageLocation() Future<CreateStorageLocationResultMessage>
Creates a bucket in Amazon S3 to store application versions, logs, and other files used by Elastic Beanstalk environments. The Elastic Beanstalk console and EB CLI call this API the first time you create an environment in a region. If the storage location already exists, CreateStorageLocation still returns the bucket name but does not create a new bucket. [...]
deleteApplication({String applicationName, bool terminateEnvByForce}) Future<void>
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({String applicationName, String versionLabel, bool deleteSourceBundle}) Future<void>
Deletes the specified version from the specified application. You cannot delete an application version that is associated with a running environment. [...]
deleteConfigurationTemplate({String applicationName, String templateName}) Future<void>
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({String applicationName, String environmentName}) Future<void>
Deletes the draft configuration associated with the running environment. [...]
deletePlatformVersion({String platformArn}) Future<DeletePlatformVersionResult>
Deletes the specified version of a custom platform. [...]
describeAccountAttributes() Future<DescribeAccountAttributesResult>
Returns attributes related to AWS Elastic Beanstalk that are associated with the calling AWS account. [...]
describeApplications({List<String> applicationNames}) Future<ApplicationDescriptionsMessage>
Returns the descriptions of existing applications. [...]
describeApplicationVersions({String applicationName, int maxRecords, String nextToken, List<String> versionLabels}) Future<ApplicationVersionDescriptionsMessage>
Retrieve a list of application versions. [...]
describeConfigurationOptions({String applicationName, String environmentName, List<OptionSpecification> options, String platformArn, String solutionStackName, String templateName}) Future<ConfigurationOptionsDescription>
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({String applicationName, String environmentName, String templateName}) Future<ConfigurationSettingsDescriptions>
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. [...]
describeEnvironmentHealth({List<String> attributeNames, String environmentId, String environmentName}) Future<DescribeEnvironmentHealthResult>
Returns information about the overall health of the specified environment. The DescribeEnvironmentHealth operation is only available with AWS Elastic Beanstalk Enhanced Health. [...]
describeEnvironmentManagedActionHistory({String environmentId, String environmentName, int maxItems, String nextToken}) Future<DescribeEnvironmentManagedActionHistoryResult>
Lists an environment's completed and failed managed actions. [...]
describeEnvironmentManagedActions({String environmentId, String environmentName, ActionStatus status}) Future<DescribeEnvironmentManagedActionsResult>
Lists an environment's upcoming and in-progress managed actions. [...]
describeEnvironmentResources({String environmentId, String environmentName}) Future<EnvironmentResourceDescriptionsMessage>
Returns AWS resources for this environment. [...]
describeEnvironments({String applicationName, List<String> environmentIds, List<String> environmentNames, bool includeDeleted, DateTime includedDeletedBackTo, int maxRecords, String nextToken, String versionLabel}) Future<EnvironmentDescriptionsMessage>
Returns descriptions for existing environments. [...]
describeEvents({String applicationName, DateTime endTime, String environmentId, String environmentName, int maxRecords, String nextToken, String platformArn, String requestId, EventSeverity severity, DateTime startTime, String templateName, String versionLabel}) Future<EventDescriptionsMessage>
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({List<String> attributeNames, String environmentId, String environmentName, String nextToken}) Future<DescribeInstancesHealthResult>
Retrieves detailed information about the health of instances in your AWS Elastic Beanstalk. This operation requires enhanced health reporting. [...]
describePlatformVersion({String platformArn}) Future<DescribePlatformVersionResult>
Describes a platform version. Provides full details. Compare to ListPlatformVersions, which provides summary information about a list of platform versions. [...]
listAvailableSolutionStacks() Future<ListAvailableSolutionStacksResultMessage>
Returns a list of the available solution stack names, with the public version first and then in reverse chronological order.
listPlatformBranches({List<SearchFilter> filters, int maxRecords, String nextToken}) Future<ListPlatformBranchesResult>
Lists the platform branches available for your account in an AWS Region. Provides summary information about each platform branch. [...]
listPlatformVersions({List<PlatformFilter> filters, int maxRecords, String nextToken}) Future<ListPlatformVersionsResult>
Lists the platform versions available for your account in an AWS Region. Provides summary information about each platform version. Compare to DescribePlatformVersion, which provides full details about a single platform version. [...]
listTagsForResource({String resourceArn}) Future<ResourceTagsDescriptionMessage>
Return the tags applied to an AWS Elastic Beanstalk resource. The response contains a list of tag key-value pairs. [...]
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
inherited
rebuildEnvironment({String environmentId, String environmentName}) Future<void>
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({EnvironmentInfoType infoType, String environmentId, String environmentName}) Future<void>
Initiates a request to compile the specified type of information of the deployed environment. [...]
restartAppServer({String environmentId, String environmentName}) Future<void>
Causes the environment to restart the application container server running on each Amazon EC2 instance. [...]
retrieveEnvironmentInfo({EnvironmentInfoType infoType, String environmentId, String environmentName}) Future<RetrieveEnvironmentInfoResultMessage>
Retrieves the compiled information from a RequestEnvironmentInfo request. [...]
swapEnvironmentCNAMEs({String destinationEnvironmentId, String destinationEnvironmentName, String sourceEnvironmentId, String sourceEnvironmentName}) Future<void>
Swaps the CNAMEs of two environments. [...]
terminateEnvironment({String environmentId, String environmentName, bool forceTerminate, bool terminateResources}) Future<EnvironmentDescription>
Terminates the specified environment. [...]
toString() String
Returns a string representation of this object.
inherited
updateApplication({String applicationName, String description}) Future<ApplicationDescriptionMessage>
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({String applicationName, ApplicationResourceLifecycleConfig resourceLifecycleConfig}) Future<ApplicationResourceLifecycleDescriptionMessage>
Modifies lifecycle settings for an application. [...]
updateApplicationVersion({String applicationName, String versionLabel, String description}) Future<ApplicationVersionDescriptionMessage>
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({String applicationName, String templateName, String description, List<ConfigurationOptionSetting> optionSettings, List<OptionSpecification> optionsToRemove}) Future<ConfigurationSettingsDescription>
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({String applicationName, String description, String environmentId, String environmentName, String groupName, List<ConfigurationOptionSetting> optionSettings, List<OptionSpecification> optionsToRemove, String platformArn, String solutionStackName, String templateName, EnvironmentTier tier, String versionLabel}) Future<EnvironmentDescription>
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. [...]
updateTagsForResource({String resourceArn, List<Tag> tagsToAdd, List<String> tagsToRemove}) Future<void>
Update the list of tags applied to an AWS Elastic Beanstalk resource. Two lists can be passed: TagsToAdd for tags to add or update, and TagsToRemove. [...]
validateConfigurationSettings({String applicationName, List<ConfigurationOptionSetting> optionSettings, String environmentName, String templateName}) Future<ConfigurationSettingsValidationMessages>
Takes a set of configuration settings and either a configuration template or environment, and determines whether those values are valid. [...]

Operators

operator ==(dynamic other) bool
The equality operator. [...]
inherited