Class CfnIdentityProvider

This resource specifies an identity provider that is then associated with a web portal.

Inheritance
System.Object
CfnElement
CfnRefElement
CfnResource
CfnIdentityProvider
Inherited Members
Namespace: Amazon.CDK.AwsWorkspacesweb
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnIdentityProvider : CfnResource, IInspectable, ITaggableV2
Syntax (vb)
Public Class CfnIdentityProvider
    Inherits CfnResource
    Implements IInspectable, ITaggableV2
Remarks

This resource is not required if your portal's AuthenticationType is IAM Identity Center.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-identityprovider.html

CloudformationResource: AWS::WorkSpacesWeb::IdentityProvider

ExampleMetadata: fixture=_generated

Examples
// 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 cfnIdentityProvider = new CfnIdentityProvider(this, "MyCfnIdentityProvider", 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"
    } }
});

Synopsis

Constructors

CfnIdentityProvider(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference
CfnIdentityProvider(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps
CfnIdentityProvider(Construct, String, ICfnIdentityProviderProps)

Properties

AttrIdentityProviderArn

The ARN of the identity provider.
CdkTagManager

Tag Manager which manages the tags for this resource.
CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CfnProperties
IdentityProviderDetails

The identity provider details.
IdentityProviderName

The identity provider name.
IdentityProviderType

The identity provider type.
PortalArn

The ARN of the identity provider.
Tags

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<String, Object>)

Constructors

CfnIdentityProvider(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnIdentityProvider(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

CfnIdentityProvider(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnIdentityProvider(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

CfnIdentityProvider(Construct, String, ICfnIdentityProviderProps)

public CfnIdentityProvider(Construct scope, string id, ICfnIdentityProviderProps props)
Parameters
scope Constructs.Construct

Scope in which this resource is defined.

id System.String

Construct identifier for this resource (unique in its scope).

props ICfnIdentityProviderProps

Resource properties.

Properties

AttrIdentityProviderArn

The ARN of the identity provider.

public virtual string AttrIdentityProviderArn { get; }
Property Value

System.String

Remarks

CloudformationAttribute: IdentityProviderArn

CdkTagManager

Tag Manager which manages the tags for this resource.

public virtual TagManager CdkTagManager { get; }
Property Value

TagManager

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

System.String

CfnProperties

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

IdentityProviderDetails

The identity provider details.

public virtual object IdentityProviderDetails { get; set; }
Property Value

System.Object

Remarks

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

IdentityProviderName

The identity provider name.

public virtual string IdentityProviderName { get; set; }
Property Value

System.String

IdentityProviderType

The identity provider type.

public virtual string IdentityProviderType { get; set; }
Property Value

System.String

PortalArn

The ARN of the identity provider.

public virtual string PortalArn { get; set; }
Property Value

System.String

Tags

public virtual ICfnTag[] Tags { get; set; }
Property Value

ICfnTag[]

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)
Parameters
inspector TreeInspector

tree inspector to collect and process attributes.

RenderProperties(IDictionary<String, Object>)

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

Implements