software.amazon.awssdk.services.cognitoidentity.model

Class GetOpenIdTokenForDeveloperIdentityRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.cognitoidentity.model.CognitoIdentityRequest

software.amazon.awssdk.services.cognitoidentity.model.GetOpenIdTokenForDeveloperIdentityRequest

All Implemented Interfaces:

ToCopyableBuilder<GetOpenIdTokenForDeveloperIdentityRequest.Builder,GetOpenIdTokenForDeveloperIdentityRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class GetOpenIdTokenForDeveloperIdentityRequest
extends CognitoIdentityRequest
implements ToCopyableBuilder<GetOpenIdTokenForDeveloperIdentityRequest.Builder,GetOpenIdTokenForDeveloperIdentityRequest>

Input to the GetOpenIdTokenForDeveloperIdentity action.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetOpenIdTokenForDeveloperIdentityRequest.Builder

Method Summary

Modifier and Type	Method and Description
static GetOpenIdTokenForDeveloperIdentityRequest.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
String	identityId() A unique identifier in the format REGION:GUID.
String	identityPoolId() An identity pool ID in the format REGION:GUID.
Map<String,String>	logins() A set of optional name-value pairs that map provider names to provider tokens.
static Class<? extends GetOpenIdTokenForDeveloperIdentityRequest.Builder>	serializableBuilderClass()
GetOpenIdTokenForDeveloperIdentityRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
Long	tokenDuration() The expiration time of the token, in seconds.
String	toString()

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

identityPoolId

public String identityPoolId()

An identity pool ID in the format REGION:GUID.

Returns:

An identity pool ID in the format REGION:GUID.

identityId

public String identityId()

A unique identifier in the format REGION:GUID.

Returns:

A unique identifier in the format REGION:GUID.

logins

public Map<String,String> logins()

A set of optional name-value pairs that map provider names to provider tokens. Each name-value pair represents a user from a public provider or developer provider. If the user is from a developer provider, the name-value pair will follow the syntax "developer_provider_name": "developer_user_identifier". The developer provider is the "domain" by which Cognito will refer to your users; you provided this domain while creating/updating the identity pool. The developer user identifier is an identifier from your backend that uniquely identifies a user. When you create an identity pool, you can specify the supported logins.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

A set of optional name-value pairs that map provider names to provider tokens. Each name-value pair represents a user from a public provider or developer provider. If the user is from a developer provider, the name-value pair will follow the syntax "developer_provider_name": "developer_user_identifier". The developer provider is the "domain" by which Cognito will refer to your users; you provided this domain while creating/updating the identity pool. The developer user identifier is an identifier from your backend that uniquely identifies a user. When you create an identity pool, you can specify the supported logins.

tokenDuration

public Long tokenDuration()

The expiration time of the token, in seconds. You can specify a custom expiration time for the token so that you can cache it. If you don't provide an expiration time, the token is valid for 15 minutes. You can exchange the token with Amazon STS for temporary AWS credentials, which are valid for a maximum of one hour. The maximum token duration you can set is 24 hours. You should take care in setting the expiration time for a token, as there are significant security implications: an attacker could use a leaked token to access your AWS resources for the token's duration.

Returns:

The expiration time of the token, in seconds. You can specify a custom expiration time for the token so that you can cache it. If you don't provide an expiration time, the token is valid for 15 minutes. You can exchange the token with Amazon STS for temporary AWS credentials, which are valid for a maximum of one hour. The maximum token duration you can set is 24 hours. You should take care in setting the expiration time for a token, as there are significant security implications: an attacker could use a leaked token to access your AWS resources for the token's duration.

toBuilder

public GetOpenIdTokenForDeveloperIdentityRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<GetOpenIdTokenForDeveloperIdentityRequest.Builder,GetOpenIdTokenForDeveloperIdentityRequest>

Specified by:

toBuilder in class CognitoIdentityRequest

Returns:

a builder for type T

builder

public static GetOpenIdTokenForDeveloperIdentityRequest.Builder builder()

serializableBuilderClass

public static Class<? extends GetOpenIdTokenForDeveloperIdentityRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value