Package software.amazon.awscdk.services.iam

Class SamlProviderProps.Builder

java.lang.Object
software.amazon.awscdk.services.iam.SamlProviderProps.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<SamlProviderProps>
Enclosing interface:
SamlProviderProps
@Stability(Stable) public static final class SamlProviderProps.Builder extends Object implements software.amazon.jsii.Builder<SamlProviderProps>
A builder for SamlProviderProps

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • metadataDocument

      @Stability(Stable) public SamlProviderProps.Builder metadataDocument(SamlMetadataDocument metadataDocument)
      Sets the value of SamlProviderProps.getMetadataDocument()
      Parameters:
      metadataDocument - 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. This parameter is required.
      Returns:
      this

    • name

      @Stability(Stable) public SamlProviderProps.Builder name(String name)
      Sets the value of SamlProviderProps.getName()
      Parameters:
      name - The name of the provider to create. This parameter allows a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

      Length must be between 1 and 128 characters.

      Returns:
      this

    • build

      @Stability(Stable) public SamlProviderProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<SamlProviderProps>
      Returns:
      a new instance of SamlProviderProps
      Throws:
      NullPointerException - if any required attribute was not provided