Class GetOpenIdTokenForDeveloperIdentityRequest
- java.lang.Object
-
- com.amazonaws.AmazonWebServiceRequest
-
- com.amazonaws.services.cognitoidentity.model.GetOpenIdTokenForDeveloperIdentityRequest
-
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
public class GetOpenIdTokenForDeveloperIdentityRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
Input to the
GetOpenIdTokenForDeveloperIdentity
action.- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
-
Constructor Summary
Constructors Constructor Description GetOpenIdTokenForDeveloperIdentityRequest()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description GetOpenIdTokenForDeveloperIdentityRequest
addLoginsEntry(String key, String value)
GetOpenIdTokenForDeveloperIdentityRequest
clearLoginsEntries()
Removes all the entries added into Logins.GetOpenIdTokenForDeveloperIdentityRequest
clone()
Creates a shallow clone of this request.boolean
equals(Object obj)
String
getIdentityId()
A unique identifier in the format REGION:GUID.String
getIdentityPoolId()
An identity pool ID in the format REGION:GUID.Map<String,String>
getLogins()
A set of optional name-value pairs that map provider names to provider tokens.Long
getTokenDuration()
The expiration time of the token, in seconds.int
hashCode()
void
setIdentityId(String identityId)
A unique identifier in the format REGION:GUID.void
setIdentityPoolId(String identityPoolId)
An identity pool ID in the format REGION:GUID.void
setLogins(Map<String,String> logins)
A set of optional name-value pairs that map provider names to provider tokens.void
setTokenDuration(Long tokenDuration)
The expiration time of the token, in seconds.String
toString()
Returns a string representation of this object; useful for testing and debugging.GetOpenIdTokenForDeveloperIdentityRequest
withIdentityId(String identityId)
A unique identifier in the format REGION:GUID.GetOpenIdTokenForDeveloperIdentityRequest
withIdentityPoolId(String identityPoolId)
An identity pool ID in the format REGION:GUID.GetOpenIdTokenForDeveloperIdentityRequest
withLogins(Map<String,String> logins)
A set of optional name-value pairs that map provider names to provider tokens.GetOpenIdTokenForDeveloperIdentityRequest
withTokenDuration(Long tokenDuration)
The expiration time of the token, in seconds.-
Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
-
-
-
Method Detail
-
setIdentityPoolId
public void setIdentityPoolId(String identityPoolId)
An identity pool ID in the format REGION:GUID.
- Parameters:
identityPoolId
- An identity pool ID in the format REGION:GUID.
-
getIdentityPoolId
public String getIdentityPoolId()
An identity pool ID in the format REGION:GUID.
- Returns:
- An identity pool ID in the format REGION:GUID.
-
withIdentityPoolId
public GetOpenIdTokenForDeveloperIdentityRequest withIdentityPoolId(String identityPoolId)
An identity pool ID in the format REGION:GUID.
- Parameters:
identityPoolId
- An identity pool ID in the format REGION:GUID.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setIdentityId
public void setIdentityId(String identityId)
A unique identifier in the format REGION:GUID.
- Parameters:
identityId
- A unique identifier in the format REGION:GUID.
-
getIdentityId
public String getIdentityId()
A unique identifier in the format REGION:GUID.
- Returns:
- A unique identifier in the format REGION:GUID.
-
withIdentityId
public GetOpenIdTokenForDeveloperIdentityRequest withIdentityId(String identityId)
A unique identifier in the format REGION:GUID.
- Parameters:
identityId
- A unique identifier in the format REGION:GUID.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getLogins
public Map<String,String> getLogins()
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.- 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.
-
setLogins
public void setLogins(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.- Parameters:
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.
-
withLogins
public GetOpenIdTokenForDeveloperIdentityRequest withLogins(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.- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
addLoginsEntry
public GetOpenIdTokenForDeveloperIdentityRequest addLoginsEntry(String key, String value)
-
clearLoginsEntries
public GetOpenIdTokenForDeveloperIdentityRequest clearLoginsEntries()
Removes all the entries added into Logins. <p> Returns a reference to this object so that method calls can be chained together.
-
setTokenDuration
public void setTokenDuration(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.
- Parameters:
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.
-
getTokenDuration
public Long getTokenDuration()
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.
-
withTokenDuration
public GetOpenIdTokenForDeveloperIdentityRequest withTokenDuration(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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
toString
public String toString()
Returns a string representation of this object; useful for testing and debugging.- Overrides:
toString
in classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public GetOpenIdTokenForDeveloperIdentityRequest clone()
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
Object.clone()
-
-