IMDS Release #3723
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| { | ||
| "type": "feature", | ||
| "category": "AWS SDK for Java v2", | ||
| "contributor": "", | ||
| "description": "EC2 Instance Metadata Client is now generally available - https://github.com/aws/aws-sdk-java-v2/issues/61" | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,138 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <!-- | ||
| ~ Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
| ~ | ||
| ~ Licensed under the Apache License, Version 2.0 (the "License"). | ||
| ~ You may not use this file except in compliance with the License. | ||
| ~ A copy of the License is located at | ||
| ~ | ||
| ~ http://aws.amazon.com/apache2.0 | ||
| ~ | ||
| ~ or in the "license" file accompanying this file. This file is distributed | ||
| ~ on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either | ||
| ~ express or implied. See the License for the specific language governing | ||
| ~ permissions and limitations under the License. | ||
| --> | ||
|
|
||
| <project xmlns="http://maven.apache.org/POM/4.0.0" | ||
| xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" | ||
| xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> | ||
| <parent> | ||
| <artifactId>core</artifactId> | ||
| <groupId>software.amazon.awssdk</groupId> | ||
| <version>2.17.209-SNAPSHOT</version> | ||
| </parent> | ||
| <modelVersion>4.0.0</modelVersion> | ||
|
|
||
| <artifactId>imds</artifactId> | ||
| <name>AWS Java SDK :: Core :: Imds</name> | ||
| <url>https://aws.amazon.com/sdkforjava</url> | ||
|
|
||
| <dependencies> | ||
| <dependency> | ||
| <groupId>software.amazon.awssdk</groupId> | ||
| <artifactId>annotations</artifactId> | ||
| <version>${awsjavasdk.version}</version> | ||
| </dependency> | ||
| <dependency> | ||
| <groupId>org.junit.jupiter</groupId> | ||
|
There was a problem hiding this comment. Does this module only have JUnit5 tests only? If so, let's remove JUnit4 dependencies to avoid the chances of mixing JUnit4 and JUnit5 annotations. See https://github.com/aws/aws-sdk-java-v2/blob/master/services-custom/s3-transfer-manager/pom.xml#L121-L130 There was a problem hiding this comment. Good point, will do that to prevent any junit4 dependency in the classpath |
||
| <artifactId>junit-jupiter</artifactId> | ||
| <scope>test</scope> | ||
| </dependency> | ||
| <dependency> | ||
| <groupId>org.junit.vintage</groupId> | ||
| <artifactId>junit-vintage-engine</artifactId> | ||
| <scope>test</scope> | ||
| </dependency> | ||
| <dependency> | ||
| <groupId>org.assertj</groupId> | ||
| <artifactId>assertj-core</artifactId> | ||
| <scope>test</scope> | ||
| </dependency> | ||
| <dependency> | ||
| <groupId>org.mockito</groupId> | ||
| <artifactId>mockito-core</artifactId> | ||
| <scope>test</scope> | ||
| </dependency> | ||
| <dependency> | ||
| <groupId>software.amazon.awssdk</groupId> | ||
| <artifactId>url-connection-client</artifactId> | ||
| <version>${awsjavasdk.version}</version> | ||
| <scope>test</scope> | ||
| </dependency> | ||
| <dependency> | ||
| <groupId>software.amazon.awssdk</groupId> | ||
| <artifactId>http-client-spi</artifactId> | ||
| <version>${awsjavasdk.version}</version> | ||
| <scope>compile</scope> | ||
| </dependency> | ||
| <dependency> | ||
| <groupId>nl.jqno.equalsverifier</groupId> | ||
| <artifactId>equalsverifier</artifactId> | ||
| <scope>test</scope> | ||
| </dependency> | ||
| <dependency> | ||
| <groupId>software.amazon.awssdk</groupId> | ||
| <artifactId>sdk-core</artifactId> | ||
| <version>${awsjavasdk.version}</version> | ||
| <scope>compile</scope> | ||
| </dependency> | ||
| <dependency> | ||
| <groupId>com.github.tomakehurst</groupId> | ||
| <artifactId>wiremock-jre8</artifactId> | ||
| <scope>test</scope> | ||
| </dependency> | ||
| <dependency> | ||
| <groupId>software.amazon.awssdk</groupId> | ||
| <artifactId>utils</artifactId> | ||
| <version>${awsjavasdk.version}</version> | ||
| <scope>compile</scope> | ||
| </dependency> | ||
| <dependency> | ||
| <groupId>software.amazon.awssdk</groupId> | ||
| <artifactId>json-utils</artifactId> | ||
| <version>${awsjavasdk.version}</version> | ||
| <scope>compile</scope> | ||
| </dependency> | ||
| <dependency> | ||
| <groupId>software.amazon.awssdk</groupId> | ||
| <artifactId>third-party-jackson-core</artifactId> | ||
| <version>${awsjavasdk.version}</version> | ||
| <scope>compile</scope> | ||
| </dependency> | ||
| <dependency> | ||
| <groupId>software.amazon.awssdk</groupId> | ||
| <artifactId>test-utils</artifactId> | ||
| <version>${awsjavasdk.version}</version> | ||
| <scope>test</scope> | ||
| </dependency> | ||
| <dependency> | ||
| <groupId>software.amazon.awssdk</groupId> | ||
| <artifactId>profiles</artifactId> | ||
| <version>${awsjavasdk.version}</version> | ||
| <scope>compile</scope> | ||
| </dependency> | ||
| <dependency> | ||
| <groupId>software.amazon.awssdk</groupId> | ||
| <artifactId>netty-nio-client</artifactId> | ||
| <version>${awsjavasdk.version}</version> | ||
| <scope>test</scope> | ||
| </dependency> | ||
| </dependencies> | ||
|
|
||
| <build> | ||
| <plugins> | ||
| <plugin> | ||
| <groupId>org.apache.maven.plugins</groupId> | ||
| <artifactId>maven-jar-plugin</artifactId> | ||
| <configuration> | ||
| <archive> | ||
| <manifestEntries> | ||
| <Automatic-Module-Name>software.amazon.awssdk.imds</Automatic-Module-Name> | ||
| </manifestEntries> | ||
| </archive> | ||
| </configuration> | ||
| </plugin> | ||
| </plugins> | ||
| </build> | ||
| </project> | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,103 @@ | ||
| /* | ||
| * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"). | ||
| * You may not use this file except in compliance with the License. | ||
| * A copy of the License is located at | ||
| * | ||
| * http://aws.amazon.com/apache2.0 | ||
| * | ||
| * or in the "license" file accompanying this file. This file is distributed | ||
| * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either | ||
| * express or implied. See the License for the specific language governing | ||
| * permissions and limitations under the License. | ||
| */ | ||
|
|
||
| package software.amazon.awssdk.imds; | ||
|
|
||
| import java.util.concurrent.CompletableFuture; | ||
| import java.util.concurrent.Executors; | ||
| import java.util.concurrent.ScheduledExecutorService; | ||
| import software.amazon.awssdk.annotations.SdkPublicApi; | ||
| import software.amazon.awssdk.core.exception.SdkClientException; | ||
| import software.amazon.awssdk.http.async.SdkAsyncHttpClient; | ||
| import software.amazon.awssdk.imds.internal.DefaultEc2MetadataAsyncClient; | ||
| import software.amazon.awssdk.utils.SdkAutoCloseable; | ||
|
|
||
| /** | ||
| * Interface to represent the Ec2Metadata Client Class. Used to access instance metadata from a running instance. | ||
|
There was a problem hiding this comment. Let's add some code snippets using |
||
| */ | ||
| @SdkPublicApi | ||
| public interface Ec2MetadataAsyncClient extends SdkAutoCloseable { | ||
|
|
||
| /** | ||
| * Gets the specified instance metadata value by the given path. For more information about instance metadata, check the | ||
| * <a href=https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html>Instance metadata documentation</a>. | ||
| * | ||
|
There was a problem hiding this comment. Let's add a code sample here as well. Same as sync client. |
||
| * @param path Input path | ||
| * @return A CompletableFuture that completes when the MetadataResponse is made available. | ||
| */ | ||
| CompletableFuture<Ec2MetadataResponse> get(String path); | ||
|
|
||
| /** | ||
| * Create an {@link Ec2MetadataAsyncClient} instance using the default values. | ||
| * | ||
| * @return the client instance. | ||
| */ | ||
| static Ec2MetadataAsyncClient create() { | ||
| return builder().build(); | ||
| } | ||
|
|
||
| /** | ||
| * Creates a builder for an async client instance. | ||
| * @return the newly created builder instance. | ||
| */ | ||
| static Ec2MetadataAsyncClient.Builder builder() { | ||
| return DefaultEc2MetadataAsyncClient.builder(); | ||
| } | ||
|
|
||
| /** | ||
| * The builder definition for a {@link Ec2MetadataClient}. All parameters are optional and have default values if not | ||
| * specified. Therefore, an instance can be simply created with {@code Ec2MetadataAsyncClient.builder().build()} or | ||
| * {@code Ec2MetadataAsyncClient.create()}, both having the same result. | ||
| */ | ||
| interface Builder extends Ec2MetadataClientBuilder<Ec2MetadataAsyncClient.Builder, Ec2MetadataAsyncClient> { | ||
|
|
||
| /** | ||
| * Define the {@link ScheduledExecutorService} used to schedule asynchronous retry attempts. If provided, the | ||
| * Ec2MetadataClient will <em>NOT</em> manage the lifetime if the httpClient and must therefore be | ||
| * closed explicitly by calling the {@link SdkAsyncHttpClient#close()} method on it. | ||
| * <p> | ||
| * If not specified, defaults to {@link Executors#newScheduledThreadPool} with a default value of 3 thread in the | ||
| * pool. | ||
| * | ||
| * @param scheduledExecutorService the ScheduledExecutorService to use for retry attempt. | ||
| * @return a reference to this builder | ||
| */ | ||
| Builder scheduledExecutorService(ScheduledExecutorService scheduledExecutorService); | ||
|
|
||
| /** | ||
| * Define the http client used by the Ec2 Metadata client. If provided, the Ec2MetadataClient will <em>NOT</em> manage the | ||
| * lifetime if the httpClient and must therefore be closed explicitly by calling the {@link SdkAsyncHttpClient#close()} | ||
| * method on it. | ||
| * <p> | ||
| * If not specified, the IMDS client will look for a SdkAsyncHttpClient class included in the classpath of the | ||
| * application and creates a new instance of that class, managed by the IMDS Client, that will be closed when the IMDS | ||
| * Client is closed. If no such class can be found, will throw a {@link SdkClientException}. | ||
| * | ||
| * @param httpClient the http client | ||
| * @return a reference to this builder | ||
| */ | ||
| Builder httpClient(SdkAsyncHttpClient httpClient); | ||
|
|
||
| /** | ||
| * An http client builder used to retrieve an instance of an {@link SdkAsyncHttpClient}. If specified, the Ec2 | ||
| * Metadata Client will use the instance returned by the builder and manage its lifetime by closing the http client | ||
| * once the Ec2 Client itself is closed. | ||
| * | ||
| * @param builder the builder to used to retrieve an instance. | ||
| * @return a reference to this builder | ||
| */ | ||
| Builder httpClient(SdkAsyncHttpClient.Builder<?> builder); | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,87 @@ | ||
| /* | ||
| * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"). | ||
| * You may not use this file except in compliance with the License. | ||
| * A copy of the License is located at | ||
| * | ||
| * http://aws.amazon.com/apache2.0 | ||
| * | ||
| * or in the "license" file accompanying this file. This file is distributed | ||
| * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either | ||
| * express or implied. See the License for the specific language governing | ||
| * permissions and limitations under the License. | ||
| */ | ||
|
|
||
| package software.amazon.awssdk.imds; | ||
|
|
||
| import software.amazon.awssdk.annotations.SdkPublicApi; | ||
| import software.amazon.awssdk.core.exception.SdkClientException; | ||
| import software.amazon.awssdk.http.SdkHttpClient; | ||
| import software.amazon.awssdk.http.async.SdkAsyncHttpClient; | ||
| import software.amazon.awssdk.imds.internal.DefaultEc2MetadataClient; | ||
| import software.amazon.awssdk.utils.SdkAutoCloseable; | ||
|
|
||
|
|
||
| /** | ||
| * Interface to represent the Ec2Metadata Client Class. Used to access instance metadata from a running instance. | ||
| */ | ||
| @SdkPublicApi | ||
| public interface Ec2MetadataClient extends SdkAutoCloseable { | ||
|
|
||
| /** | ||
| * Gets the specified instance metadata value by the given path. For more information about instance metadata, check the | ||
| * <a href=https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html>Instance metadata documentation</a> | ||
| * | ||
| * @param path Input path | ||
| * @return Instance metadata value as part of MetadataResponse Object | ||
| */ | ||
| Ec2MetadataResponse get(String path); | ||
|
|
||
| /** | ||
| * Create an {@link Ec2MetadataClient} instance using the default values. | ||
| * | ||
| * @return the client instance. | ||
| */ | ||
| static Ec2MetadataClient create() { | ||
| return builder().build(); | ||
| } | ||
|
|
||
| /** | ||
| * Creates a default builder for {@link Ec2MetadataClient}. | ||
| */ | ||
| static Builder builder() { | ||
| return DefaultEc2MetadataClient.builder(); | ||
| } | ||
|
|
||
| /** | ||
| * The builder definition for a {@link Ec2MetadataClient}. | ||
| */ | ||
| interface Builder extends Ec2MetadataClientBuilder<Ec2MetadataClient.Builder, Ec2MetadataClient> { | ||
|
|
||
| /** | ||
| * Define the http client used by the Ec2 Metadata client. If provided, the Ec2MetadataClient will <em>NOT</em> manage the | ||
| * lifetime if the httpClient and must therefore be closed explicitly by calling the {@link SdkAsyncHttpClient#close()} | ||
| * method on it. | ||
| * <p> | ||
| * If not specified, the IMDS client will look for a SdkHttpClient class included in the classpath of the | ||
| * application and creates a new instance of that class, managed by the IMDS Client, that will be closed when the IMDS | ||
| * Client is closed. If no such class can be found, will throw a {@link SdkClientException}. | ||
| * | ||
| * @param httpClient the http client | ||
| * @return a reference to this builder | ||
| */ | ||
| Builder httpClient(SdkHttpClient httpClient); | ||
|
|
||
| /** | ||
| * A http client builder used to retrieve an instance of an {@link SdkHttpClient}. If specified, the Ec2 Metadata Client | ||
| * will use the instance returned by the builder and manage its lifetime by closing the http client once the Ec2 Client | ||
| * itself is closed. | ||
| * | ||
| * @param builder the builder to used to retrieve an instance. | ||
| * @return a reference to this builder | ||
| */ | ||
| Builder httpClient(SdkHttpClient.Builder<?> builder); | ||
| } | ||
|
|
||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Minor: can we organize the dependencies a bit by separating compile and test dependencies ? Non-test dependencies should be put to the top.