JarCasting
JarCasting JarCasting

Spring-Boot-Starter - AWS-Support

This minimal Spring-Boot-Starter is an very simple EnvironmentPostProcessor that detects the application is running on AWS or not. It utilizes the EC2MetadataUtils to fetch some details about the AWS environment it's running on.

License

License

MIT
Categories

Categories

Spring Boot Container Microservices AWS PaaS Providers
GroupId

GroupId

org.zalando
ArtifactId

ArtifactId

aws-support-spring-boot-starter
Last Version

Last Version

1.0.1
Release Date

Release Date
Type

Type

jar
Description

Description

Spring-Boot-Starter - AWS-Support
This minimal Spring-Boot-Starter is an very simple EnvironmentPostProcessor that detects the application is running on AWS or not. It utilizes the EC2MetadataUtils to fetch some details about the AWS environment it's running on.
Project Organization

Project Organization

Zalando SE
Source Code Management

Source Code Management

https://github.com/zalando-incubator/aws-support-spring-boot-starter

Download aws-support-spring-boot-starter

Filename Size
aws-support-spring-boot-starter-1.0.1.pom
aws-support-spring-boot-starter-1.0.1.jar 6 KB
aws-support-spring-boot-starter-1.0.1-sources.jar 5 KB
aws-support-spring-boot-starter-1.0.1-javadoc.jar 27 KB
Browse

How to add to project

<!-- https://jarcasting.com/artifacts/org.zalando/aws-support-spring-boot-starter/ -->
<dependency>
    <groupId>org.zalando</groupId>
    <artifactId>aws-support-spring-boot-starter</artifactId>
    <version>1.0.1</version>
</dependency>
// https://jarcasting.com/artifacts/org.zalando/aws-support-spring-boot-starter/
implementation 'org.zalando:aws-support-spring-boot-starter:1.0.1'
// https://jarcasting.com/artifacts/org.zalando/aws-support-spring-boot-starter/
implementation ("org.zalando:aws-support-spring-boot-starter:1.0.1")
'org.zalando:aws-support-spring-boot-starter:jar:1.0.1'
<dependency org="org.zalando" name="aws-support-spring-boot-starter" rev="1.0.1">
  <artifact name="aws-support-spring-boot-starter" type="jar" />
</dependency>
@Grapes(
@Grab(group='org.zalando', module='aws-support-spring-boot-starter', version='1.0.1')
)
libraryDependencies += "org.zalando" % "aws-support-spring-boot-starter" % "1.0.1"
[org.zalando/aws-support-spring-boot-starter "1.0.1"]

Dependencies

compile (3)

Group / Artifact Type Version
org.springframework.boot : spring-boot-autoconfigure jar
com.amazonaws : aws-java-sdk-core jar 1.11.6
org.slf4j : slf4j-api jar

Project Modules

There are no modules declared in this project.

Spring Boot Starter - AWS Support

This minimal Spring-Boot-Starter is a very simple EnvironmentPostProcessor that detects whether an application is running on AWS or not. It utilizes the EC2MetadataUtils to fetch some details about the AWS environment it's running on.

Build Status Javadoc Release Maven Central License

Usage

Simply add the JAR as a dependency to your project. It is available via Maven Central.

Maven

Add the following to your pom.xml

<dependency>
    <groupId>org.zalando</groupId>
    <artifactId>aws-support-spring-boot-starter</artifactId>
    <version>${aws-support-spring-boot-starter.version}</version>
</dependency>

Gradle

Add the following to your build.gradle

compile('org.zalando:aws-support-spring-boot-starter:$aws-support-spring-boot-starter.version')

Download

You can download the .jar artifacts directly from the Releases page here on GitHub.

Exposed Properties

If the application is starting on AWS it will provide/set the following properties.

Property Description
aws.az Availability-Zone
aws.region Region
aws.localhostname Hostname
aws.localipv4 IP ( v. 4)
aws.instanceid Instance-Id

Contributing

Issues

Found a bug or have an idea for a feature? You can help us by creating an issue. Just make sure that an issue describing the bug or feature does not already exist. You can go even further and open a Pull Request with the fix or proposed feature.

Pull Requests

Follow these steps to contribute your work to Spring Boot Starter - AWS Support:

  1. Open an issue describing the problem or proposed feature. Assign yourself so we know you're working on it.
  2. Fork this repo and create a branch for your work.
  3. Push changes to your branch.
  4. Test your changes.
  5. Open a Pull Request when your code is ready for review.
    1. Mention the issue number in the comment (e.g. Fixes #37).
    2. If you're still working on it, add the under development label.
  6. We will review your PR, give feedback, and merge when it is ready.

Thanks for your contribution!

TODO

There are no further features planned at the moment. But we are open for any suggestions that should be added.

Contact

Simply open an issues and assign the question label or reach out to any of the maintainers.

Licence

The MIT License (MIT) Copyright © 2016 Zalando SE, https://tech.zalando.com

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

org.zalando

The Zalando Incubator

Projects in development at Zalando. We accept contributions and feedback—leave an issue at the relevant project's issues tracker.

Versions

Version
1.0.1
1.0.0