software.amazon.awscdk.services.iam

Class SamlProvider

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.iam.SamlProvider

All Implemented Interfaces:

IConstruct, IDependable, IResource, ISamlProvider

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-25T18:28:57.829Z")
public class SamlProvider
extends Resource
implements ISamlProvider

A SAML provider.

Example:

 SamlProvider provider = SamlProvider.Builder.create(this, "Provider")
         .metadataDocument(SamlMetadataDocument.fromFile("/path/to/saml-metadata-document.xml"))
         .build();
 Role.Builder.create(this, "Role")
         .assumedBy(new SamlConsolePrincipal(provider))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SamlProvider.Builder A fluent builder for SamlProvider.

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.iam.ISamlProvider

ISamlProvider.Jsii$Default, ISamlProvider.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SamlProvider(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	SamlProvider(software.amazon.jsii.JsiiObjectRef objRef)
	SamlProvider(software.constructs.Construct scope, java.lang.String id, SamlProviderProps props)

Method Summary

Modifier and Type	Method and Description
static ISamlProvider	fromSamlProviderArn(software.constructs.Construct scope, java.lang.String id, java.lang.String samlProviderArn) Import an existing provider.
java.lang.String	getSamlProviderArn() The Amazon Resource Name (ARN) of the provider.

Methods inherited from class software.amazon.awscdk.core.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Constructor Detail

SamlProvider

protected SamlProvider(software.amazon.jsii.JsiiObjectRef objRef)

SamlProvider

protected SamlProvider(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

SamlProvider

public SamlProvider(software.constructs.Construct scope,
                    java.lang.String id,
                    SamlProviderProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

fromSamlProviderArn

public static ISamlProvider fromSamlProviderArn(software.constructs.Construct scope,
                                                java.lang.String id,
                                                java.lang.String samlProviderArn)

Import an existing provider.

Parameters:

scope - This parameter is required.

id - This parameter is required.

samlProviderArn - This parameter is required.

getSamlProviderArn

public java.lang.String getSamlProviderArn()

The Amazon Resource Name (ARN) of the provider.

Specified by:

getSamlProviderArn in interface ISamlProvider