Class CfnIpAccessSettings
This resource specifies IP access settings that can be associated with a web portal.
Inherited Members
Namespace: Amazon.CDK.AwsWorkspacesweb
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnIpAccessSettings : CfnResource, IInspectable, ITaggableV2
Syntax (vb)
Public Class CfnIpAccessSettings
Inherits CfnResource
Implements IInspectable, ITaggableV2
Remarks
For more information, see Set up IP access controls (optional) .
CloudformationResource: AWS::WorkSpacesWeb::IpAccessSettings
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 cfnIpAccessSettings = new CfnIpAccessSettings(this, "MyCfnIpAccessSettings", new CfnIpAccessSettingsProps {
IpRules = new [] { new IpRuleProperty {
IpRange = "ipRange",
// the properties below are optional
Description = "description"
} },
// the properties below are optional
AdditionalEncryptionContext = new Dictionary<string, string> {
{ "additionalEncryptionContextKey", "additionalEncryptionContext" }
},
CustomerManagedKey = "customerManagedKey",
Description = "description",
DisplayName = "displayName",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnIpAccessSettings(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnIpAccessSettings(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnIpAccessSettings(Construct, String, ICfnIpAccessSettingsProps) |
Properties
AdditionalEncryptionContext | Additional encryption context of the IP access settings. |
AttrAssociatedPortalArns | A list of web portal ARNs that this IP access settings resource is associated with. |
AttrCreationDate | The creation date timestamp of the IP access settings. |
AttrIpAccessSettingsArn | The ARN of the IP access settings resource. |
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 custom managed key of the IP access settings. |
Description | The description of the IP access settings. |
DisplayName | The display name of the IP access settings. |
IpRules | The IP rules of the IP access settings. |
Tags | The tags to add to the IP access settings resource. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnIpAccessSettings(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnIpAccessSettings(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnIpAccessSettings(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnIpAccessSettings(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnIpAccessSettings(Construct, String, ICfnIpAccessSettingsProps)
public CfnIpAccessSettings(Construct scope, string id, ICfnIpAccessSettingsProps 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 ICfnIpAccessSettingsProps
Resource properties.
Properties
AdditionalEncryptionContext
Additional encryption context of the IP access settings.
public virtual object AdditionalEncryptionContext { get; set; }
Property Value
System.Object
AttrAssociatedPortalArns
A list of web portal ARNs that this IP access settings resource is associated with.
public virtual string[] AttrAssociatedPortalArns { get; }
Property Value
System.String[]
Remarks
CloudformationAttribute: AssociatedPortalArns
AttrCreationDate
The creation date timestamp of the IP access settings.
public virtual string AttrCreationDate { get; }
Property Value
System.String
Remarks
CloudformationAttribute: CreationDate
AttrIpAccessSettingsArn
The ARN of the IP access settings resource.
public virtual string AttrIpAccessSettingsArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: IpAccessSettingsArn
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
CustomerManagedKey
The custom managed key of the IP access settings.
public virtual string CustomerManagedKey { get; set; }
Property Value
System.String
Description
The description of the IP access settings.
public virtual string Description { get; set; }
Property Value
System.String
DisplayName
The display name of the IP access settings.
public virtual string DisplayName { get; set; }
Property Value
System.String
IpRules
The IP rules of the IP access settings.
public virtual object IpRules { get; set; }
Property Value
System.Object
Tags
The tags to add to the IP access 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>