Package software.amazon.awscdk.services.iam

Class SamlProvider

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.iam.SamlProvider

All Implemented Interfaces:

IResource, ISamlProvider, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:24:02.821Z")
@Stability(Stable)
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	Description
static final class	SamlProvider.Builder	A fluent builder for SamlProvider.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

IResource.Jsii$Default

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

ISamlProvider.Jsii$Default, ISamlProvider.Jsii$Proxy

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class software.amazon.awscdk.Resource

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

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

SamlProvider

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

SamlProvider

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

SamlProvider

@Stability(Stable)
public SamlProvider(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 SamlProviderProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Details

fromSamlProviderArn

@Stability(Stable)
@NotNull
public static ISamlProvider fromSamlProviderArn(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String samlProviderArn)

Import an existing provider.

Parameters:

scope - This parameter is required.

id - This parameter is required.

samlProviderArn - This parameter is required.

getSamlProviderArn

@Stability(Stable)
@NotNull
public String getSamlProviderArn()

The Amazon Resource Name (ARN) of the provider.

Specified by:

getSamlProviderArn in interface ISamlProvider