Class CfnPortal

This resource specifies a web portal, which users use to start browsing sessions.

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

A Standard web portal can't start browsing sessions unless you have at defined and associated an IdentityProvider and NetworkSettings resource. An IAM Identity Center web portal does not require an IdentityProvider resource.

For more information about web portals, see What is Amazon WorkSpaces Secure Browser? .

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

CloudformationResource: AWS::WorkSpacesWeb::Portal

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 cfnPortal = new CfnPortal(this, "MyCfnPortal", new CfnPortalProps {
    AdditionalEncryptionContext = new Dictionary<string, string> {
        { "additionalEncryptionContextKey", "additionalEncryptionContext" }
    },
    AuthenticationType = "authenticationType",
    BrowserSettingsArn = "browserSettingsArn",
    CustomerManagedKey = "customerManagedKey",
    DataProtectionSettingsArn = "dataProtectionSettingsArn",
    DisplayName = "displayName",
    InstanceType = "instanceType",
    IpAccessSettingsArn = "ipAccessSettingsArn",
    MaxConcurrentSessions = 123,
    NetworkSettingsArn = "networkSettingsArn",
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } },
    TrustStoreArn = "trustStoreArn",
    UserAccessLoggingSettingsArn = "userAccessLoggingSettingsArn",
    UserSettingsArn = "userSettingsArn"
});

Synopsis

Constructors

CfnPortal(ByRefValue)

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

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

Properties

AdditionalEncryptionContext

The additional encryption context of the portal.
AttrBrowserType

The browser that users see when using a streaming session.
AttrCreationDate

The creation date of the web portal.
AttrPortalArn

The ARN of the web portal.
AttrPortalEndpoint

The endpoint URL of the web portal that users access in order to start streaming sessions.
AttrPortalStatus

The status of the web portal.
AttrRendererType

The renderer that is used in streaming sessions.
AttrServiceProviderSamlMetadata

The SAML metadata of the service provider.
AttrStatusReason

A message that explains why the web portal is in its current status.
AuthenticationType

The type of authentication integration points used when signing into the web portal.
BrowserSettingsArn

The ARN of the browser settings that is associated with this web portal.
CdkTagManager

Tag Manager which manages the tags for this resource.
CFN_RESOURCE_TYPE_NAME

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

The customer managed key of the web portal.
DataProtectionSettingsArn

The ARN of the data protection settings.
DisplayName

The name of the web portal.
InstanceType

The type and resources of the underlying instance.
IpAccessSettingsArn

The ARN of the IP access settings that is associated with the web portal.
MaxConcurrentSessions

The maximum number of concurrent sessions for the portal.
NetworkSettingsArn

The ARN of the network settings that is associated with the web portal.
Tags

The tags to add to the web portal.
TrustStoreArn

The ARN of the trust store that is associated with the web portal.
UserAccessLoggingSettingsArn

The ARN of the user access logging settings that is associated with the web portal.
UserSettingsArn

The ARN of the user settings that is associated with the web portal.

Methods

Inspect(TreeInspector)

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

Constructors

CfnPortal(ByRefValue)

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

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

The Javascript-owned object reference

CfnPortal(DeputyBase.DeputyProps)

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

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

The deputy props

CfnPortal(Construct, String, ICfnPortalProps)

public CfnPortal(Construct scope, string id, ICfnPortalProps props = null)
Parameters
scope Constructs.Construct

Scope in which this resource is defined.

id System.String

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

props ICfnPortalProps

Resource properties.

Properties

AdditionalEncryptionContext

The additional encryption context of the portal.

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

System.Object

AttrBrowserType

The browser that users see when using a streaming session.

public virtual string AttrBrowserType { get; }
Property Value

System.String

Remarks

CloudformationAttribute: BrowserType

AttrCreationDate

The creation date of the web portal.

public virtual string AttrCreationDate { get; }
Property Value

System.String

Remarks

CloudformationAttribute: CreationDate

AttrPortalArn

The ARN of the web portal.

public virtual string AttrPortalArn { get; }
Property Value

System.String

Remarks

CloudformationAttribute: PortalArn

AttrPortalEndpoint

The endpoint URL of the web portal that users access in order to start streaming sessions.

public virtual string AttrPortalEndpoint { get; }
Property Value

System.String

Remarks

CloudformationAttribute: PortalEndpoint

AttrPortalStatus

The status of the web portal.

public virtual string AttrPortalStatus { get; }
Property Value

System.String

Remarks

CloudformationAttribute: PortalStatus

AttrRendererType

The renderer that is used in streaming sessions.

public virtual string AttrRendererType { get; }
Property Value

System.String

Remarks

CloudformationAttribute: RendererType

AttrServiceProviderSamlMetadata

The SAML metadata of the service provider.

public virtual string AttrServiceProviderSamlMetadata { get; }
Property Value

System.String

Remarks

CloudformationAttribute: ServiceProviderSamlMetadata

AttrStatusReason

A message that explains why the web portal is in its current status.

public virtual string AttrStatusReason { get; }
Property Value

System.String

Remarks

CloudformationAttribute: StatusReason

AuthenticationType

The type of authentication integration points used when signing into the web portal.

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

System.String

Remarks

Defaults to Standard .

BrowserSettingsArn

The ARN of the browser settings that is associated with this web portal.

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

System.String

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

CustomerManagedKey

The customer managed key of the web portal.

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

System.String

DataProtectionSettingsArn

The ARN of the data protection settings.

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

System.String

DisplayName

The name of the web portal.

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

System.String

InstanceType

The type and resources of the underlying instance.

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

System.String

IpAccessSettingsArn

The ARN of the IP access settings that is associated with the web portal.

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

System.String

MaxConcurrentSessions

The maximum number of concurrent sessions for the portal.

public virtual Nullable<double> MaxConcurrentSessions { get; set; }
Property Value

System.Nullable<System.Double>

NetworkSettingsArn

The ARN of the network settings that is associated with the web portal.

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

System.String

Tags

The tags to add to the web portal.

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

ICfnTag[]

TrustStoreArn

The ARN of the trust store that is associated with the web portal.

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

System.String

UserAccessLoggingSettingsArn

The ARN of the user access logging settings that is associated with the web portal.

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

System.String

UserSettingsArn

The ARN of the user settings that is associated with the web portal.

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

System.String

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