ElasticBeanstalk

public struct ElasticBeanstalk

Client object for interacting with AWS ElasticBeanstalk service.

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 https://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.

Member variables

Initialization

  • Initialize the ElasticBeanstalk client

    Declaration

    Swift

    public init(accessKeyId: String? = nil, secretAccessKey: String? = nil, sessionToken: String? = nil, region: AWSSDKSwiftCore.Region? = nil, endpoint: String? = nil, middlewares: [AWSServiceMiddleware] = [], eventLoopGroupProvider: AWSClient.EventLoopGroupProvider = .useAWSClientShared)

    Parameters

    accessKeyId

    Public access key provided by AWS
    secretAccessKey

    Private access key provided by AWS
    sessionToken

    Token provided by STS.AssumeRole() which allows access to another AWS account
    region

    Region of server you want to communicate with
    endpoint

    Custom endpoint URL to use instead of standard AWS servers
    middlewares

    Array of middlewares to apply to requests and responses
    eventLoopGroupProvider

    EventLoopGroup to use. Use useAWSClientShared if the client shall manage its own EventLoopGroup.

API Calls

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

    Declaration

    Swift

    @discardableResult
public func abortEnvironmentUpdate(_ input: AbortEnvironmentUpdateMessage) -> EventLoopFuture<Void>

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

    Declaration

    Swift

    public func applyEnvironmentManagedAction(_ input: ApplyEnvironmentManagedActionRequest) -> EventLoopFuture<ApplyEnvironmentManagedActionResult>

  • Add or change the operations role used by an environment. After this call is made, Elastic Beanstalk uses the associated operations role for permissions to downstream services during subsequent calls acting on this environment. For more information, see Operations roles in the AWS Elastic Beanstalk Developer Guide.

    Declaration

    Swift

    @discardableResult
public func associateEnvironmentOperationsRole(_ input: AssociateEnvironmentOperationsRoleMessage) -> EventLoopFuture<Void>

  • Checks if the specified CNAME is available.

    Declaration

    Swift

    public func checkDNSAvailability(_ input: CheckDNSAvailabilityMessage) -> EventLoopFuture<CheckDNSAvailabilityResultMessage>

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

    Declaration

    Swift

    public func composeEnvironments(_ input: ComposeEnvironmentsMessage) -> EventLoopFuture<EnvironmentDescriptionsMessage>

  • Creates an application that has one configuration template named default and no application versions.

    Declaration

    Swift

    public func createApplication(_ input: CreateApplicationMessage) -> EventLoopFuture<ApplicationDescriptionMessage>

  • 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. After you create an application version with a specified Amazon S3 bucket and key location, you can’t 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.

    Declaration

    Swift

    public func createApplicationVersion(_ input: CreateApplicationVersionMessage) -> EventLoopFuture<ApplicationVersionDescriptionMessage>

  • 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. Templates aren’t associated with any environment. The EnvironmentName response element is always null. Related Topics DescribeConfigurationOptions DescribeConfigurationSettings ListAvailableSolutionStacks

    Declaration

    Swift

    public func createConfigurationTemplate(_ input: CreateConfigurationTemplateMessage) -> EventLoopFuture<ConfigurationSettingsDescription>

  • Launches an AWS Elastic Beanstalk environment for the specified application using the specified configuration.

    Declaration

    Swift

    public func createEnvironment(_ input: CreateEnvironmentMessage) -> EventLoopFuture<EnvironmentDescription>

  • Create a new version of your custom platform.

    Declaration

    Swift

    public func createPlatformVersion(_ input: CreatePlatformVersionRequest) -> EventLoopFuture<CreatePlatformVersionResult>

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

    Declaration

    Swift

    public func createStorageLocation() -> EventLoopFuture<CreateStorageLocationResultMessage>

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

    Declaration

    Swift

    @discardableResult
public func deleteApplication(_ input: DeleteApplicationMessage) -> EventLoopFuture<Void>

  • Deletes the specified version from the specified application. You cannot delete an application version that is associated with a running environment.

    Declaration

    Swift

    @discardableResult
public func deleteApplicationVersion(_ input: DeleteApplicationVersionMessage) -> EventLoopFuture<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.

    Declaration

    Swift

    @discardableResult
public func deleteConfigurationTemplate(_ input: DeleteConfigurationTemplateMessage) -> EventLoopFuture<Void>

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

    Declaration

    Swift

    @discardableResult
public func deleteEnvironmentConfiguration(_ input: DeleteEnvironmentConfigurationMessage) -> EventLoopFuture<Void>

  • Deletes the specified version of a custom platform.

    Declaration

    Swift

    public func deletePlatformVersion(_ input: DeletePlatformVersionRequest) -> EventLoopFuture<DeletePlatformVersionResult>

  • Returns attributes related to AWS Elastic Beanstalk that are associated with the calling AWS account. The result currently has one set of attributes—resource quotas.

    Declaration

    Swift

    public func describeAccountAttributes() -> EventLoopFuture<DescribeAccountAttributesResult>

  • Retrieve a list of application versions.

    Declaration

    Swift

    public func describeApplicationVersions(_ input: DescribeApplicationVersionsMessage) -> EventLoopFuture<ApplicationVersionDescriptionsMessage>

  • Returns the descriptions of existing applications.

    Declaration

    Swift

    public func describeApplications(_ input: DescribeApplicationsMessage) -> EventLoopFuture<ApplicationDescriptionsMessage>

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

    Declaration

    Swift

    public func describeConfigurationOptions(_ input: DescribeConfigurationOptionsMessage) -> EventLoopFuture<ConfigurationOptionsDescription>

  • 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

    Declaration

    Swift

    public func describeConfigurationSettings(_ input: DescribeConfigurationSettingsMessage) -> EventLoopFuture<ConfigurationSettingsDescriptions>

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

    Declaration

    Swift

    public func describeEnvironmentHealth(_ input: DescribeEnvironmentHealthRequest) -> EventLoopFuture<DescribeEnvironmentHealthResult>

  • Lists an environment’s completed and failed managed actions.

    Declaration

    Swift

    public func describeEnvironmentManagedActionHistory(_ input: DescribeEnvironmentManagedActionHistoryRequest) -> EventLoopFuture<DescribeEnvironmentManagedActionHistoryResult>

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

    Declaration

    Swift

    public func describeEnvironmentManagedActions(_ input: DescribeEnvironmentManagedActionsRequest) -> EventLoopFuture<DescribeEnvironmentManagedActionsResult>

  • Returns AWS resources for this environment.

    Declaration

    Swift

    public func describeEnvironmentResources(_ input: DescribeEnvironmentResourcesMessage) -> EventLoopFuture<EnvironmentResourceDescriptionsMessage>

  • Returns descriptions for existing environments.

    Declaration

    Swift

    public func describeEnvironments(_ input: DescribeEnvironmentsMessage) -> EventLoopFuture<EnvironmentDescriptionsMessage>

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

    Declaration

    Swift

    public func describeEvents(_ input: DescribeEventsMessage) -> EventLoopFuture<EventDescriptionsMessage>

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

    Declaration

    Swift

    public func describeInstancesHealth(_ input: DescribeInstancesHealthRequest) -> EventLoopFuture<DescribeInstancesHealthResult>

  • Describes a platform version. Provides full details. Compare to ListPlatformVersions, which provides summary information about a list of platform versions. For definitions of platform version and other platform-related terms, see AWS Elastic Beanstalk Platforms Glossary.

    Declaration

    Swift

    public func describePlatformVersion(_ input: DescribePlatformVersionRequest) -> EventLoopFuture<DescribePlatformVersionResult>

  • Disassociate the operations role from an environment. After this call is made, Elastic Beanstalk uses the caller’s permissions for permissions to downstream services during subsequent calls acting on this environment. For more information, see Operations roles in the AWS Elastic Beanstalk Developer Guide.

    Declaration

    Swift

    @discardableResult
public func disassociateEnvironmentOperationsRole(_ input: DisassociateEnvironmentOperationsRoleMessage) -> EventLoopFuture<Void>

  • Returns a list of the available solution stack names, with the public version first and then in reverse chronological order.

    Declaration

    Swift

    public func listAvailableSolutionStacks() -> EventLoopFuture<ListAvailableSolutionStacksResultMessage>

  • Lists the platform branches available for your account in an AWS Region. Provides summary information about each platform branch. For definitions of platform branch and other platform-related terms, see AWS Elastic Beanstalk Platforms Glossary.

    Declaration

    Swift

    public func listPlatformBranches(_ input: ListPlatformBranchesRequest) -> EventLoopFuture<ListPlatformBranchesResult>

  • 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. For definitions of platform version and other platform-related terms, see AWS Elastic Beanstalk Platforms Glossary.

    Declaration

    Swift

    public func listPlatformVersions(_ input: ListPlatformVersionsRequest) -> EventLoopFuture<ListPlatformVersionsResult>

  • Return the tags applied to an AWS Elastic Beanstalk resource. The response contains a list of tag key-value pairs. Elastic Beanstalk supports tagging of all of its resources. For details about resource tagging, see Tagging Application Resources.

    Declaration

    Swift

    public func listTagsForResource(_ input: ListTagsForResourceMessage) -> EventLoopFuture<ResourceTagsDescriptionMessage>

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

    Declaration

    Swift

    @discardableResult
public func rebuildEnvironment(_ input: RebuildEnvironmentMessage) -> EventLoopFuture<Void>

  • 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

    Declaration

    Swift

    @discardableResult
public func requestEnvironmentInfo(_ input: RequestEnvironmentInfoMessage) -> EventLoopFuture<Void>

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

    Declaration

    Swift

    @discardableResult
public func restartAppServer(_ input: RestartAppServerMessage) -> EventLoopFuture<Void>

  • Retrieves the compiled information from a RequestEnvironmentInfo request. Related Topics RequestEnvironmentInfo

    Declaration

    Swift

    public func retrieveEnvironmentInfo(_ input: RetrieveEnvironmentInfoMessage) -> EventLoopFuture<RetrieveEnvironmentInfoResultMessage>

  • Swaps the CNAMEs of two environments.

    Declaration

    Swift

    @discardableResult
public func swapEnvironmentCNAMEs(_ input: SwapEnvironmentCNAMEsMessage) -> EventLoopFuture<Void>

  • Terminates the specified environment.

    Declaration

    Swift

    public func terminateEnvironment(_ input: TerminateEnvironmentMessage) -> EventLoopFuture<EnvironmentDescription>

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

    Declaration

    Swift

    public func updateApplication(_ input: UpdateApplicationMessage) -> EventLoopFuture<ApplicationDescriptionMessage>

  • Modifies lifecycle settings for an application.

    Declaration

    Swift

    public func updateApplicationResourceLifecycle(_ input: UpdateApplicationResourceLifecycleMessage) -> EventLoopFuture<ApplicationResourceLifecycleDescriptionMessage>

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

    Declaration

    Swift

    public func updateApplicationVersion(_ input: UpdateApplicationVersionMessage) -> EventLoopFuture<ApplicationVersionDescriptionMessage>

  • 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

    Declaration

    Swift

    public func updateConfigurationTemplate(_ input: UpdateConfigurationTemplateMessage) -> EventLoopFuture<ConfigurationSettingsDescription>

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

    Declaration

    Swift

    public func updateEnvironment(_ input: UpdateEnvironmentMessage) -> EventLoopFuture<EnvironmentDescription>

  • 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. Elastic Beanstalk supports tagging of all of its resources. For details about resource tagging, see Tagging Application Resources. If you create a custom IAM user policy to control permission to this operation, specify one of the following two virtual actions (or both) instead of the API operation name: elasticbeanstalk:AddTags Controls permission to call UpdateTagsForResource and pass a list of tags to add in the TagsToAdd parameter. elasticbeanstalk:RemoveTags Controls permission to call UpdateTagsForResource and pass a list of tag keys to remove in the TagsToRemove parameter. For details about creating a custom user policy, see Creating a Custom User Policy.

    Declaration

    Swift

    @discardableResult
public func updateTagsForResource(_ input: UpdateTagsForResourceMessage) -> EventLoopFuture<Void>

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

    Declaration

    Swift

    public func validateConfigurationSettings(_ input: ValidateConfigurationSettingsMessage) -> EventLoopFuture<ConfigurationSettingsValidationMessages>

Paginators

Shapes

Enums

  • Undocumented

    See more

    Declaration

    Swift

    public enum ActionHistoryStatus : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum ActionStatus : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum ActionType : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum ApplicationVersionStatus : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum ComputeType : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum ConfigurationDeploymentStatus : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum ConfigurationOptionValueType : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum EnvironmentHealth : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum EnvironmentHealthAttribute : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum EnvironmentHealthStatus : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum EnvironmentInfoType : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum EnvironmentStatus : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum EventSeverity : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum FailureType : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum InstancesHealthAttribute : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum PlatformStatus : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum SourceRepository : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum SourceType : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum ValidationSeverity : String, CustomStringConvertible, Codable