software.amazon.awscdk.services.iam

Class SamlProvider.Builder

java.lang.Object

software.amazon.awscdk.services.iam.SamlProvider.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<SamlProvider>

Enclosing class:

SamlProvider

@Stability(value=Experimental)
public static final class SamlProvider.Builder
extends Object
implements software.amazon.jsii.Builder<SamlProvider>

(experimental) A fluent builder for SamlProvider.

Method Summary

Modifier and Type	Method and Description
SamlProvider	build()
static SamlProvider.Builder	create(software.constructs.Construct scope, String id)
SamlProvider.Builder	metadataDocument(SamlMetadataDocument metadataDocument) (experimental) An XML document generated by an identity provider (IdP) that supports SAML 2.0.
SamlProvider.Builder	name(String name) (experimental) The name of the provider to create.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(value=Experimental)
public static SamlProvider.Builder create(software.constructs.Construct scope,
                                                                         String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of SamlProvider.Builder.

metadataDocument

@Stability(value=Experimental)
public SamlProvider.Builder metadataDocument(SamlMetadataDocument metadataDocument)

(experimental) 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.

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(value=Experimental)
public SamlProvider.Builder name(String name)

(experimental) 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.

Default: - a CloudFormation generated name

Parameters:

name - The name of the provider to create. This parameter is required.

Returns:

this

build

@Stability(value=Experimental)
public SamlProvider build()

Specified by:

build in interface software.amazon.jsii.Builder<SamlProvider>