beanstalk:retrieve-environment-info

Full name:

br.com.ingenieux:beanstalk-maven-plugin:1.5.1-SNAPSHOT:retrieve-environment-info

Description:

Returns Environment Info See the docs for RetrieveEnvironmentInfo API call.

Attributes:

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

Required Parameters

Name Type Since Description
applicationName String 0.2.6 Beanstalk Application Name
Default value is: ${project.artifactId}.
User property is: beanstalk.applicationName.
infoType String 0.2.6 Type of information ro retrieve. Accepted: tail
Default value is: tail.
User property is: beanstalk.infoType.
session MavenSession 0.2.6 (no description)
Default value is: ${session}.

Optional Parameters

Name Type Since Description
configurableOptionSettings List 0.2.6

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.6 The credential id (on ~/.aws/credentials file) to use)
Default value is: default.
User property is: beanstalker.credentialId.
endpointUrl String 0.2.6 Endpoint URL
User property is: beanstalk.endpointUrl.
environmentRef String 0.2.6 Environment Ref
Default value is: ${project.artifactId}.elasticbeanstalk.com.
User property is: beanstalk.environmentRef.
ignoreExceptions boolean 0.2.6 Ignore Exceptions?
Default value is: false.
User property is: beanstalker.ignoreExceptions.
regionName String 0.2.6

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

See this list for reference.


User property is: beanstalker.region.
serverId String 0.2.6 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.
verbose boolean 0.2.6 Verbose Logging?
Default value is: false.
User property is: beanstalker.verbose.

Parameter Details

applicationName:

Beanstalk Application Name
  • Type: java.lang.String
  • Since: 0.2.6
  • 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.6
  • Required: No

credentialId:

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

endpointUrl:

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

environmentRef:

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

ignoreExceptions:

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

infoType:

Type of information ro retrieve. Accepted: tail
  • Type: java.lang.String
  • Since: 0.2.6
  • Required: Yes
  • User Property: beanstalk.infoType
  • Default: tail

regionName:

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

See this list for reference.

  • Type: java.lang.String
  • Since: 0.2.6
  • 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.6
  • Required: No
  • User Property: beanstalker.serverId
  • Default: aws.amazon.com

session:

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

verbose:

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