Interface ICfnPortalProps
Properties for defining a CfnPortal.
Namespace: Amazon.CDK.AwsWorkspacesweb
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICfnPortalPropsSyntax (vb)
Public Interface ICfnPortalPropsRemarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-portal.html
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 cfnPortalProps = 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
Properties
| AdditionalEncryptionContext | The additional encryption context of the portal. |
| AuthenticationType | The type of authentication integration points used when signing into the web portal. Defaults to |
| BrowserSettingsArn | The ARN of the browser settings that is associated with this web portal. |
| CustomerManagedKey | The customer managed key of the web portal. |
| DataProtectionSettingsArn | |
| 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. |
Properties
AdditionalEncryptionContext
The additional encryption context of the portal.
virtual object AdditionalEncryptionContext { get; }Property Value
System.Object
Remarks
AuthenticationType
The type of authentication integration points used when signing into the web portal. Defaults to Standard .
virtual string AuthenticationType { get; }Property Value
System.String
Remarks
Standard web portals are authenticated directly through your identity provider (IdP). User and group access to your web portal is controlled through your IdP. You need to include an IdP resource in your template to integrate your IdP with your web portal. Completing the configuration for your IdP requires exchanging WorkSpaces Secure Browser’s SP metadata with your IdP’s IdP metadata. If your IdP requires the SP metadata first before returning the IdP metadata, you should follow these steps:
IAM Identity Center web portals are authenticated through AWS IAM Identity Center . They provide additional features, such as IdP-initiated authentication. Identity sources (including external identity provider integration) and other identity provider information must be configured in IAM Identity Center . User and group assignment must be done through the WorkSpaces Secure Browser console. These cannot be configured in CloudFormation.
BrowserSettingsArn
The ARN of the browser settings that is associated with this web portal.
virtual string BrowserSettingsArn { get; }Property Value
System.String
Remarks
CustomerManagedKey
The customer managed key of the web portal.
virtual string CustomerManagedKey { get; }Property Value
System.String
Remarks
Pattern : ^arn:[\w+=/,.@-]+:kms:[a-zA-Z0-9-]*:[a-zA-Z0-9]{1,12}:key/[a-zA-Z0-9-]+$
DataProtectionSettingsArn
virtual string DataProtectionSettingsArn { get; }Property Value
System.String
Remarks
DisplayName
The name of the web portal.
virtual string DisplayName { get; }Property Value
System.String
Remarks
InstanceType
The type and resources of the underlying instance.
virtual string InstanceType { get; }Property Value
System.String
Remarks
IpAccessSettingsArn
The ARN of the IP access settings that is associated with the web portal.
virtual string IpAccessSettingsArn { get; }Property Value
System.String
Remarks
MaxConcurrentSessions
The maximum number of concurrent sessions for the portal.
virtual Nullable<double> MaxConcurrentSessions { get; }Property Value
System.Nullable<System.Double>
Remarks
NetworkSettingsArn
The ARN of the network settings that is associated with the web portal.
virtual string NetworkSettingsArn { get; }Property Value
System.String
Remarks
Tags
TrustStoreArn
The ARN of the trust store that is associated with the web portal.
virtual string TrustStoreArn { get; }Property Value
System.String
Remarks
UserAccessLoggingSettingsArn
The ARN of the user access logging settings that is associated with the web portal.
virtual string UserAccessLoggingSettingsArn { get; }Property Value
System.String
Remarks
UserSettingsArn
The ARN of the user settings that is associated with the web portal.
virtual string UserSettingsArn { get; }Property Value
System.String