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(Stable)
public static final class SamlProvider.Builder
extends Object
implements software.amazon.jsii.Builder<SamlProvider>
A fluent builder for
SamlProvider
.-
Method Summary
Modifier and TypeMethodDescriptionbuild()
static SamlProvider.Builder
metadataDocument
(SamlMetadataDocument metadataDocument) An XML document generated by an identity provider (IdP) that supports SAML 2.0.The name of the provider to create.
-
Method Details
-
create
@Stability(Stable) 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(Stable) public SamlProvider.Builder metadataDocument(SamlMetadataDocument 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.- 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
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
- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<SamlProvider>
- Returns:
- a newly built instance of
SamlProvider
.
-