Class CfnUserAccessLoggingSettings
This resource specifies user access logging settings that can be associated with a web portal.
Inherited Members
Namespace: Amazon.CDK.AwsWorkspacesweb
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnUserAccessLoggingSettings : CfnResource, IInspectable, ITaggableV2
Syntax (vb)
Public Class CfnUserAccessLoggingSettings
Inherits CfnResource
Implements IInspectable, ITaggableV2
Remarks
In order to receive logs from WorkSpaces Secure Browser, you must have an Amazon Kinesis Data Stream that starts with "amazon-workspaces-web-*". Your Amazon Kinesis data stream must either have server-side encryption turned off, or must use AWS managed keys for server-side encryption.
For more information about setting server-side encryption in Amazon Kinesis , see How Do I Get Started with Server-Side Encryption? .
For more information about setting up user access logging, see Set up user access logging .
CloudformationResource: AWS::WorkSpacesWeb::UserAccessLoggingSettings
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 cfnUserAccessLoggingSettings = new CfnUserAccessLoggingSettings(this, "MyCfnUserAccessLoggingSettings", new CfnUserAccessLoggingSettingsProps {
KinesisStreamArn = "kinesisStreamArn",
// the properties below are optional
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnUserAccessLoggingSettings(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnUserAccessLoggingSettings(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnUserAccessLoggingSettings(Construct, String, ICfnUserAccessLoggingSettingsProps) |
Properties
AttrAssociatedPortalArns | A list of web portal ARNs that this user access logging settings is associated with. |
AttrUserAccessLoggingSettingsArn | The ARN of the user access logging settings. |
CdkTagManager | Tag Manager which manages the tags for this resource. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
KinesisStreamArn | The ARN of the Kinesis stream. |
Tags | The tags to add to the user access logging settings resource. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnUserAccessLoggingSettings(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnUserAccessLoggingSettings(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnUserAccessLoggingSettings(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnUserAccessLoggingSettings(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnUserAccessLoggingSettings(Construct, String, ICfnUserAccessLoggingSettingsProps)
public CfnUserAccessLoggingSettings(Construct scope, string id, ICfnUserAccessLoggingSettingsProps 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 ICfnUserAccessLoggingSettingsProps
Resource properties.
Properties
AttrAssociatedPortalArns
A list of web portal ARNs that this user access logging settings is associated with.
public virtual string[] AttrAssociatedPortalArns { get; }
Property Value
System.String[]
Remarks
CloudformationAttribute: AssociatedPortalArns
AttrUserAccessLoggingSettingsArn
The ARN of the user access logging settings.
public virtual string AttrUserAccessLoggingSettingsArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: UserAccessLoggingSettingsArn
CdkTagManager
Tag Manager which manages the tags for this resource.
public virtual TagManager CdkTagManager { get; }
Property Value
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
KinesisStreamArn
The ARN of the Kinesis stream.
public virtual string KinesisStreamArn { get; set; }
Property Value
System.String
Tags
The tags to add to the user access logging settings resource.
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>