Overview
Guides
Project Documentation
Full name:
br.com.ingenieux:beanstalk-maven-plugin:1.5.6:replace-environment
Description:
Attributes:
| Name | Type | Since | Description |
|---|---|---|---|
| <applicationName> | String | 0.2.0 | Beanstalk Application Name Default value is: ${project.artifactId}. User property is: beanstalk.applicationName. |
| <environmentName> | String | 0.2.0 | environmentName. Takes precedence over environmentRef. User property is: beanstalk.environmentName. |
| <session> | MavenSession | 0.2.0 | (no description) Default value is: ${session}. |
| Name | Type | Since | Description |
|---|---|---|---|
| <applicationDescription> | String | 0.2.0 | Application Description Default value is: ${project.name}. User property is: beanstalk.applicationDescription. |
| <attemptRetryInterval> | int | 0.2.0 | Retry Interval, in Seconds Default value is: 60. User property is: beanstalk.attemptRetryInterval. |
| <cnamePrefix> | String | 0.2.0 |
CNAME Prefix User property is: beanstalk.cnamePrefix. |
| <configurableOptionSettings> | List | 0.2.0 |
Allows you to declare your own properties inside the plugin configuration, as long as it starts with "beanstalk.x."
<pluginManagement>
<plugins>
<plugin>
<groupId>br.com.ingenieux</groupId>
<artifactId>beanstalk-maven-plugin</artifactId>
<inherited>true</inherited>
<version>XXX</version>
<configuration>
<tags>
<Uses>ingenieux Beanstalker, http://beanstalker.ingenieux.com.br/</Uses>
</tags>
<configurableOptionSettings>
<configurableOptionSetting>
<alias>beanstalkx.serviceRole</alias>
<namespace>aws:elasticbeanstalk:environment</namespace>
<optionName>ServiceRole</optionName>
</configurableOptionSetting>
</configurableOptionSettings>
</configuration>
</plugin>
</plugins>
</pluginManagement>
This basically exposes the beanstalkx.serviceRole property as the mentioned Configuration Option Setting |
| <copyOptionSettings> | boolean | 0.2.0 | Whether or not to copy option settings from old environment when
replacing Default value is: true. User property is: beanstalk.copyOptionSettings. |
| <copySolutionStack> | boolean | 0.2.0 | Whether or not to keep the Elastic Beanstalk platform (aka
solutionStack) from the old environment when replacing Default value is: true. User property is: beanstalk.copySolutionStack. |
| <credentialId> | String | 0.2.0 | The credential id (on ~/.aws/credentials file) to use) Default value is: default. User property is: beanstalker.credentialId. |
| <domains> | String[] | 0.2.0 |
List of R53 Domains Could be set as either:
User property is: beanstalk.domains. |
| <endpointUrl> | String | 0.2.0 | Endpoint URL User property is: beanstalk.endpointUrl. |
| <environmentRef> | String | 0.2.0 | Environment Ref Default value is: ${project.artifactId}.elasticbeanstalk.com. User property is: beanstalk.environmentRef. |
| <environmentTierName> | String | 0.2.0 |
Environment Tier Name (defaults to "WebServer") Default value is: WebServer. User property is: beanstalk.environmentTierName. |
| <environmentTierType> | String | 0.2.0 |
Environment Tier Type User property is: beanstalk.environmentTierType. |
| <environmentTierVersion> | String | 0.2.0 |
Environment Tier Version User property is: beanstalk.environmentTierVersion. |
| <ignoreExceptions> | boolean | 0.2.0 | Ignore Exceptions? Default value is: false. User property is: beanstalker.ignoreExceptions. |
| <maxAttempts> | Integer | 0.2.0 | Max Number of Attempts (for cnameSwap in Particular) Default value is: 15. User property is: beanstalk.maxAttempts. |
| <mockTerminateEnvironment> | boolean | 0.2.0 | Do a 'Mock' Terminate Environment Call (useful for Debugging) Default value is: false. User property is: beanstalk.mockTerminateEnvironment. |
| <mustBeHealthy> | boolean | 0.2.0 |
If waiting for the environment to become ready, this indicates wether or not we require the Green health checks to pass. One reason to avoid such a requirement is if we are frantically replacing one failed environment with another one trying to get a ring of interdependant services to operate. Optional, but usually true. Under normal circumstances we *only* want to swap in a healthy service. Default value is: true. User property is: beanstalk.mustBeHealthy. |
| <optionSettings> | ConfigurationOptionSetting[] | 0.2.0 |
Configuration Option Settings. Will evaluate as such: If empty, will lookup for beanstalk.env.aws.x.y variable in the context, and it will map this variable to namespace [aws.x], under option name y, unless there's an alias set. A Property might be aliased. Current aliases include:
The reason for most of those aliases if the need to address space and ':' inside Maven Properties and XML Files. |
| <optionsToRemove> | OptionSpecification[] | 0.2.0 | (no description) |
| <redToRedOkay> | boolean | 0.2.0 | Allows one Red (broken) environment to replace another Red (broken)
environment. Default value is: true. User property is: beanstalk.redToRedOkay. |
| <regionName> | String | 0.2.0 |
Service region e.g. "us-east-1" See this list for reference. User property is: beanstalker.region. |
| <serverId> | String | 0.2.0 | The server id in maven settings.xml to use for AWS Services
Credentials (accessKey / secretKey) Default value is: aws.amazon.com. User property is: beanstalker.serverId. |
| <skipIfSameVersion> | boolean | 0.2.0 | Skips if Same Version? Default value is: true. User property is: beanstalk.skipIfSameVersion. |
| <solutionStack> | String | 0.2.0 | Solution Stack Name Default value is: 32bit Amazon Linux running Tomcat 7. User property is: beanstalk.solutionStack. |
| <tags> | Map | 0.2.0 |
Environment Tag List To set up environment tags put this under plugin configuration tag <tags> <tagName>tagValue</tagName> </tags> |
| <templateName> | String | 0.2.0 |
Template Name. Could be either literal or a glob, like, ingenieux-services-prod-* User property is: beanstalk.templateName. |
| <timeoutMins> | Integer | 0.2.0 | Minutes until timeout Default value is: 20. User property is: beanstalk.timeoutMins. |
| <verbose> | boolean | 0.2.0 | Verbose Logging? Default value is: false. User property is: beanstalker.verbose. |
| <versionLabel> | String | 0.2.0 | Version Label to use User property is: beanstalk.versionLabel. |
| <waitForReady> | boolean | 0.2.0 |
Status to Wait For Optional. If set, will block until app status is set eg "Ready" Default value is: true. User property is: beanstalk.waitForReady. |
CNAME Prefix
Allows you to declare your own properties inside the plugin configuration, as long as it starts with "beanstalk.x."
<pluginManagement>
<plugins>
<plugin>
<groupId>br.com.ingenieux</groupId>
<artifactId>beanstalk-maven-plugin</artifactId>
<inherited>true</inherited>
<version>XXX</version>
<configuration>
<tags>
<Uses>ingenieux Beanstalker, http://beanstalker.ingenieux.com.br/</Uses>
</tags>
<configurableOptionSettings>
<configurableOptionSetting>
<alias>beanstalkx.serviceRole</alias>
<namespace>aws:elasticbeanstalk:environment</namespace>
<optionName>ServiceRole</optionName>
</configurableOptionSetting>
</configurableOptionSettings>
</configuration>
</plugin>
</plugins>
</pluginManagement>
This basically exposes the beanstalkx.serviceRole property as the mentioned Configuration Option Setting
List of R53 Domains
Could be set as either:
Environment Tier Name (defaults to "WebServer")
Environment Tier Type
Environment Tier Version
If waiting for the environment to become ready, this indicates wether or not we require the Green health checks to pass.
One reason to avoid such a requirement is if we are frantically replacing one failed environment with another one trying to get a ring of interdependant services to operate.
Optional, but usually true. Under normal circumstances we *only* want to swap in a healthy service.
Configuration Option Settings. Will evaluate as such:
If empty, will lookup for beanstalk.env.aws.x.y variable in the context, and it will map this variable to namespace [aws.x], under option name y, unless there's an alias set.
A Property might be aliased. Current aliases include:
The reason for most of those aliases if the need to address space and ':' inside Maven Properties and XML Files.
Service region e.g. "us-east-1"
See this list for reference.
Environment Tag List
To set up environment tags put this under plugin configuration tag
<tags> <tagName>tagValue</tagName> </tags>
Template Name.
Could be either literal or a glob, like,
ingenieux-services-prod-*
Status to Wait For
Optional. If set, will block until app status is set eg "Ready"