Class GetOpenIdTokenForDeveloperIdentityRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
Input to the GetOpenIdTokenForDeveloperIdentity
action.
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddLoginsEntry
(String key, String value) Removes all the entries added into Logins.clone()
Creates a shallow clone of this request.boolean
A unique identifier in the format REGION:GUID.An identity pool ID in the format REGION:GUID.A set of optional name-value pairs that map provider names to provider tokens.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
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.toString()
Returns a string representation of this object; useful for testing and debugging.withIdentityId
(String identityId) A unique identifier in the format REGION:GUID.withIdentityPoolId
(String identityPoolId) An identity pool ID in the format REGION:GUID.withLogins
(Map<String, String> logins) A set of optional name-value pairs that map provider names to provider tokens.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
-
Constructor Details
-
GetOpenIdTokenForDeveloperIdentityRequest
public GetOpenIdTokenForDeveloperIdentityRequest()
-
-
Method Details
-
setIdentityPoolId
An identity pool ID in the format REGION:GUID.
- Parameters:
identityPoolId
- An identity pool ID in the format REGION:GUID.
-
getIdentityPoolId
An identity pool ID in the format REGION:GUID.
- Returns:
- An identity pool ID in the format REGION:GUID.
-
withIdentityPoolId
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
A unique identifier in the format REGION:GUID.
- Parameters:
identityId
- A unique identifier in the format REGION:GUID.
-
getIdentityId
A unique identifier in the format REGION:GUID.
- Returns:
- A unique identifier in the format REGION:GUID.
-
withIdentityId
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
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
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
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
-
clearLoginsEntries
Removes all the entries added into Logins. <p> Returns a reference to this object so that method calls can be chained together. -
setTokenDuration
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
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
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
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
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:
-