com.amazonaws.services.workspacesweb.model

Class CreateIdentityProviderRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.workspacesweb.model.CreateIdentityProviderRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateIdentityProviderRequest()

Method Summary

Modifier and Type	Method and Description
CreateIdentityProviderRequest	addIdentityProviderDetailsEntry(String key, String value) Add a single IdentityProviderDetails entry
CreateIdentityProviderRequest	clearIdentityProviderDetailsEntries() Removes all the entries added into IdentityProviderDetails.
CreateIdentityProviderRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getClientToken() A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
Map<String,String>	getIdentityProviderDetails() The identity provider details.
String	getIdentityProviderName() The identity provider name.
String	getIdentityProviderType() The identity provider type.
String	getPortalArn() The ARN of the web portal.
List<Tag>	getTags() The tags to add to the identity provider resource.
int	hashCode()
void	setClientToken(String clientToken) A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
void	setIdentityProviderDetails(Map<String,String> identityProviderDetails) The identity provider details.
void	setIdentityProviderName(String identityProviderName) The identity provider name.
void	setIdentityProviderType(String identityProviderType) The identity provider type.
void	setPortalArn(String portalArn) The ARN of the web portal.
void	setTags(Collection<Tag> tags) The tags to add to the identity provider resource.
String	toString() Returns a string representation of this object.
CreateIdentityProviderRequest	withClientToken(String clientToken) A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
CreateIdentityProviderRequest	withIdentityProviderDetails(Map<String,String> identityProviderDetails) The identity provider details.
CreateIdentityProviderRequest	withIdentityProviderName(String identityProviderName) The identity provider name.
CreateIdentityProviderRequest	withIdentityProviderType(IdentityProviderType identityProviderType) The identity provider type.
CreateIdentityProviderRequest	withIdentityProviderType(String identityProviderType) The identity provider type.
CreateIdentityProviderRequest	withPortalArn(String portalArn) The ARN of the web portal.
CreateIdentityProviderRequest	withTags(Collection<Tag> tags) The tags to add to the identity provider resource.
CreateIdentityProviderRequest	withTags(Tag... tags) The tags to add to the identity provider resource.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateIdentityProviderRequest

public CreateIdentityProviderRequest()

Method Detail

setClientToken

public void setClientToken(String clientToken)

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.

If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

Parameters:

clientToken - A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.

If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

getClientToken

public String getClientToken()

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.

If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

Returns:

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.

If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

withClientToken

public CreateIdentityProviderRequest withClientToken(String clientToken)

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.

If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

Parameters:

clientToken - A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.

If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

Returns:

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

getIdentityProviderDetails

public Map<String,String> getIdentityProviderDetails()

The identity provider details. The following list describes the provider detail keys for each identity provider type.

• For Google and Login with Amazon:

  • client_id

  • client_secret

  • authorize_scopes

• For Facebook:

  • client_id

  • client_secret

  • authorize_scopes

  • api_version

• For Sign in with Apple:

  • client_id

  • team_id

  • key_id

  • private_key

  • authorize_scopes

• For OIDC providers:

  • client_id

  • client_secret

  • attributes_request_method

  • oidc_issuer

  • authorize_scopes

  • authorize_url if not available from discovery URL specified by oidc_issuer key

  • token_url if not available from discovery URL specified by oidc_issuer key

  • attributes_url if not available from discovery URL specified by oidc_issuer key

  • jwks_uri if not available from discovery URL specified by oidc_issuer key

• For SAML providers:

  • MetadataFile OR MetadataURL

  • IDPSignout (boolean) optional

  • IDPInit (boolean) optional

  • RequestSigningAlgorithm (string) optional - Only accepts rsa-sha256

  • EncryptedResponses (boolean) optional

Returns:

The identity provider details. The following list describes the provider detail keys for each identity provider type.

• For Google and Login with Amazon:

  • client_id

  • client_secret

  • authorize_scopes

• For Facebook:

  • client_id

  • client_secret

  • authorize_scopes

  • api_version

• For Sign in with Apple:

  • client_id

  • team_id

  • key_id

  • private_key

  • authorize_scopes

• For OIDC providers:

  • client_id

  • client_secret

  • attributes_request_method

  • oidc_issuer

  • authorize_scopes

  • authorize_url if not available from discovery URL specified by oidc_issuer key

  • token_url if not available from discovery URL specified by oidc_issuer key

  • attributes_url if not available from discovery URL specified by oidc_issuer key

  • jwks_uri if not available from discovery URL specified by oidc_issuer key

• For SAML providers:

  • MetadataFile OR MetadataURL

  • IDPSignout (boolean) optional

  • IDPInit (boolean) optional

  • RequestSigningAlgorithm (string) optional - Only accepts rsa-sha256

  • EncryptedResponses (boolean) optional

setIdentityProviderDetails

public void setIdentityProviderDetails(Map<String,String> identityProviderDetails)

The identity provider details. The following list describes the provider detail keys for each identity provider type.

• For Google and Login with Amazon:

  • client_id

  • client_secret

  • authorize_scopes

• For Facebook:

  • client_id

  • client_secret

  • authorize_scopes

  • api_version

• For Sign in with Apple:

  • client_id

  • team_id

  • key_id

  • private_key

  • authorize_scopes

• For OIDC providers:

  • client_id

  • client_secret

  • attributes_request_method

  • oidc_issuer

  • authorize_scopes

  • authorize_url if not available from discovery URL specified by oidc_issuer key

  • token_url if not available from discovery URL specified by oidc_issuer key

  • attributes_url if not available from discovery URL specified by oidc_issuer key

  • jwks_uri if not available from discovery URL specified by oidc_issuer key

• For SAML providers:

  • MetadataFile OR MetadataURL

  • IDPSignout (boolean) optional

  • IDPInit (boolean) optional

  • RequestSigningAlgorithm (string) optional - Only accepts rsa-sha256

  • EncryptedResponses (boolean) optional

Parameters:

identityProviderDetails - The identity provider details. The following list describes the provider detail keys for each identity provider type.

• For Google and Login with Amazon:

  • client_id

  • client_secret

  • authorize_scopes

• For Facebook:

  • client_id

  • client_secret

  • authorize_scopes

  • api_version

• For Sign in with Apple:

  • client_id

  • team_id

  • key_id

  • private_key

  • authorize_scopes

• For OIDC providers:

  • client_id

  • client_secret

  • attributes_request_method

  • oidc_issuer

  • authorize_scopes

  • authorize_url if not available from discovery URL specified by oidc_issuer key

  • token_url if not available from discovery URL specified by oidc_issuer key

  • attributes_url if not available from discovery URL specified by oidc_issuer key

  • jwks_uri if not available from discovery URL specified by oidc_issuer key

• For SAML providers:

  • MetadataFile OR MetadataURL

  • IDPSignout (boolean) optional

  • IDPInit (boolean) optional

  • RequestSigningAlgorithm (string) optional - Only accepts rsa-sha256

  • EncryptedResponses (boolean) optional

withIdentityProviderDetails

public CreateIdentityProviderRequest withIdentityProviderDetails(Map<String,String> identityProviderDetails)

The identity provider details. The following list describes the provider detail keys for each identity provider type.

• For Google and Login with Amazon:

  • client_id

  • client_secret

  • authorize_scopes

• For Facebook:

  • client_id

  • client_secret

  • authorize_scopes

  • api_version

• For Sign in with Apple:

  • client_id

  • team_id

  • key_id

  • private_key

  • authorize_scopes

• For OIDC providers:

  • client_id

  • client_secret

  • attributes_request_method

  • oidc_issuer

  • authorize_scopes

  • authorize_url if not available from discovery URL specified by oidc_issuer key

  • token_url if not available from discovery URL specified by oidc_issuer key

  • attributes_url if not available from discovery URL specified by oidc_issuer key

  • jwks_uri if not available from discovery URL specified by oidc_issuer key

• For SAML providers:

  • MetadataFile OR MetadataURL

  • IDPSignout (boolean) optional

  • IDPInit (boolean) optional

  • RequestSigningAlgorithm (string) optional - Only accepts rsa-sha256

  • EncryptedResponses (boolean) optional

Parameters:

identityProviderDetails - The identity provider details. The following list describes the provider detail keys for each identity provider type.

• For Google and Login with Amazon:

  • client_id

  • client_secret

  • authorize_scopes

• For Facebook:

  • client_id

  • client_secret

  • authorize_scopes

  • api_version

• For Sign in with Apple:

  • client_id

  • team_id

  • key_id

  • private_key

  • authorize_scopes

• For OIDC providers:

  • client_id

  • client_secret

  • attributes_request_method

  • oidc_issuer

  • authorize_scopes

  • authorize_url if not available from discovery URL specified by oidc_issuer key

  • token_url if not available from discovery URL specified by oidc_issuer key

  • attributes_url if not available from discovery URL specified by oidc_issuer key

  • jwks_uri if not available from discovery URL specified by oidc_issuer key

• For SAML providers:

  • MetadataFile OR MetadataURL

  • IDPSignout (boolean) optional

  • IDPInit (boolean) optional

  • RequestSigningAlgorithm (string) optional - Only accepts rsa-sha256

  • EncryptedResponses (boolean) optional

Returns:

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

addIdentityProviderDetailsEntry

public CreateIdentityProviderRequest addIdentityProviderDetailsEntry(String key,
                                                                     String value)

Add a single IdentityProviderDetails entry

See Also:

withIdentityProviderDetails(java.util.Map<java.lang.String, java.lang.String>)

clearIdentityProviderDetailsEntries

public CreateIdentityProviderRequest clearIdentityProviderDetailsEntries()

Removes all the entries added into IdentityProviderDetails.

Returns:

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

setIdentityProviderName

public void setIdentityProviderName(String identityProviderName)

The identity provider name.

Parameters:

identityProviderName - The identity provider name.

getIdentityProviderName

public String getIdentityProviderName()

The identity provider name.

Returns:

The identity provider name.

withIdentityProviderName

public CreateIdentityProviderRequest withIdentityProviderName(String identityProviderName)

The identity provider name.

Parameters:

identityProviderName - The identity provider name.

Returns:

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

setIdentityProviderType

public void setIdentityProviderType(String identityProviderType)

The identity provider type.

Parameters:

identityProviderType - The identity provider type.

See Also:

IdentityProviderType

getIdentityProviderType

public String getIdentityProviderType()

The identity provider type.

Returns:

The identity provider type.

See Also:

IdentityProviderType

withIdentityProviderType

public CreateIdentityProviderRequest withIdentityProviderType(String identityProviderType)

The identity provider type.

Parameters:

identityProviderType - The identity provider type.

Returns:

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

See Also:

IdentityProviderType

withIdentityProviderType

public CreateIdentityProviderRequest withIdentityProviderType(IdentityProviderType identityProviderType)

The identity provider type.

Parameters:

identityProviderType - The identity provider type.

Returns:

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

See Also:

IdentityProviderType

setPortalArn

public void setPortalArn(String portalArn)

The ARN of the web portal.

Parameters:

portalArn - The ARN of the web portal.

getPortalArn

public String getPortalArn()

The ARN of the web portal.

Returns:

The ARN of the web portal.

withPortalArn

public CreateIdentityProviderRequest withPortalArn(String portalArn)

The ARN of the web portal.

Parameters:

portalArn - The ARN of the web portal.

Returns:

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

getTags

public List<Tag> getTags()

The tags to add to the identity provider resource. A tag is a key-value pair.

Returns:

The tags to add to the identity provider resource. A tag is a key-value pair.

setTags

public void setTags(Collection<Tag> tags)

The tags to add to the identity provider resource. A tag is a key-value pair.

Parameters:

tags - The tags to add to the identity provider resource. A tag is a key-value pair.

withTags

public CreateIdentityProviderRequest withTags(Tag... tags)

The tags to add to the identity provider resource. A tag is a key-value pair.

NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.

Parameters:

tags - The tags to add to the identity provider resource. A tag is a key-value pair.

Returns:

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

withTags

public CreateIdentityProviderRequest withTags(Collection<Tag> tags)

The tags to add to the identity provider resource. A tag is a key-value pair.

Parameters:

tags - The tags to add to the identity provider resource. A tag is a key-value pair.

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 CreateIdentityProviderRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()