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.97.0 (build 729de35)",
date="2024-04-24T21:00:27.467Z")
@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") .providerName("providerName") .providerType("providerType") .userPoolId("userPoolId") // the properties below are optional .attributeMapping(attributeMapping) .idpIdentifiers(List.of("idpIdentifiers")) .providerDetails(providerDetails) .build();
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
A fluent builder forCfnUserPoolIdentityProvider
.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
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
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 TypeMethodDescriptionA mapping of IdP attributes to standard and custom user pool attributes.The resource ID.A list of IdP identifiers.The scopes, URLs, and identifiers for your external identity provider.The IdP name.The IdP type.The user pool ID.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.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
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
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- 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 classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrId
The resource ID. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getProviderName
The IdP name. -
setProviderName
The IdP name. -
getProviderType
The IdP type. -
setProviderType
The IdP type. -
getUserPoolId
The user pool ID. -
setUserPoolId
The user pool ID. -
getAttributeMapping
A mapping of IdP attributes to standard and custom user pool attributes. -
setAttributeMapping
A mapping of IdP attributes to standard and custom user pool attributes. -
getIdpIdentifiers
A list of IdP identifiers. -
setIdpIdentifiers
A list of IdP identifiers. -
getProviderDetails
The scopes, URLs, and identifiers for your external identity provider. -
setProviderDetails
The scopes, URLs, and identifiers for your external identity provider.
-