software.amazon.awscdk.services.iam

Class CfnSAMLProvider.Builder

java.lang.Object

software.amazon.awscdk.services.iam.CfnSAMLProvider.Builder

Enclosing class:

CfnSAMLProvider

public static final class CfnSAMLProvider.Builder
extends java.lang.Object

A fluent builder for CfnSAMLProvider.

Method Summary

Modifier and Type	Method and Description
CfnSAMLProvider	build()
static CfnSAMLProvider.Builder	create(Construct scope, java.lang.String id)
CfnSAMLProvider.Builder	name(java.lang.String name) The name of the provider to create.
CfnSAMLProvider.Builder	samlMetadataDocument(java.lang.String samlMetadataDocument) An XML document generated by an identity provider (IdP) that supports SAML 2.0.
CfnSAMLProvider.Builder	tags(java.util.List<? extends CfnTag> tags) A list of tags that you want to attach to the new IAM SAML provider.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static CfnSAMLProvider.Builder create(Construct scope,
                                             java.lang.String id)

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Returns:

a new instance of CfnSAMLProvider.Builder.

samlMetadataDocument

public CfnSAMLProvider.Builder samlMetadataDocument(java.lang.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

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. This parameter is required.

Returns:

this

name

public CfnSAMLProvider.Builder name(java.lang.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: _+=,.@-

Parameters:

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

Returns:

this

tags

public CfnSAMLProvider.Builder tags(java.util.List<? extends CfnTag> 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.

Parameters:

tags - A list of tags that you want to attach to the new IAM SAML provider. This parameter is required.

Returns:

this

build

public CfnSAMLProvider build()