software.amazon.awscdk.services.iam

Class CfnSAMLProviderProps.Builder

java.lang.Object

software.amazon.awscdk.services.iam.CfnSAMLProviderProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnSAMLProviderProps>

Enclosing interface:

CfnSAMLProviderProps

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

A builder for CfnSAMLProviderProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnSAMLProviderProps	build() Builds the configured instance.
CfnSAMLProviderProps.Builder	name(String name) Sets the value of CfnSAMLProviderProps.getName()
CfnSAMLProviderProps.Builder	samlMetadataDocument(String samlMetadataDocument) Sets the value of CfnSAMLProviderProps.getSamlMetadataDocument()
CfnSAMLProviderProps.Builder	tags(List<? extends CfnTag> tags) Sets the value of CfnSAMLProviderProps.getTags()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

samlMetadataDocument

@Stability(value=Stable)
public CfnSAMLProviderProps.Builder samlMetadataDocument(String samlMetadataDocument)

Sets the value of CfnSAMLProviderProps.getSamlMetadataDocument()

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. For more information, see About SAML 2.0-based federation in the IAM User Guide

Returns:

this

name

@Stability(value=Stable)
public CfnSAMLProviderProps.Builder name(String name)

Sets the value of CfnSAMLProviderProps.getName()

Parameters:

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:

this

tags

@Stability(value=Stable)
public CfnSAMLProviderProps.Builder tags(List<? extends CfnTag> tags)

Sets the value of CfnSAMLProviderProps.getTags()

Parameters:

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.

Returns:

this

build

@Stability(value=Stable)
public CfnSAMLProviderProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnSAMLProviderProps

Throws:

NullPointerException - if any required attribute was not provided