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.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:37.639Z")
 @Stability(value=Stable)
public class CfnUserPoolIdentityProvider
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Cognito::UserPoolIdentityProvider`.

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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static 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.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

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

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnUserPoolIdentityProvider(software.constructs.Construct scope, String id, CfnUserPoolIdentityProviderProps props) Create a new `AWS::Cognito::UserPoolIdentityProvider`.
protected	CfnUserPoolIdentityProvider(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnUserPoolIdentityProvider(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and 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 IdP details.
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 IdP details.
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, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, 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 Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnUserPoolIdentityProvider

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

CfnUserPoolIdentityProvider

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

CfnUserPoolIdentityProvider

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

Create a new `AWS::Cognito::UserPoolIdentityProvider`.

Parameters:

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

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getAttributeMapping

@Stability(value=Stable)
 @NotNull
public Object getAttributeMapping()

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

setAttributeMapping

@Stability(value=Stable)
public void setAttributeMapping(@NotNull
                                                         Object value)

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

getProviderDetails

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

The IdP details. The following list describes the provider detail keys for each IdP type.

• For Google and Login with Amazon:
• client_id
• client_secret
• authorize_scopes
• For Facebook:
• client_id
• client_secret
• authorize_scopes
• api_version
• For Sign in with Apple:
• client_id
• team_id
• key_id
• private_key
• authorize_scopes
• For OpenID Connect (OIDC) providers:
• client_id
• client_secret
• attributes_request_method
• oidc_issuer
• authorize_scopes
• The following keys are only present if Amazon Cognito didn't discover them at the oidc_issuer URL.
• authorize_url
• token_url
• attributes_url
• jwks_uri
• Amazon Cognito sets the value of the following keys automatically. They are read-only.
• attributes_url_add_attributes
• For SAML providers:
• MetadataFile or MetadataURL
• IDPSignout optional

setProviderDetails

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

The IdP details. The following list describes the provider detail keys for each IdP type.

• For Google and Login with Amazon:
• client_id
• client_secret
• authorize_scopes
• For Facebook:
• client_id
• client_secret
• authorize_scopes
• api_version
• For Sign in with Apple:
• client_id
• team_id
• key_id
• private_key
• authorize_scopes
• For OpenID Connect (OIDC) providers:
• client_id
• client_secret
• attributes_request_method
• oidc_issuer
• authorize_scopes
• The following keys are only present if Amazon Cognito didn't discover them at the oidc_issuer URL.
• authorize_url
• token_url
• attributes_url
• jwks_uri
• Amazon Cognito sets the value of the following keys automatically. They are read-only.
• attributes_url_add_attributes
• For SAML providers:
• MetadataFile or MetadataURL
• IDPSignout optional

getProviderName

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

The IdP name.

setProviderName

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

The IdP name.

getProviderType

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

The IdP type.

setProviderType

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

The IdP type.

getUserPoolId

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

The user pool ID.

setUserPoolId

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

The user pool ID.

getIdpIdentifiers

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

A list of IdP identifiers.

setIdpIdentifiers

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

A list of IdP identifiers.