beanstalk:update-environment-options

Full name:

br.com.ingenieux:beanstalk-maven-plugin:1.5.1-SNAPSHOT:update-environment-options

Description:

Updates the environment configuration (optionsSettings / optionsToRemove) See the UpdateEnvironment API call.

Attributes:

  • Requires a Maven project to be executed.
  • Executes by direct invocation only.
  • Since version: 0.2.2.

Required Parameters

Name Type Since Description
applicationName String 0.2.2 Beanstalk Application Name
Default value is: ${project.artifactId}.
User property is: beanstalk.applicationName.
session MavenSession 0.2.2 (no description)
Default value is: ${session}.
whatToSet UpdateEnvironmentOptionsMojo$WhatToSet 0.2.2 What to set?
Default value is: versionLabel.
User property is: beanstalk.whatToSet.

Optional Parameters

Name Type Since Description
configurableOptionSettings List 0.2.2

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


credentialId String 0.2.2 The credential id (on ~/.aws/credentials file) to use)
Default value is: default.
User property is: beanstalker.credentialId.
endpointUrl String 0.2.2 Endpoint URL
User property is: beanstalk.endpointUrl.
environmentDescription String 0.2.2 Environment Name
Default value is: default.
User property is: beanstalk.environmentDescription.
environmentRef String 0.2.2 Environment Ref
Default value is: ${project.artifactId}.elasticbeanstalk.com.
User property is: beanstalk.environmentRef.
ignoreExceptions boolean 0.2.2 Ignore Exceptions?
Default value is: false.
User property is: beanstalker.ignoreExceptions.
optionSettings ConfigurationOptionSetting[] 0.2.2 Configuration Option Settings
optionsToRemove OptionSpecification[] 0.2.2 Configuration Options To Remove
regionName String 0.2.2

Service region e.g. "us-east-1"

See this list for reference.


User property is: beanstalker.region.
serverId String 0.2.2 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.
templateName String 0.2.2

Template Name.

Could be either literal or a glob, like,

ingenieux-services-prod-*
. If a glob, there will be a lookup involved, and the first one in reverse ASCIIbetical order will be picked upon.


User property is: beanstalk.templateName.
verbose boolean 0.2.2 Verbose Logging?
Default value is: false.
User property is: beanstalker.verbose.
versionLabel String 0.2.2 Version Label to use.
User property is: beanstalk.versionLabel.

Parameter Details

applicationName:

Beanstalk Application Name
  • Type: java.lang.String
  • Since: 0.2.2
  • Required: Yes
  • User Property: beanstalk.applicationName
  • Default: ${project.artifactId}

configurableOptionSettings:

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

  • Type: java.util.List
  • Since: 0.2.2
  • Required: No

credentialId:

The credential id (on ~/.aws/credentials file) to use)
  • Type: java.lang.String
  • Since: 0.2.2
  • Required: No
  • User Property: beanstalker.credentialId
  • Default: default

endpointUrl:

Endpoint URL
  • Type: java.lang.String
  • Since: 0.2.2
  • Required: No
  • User Property: beanstalk.endpointUrl

environmentDescription:

Environment Name
  • Type: java.lang.String
  • Since: 0.2.2
  • Required: No
  • User Property: beanstalk.environmentDescription
  • Default: default

environmentRef:

Environment Ref
  • Type: java.lang.String
  • Since: 0.2.2
  • Required: No
  • User Property: beanstalk.environmentRef
  • Default: ${project.artifactId}.elasticbeanstalk.com

ignoreExceptions:

Ignore Exceptions?
  • Type: boolean
  • Since: 0.2.2
  • Required: No
  • User Property: beanstalker.ignoreExceptions
  • Default: false

optionSettings:

Configuration Option Settings
  • Type: com.amazonaws.services.elasticbeanstalk.model.ConfigurationOptionSetting[]
  • Since: 0.2.2
  • Required: No

optionsToRemove:

Configuration Options To Remove
  • Type: com.amazonaws.services.elasticbeanstalk.model.OptionSpecification[]
  • Since: 0.2.2
  • Required: No

regionName:

Service region e.g. "us-east-1"

See this list for reference.

  • Type: java.lang.String
  • Since: 0.2.2
  • Required: No
  • User Property: beanstalker.region

serverId:

The server id in maven settings.xml to use for AWS Services Credentials (accessKey / secretKey)
  • Type: java.lang.String
  • Since: 0.2.2
  • Required: No
  • User Property: beanstalker.serverId
  • Default: aws.amazon.com

session:

(no description)
  • Type: org.apache.maven.execution.MavenSession
  • Since: 0.2.2
  • Required: Yes
  • Default: ${session}

templateName:

Template Name.

Could be either literal or a glob, like,

ingenieux-services-prod-*
. If a glob, there will be a lookup involved, and the first one in reverse ASCIIbetical order will be picked upon.

  • Type: java.lang.String
  • Since: 0.2.2
  • Required: No
  • User Property: beanstalk.templateName

verbose:

Verbose Logging?
  • Type: boolean
  • Since: 0.2.2
  • Required: No
  • User Property: beanstalker.verbose
  • Default: false

versionLabel:

Version Label to use.
  • Type: java.lang.String
  • Since: 0.2.2
  • Required: No
  • User Property: beanstalk.versionLabel

whatToSet:

What to set?
  • Type: br.com.ingenieux.mojo.beanstalk.env.UpdateEnvironmentOptionsMojo$WhatToSet
  • Since: 0.2.2
  • Required: Yes
  • User Property: beanstalk.whatToSet
  • Default: versionLabel