ContainerCredentialsProvider (AWS Java SDK :: Auth 2.25.39 API)

java.lang.Object
- software.amazon.awssdk.auth.credentials.ContainerCredentialsProvider

All Implemented Interfaces:

AutoCloseable, AwsCredentialsProvider, HttpCredentialsProvider, IdentityProvider<AwsCredentialsIdentity>, ToCopyableBuilder<ContainerCredentialsProvider.Builder,ContainerCredentialsProvider>, SdkAutoCloseable
```
public final class ContainerCredentialsProvider
extends Object
implements HttpCredentialsProvider, ToCopyableBuilder<ContainerCredentialsProvider.Builder,ContainerCredentialsProvider>
```
AwsCredentialsProvider implementation that loads credentials from a local metadata service. Currently supported containers:
- Amazon Elastic Container Service (ECS)
- AWS Greengrass
The URI path is retrieved from the environment variable "AWS_CONTAINER_CREDENTIALS_RELATIVE_URI" or "AWS_CONTAINER_CREDENTIALS_FULL_URI" in the container's environment. If the environment variable is not set, this credentials provider will throw an exception.
See Also:

Amazon Elastic Container Service (ECS)

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface ContainerCredentialsProvider.Builder
A builder for creating a custom a ContainerCredentialsProvider.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static ContainerCredentialsProvider.Builder`	`builder()`	Create a builder for creating a `ContainerCredentialsProvider`.
`void`	`close()`
`AwsCredentials`	`resolveCredentials()`	Returns `AwsCredentials` that can be used to authorize an AWS request.
`ContainerCredentialsProvider.Builder`	`toBuilder()`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.auth.credentials.AwsCredentialsProvider
identityType, resolveIdentity

Methods inherited from interface software.amazon.awssdk.identity.spi.IdentityProvider
resolveIdentity, resolveIdentity

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - builder
```
public static ContainerCredentialsProvider.Builder builder()
```
    Create a builder for creating a ContainerCredentialsProvider.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - resolveCredentials
```
public AwsCredentials resolveCredentials()
```
    Description copied from interface: AwsCredentialsProvider
    
    Returns AwsCredentials that can be used to authorize an AWS request. Each implementation of AWSCredentialsProvider can choose its own strategy for loading credentials. For example, an implementation might load credentials from an existing key management system, or load new credentials when credentials are rotated.
    If an error occurs during the loading of credentials or credentials could not be found, a runtime exception will be raised.
    
    Specified by:
    
    resolveCredentials in interface AwsCredentialsProvider
    
    Returns:
    
    AwsCredentials which the caller can use to authorize an AWS request.
  - close
```
public void close()
```
    Specified by:
    
    close in interface AutoCloseable
    
    Specified by:
    
    close in interface SdkAutoCloseable
  - toBuilder
```
public ContainerCredentialsProvider.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ContainerCredentialsProvider.Builder,ContainerCredentialsProvider>