interface CfnIdentityProviderProps

Language	Type name
.NET	`Amazon.CDK.AWS.WorkSpacesWeb.CfnIdentityProviderProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsworkspacesweb#CfnIdentityProviderProps`
Java	`software.amazon.awscdk.services.workspacesweb.CfnIdentityProviderProps`
Python	`aws_cdk.aws_workspacesweb.CfnIdentityProviderProps`
TypeScript	`aws-cdk-lib` » `aws_workspacesweb` » `CfnIdentityProviderProps`

Properties for defining a CfnIdentityProvider.

Example

// 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

Name	Type	Description
identityProviderDetails	`{ [string]: string } \|` `IResolvable`	The identity provider details. The following list describes the provider detail keys for each identity provider type.
identityProviderName	`string`	The identity provider name.
identityProviderType	`string`	The identity provider type.
portalArn?	`string`	The ARN of the identity provider.
tags?	`CfnTag[]`

identityProviderDetails

Type: { [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

identityProviderName

Type: string

The identity provider name.

identityProviderType

Type: string

The identity provider type.

portalArn?

Type: string (optional)

The ARN of the identity provider.

tags?

Type: CfnTag[] (optional)