Skip to content
v2.278.0

CfnIdentityProviderProps Struct ​

Properties for defining a CfnIdentityProvider.

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',
  }],
};
python
from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_workspacesweb as workspacesweb

cfn_identity_provider_props = workspacesweb.CfnIdentityProviderProps(
    identity_provider_details={
        "identity_provider_details_key": "identityProviderDetails"
    },
    identity_provider_name="identityProviderName",
    identity_provider_type="identityProviderType",

    # the properties below are optional
    portal_arn="portalArn",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.workspacesweb.*;

CfnIdentityProviderProps cfnIdentityProviderProps = CfnIdentityProviderProps.builder()
        .identityProviderDetails(Map.of(
                "identityProviderDetailsKey", "identityProviderDetails"))
        .identityProviderName("identityProviderName")
        .identityProviderType("identityProviderType")

        // the properties below are optional
        .portalArn("portalArn")
        .tags(List.of(CfnTag.builder()
                .key("key")
                .value("value")
                .build()))
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.WorkSpacesWeb;

var cfnIdentityProviderProps = new CfnIdentityProviderProps {
    IdentityProviderDetails = new Dictionary<string, string> {
        { "identityProviderDetailsKey", "identityProviderDetails" }
    },
    IdentityProviderName = "identityProviderName",
    IdentityProviderType = "identityProviderType",

    // the properties below are optional
    PortalArn = "portalArn",
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnIdentityProviderProps := &CfnIdentityProviderProps{
	IdentityProviderDetails: map[string]*string{
		"identityProviderDetailsKey": jsii.String("identityProviderDetails"),
	},
	IdentityProviderName: jsii.String("identityProviderName"),
	IdentityProviderType: jsii.String("identityProviderType"),

	// the properties below are optional
	PortalArn: jsii.String("portalArn"),
	Tags: []CfnTag{
		&CfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("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*string required #
The identity provider name.
identityProviderTypestringidentity_provider_typestridentityProviderTypeStringIdentityProviderTypestringIdentityProviderType*string required #
The identity provider type.
portalArnoptionalstringportal_arnoptionalstrportalArnoptionalStringPortalArnoptionalstringPortalArnoptional*string #
The ARN of the identity provider.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag #