com.amazonaws.services.identitymanagement.model

Class CreateSAMLProviderRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.identitymanagement.model.CreateSAMLProviderRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class CreateSAMLProviderRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the CreateSAMLProvider operation.

Creates an IAM entity to describe an identity provider (IdP) that supports SAML 2.0.

The SAML provider that you create with this operation can be used as a principal in a role's trust policy to establish a trust relationship between AWS and a SAML identity provider. You can create an IAM role that supports Web-based single sign-on (SSO) to the AWS Management Console or one that supports API access to AWS.

When you create the SAML provider, you upload an a SAML metadata document that you get from your IdP and that includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that are received from the IdP. You must generate the metadata document using the identity management software that is used as your organization's IdP.

NOTE: This operation requires Signature Version 4.

For more information, see Enabling SAML 2.0 Federated Users to Access the AWS Management Console and About SAML 2.0-based Federation in the IAM User Guide .

See Also:

AmazonIdentityManagement.createSAMLProvider(CreateSAMLProviderRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateSAMLProviderRequest()

Method Summary

Methods

Modifier and Type	Method and Description
CreateSAMLProviderRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getName() The name of the provider to create.
String	getSAMLMetadataDocument() An XML document generated by an identity provider (IdP) that supports SAML 2.0.
int	hashCode()
void	setName(String name) The name of the provider to create.
void	setSAMLMetadataDocument(String sAMLMetadataDocument) An XML document generated by an identity provider (IdP) that supports SAML 2.0.
String	toString() Returns a string representation of this object; useful for testing and debugging.
CreateSAMLProviderRequest	withName(String name) The name of the provider to create.
CreateSAMLProviderRequest	withSAMLMetadataDocument(String sAMLMetadataDocument) An XML document generated by an identity provider (IdP) that supports SAML 2.0.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

CreateSAMLProviderRequest

public CreateSAMLProviderRequest()

Method Detail

getSAMLMetadataDocument

public String getSAMLMetadataDocument()

An XML document generated by an identity provider (IdP) that supports SAML 2.0. The document includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that are received from the IdP. You must generate the metadata document using the identity management software that is used as your organization's IdP.

For more information, see About SAML 2.0-based Federation in the IAM User Guide

Constraints:
Length: 1000 - 10000000

Returns:

An XML document generated by an identity provider (IdP) that supports SAML 2.0. The document includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that are received from the IdP. You must generate the metadata document using the identity management software that is used as your organization's IdP.

For more information, see About SAML 2.0-based Federation in the IAM User Guide

setSAMLMetadataDocument

public void setSAMLMetadataDocument(String sAMLMetadataDocument)

An XML document generated by an identity provider (IdP) that supports SAML 2.0. The document includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that are received from the IdP. You must generate the metadata document using the identity management software that is used as your organization's IdP.

For more information, see About SAML 2.0-based Federation in the IAM User Guide

Constraints:
Length: 1000 - 10000000

Parameters:

sAMLMetadataDocument - An XML document generated by an identity provider (IdP) that supports SAML 2.0. The document includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that are received from the IdP. You must generate the metadata document using the identity management software that is used as your organization's IdP.

For more information, see About SAML 2.0-based Federation in the IAM User Guide

withSAMLMetadataDocument

public CreateSAMLProviderRequest withSAMLMetadataDocument(String sAMLMetadataDocument)

An XML document generated by an identity provider (IdP) that supports SAML 2.0. The document includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that are received from the IdP. You must generate the metadata document using the identity management software that is used as your organization's IdP.

For more information, see About SAML 2.0-based Federation in the IAM User Guide

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

Constraints:
Length: 1000 - 10000000

Parameters:

sAMLMetadataDocument - An XML document generated by an identity provider (IdP) that supports SAML 2.0. The document includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that are received from the IdP. You must generate the metadata document using the identity management software that is used as your organization's IdP.

For more information, see About SAML 2.0-based Federation in the IAM User Guide

Returns:

A reference to this updated object so that method calls can be chained together.

getName

public String getName()

The name of the provider to create.

Constraints:
Length: 1 - 128
Pattern: [\w._-]+

Returns:

The name of the provider to create.

setName

public void setName(String name)

The name of the provider to create.

Constraints:
Length: 1 - 128
Pattern: [\w._-]+

Parameters:

name - The name of the provider to create.

withName

public CreateSAMLProviderRequest withName(String name)

The name of the provider to create.

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

Constraints:
Length: 1 - 128
Pattern: [\w._-]+

Parameters:

name - The name of the provider to create.

Returns:

A reference to this updated 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 class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public CreateSAMLProviderRequest 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 class AmazonWebServiceRequest

See Also:

Object.clone()