AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::WorkSpacesWeb::IdentityProvider

CfnIdentityProvider

This resource specifies an identity provider that is then associated with a web portal. This resource is not required if your portal's `AuthenticationType` is IAM Identity Center.

Import

import { CfnIdentityProvider } from 'aws-cdk-lib/aws-workspacesweb';

Or use the module namespace:

import * as workspacesweb from 'aws-cdk-lib/aws-workspacesweb';
// workspacesweb.CfnIdentityProvider

Properties

Configuration passed to the constructor as CfnIdentityProviderProps.

identityProviderDetailsRequired
{ [key: string]: string } | IResolvable

The identity provider details. The following list describes the provider detail keys for each identity provider 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 OIDC providers: - `client_id` - `client_secret` - `attributes_request_method` - `oidc_issuer` - `authorize_scopes` - `authorize_url` *if not available from discovery URL specified by oidc_issuer key* - `token_url` *if not available from discovery URL specified by oidc_issuer key* - `attributes_url` *if not available from discovery URL specified by oidc_issuer key* - `jwks_uri` *if not available from discovery URL specified by oidc_issuer key* - For SAML providers: - `MetadataFile` OR `MetadataURL` - `IDPSignout` (boolean) *optional* - `IDPInit` (boolean) *optional* - `RequestSigningAlgorithm` (string) *optional* - Only accepts `rsa-sha256` - `EncryptedResponses` (boolean) *optional*

identityProviderNameRequired
string

The identity provider name.

identityProviderTypeRequired
string

The identity provider type.

portalArnOptional
string

The ARN of the identity provider.

tagsOptional
CfnTag[]

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::WorkSpacesWeb::IdentityProviderView in CloudFormation Explorer

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-workspacesweb
CFN TypeAWS::WorkSpacesWeb::IdentityProvider
Properties5

Related Constructs

Explore This Service

External Links