java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.iam.model.IamRequest
    - - software.amazon.awssdk.services.iam.model.CreateSamlProviderRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateSamlProviderRequest.Builder,CreateSamlProviderRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateSamlProviderRequest
extends IamRequest
implements ToCopyableBuilder<CreateSamlProviderRequest.Builder,CreateSamlProviderRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface CreateSamlProviderRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`addPrivateKey()`	The private key generated from your external identity provider.
`AssertionEncryptionModeType`	`assertionEncryptionMode()`	Specifies the encryption setting for the SAML provider.
`String`	`assertionEncryptionModeAsString()`	Specifies the encryption setting for the SAML provider.
`static CreateSamlProviderRequest.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTags()`	For responses, this returns true if the service returned a value for the Tags property.
`String`	`name()`	The name of the provider to create.
`String`	`samlMetadataDocument()`	An XML document generated by an identity provider (IdP) that supports SAML 2.0.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateSamlProviderRequest.Builder>`	`serializableBuilderClass()`
`List<Tag>`	`tags()`	A list of tags that you want to attach to the new IAM SAML provider.
`CreateSamlProviderRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - samlMetadataDocument
```
public final 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:
    
    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
  - name
```
public final String name()
```
    The name of the provider to create.
    
    This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
    
    Returns:
    
    The name of the provider to create.
    
    This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
  - hasTags
```
public final boolean hasTags()
```
    For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - tags
```
public final List<Tag> tags()
```
    A list of tags that you want to attach to the new IAM SAML provider. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
    
    If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.
    
    Returns:
    
    A list of tags that you want to attach to the new IAM SAML provider. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
    
    If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.
  - assertionEncryptionMode
```
public final AssertionEncryptionModeType assertionEncryptionMode()
```
    Specifies the encryption setting for the SAML provider.
    
    If the service returns an enum value that is not available in the current SDK version, assertionEncryptionMode will return AssertionEncryptionModeType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from assertionEncryptionModeAsString().
    
    Returns:
    
    Specifies the encryption setting for the SAML provider.
    
    See Also:
    
    AssertionEncryptionModeType
  - assertionEncryptionModeAsString
```
public final String assertionEncryptionModeAsString()
```
    Specifies the encryption setting for the SAML provider.
    
    If the service returns an enum value that is not available in the current SDK version, assertionEncryptionMode will return AssertionEncryptionModeType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from assertionEncryptionModeAsString().
    
    Returns:
    
    Specifies the encryption setting for the SAML provider.
    
    See Also:
    
    AssertionEncryptionModeType
  - addPrivateKey
```
public final String addPrivateKey()
```
    The private key generated from your external identity provider. The private key must be a .pem file that uses AES-GCM or AES-CBC encryption algorithm to decrypt SAML assertions.
    
    Returns:
    
    The private key generated from your external identity provider. The private key must be a .pem file that uses AES-GCM or AES-CBC encryption algorithm to decrypt SAML assertions.
  - toBuilder
```
public CreateSamlProviderRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateSamlProviderRequest.Builder,CreateSamlProviderRequest>
    
    Specified by:
    
    toBuilder in class IamRequest
  - builder
```
public static CreateSamlProviderRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateSamlProviderRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class CreateSamlProviderRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

samlMetadataDocument

name

hasTags

tags

assertionEncryptionMode

assertionEncryptionModeAsString

addPrivateKey

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField