com.amazonaws.services.amplifybackend.model

Class BackendAPIAppSyncAuthSettings

java.lang.Object

com.amazonaws.services.amplifybackend.model.BackendAPIAppSyncAuthSettings

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class BackendAPIAppSyncAuthSettings
extends Object
implements Serializable, Cloneable, StructuredPojo

The authentication settings for accessing provisioned data models in your Amplify project.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
BackendAPIAppSyncAuthSettings()

Method Summary

Modifier and Type	Method and Description
BackendAPIAppSyncAuthSettings	clone()
boolean	equals(Object obj)
String	getCognitoUserPoolId() The Amazon Cognito user pool ID, if Amazon Cognito was used as an authentication setting to access your data models.
String	getDescription() The API key description for API_KEY, if it was used as an authentication mechanism to access your data models.
Double	getExpirationTime() The API key expiration time for API_KEY, if it was used as an authentication mechanism to access your data models.
String	getOpenIDAuthTTL() The expiry time for the OpenID authentication mechanism.
String	getOpenIDClientId() The clientID for openID, if openID was used as an authentication setting to access your data models.
String	getOpenIDIatTTL() The expiry time for the OpenID authentication mechanism.
String	getOpenIDIssueURL() The openID issuer URL, if openID was used as an authentication setting to access your data models.
String	getOpenIDProviderName() The OpenID provider name, if OpenID was used as an authentication mechanism to access your data models.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)
void	setCognitoUserPoolId(String cognitoUserPoolId) The Amazon Cognito user pool ID, if Amazon Cognito was used as an authentication setting to access your data models.
void	setDescription(String description) The API key description for API_KEY, if it was used as an authentication mechanism to access your data models.
void	setExpirationTime(Double expirationTime) The API key expiration time for API_KEY, if it was used as an authentication mechanism to access your data models.
void	setOpenIDAuthTTL(String openIDAuthTTL) The expiry time for the OpenID authentication mechanism.
void	setOpenIDClientId(String openIDClientId) The clientID for openID, if openID was used as an authentication setting to access your data models.
void	setOpenIDIatTTL(String openIDIatTTL) The expiry time for the OpenID authentication mechanism.
void	setOpenIDIssueURL(String openIDIssueURL) The openID issuer URL, if openID was used as an authentication setting to access your data models.
void	setOpenIDProviderName(String openIDProviderName) The OpenID provider name, if OpenID was used as an authentication mechanism to access your data models.
String	toString() Returns a string representation of this object.
BackendAPIAppSyncAuthSettings	withCognitoUserPoolId(String cognitoUserPoolId) The Amazon Cognito user pool ID, if Amazon Cognito was used as an authentication setting to access your data models.
BackendAPIAppSyncAuthSettings	withDescription(String description) The API key description for API_KEY, if it was used as an authentication mechanism to access your data models.
BackendAPIAppSyncAuthSettings	withExpirationTime(Double expirationTime) The API key expiration time for API_KEY, if it was used as an authentication mechanism to access your data models.
BackendAPIAppSyncAuthSettings	withOpenIDAuthTTL(String openIDAuthTTL) The expiry time for the OpenID authentication mechanism.
BackendAPIAppSyncAuthSettings	withOpenIDClientId(String openIDClientId) The clientID for openID, if openID was used as an authentication setting to access your data models.
BackendAPIAppSyncAuthSettings	withOpenIDIatTTL(String openIDIatTTL) The expiry time for the OpenID authentication mechanism.
BackendAPIAppSyncAuthSettings	withOpenIDIssueURL(String openIDIssueURL) The openID issuer URL, if openID was used as an authentication setting to access your data models.
BackendAPIAppSyncAuthSettings	withOpenIDProviderName(String openIDProviderName) The OpenID provider name, if OpenID was used as an authentication mechanism to access your data models.

Methods inherited from class java.lang.Object

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

Constructor Detail

BackendAPIAppSyncAuthSettings

public BackendAPIAppSyncAuthSettings()

Method Detail

setCognitoUserPoolId

public void setCognitoUserPoolId(String cognitoUserPoolId)

The Amazon Cognito user pool ID, if Amazon Cognito was used as an authentication setting to access your data models.

Parameters:

cognitoUserPoolId - The Amazon Cognito user pool ID, if Amazon Cognito was used as an authentication setting to access your data models.

getCognitoUserPoolId

public String getCognitoUserPoolId()

The Amazon Cognito user pool ID, if Amazon Cognito was used as an authentication setting to access your data models.

Returns:

The Amazon Cognito user pool ID, if Amazon Cognito was used as an authentication setting to access your data models.

withCognitoUserPoolId

public BackendAPIAppSyncAuthSettings withCognitoUserPoolId(String cognitoUserPoolId)

The Amazon Cognito user pool ID, if Amazon Cognito was used as an authentication setting to access your data models.

Parameters:

cognitoUserPoolId - The Amazon Cognito user pool ID, if Amazon Cognito was used as an authentication setting to access your data models.

Returns:

Returns a reference to this object so that method calls can be chained together.

setDescription

public void setDescription(String description)

The API key description for API_KEY, if it was used as an authentication mechanism to access your data models.

Parameters:

description - The API key description for API_KEY, if it was used as an authentication mechanism to access your data models.

getDescription

public String getDescription()

The API key description for API_KEY, if it was used as an authentication mechanism to access your data models.

Returns:

The API key description for API_KEY, if it was used as an authentication mechanism to access your data models.

withDescription

public BackendAPIAppSyncAuthSettings withDescription(String description)

The API key description for API_KEY, if it was used as an authentication mechanism to access your data models.

Parameters:

description - The API key description for API_KEY, if it was used as an authentication mechanism to access your data models.

Returns:

Returns a reference to this object so that method calls can be chained together.

setExpirationTime

public void setExpirationTime(Double expirationTime)

The API key expiration time for API_KEY, if it was used as an authentication mechanism to access your data models.

Parameters:

expirationTime - The API key expiration time for API_KEY, if it was used as an authentication mechanism to access your data models.

getExpirationTime

public Double getExpirationTime()

The API key expiration time for API_KEY, if it was used as an authentication mechanism to access your data models.

Returns:

The API key expiration time for API_KEY, if it was used as an authentication mechanism to access your data models.

withExpirationTime

public BackendAPIAppSyncAuthSettings withExpirationTime(Double expirationTime)

The API key expiration time for API_KEY, if it was used as an authentication mechanism to access your data models.

Parameters:

expirationTime - The API key expiration time for API_KEY, if it was used as an authentication mechanism to access your data models.

Returns:

Returns a reference to this object so that method calls can be chained together.

setOpenIDAuthTTL

public void setOpenIDAuthTTL(String openIDAuthTTL)

The expiry time for the OpenID authentication mechanism.

Parameters:

openIDAuthTTL - The expiry time for the OpenID authentication mechanism.

getOpenIDAuthTTL

public String getOpenIDAuthTTL()

The expiry time for the OpenID authentication mechanism.

Returns:

The expiry time for the OpenID authentication mechanism.

withOpenIDAuthTTL

public BackendAPIAppSyncAuthSettings withOpenIDAuthTTL(String openIDAuthTTL)

The expiry time for the OpenID authentication mechanism.

Parameters:

openIDAuthTTL - The expiry time for the OpenID authentication mechanism.

Returns:

Returns a reference to this object so that method calls can be chained together.

setOpenIDClientId

public void setOpenIDClientId(String openIDClientId)

The clientID for openID, if openID was used as an authentication setting to access your data models.

Parameters:

openIDClientId - The clientID for openID, if openID was used as an authentication setting to access your data models.

getOpenIDClientId

public String getOpenIDClientId()

The clientID for openID, if openID was used as an authentication setting to access your data models.

Returns:

The clientID for openID, if openID was used as an authentication setting to access your data models.

withOpenIDClientId

public BackendAPIAppSyncAuthSettings withOpenIDClientId(String openIDClientId)

The clientID for openID, if openID was used as an authentication setting to access your data models.

Parameters:

openIDClientId - The clientID for openID, if openID was used as an authentication setting to access your data models.

Returns:

Returns a reference to this object so that method calls can be chained together.

setOpenIDIatTTL

public void setOpenIDIatTTL(String openIDIatTTL)

The expiry time for the OpenID authentication mechanism.

Parameters:

openIDIatTTL - The expiry time for the OpenID authentication mechanism.

getOpenIDIatTTL

public String getOpenIDIatTTL()

The expiry time for the OpenID authentication mechanism.

Returns:

The expiry time for the OpenID authentication mechanism.

withOpenIDIatTTL

public BackendAPIAppSyncAuthSettings withOpenIDIatTTL(String openIDIatTTL)

The expiry time for the OpenID authentication mechanism.

Parameters:

openIDIatTTL - The expiry time for the OpenID authentication mechanism.

Returns:

Returns a reference to this object so that method calls can be chained together.

setOpenIDIssueURL

public void setOpenIDIssueURL(String openIDIssueURL)

The openID issuer URL, if openID was used as an authentication setting to access your data models.

Parameters:

openIDIssueURL - The openID issuer URL, if openID was used as an authentication setting to access your data models.

getOpenIDIssueURL

public String getOpenIDIssueURL()

The openID issuer URL, if openID was used as an authentication setting to access your data models.

Returns:

The openID issuer URL, if openID was used as an authentication setting to access your data models.

withOpenIDIssueURL

public BackendAPIAppSyncAuthSettings withOpenIDIssueURL(String openIDIssueURL)

The openID issuer URL, if openID was used as an authentication setting to access your data models.

Parameters:

openIDIssueURL - The openID issuer URL, if openID was used as an authentication setting to access your data models.

Returns:

Returns a reference to this object so that method calls can be chained together.

setOpenIDProviderName

public void setOpenIDProviderName(String openIDProviderName)

The OpenID provider name, if OpenID was used as an authentication mechanism to access your data models.

Parameters:

openIDProviderName - The OpenID provider name, if OpenID was used as an authentication mechanism to access your data models.

getOpenIDProviderName

public String getOpenIDProviderName()

The OpenID provider name, if OpenID was used as an authentication mechanism to access your data models.

Returns:

The OpenID provider name, if OpenID was used as an authentication mechanism to access your data models.

withOpenIDProviderName

public BackendAPIAppSyncAuthSettings withOpenIDProviderName(String openIDProviderName)

The OpenID provider name, if OpenID was used as an authentication mechanism to access your data models.

Parameters:

openIDProviderName - The OpenID provider name, if OpenID was used as an authentication mechanism to access your data models.

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. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public BackendAPIAppSyncAuthSettings clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Specified by:

marshall in interface StructuredPojo