com.ibm.cos.v2.auth.credentials

Class AwsSessionCredentials.Builder

java.lang.Object

com.ibm.cos.v2.auth.credentials.AwsSessionCredentials.Builder

All Implemented Interfaces:

Buildable, CopyableBuilder<AwsSessionCredentials.Builder,AwsSessionCredentials>, SdkBuilder<AwsSessionCredentials.Builder,AwsSessionCredentials>

Enclosing class:

AwsSessionCredentials

public static final class AwsSessionCredentials.Builder
extends Object
implements CopyableBuilder<AwsSessionCredentials.Builder,AwsSessionCredentials>

A builder for creating an instance of AwsSessionCredentials. This can be created with the static AwsSessionCredentials.builder() method.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
AwsSessionCredentials.Builder	accessKeyId(String accessKeyId) The AWS access key, used to identify the user interacting with services.
AwsSessionCredentials.Builder	accountId(String accountId) The AWS accountId
AwsSessionCredentials	build() An immutable object that is created from the properties that have been set on the builder.
AwsSessionCredentials.Builder	expirationTime(Instant expirationTime) The time after which this identity will no longer be valid.
AwsSessionCredentials.Builder	providerName(String providerName) The name of the identity provider that created this credential identity.
AwsSessionCredentials.Builder	secretAccessKey(String secretAccessKey) The AWS secret access key, used to authenticate the user interacting with services.
AwsSessionCredentials.Builder	sessionToken(String sessionToken) The AWS session token, retrieved from an AWS token service, used for authenticating that this user has received temporary permission to access some resource.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.ibm.cos.v2.utils.builder.CopyableBuilder

copy

Methods inherited from interface com.ibm.cos.v2.utils.builder.SdkBuilder

applyMutation

Constructor Detail

Builder

public Builder()

Method Detail

accessKeyId

public AwsSessionCredentials.Builder accessKeyId(String accessKeyId)

The AWS access key, used to identify the user interacting with services. Required.

secretAccessKey

public AwsSessionCredentials.Builder secretAccessKey(String secretAccessKey)

The AWS secret access key, used to authenticate the user interacting with services. Required

sessionToken

public AwsSessionCredentials.Builder sessionToken(String sessionToken)

The AWS session token, retrieved from an AWS token service, used for authenticating that this user has received temporary permission to access some resource. Required

accountId

public AwsSessionCredentials.Builder accountId(String accountId)

The AWS accountId

Parameters:

accountId -

Returns:

expirationTime

public AwsSessionCredentials.Builder expirationTime(Instant expirationTime)

The time after which this identity will no longer be valid. If this is empty, an expiration time is not known (but the identity may still expire at some time in the future).

providerName

public AwsSessionCredentials.Builder providerName(String providerName)

The name of the identity provider that created this credential identity.

build

public AwsSessionCredentials build()

Description copied from interface: SdkBuilder

An immutable object that is created from the properties that have been set on the builder.

Specified by:

build in interface Buildable

Specified by:

build in interface SdkBuilder<AwsSessionCredentials.Builder,AwsSessionCredentials>

Returns:

an instance of T