Edit This Page

Module elasticbeanstalk

@pulumi/aws > elasticbeanstalk

Index

elasticbeanstalk/application.ts elasticbeanstalk/applicationVersion.ts elasticbeanstalk/configurationTemplate.ts elasticbeanstalk/environment.ts elasticbeanstalk/getHostedZone.ts elasticbeanstalk/getSolutionStack.ts

class Application

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

constructor 

new Application(name: string, args?: ApplicationArgs, opts?: pulumi.CustomResourceOptions)

Create a Application resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get 

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ApplicationState): Application

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

method getProvider 

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance 

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property appversionLifecycle 

public appversionLifecycle: pulumi.Output<{ ... } | undefined>;

property description 

public description: pulumi.Output<string | undefined>;

Short description of the application

property id 

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name 

public name: pulumi.Output<string>;

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

property urn 

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class ApplicationVersion

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 `aws_elastic_beanstalk_application_version` resources with a unique names in your Elastic Beanstalk Application. For example <revision>-<environment>.

constructor 

new ApplicationVersion(name: string, args: ApplicationVersionArgs, opts?: pulumi.CustomResourceOptions)

Create a ApplicationVersion resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get 

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ApplicationVersionState): ApplicationVersion

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

method getProvider 

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance 

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property application 

public application: pulumi.Output<Application>;

Name of the Beanstalk Application the version is associated with.

property bucket 

public bucket: pulumi.Output<string>;

S3 bucket that contains the Application Version source bundle.

property description 

public description: pulumi.Output<string | undefined>;

Short description of the Application Version.

property forceDelete 

public forceDelete: pulumi.Output<boolean | undefined>;

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

property id 

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property key 

public key: pulumi.Output<string>;

S3 object that is the Application Version source bundle.

property name 

public name: pulumi.Output<string>;

A unique name for the this Application Version.

property urn 

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class ConfigurationTemplate

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.

constructor 

new ConfigurationTemplate(name: string, args: ConfigurationTemplateArgs, opts?: pulumi.CustomResourceOptions)

Create a ConfigurationTemplate resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get 

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ConfigurationTemplateState): ConfigurationTemplate

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

method getProvider 

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance 

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property application 

public application: pulumi.Output<string>;

name of the application to associate with this configuration template

property description 

public description: pulumi.Output<string | undefined>;

Short description of the Template

property environmentId 

public environmentId: pulumi.Output<string | undefined>;

The ID of the environment used with this configuration template

property id 

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name 

public name: pulumi.Output<string>;

A unique name for this Template.

property settings 

public settings: pulumi.Output<{ ... }[]>;

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

property solutionStackName 

public solutionStackName: pulumi.Output<string | undefined>;

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

property urn 

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class Environment

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.

constructor 

new Environment(name: string, args: EnvironmentArgs, opts?: pulumi.CustomResourceOptions)

Create a Environment resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get 

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: EnvironmentState): Environment

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

method getProvider 

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance 

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property allSettings 

public allSettings: pulumi.Output<{ ... }[]>;

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

property application 

public application: pulumi.Output<Application>;

Name of the application that contains the version to be deployed

property arn 

public arn: pulumi.Output<string>;

property autoscalingGroups 

public autoscalingGroups: pulumi.Output<string[]>;

The autoscaling groups used by this environment.

property cname 

public cname: pulumi.Output<string>;

Fully qualified DNS name for the Environment.

property cnamePrefix 

public cnamePrefix: pulumi.Output<string>;

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

property description 

public description: pulumi.Output<string | undefined>;

Short description of the Environment

property id 

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property instances 

public instances: pulumi.Output<string[]>;

Instances used by this environment.

property launchConfigurations 

public launchConfigurations: pulumi.Output<string[]>;

Launch configurations in use by this environment.

property loadBalancers 

public loadBalancers: pulumi.Output<string[]>;

Elastic load balancers in use by this environment.

property name 

public name: pulumi.Output<string>;

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

property platformArn 

public platformArn: pulumi.Output<string>;

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

property pollInterval 

public pollInterval: pulumi.Output<string | undefined>;

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

property queues 

public queues: pulumi.Output<string[]>;

SQS queues in use by this environment.

property settings 

public settings: pulumi.Output<{ ... }[] | undefined>;

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

property solutionStackName 

public solutionStackName: pulumi.Output<string>;

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

property tags 

public tags: pulumi.Output<Tags | undefined>;

A set of tags to apply to the Environment.

property templateName 

public templateName: pulumi.Output<string | undefined>;

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

property tier 

public tier: pulumi.Output<string | undefined>;

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

property triggers 

public triggers: pulumi.Output<string[]>;

Autoscaling triggers in use by this environment.

property urn 

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property version 

public version: pulumi.Output<ApplicationVersion>;

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

property waitForReadyTimeout 

public waitForReadyTimeout: pulumi.Output<string | undefined>;

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

function getHostedZone 

getHostedZone(args?: GetHostedZoneArgs, opts?: pulumi.InvokeOptions): Promise<GetHostedZoneResult>

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

function getSolutionStack 

getSolutionStack(args: GetSolutionStackArgs, opts?: pulumi.InvokeOptions): Promise<GetSolutionStackResult>

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

interface ApplicationArgs

The set of arguments for constructing a Application resource.

property appversionLifecycle 

appversionLifecycle?: pulumi.Input<{ ... }>;

property description 

description?: pulumi.Input<string>;

Short description of the application

property name 

name?: pulumi.Input<string>;

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

interface ApplicationState

Input properties used for looking up and filtering Application resources.

property appversionLifecycle 

appversionLifecycle?: pulumi.Input<{ ... }>;

property description 

description?: pulumi.Input<string>;

Short description of the application

property name 

name?: pulumi.Input<string>;

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

interface ApplicationVersionArgs

The set of arguments for constructing a ApplicationVersion resource.

property application 

application: pulumi.Input<Application>;

Name of the Beanstalk Application the version is associated with.

property bucket 

bucket: pulumi.Input<string | Bucket>;

S3 bucket that contains the Application Version source bundle.

property description 

description?: pulumi.Input<string>;

Short description of the Application Version.

property forceDelete 

forceDelete?: pulumi.Input<boolean>;

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

property key 

key: pulumi.Input<string>;

S3 object that is the Application Version source bundle.

property name 

name?: pulumi.Input<string>;

A unique name for the this Application Version.

interface ApplicationVersionState

Input properties used for looking up and filtering ApplicationVersion resources.

property application 

application?: pulumi.Input<Application>;

Name of the Beanstalk Application the version is associated with.

property bucket 

bucket?: pulumi.Input<string | Bucket>;

S3 bucket that contains the Application Version source bundle.

property description 

description?: pulumi.Input<string>;

Short description of the Application Version.

property forceDelete 

forceDelete?: pulumi.Input<boolean>;

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

property key 

key?: pulumi.Input<string>;

S3 object that is the Application Version source bundle.

property name 

name?: pulumi.Input<string>;

A unique name for the this Application Version.

interface ConfigurationTemplateArgs

The set of arguments for constructing a ConfigurationTemplate resource.

property application 

application: pulumi.Input<string>;

name of the application to associate with this configuration template

property description 

description?: pulumi.Input<string>;

Short description of the Template

property environmentId 

environmentId?: pulumi.Input<string>;

The ID of the environment used with this configuration template

property name 

name?: pulumi.Input<string>;

A unique name for this Template.

property settings 

settings?: pulumi.Input<pulumi.Input<{ ... }>[]>;

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

property solutionStackName 

solutionStackName?: pulumi.Input<string>;

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

interface ConfigurationTemplateState

Input properties used for looking up and filtering ConfigurationTemplate resources.

property application 

application?: pulumi.Input<string>;

name of the application to associate with this configuration template

property description 

description?: pulumi.Input<string>;

Short description of the Template

property environmentId 

environmentId?: pulumi.Input<string>;

The ID of the environment used with this configuration template

property name 

name?: pulumi.Input<string>;

A unique name for this Template.

property settings 

settings?: pulumi.Input<pulumi.Input<{ ... }>[]>;

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

property solutionStackName 

solutionStackName?: pulumi.Input<string>;

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

interface EnvironmentArgs

The set of arguments for constructing a Environment resource.

property application 

application: pulumi.Input<Application>;

Name of the application that contains the version to be deployed

property cnamePrefix 

cnamePrefix?: pulumi.Input<string>;

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

property description 

description?: pulumi.Input<string>;

Short description of the Environment

property name 

name?: pulumi.Input<string>;

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

property platformArn 

platformArn?: pulumi.Input<string>;

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

property pollInterval 

pollInterval?: pulumi.Input<string>;

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

property settings 

settings?: pulumi.Input<pulumi.Input<{ ... }>[]>;

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

property solutionStackName 

solutionStackName?: pulumi.Input<string>;

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

property tags 

tags?: pulumi.Input<Tags>;

A set of tags to apply to the Environment.

property templateName 

templateName?: pulumi.Input<string>;

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

property tier 

tier?: pulumi.Input<string>;

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

property version 

version?: pulumi.Input<ApplicationVersion>;

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

property waitForReadyTimeout 

waitForReadyTimeout?: pulumi.Input<string>;

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

interface EnvironmentState

Input properties used for looking up and filtering Environment resources.

property allSettings 

allSettings?: pulumi.Input<pulumi.Input<{ ... }>[]>;

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

property application 

application?: pulumi.Input<Application>;

Name of the application that contains the version to be deployed

property arn 

arn?: pulumi.Input<string>;

property autoscalingGroups 

autoscalingGroups?: pulumi.Input<pulumi.Input<string>[]>;

The autoscaling groups used by this environment.

property cname 

cname?: pulumi.Input<string>;

Fully qualified DNS name for the Environment.

property cnamePrefix 

cnamePrefix?: pulumi.Input<string>;

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

property description 

description?: pulumi.Input<string>;

Short description of the Environment

property instances 

instances?: pulumi.Input<pulumi.Input<string>[]>;

Instances used by this environment.

property launchConfigurations 

launchConfigurations?: pulumi.Input<pulumi.Input<string>[]>;

Launch configurations in use by this environment.

property loadBalancers 

loadBalancers?: pulumi.Input<pulumi.Input<string>[]>;

Elastic load balancers in use by this environment.

property name 

name?: pulumi.Input<string>;

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

property platformArn 

platformArn?: pulumi.Input<string>;

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

property pollInterval 

pollInterval?: pulumi.Input<string>;

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

property queues 

queues?: pulumi.Input<pulumi.Input<string>[]>;

SQS queues in use by this environment.

property settings 

settings?: pulumi.Input<pulumi.Input<{ ... }>[]>;

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

property solutionStackName 

solutionStackName?: pulumi.Input<string>;

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

property tags 

tags?: pulumi.Input<Tags>;

A set of tags to apply to the Environment.

property templateName 

templateName?: pulumi.Input<string>;

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

property tier 

tier?: pulumi.Input<string>;

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

property triggers 

triggers?: pulumi.Input<pulumi.Input<string>[]>;

Autoscaling triggers in use by this environment.

property version 

version?: pulumi.Input<ApplicationVersion>;

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

property waitForReadyTimeout 

waitForReadyTimeout?: pulumi.Input<string>;

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

interface GetHostedZoneArgs

A collection of arguments for invoking getHostedZone.

property region 

region?: string;

The region you’d like the zone for. By default, fetches the current region.

interface GetHostedZoneResult

A collection of values returned by getHostedZone.

property id 

id: string;

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

interface GetSolutionStackArgs

A collection of arguments for invoking getSolutionStack.

property mostRecent 

mostRecent?: boolean;

If more than one result is returned, use the most recent solution stack.

property nameRegex 

nameRegex: string;

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.

interface GetSolutionStackResult

A collection of values returned by getSolutionStack.

property id 

id: string;

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

property name 

name: string;

The name of the solution stack.