Client

elasticbeanstalk

R Documentation

AWS Elastic Beanstalk¶

Description¶

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.

Usage¶

elasticbeanstalk(
  config = list(),
  credentials = list(),
  endpoint = NULL,
  region = NULL
)

Arguments¶

config

Optional configuration of credentials, endpoint, and/or region.

credentials:
- creds:
  - access_key_id: AWS access key ID
  - secret_access_key: AWS secret access key
  - session_token: AWS temporary session token
- profile: The name of a profile to use. If not given, then the default profile is used.
- anonymous: Set anonymous credentials.
endpoint: The complete URL to use for the constructed client.
region: The AWS Region used in instantiating the client.
close_connection: Immediately close all HTTP connections.
timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.
sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

credentials

Optional credentials shorthand for the config parameter

creds:
- access_key_id: AWS access key ID
- secret_access_key: AWS secret access key
- session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.

endpoint

Optional shorthand for complete URL to use for the constructed client.

region

Optional shorthand for AWS Region used in instantiating the client.

Value¶

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax¶

svc <- elasticbeanstalk(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations¶

abort_environment_update: Cancels in-progress environment configuration update or application version deployment
apply_environment_managed_action: Applies a scheduled managed action immediately
associate_environment_operations_role: Add or change the operations role used by an environment
check_dns_availability: Checks if the specified CNAME is available
compose_environments: Create or update a group of environments that each run a separate component of a single application
create_application: Creates an application that has one configuration template named default and no application versions
create_application_version: Creates an application version for the specified application
create_configuration_template: Creates an AWS Elastic Beanstalk configuration template, associated with a specific Elastic Beanstalk application
create_environment: Launches an AWS Elastic Beanstalk environment for the specified application using the specified configuration
create_platform_version: Create a new version of your custom platform
create_storage_location: Creates a bucket in Amazon S3 to store application versions, logs, and other files used by Elastic Beanstalk environments
delete_application: Deletes the specified application along with all associated versions and configurations
delete_application_version: Deletes the specified version from the specified application
delete_configuration_template: Deletes the specified configuration template
delete_environment_configuration: Deletes the draft configuration associated with the running environment
delete_platform_version: Deletes the specified version of a custom platform
describe_account_attributes: Returns attributes related to AWS Elastic Beanstalk that are associated with the calling AWS account
describe_applications: Returns the descriptions of existing applications
describe_application_versions: Retrieve a list of application versions
describe_configuration_options: Describes the configuration options that are used in a particular configuration template or environment, or that a specified solution stack defines
describe_configuration_settings: 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
describe_environment_health: Returns information about the overall health of the specified environment; Lists an environment's completed and failed managed actions
describe_environment_managed_actions: Lists an environment's upcoming and in-progress managed actions
describe_environment_resources: Returns AWS resources for this environment
describe_environments: Returns descriptions for existing environments
describe_events: Returns list of event descriptions matching criteria up to the last 6 weeks
describe_instances_health: Retrieves detailed information about the health of instances in your AWS Elastic Beanstalk
describe_platform_version: Describes a platform version; Disassociate the operations role from an environment
list_available_solution_stacks: Returns a list of the available solution stack names, with the public version first and then in reverse chronological order
list_platform_branches: Lists the platform branches available for your account in an AWS Region
list_platform_versions: Lists the platform versions available for your account in an AWS Region
list_tags_for_resource: Return the tags applied to an AWS Elastic Beanstalk resource
rebuild_environment: Deletes and recreates all of the AWS resources (for example: the Auto Scaling group, load balancer, etc
request_environment_info: Initiates a request to compile the specified type of information of the deployed environment
restart_app_server: Causes the environment to restart the application container server running on each Amazon EC2 instance
retrieve_environment_info: Retrieves the compiled information from a RequestEnvironmentInfo request
swap_environment_cnam_es: Swaps the CNAMEs of two environments
terminate_environment: Terminates the specified environment
update_application: Updates the specified application to have the specified properties
update_application_resource_lifecycle: Modifies lifecycle settings for an application
update_application_version: Updates the specified application version to have the specified properties
update_configuration_template: Updates the specified configuration template to have the specified properties or configuration option values
update_environment: 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
update_tags_for_resource: Update the list of tags applied to an AWS Elastic Beanstalk resource
validate_configuration_settings: Takes a set of configuration settings and either a configuration template or environment, and determines whether those values are valid

Examples¶

## Not run: 
svc <- elasticbeanstalk()
# The following code aborts a running application version deployment for
# an environment named my-env:
svc$abort_environment_update(
  EnvironmentName = "my-env"
)

## End(Not run)