elasticbeanstalk

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-aws repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-aws repo.

class pulumi_aws.elasticbeanstalk.Application(resource_name, opts=None, appversion_lifecycle=None, description=None, name=None, tags=None, __props__=None, __name__=None, __opts__=None)

Provides an Elastic Beanstalk Application Resource. Elastic Beanstalk allows you to deploy and manage applications in the AWS cloud without worrying about the infrastructure that runs those applications.

This resource creates an application that has one configuration template named default, and no application versions

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • description (pulumi.Input[str]) – Short description of the application

  • name (pulumi.Input[str]) – The name of the application, must be unique within your account

  • tags (pulumi.Input[dict]) – Key-value mapping of tags for the Elastic Beanstalk Application.

The appversion_lifecycle object supports the following:

  • deleteSourceFromS3 (pulumi.Input[bool]) - Set to true to delete a version’s source bundle from S3 when the application version is deleted.

  • maxAgeInDays (pulumi.Input[float]) - The number of days to retain an application version.

  • maxCount (pulumi.Input[float]) - The maximum number of application versions to retain.

  • service_role (pulumi.Input[str]) - The ARN of an IAM service role under which the application version is deleted. Elastic Beanstalk must have permission to assume this role.

arn = None

The ARN assigned by AWS for this Elastic Beanstalk Application.

description = None

Short description of the application

name = None

The name of the application, must be unique within your account

tags = None

Key-value mapping of tags for the Elastic Beanstalk Application.

static get(resource_name, id, opts=None, appversion_lifecycle=None, arn=None, description=None, name=None, tags=None)

Get an existing Application resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • arn (pulumi.Input[str]) – The ARN assigned by AWS for this Elastic Beanstalk Application.

  • description (pulumi.Input[str]) – Short description of the application

  • name (pulumi.Input[str]) – The name of the application, must be unique within your account

  • tags (pulumi.Input[dict]) – Key-value mapping of tags for the Elastic Beanstalk Application.

The appversion_lifecycle object supports the following:

  • deleteSourceFromS3 (pulumi.Input[bool]) - Set to true to delete a version’s source bundle from S3 when the application version is deleted.

  • maxAgeInDays (pulumi.Input[float]) - The number of days to retain an application version.

  • maxCount (pulumi.Input[float]) - The maximum number of application versions to retain.

  • service_role (pulumi.Input[str]) - The ARN of an IAM service role under which the application version is deleted. Elastic Beanstalk must have permission to assume this role.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_aws.elasticbeanstalk.ApplicationVersion(resource_name, opts=None, application=None, bucket=None, description=None, force_delete=None, key=None, name=None, tags=None, __props__=None, __name__=None, __opts__=None)

Provides an Elastic Beanstalk Application Version Resource. Elastic Beanstalk allows you to deploy and manage applications in the AWS cloud without worrying about the infrastructure that runs those applications.

This resource creates a Beanstalk Application Version that can be deployed to a Beanstalk Environment.

NOTE on Application Version Resource: When using the Application Version resource with multiple Elastic Beanstalk Environments it is possible that an error may be returned when attempting to delete an Application Version while it is still in use by a different environment. To work around this you can:

  1. Create each environment in a separate AWS account
  2. Create your `elasticbeanstalk.ApplicationVersion` resources with a unique names in your Elastic Beanstalk Application. For example <revision>-<environment>.
Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • application (pulumi.Input[str]) – Name of the Beanstalk Application the version is associated with.

  • bucket (pulumi.Input[str]) – S3 bucket that contains the Application Version source bundle.

  • description (pulumi.Input[str]) – Short description of the Application Version.

  • force_delete (pulumi.Input[bool]) – On delete, force an Application Version to be deleted when it may be in use by multiple Elastic Beanstalk Environments.

  • key (pulumi.Input[str]) – S3 object that is the Application Version source bundle.

  • name (pulumi.Input[str]) – A unique name for the this Application Version.

  • tags (pulumi.Input[dict]) – Key-value mapping of tags for the Elastic Beanstalk Application Version.

application = None

Name of the Beanstalk Application the version is associated with.

arn = None

The ARN assigned by AWS for this Elastic Beanstalk Application.

bucket = None

S3 bucket that contains the Application Version source bundle.

description = None

Short description of the Application Version.

force_delete = None

On delete, force an Application Version to be deleted when it may be in use by multiple Elastic Beanstalk Environments.

key = None

S3 object that is the Application Version source bundle.

name = None

A unique name for the this Application Version.

tags = None

Key-value mapping of tags for the Elastic Beanstalk Application Version.

static get(resource_name, id, opts=None, application=None, arn=None, bucket=None, description=None, force_delete=None, key=None, name=None, tags=None)

Get an existing ApplicationVersion resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • application (pulumi.Input[str]) – Name of the Beanstalk Application the version is associated with.

  • arn (pulumi.Input[str]) – The ARN assigned by AWS for this Elastic Beanstalk Application.

  • bucket (pulumi.Input[str]) – S3 bucket that contains the Application Version source bundle.

  • description (pulumi.Input[str]) – Short description of the Application Version.

  • force_delete (pulumi.Input[bool]) – On delete, force an Application Version to be deleted when it may be in use by multiple Elastic Beanstalk Environments.

  • key (pulumi.Input[str]) – S3 object that is the Application Version source bundle.

  • name (pulumi.Input[str]) – A unique name for the this Application Version.

  • tags (pulumi.Input[dict]) – Key-value mapping of tags for the Elastic Beanstalk Application Version.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_aws.elasticbeanstalk.AwaitableGetApplicationResult(appversion_lifecycle=None, arn=None, description=None, name=None, id=None)
class pulumi_aws.elasticbeanstalk.AwaitableGetHostedZoneResult(region=None, id=None)
class pulumi_aws.elasticbeanstalk.AwaitableGetSolutionStackResult(most_recent=None, name=None, name_regex=None, id=None)
class pulumi_aws.elasticbeanstalk.ConfigurationTemplate(resource_name, opts=None, application=None, description=None, environment_id=None, name=None, settings=None, solution_stack_name=None, __props__=None, __name__=None, __opts__=None)

Provides an Elastic Beanstalk Configuration Template, which are associated with a specific application and are used to deploy different versions of the application with the same configuration settings.

The setting field supports the following format:

  • namespace - unique namespace identifying the option’s associated AWS resource

  • name - name of the configuration option

  • value - value for the configuration option

  • resource - (Optional) resource name for scheduled action

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • application (pulumi.Input[str]) – name of the application to associate with this configuration template

  • description (pulumi.Input[str]) – Short description of the Template

  • environment_id (pulumi.Input[str]) – The ID of the environment used with this configuration template

  • name (pulumi.Input[str]) – A unique name for this Template.

  • settings (pulumi.Input[list]) – Option settings to configure the new Environment. These override specific values that are set as defaults. The format is detailed below in Option Settings

  • solution_stack_name (pulumi.Input[str]) – A solution stack to base your Template off of. Example stacks can be found in the [Amazon API documentation][1]

The settings object supports the following:

  • name (pulumi.Input[str]) - A unique name for this Template.

  • namespace (pulumi.Input[str])

  • resource (pulumi.Input[str])

  • value (pulumi.Input[str])

application = None

name of the application to associate with this configuration template

description = None

Short description of the Template

environment_id = None

The ID of the environment used with this configuration template

name = None

A unique name for this Template.

settings = None

Option settings to configure the new Environment. These override specific values that are set as defaults. The format is detailed below in Option Settings

  • name (str) - A unique name for this Template.

  • namespace (str)

  • resource (str)

  • value (str)

solution_stack_name = None

A solution stack to base your Template off of. Example stacks can be found in the [Amazon API documentation][1]

static get(resource_name, id, opts=None, application=None, description=None, environment_id=None, name=None, settings=None, solution_stack_name=None)

Get an existing ConfigurationTemplate resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • application (pulumi.Input[str]) – name of the application to associate with this configuration template

  • description (pulumi.Input[str]) – Short description of the Template

  • environment_id (pulumi.Input[str]) – The ID of the environment used with this configuration template

  • name (pulumi.Input[str]) – A unique name for this Template.

  • settings (pulumi.Input[list]) – Option settings to configure the new Environment. These override specific values that are set as defaults. The format is detailed below in Option Settings

  • solution_stack_name (pulumi.Input[str]) – A solution stack to base your Template off of. Example stacks can be found in the [Amazon API documentation][1]

The settings object supports the following:

  • name (pulumi.Input[str]) - A unique name for this Template.

  • namespace (pulumi.Input[str])

  • resource (pulumi.Input[str])

  • value (pulumi.Input[str])

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_aws.elasticbeanstalk.Environment(resource_name, opts=None, application=None, cname_prefix=None, description=None, name=None, platform_arn=None, poll_interval=None, settings=None, solution_stack_name=None, tags=None, template_name=None, tier=None, version=None, wait_for_ready_timeout=None, __props__=None, __name__=None, __opts__=None)

Provides an Elastic Beanstalk Environment Resource. Elastic Beanstalk allows you to deploy and manage applications in the AWS cloud without worrying about the infrastructure that runs those applications.

Environments are often things such as development, integration, or production.

Some options can be stack-specific, check AWS Docs for supported options and examples.

The setting and all_settings mappings support the following format:

  • namespace - unique namespace identifying the option’s associated AWS resource

  • name - name of the configuration option

  • value - value for the configuration option

  • resource - (Optional) resource name for scheduled action

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • application (pulumi.Input[str]) – Name of the application that contains the version to be deployed

  • cname_prefix (pulumi.Input[str]) – Prefix to use for the fully qualified DNS name of the Environment.

  • description (pulumi.Input[str]) – Short description of the Environment

  • name (pulumi.Input[str]) – A unique name for this Environment. This name is used in the application URL

  • platform_arn (pulumi.Input[str]) – The [ARN][2] of the Elastic Beanstalk [Platform][3] to use in deployment

  • poll_interval (pulumi.Input[str]) – The time between polling the AWS API to check if changes have been applied. Use this to adjust the rate of API calls for any create or update action. Minimum 10s, maximum 180s. Omit this to use the default behavior, which is an exponential backoff

  • settings (pulumi.Input[list]) – Option settings to configure the new Environment. These override specific values that are set as defaults. The format is detailed below in Option Settings

  • solution_stack_name (pulumi.Input[str]) – A solution stack to base your environment off of. Example stacks can be found in the [Amazon API documentation][1]

  • tags (pulumi.Input[dict]) – A set of tags to apply to the Environment.

  • template_name (pulumi.Input[str]) – The name of the Elastic Beanstalk Configuration template to use in deployment

  • tier (pulumi.Input[str]) – Elastic Beanstalk Environment tier. Valid values are Worker or WebServer. If tier is left blank WebServer will be used.

  • version (pulumi.Input[str]) – The name of the Elastic Beanstalk Application Version to use in deployment.

  • wait_for_ready_timeout (pulumi.Input[str]) – The maximum duration that this provider should wait for an Elastic Beanstalk Environment to be in a ready state before timing out.

The settings object supports the following:

  • name (pulumi.Input[str]) - A unique name for this Environment. This name is used in the application URL

  • namespace (pulumi.Input[str])

  • resource (pulumi.Input[str])

  • value (pulumi.Input[str])

all_settings = None

List of all option settings configured in this Environment. These are a combination of default settings and their overrides from setting in the configuration.

  • name (str) - A unique name for this Environment. This name is used in the application URL

  • namespace (str)

  • resource (str)

  • value (str)

application = None

Name of the application that contains the version to be deployed

autoscaling_groups = None

The autoscaling groups used by this Environment.

cname = None

Fully qualified DNS name for this Environment.

cname_prefix = None

Prefix to use for the fully qualified DNS name of the Environment.

description = None

Short description of the Environment

endpoint_url = None

The URL to the Load Balancer for this Environment

instances = None

Instances used by this Environment.

launch_configurations = None

Launch configurations in use by this Environment.

load_balancers = None

Elastic load balancers in use by this Environment.

name = None

A unique name for this Environment. This name is used in the application URL

platform_arn = None

The [ARN][2] of the Elastic Beanstalk [Platform][3] to use in deployment

poll_interval = None

The time between polling the AWS API to check if changes have been applied. Use this to adjust the rate of API calls for any create or update action. Minimum 10s, maximum 180s. Omit this to use the default behavior, which is an exponential backoff

queues = None

SQS queues in use by this Environment.

settings = None

Option settings to configure the new Environment. These override specific values that are set as defaults. The format is detailed below in Option Settings

  • name (str) - A unique name for this Environment. This name is used in the application URL

  • namespace (str)

  • resource (str)

  • value (str)

solution_stack_name = None

A solution stack to base your environment off of. Example stacks can be found in the [Amazon API documentation][1]

tags = None

A set of tags to apply to the Environment.

template_name = None

The name of the Elastic Beanstalk Configuration template to use in deployment

tier = None

Elastic Beanstalk Environment tier. Valid values are Worker or WebServer. If tier is left blank WebServer will be used.

triggers = None

Autoscaling triggers in use by this Environment.

version = None

The name of the Elastic Beanstalk Application Version to use in deployment.

wait_for_ready_timeout = None

The maximum duration that this provider should wait for an Elastic Beanstalk Environment to be in a ready state before timing out.

static get(resource_name, id, opts=None, all_settings=None, application=None, arn=None, autoscaling_groups=None, cname=None, cname_prefix=None, description=None, endpoint_url=None, instances=None, launch_configurations=None, load_balancers=None, name=None, platform_arn=None, poll_interval=None, queues=None, settings=None, solution_stack_name=None, tags=None, template_name=None, tier=None, triggers=None, version=None, wait_for_ready_timeout=None)

Get an existing Environment resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • all_settings (pulumi.Input[list]) – List of all option settings configured in this Environment. These are a combination of default settings and their overrides from setting in the configuration.

  • application (pulumi.Input[str]) – Name of the application that contains the version to be deployed

  • autoscaling_groups (pulumi.Input[list]) – The autoscaling groups used by this Environment.

  • cname (pulumi.Input[str]) – Fully qualified DNS name for this Environment.

  • cname_prefix (pulumi.Input[str]) – Prefix to use for the fully qualified DNS name of the Environment.

  • description (pulumi.Input[str]) – Short description of the Environment

  • endpoint_url (pulumi.Input[str]) – The URL to the Load Balancer for this Environment

  • instances (pulumi.Input[list]) – Instances used by this Environment.

  • launch_configurations (pulumi.Input[list]) – Launch configurations in use by this Environment.

  • load_balancers (pulumi.Input[list]) – Elastic load balancers in use by this Environment.

  • name (pulumi.Input[str]) – A unique name for this Environment. This name is used in the application URL

  • platform_arn (pulumi.Input[str]) – The [ARN][2] of the Elastic Beanstalk [Platform][3] to use in deployment

  • poll_interval (pulumi.Input[str]) – The time between polling the AWS API to check if changes have been applied. Use this to adjust the rate of API calls for any create or update action. Minimum 10s, maximum 180s. Omit this to use the default behavior, which is an exponential backoff

  • queues (pulumi.Input[list]) – SQS queues in use by this Environment.

  • settings (pulumi.Input[list]) – Option settings to configure the new Environment. These override specific values that are set as defaults. The format is detailed below in Option Settings

  • solution_stack_name (pulumi.Input[str]) – A solution stack to base your environment off of. Example stacks can be found in the [Amazon API documentation][1]

  • tags (pulumi.Input[dict]) – A set of tags to apply to the Environment.

  • template_name (pulumi.Input[str]) – The name of the Elastic Beanstalk Configuration template to use in deployment

  • tier (pulumi.Input[str]) – Elastic Beanstalk Environment tier. Valid values are Worker or WebServer. If tier is left blank WebServer will be used.

  • triggers (pulumi.Input[list]) – Autoscaling triggers in use by this Environment.

  • version (pulumi.Input[str]) – The name of the Elastic Beanstalk Application Version to use in deployment.

  • wait_for_ready_timeout (pulumi.Input[str]) –

    The maximum duration that this provider should wait for an Elastic Beanstalk Environment to be in a ready state before timing out.

The all_settings object supports the following:

  • name (pulumi.Input[str]) - A unique name for this Environment. This name is used in the application URL

  • namespace (pulumi.Input[str])

  • resource (pulumi.Input[str])

  • value (pulumi.Input[str])

The settings object supports the following:

  • name (pulumi.Input[str]) - A unique name for this Environment. This name is used in the application URL

  • namespace (pulumi.Input[str])

  • resource (pulumi.Input[str])

  • value (pulumi.Input[str])

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_aws.elasticbeanstalk.GetApplicationResult(appversion_lifecycle=None, arn=None, description=None, name=None, id=None)

A collection of values returned by getApplication.

arn = None

The Amazon Resource Name (ARN) of the application.

description = None

Short description of the application

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_aws.elasticbeanstalk.GetHostedZoneResult(region=None, id=None)

A collection of values returned by getHostedZone.

region = None

The region of the hosted zone.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_aws.elasticbeanstalk.GetSolutionStackResult(most_recent=None, name=None, name_regex=None, id=None)

A collection of values returned by getSolutionStack.

name = None

The name of the solution stack.

id = None

id is the provider-assigned unique ID for this managed resource.

pulumi_aws.elasticbeanstalk.get_application(name=None, opts=None)

Retrieve information about an Elastic Beanstalk Application.

Parameters

name (str) – The name of the application

pulumi_aws.elasticbeanstalk.get_hosted_zone(region=None, opts=None)

Use this data source to get the ID of an elastic beanstalk hosted zone.

Parameters

region (str) – The region you’d like the zone for. By default, fetches the current region.

pulumi_aws.elasticbeanstalk.get_solution_stack(most_recent=None, name_regex=None, opts=None)

Use this data source to get the name of a elastic beanstalk solution stack.

Parameters
  • most_recent (bool) – If more than one result is returned, use the most recent solution stack.

  • name_regex (str) – A regex string to apply to the solution stack list returned by AWS. See [Elastic Beanstalk Supported Platforms][beanstalk-platforms] from AWS documentation for reference solution stack names.