Package software.amazon.awscdk.services.cognito

Class CfnUserPoolIdentityProvider

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.cognito.CfnUserPoolIdentityProvider

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-21T06:34:05.550Z")
@Stability(Stable)
public class CfnUserPoolIdentityProvider
extends CfnResource
implements IInspectable

The AWS::Cognito::UserPoolIdentityProvider resource creates an identity provider for a user pool.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cognito.*;
 Object attributeMapping;
 Object providerDetails;
 CfnUserPoolIdentityProvider cfnUserPoolIdentityProvider = CfnUserPoolIdentityProvider.Builder.create(this, "MyCfnUserPoolIdentityProvider")
         .providerDetails(providerDetails)
         .providerName("providerName")
         .providerType("providerType")
         .userPoolId("userPoolId")
         // the properties below are optional
         .attributeMapping(attributeMapping)
         .idpIdentifiers(List.of("idpIdentifiers"))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolidentityprovider.html

Nested Class Summary

Nested Classes

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

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.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Object	getAttributeMapping()	A mapping of IdP attributes to standard and custom user pool attributes.
protected Map<String,Object>	getCfnProperties()
List<String>	getIdpIdentifiers()	A list of IdP identifiers.
Object	getProviderDetails()	The scopes, URLs, and identifiers for your external identity provider.
String	getProviderName()	The IdP name.
String	getProviderType()	The IdP type.
String	getUserPoolId()	The user pool ID.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAttributeMapping(Object value)	A mapping of IdP attributes to standard and custom user pool attributes.
void	setIdpIdentifiers(List<String> value)	A list of IdP identifiers.
void	setProviderDetails(Object value)	The scopes, URLs, and identifiers for your external identity provider.
void	setProviderName(String value)	The IdP name.
void	setProviderType(String value)	The IdP type.
void	setUserPoolId(String value)	The user pool ID.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnUserPoolIdentityProvider

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

CfnUserPoolIdentityProvider

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

CfnUserPoolIdentityProvider

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

Parameters:

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

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getProviderDetails

@Stability(Stable)
@NotNull
public Object getProviderDetails()

The scopes, URLs, and identifiers for your external identity provider.

setProviderDetails

@Stability(Stable)
public void setProviderDetails(@NotNull
 Object value)

The scopes, URLs, and identifiers for your external identity provider.

getProviderName

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

The IdP name.

setProviderName

@Stability(Stable)
public void setProviderName(@NotNull
 String value)

The IdP name.

getProviderType

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

The IdP type.

setProviderType

@Stability(Stable)
public void setProviderType(@NotNull
 String value)

The IdP type.

getUserPoolId

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

The user pool ID.

setUserPoolId

@Stability(Stable)
public void setUserPoolId(@NotNull
 String value)

The user pool ID.

getAttributeMapping

@Stability(Stable)
@Nullable
public Object getAttributeMapping()

A mapping of IdP attributes to standard and custom user pool attributes.

setAttributeMapping

@Stability(Stable)
public void setAttributeMapping(@Nullable
 Object value)

A mapping of IdP attributes to standard and custom user pool attributes.

getIdpIdentifiers

@Stability(Stable)
@Nullable
public List<String> getIdpIdentifiers()

A list of IdP identifiers.

setIdpIdentifiers

@Stability(Stable)
public void setIdpIdentifiers(@Nullable
 List<String> value)

A list of IdP identifiers.