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:

SdkPojo, 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)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasLogins() Returns true if the Logins property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasPrincipalTags() Returns true if the PrincipalTags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
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.
Map<String,String>	principalTags() Use this operation to configure attribute mappings for custom providers.
List<SdkField<?>>	sdkFields()
static Class<? extends GetOpenIdTokenForDeveloperIdentityRequest.Builder>	serializableBuilderClass()
GetOpenIdTokenForDeveloperIdentityRequest.Builder	toBuilder()
Long	tokenDuration() The expiration time of the token, in seconds.
String	toString() Returns a string representation of this object.

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

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

identityPoolId

public final String identityPoolId()

An identity pool ID in the format REGION:GUID.

Returns:

An identity pool ID in the format REGION:GUID.

identityId

public final String identityId()

A unique identifier in the format REGION:GUID.

Returns:

A unique identifier in the format REGION:GUID.

hasLogins

public final boolean hasLogins()

Returns true if the Logins property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

logins

public final 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.

You can use hasLogins() to see if a value was sent in this field.

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.

hasPrincipalTags

public final boolean hasPrincipalTags()

Returns true if the PrincipalTags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

principalTags

public final Map<String,String> principalTags()

Use this operation to configure attribute mappings for custom providers.

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

You can use hasPrincipalTags() to see if a value was sent in this field.

Returns:

Use this operation to configure attribute mappings for custom providers.

tokenDuration

public final 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.

Please provide for a small grace period, usually no more than 5 minutes, to account for clock skew.

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.

Please provide for a small grace period, usually no more than 5 minutes, to account for clock skew.

toBuilder

public GetOpenIdTokenForDeveloperIdentityRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetOpenIdTokenForDeveloperIdentityRequest.Builder,GetOpenIdTokenForDeveloperIdentityRequest>

Specified by:

toBuilder in class CognitoIdentityRequest

builder

public static GetOpenIdTokenForDeveloperIdentityRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

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

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo