AWS CDK Reference

Appearance

v2.275.0

CfnIdentityProviderProps Struct ​

Properties for defining a CfnIdentityProvider.

Source
Generated code
Type last changed
v2.161.0 · 4 Oct 2024

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_workspacesweb as workspacesweb } from 'aws-cdk-lib';
const cfnIdentityProviderProps: workspacesweb.CfnIdentityProviderProps = {
  identityProviderDetails: {
    identityProviderDetailsKey: 'identityProviderDetails',
  },
  identityProviderName: 'identityProviderName',
  identityProviderType: 'identityProviderType',

  // the properties below are optional
  portalArn: 'portalArn',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties ​

identityProviderDetailsIResolvable | { [key: string]: string }identity_provider_detailstyping.Union[IResolvable, typing.Mapping[str, str]]identityProviderDetailsIResolvableIdentityProviderDetailsIResolvableIdentityProviderDetailsinterface{}required#
The identity provider details. The following list describes the provider detail keys for each identity provider type.
notes

  • 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

identityProviderNamestringidentity_provider_namestridentityProviderNameStringIdentityProviderNamestringIdentityProviderName*stringrequired#
The identity provider name.
identityProviderTypestringidentity_provider_typestridentityProviderTypeStringIdentityProviderTypestringIdentityProviderType*stringrequired#
The identity provider type.
portalArnoptionalstringportal_arnoptionalstrportalArnoptionalStringPortalArnoptionalstringPortalArnoptional*string#
The ARN of the identity provider.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#