Package software.amazon.awscdk.services.workspacesweb

Class CfnIdentityProvider

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.workspacesweb.CfnIdentityProvider
All Implemented Interfaces:
IInspectable, ITaggableV2, IIdentityProviderRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-29T11:15:50.706Z") @Stability(Stable) public class CfnIdentityProvider extends CfnResource implements IInspectable, IIdentityProviderRef, ITaggableV2
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.

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.workspacesweb.*;
 CfnIdentityProvider cfnIdentityProvider = CfnIdentityProvider.Builder.create(this, "MyCfnIdentityProvider")
         .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();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnIdentityProvider

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

    • CfnIdentityProvider

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

    • CfnIdentityProvider

      @Stability(Stable) public CfnIdentityProvider(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnIdentityProviderProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(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(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrIdentityProviderArn

      @Stability(Stable) @NotNull public String getAttrIdentityProviderArn()
      The ARN of the identity provider.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getIdentityProviderRef

      @Stability(Stable) @NotNull public IdentityProviderReference getIdentityProviderRef()
      A reference to a IdentityProvider resource.
      Specified by:
      getIdentityProviderRef in interface IIdentityProviderRef

    • getIdentityProviderDetails

      @Stability(Stable) @NotNull public Object getIdentityProviderDetails()
      The identity provider details.

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

      Returns union: either Mapinvalid input: '<'String, String> or IResolvable

    • setIdentityProviderDetails

      @Stability(Stable) public void setIdentityProviderDetails(@NotNull Map<String,String> value)
      The identity provider details.

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

    • setIdentityProviderDetails

      @Stability(Stable) public void setIdentityProviderDetails(@NotNull IResolvable value)
      The identity provider details.

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

    • getIdentityProviderName

      @Stability(Stable) @NotNull public String getIdentityProviderName()
      The identity provider name.

    • setIdentityProviderName

      @Stability(Stable) public void setIdentityProviderName(@NotNull String value)
      The identity provider name.

    • getIdentityProviderType

      @Stability(Stable) @NotNull public String getIdentityProviderType()
      The identity provider type.

    • setIdentityProviderType

      @Stability(Stable) public void setIdentityProviderType(@NotNull String value)
      The identity provider type.

    • getPortalArn

      @Stability(Stable) @Nullable public String getPortalArn()
      The ARN of the identity provider.

    • setPortalArn

      @Stability(Stable) public void setPortalArn(@Nullable String value)
      The ARN of the identity provider.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)