Class CfnIpAccessSettings

This resource specifies IP access settings that can be associated with a web portal.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnIpAccessSettings

Implements

IInspectable

IIpAccessSettingsRef

IConstruct

IDependable

IEnvironmentAware

ITaggableV2

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.WorkSpacesWeb

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnIpAccessSettings : CfnResource, IInspectable, IIpAccessSettingsRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2

Syntax (vb)

Public Class CfnIpAccessSettings Inherits CfnResource Implements IInspectable, IIpAccessSettingsRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2

Remarks

For more information, see Set up IP access controls (optional) .

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

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(Construct, string, ICfnIpAccessSettingsProps)

Create a new AWS::WorkSpacesWeb::IpAccessSettings.

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.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CdkTagManager	Tag Manager which manages the tags for this resource.
CfnProperties	This resource specifies IP access settings that can be associated with a web portal.
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.
IpAccessSettingsRef	A reference to a IpAccessSettings resource.
IpRules	The IP rules of the IP access settings.
Tags	The tags to add to the IP access settings resource.

Methods

ArnForIpAccessSettings(IIpAccessSettingsRef)	This resource specifies IP access settings that can be associated with a web portal.
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnIpAccessSettings(object)	Checks whether the given object is a CfnIpAccessSettings.
RenderProperties(IDictionary<string, object>)	This resource specifies IP access settings that can be associated with a web portal.

Constructors

CfnIpAccessSettings(Construct, string, ICfnIpAccessSettingsProps)

Create a new AWS::WorkSpacesWeb::IpAccessSettings.

public CfnIpAccessSettings(Construct scope, string id, ICfnIpAccessSettingsProps props)

Parameters

scope Construct: Scope in which this resource is defined.
id string: Construct identifier for this resource (unique in its scope).
props ICfnIpAccessSettingsProps: Resource properties.

Remarks

For more information, see Set up IP access controls (optional) .

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

CloudformationResource: AWS::WorkSpacesWeb::IpAccessSettings

ExampleMetadata: fixture=_generated

Properties

AdditionalEncryptionContext

Additional encryption context of the IP access settings.

public virtual object? AdditionalEncryptionContext { get; set; }

Property Value

object

Remarks

Type union: either Dictionary<string, string> or IResolvable

AttrAssociatedPortalArns

A list of web portal ARNs that this IP access settings resource is associated with.

public virtual string[] AttrAssociatedPortalArns { get; }

Property Value

string[]

Remarks

CloudformationAttribute: AssociatedPortalArns

AttrCreationDate

The creation date timestamp of the IP access settings.

public virtual string AttrCreationDate { get; }

Property Value

string

Remarks

CloudformationAttribute: CreationDate

AttrIpAccessSettingsArn

The ARN of the IP access settings resource.

public virtual string AttrIpAccessSettingsArn { get; }

Property Value

string

Remarks

CloudformationAttribute: IpAccessSettingsArn

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

For more information, see Set up IP access controls (optional) .

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

CloudformationResource: AWS::WorkSpacesWeb::IpAccessSettings

ExampleMetadata: fixture=_generated

CdkTagManager

Tag Manager which manages the tags for this resource.

public virtual TagManager CdkTagManager { get; }

Property Value

TagManager

Remarks

For more information, see Set up IP access controls (optional) .

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

CloudformationResource: AWS::WorkSpacesWeb::IpAccessSettings

ExampleMetadata: fixture=_generated

CfnProperties

This resource specifies IP access settings that can be associated with a web portal.

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

CloudformationResource: AWS::WorkSpacesWeb::IpAccessSettings

ExampleMetadata: fixture=_generated

CustomerManagedKey

The custom managed key of the IP access settings.

public virtual string? CustomerManagedKey { get; set; }

Property Value

string

Remarks

For more information, see Set up IP access controls (optional) .

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

CloudformationResource: AWS::WorkSpacesWeb::IpAccessSettings

ExampleMetadata: fixture=_generated

Description

The description of the IP access settings.

public virtual string? Description { get; set; }

Property Value

string

Remarks

For more information, see Set up IP access controls (optional) .

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

CloudformationResource: AWS::WorkSpacesWeb::IpAccessSettings

ExampleMetadata: fixture=_generated

DisplayName

The display name of the IP access settings.

public virtual string? DisplayName { get; set; }

Property Value

string

Remarks

For more information, see Set up IP access controls (optional) .

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

CloudformationResource: AWS::WorkSpacesWeb::IpAccessSettings

ExampleMetadata: fixture=_generated

IpAccessSettingsRef

A reference to a IpAccessSettings resource.

public virtual IIpAccessSettingsReference IpAccessSettingsRef { get; }

Property Value

IIpAccessSettingsReference

Remarks

For more information, see Set up IP access controls (optional) .

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

CloudformationResource: AWS::WorkSpacesWeb::IpAccessSettings

ExampleMetadata: fixture=_generated

IpRules

The IP rules of the IP access settings.

public virtual object IpRules { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or (either IResolvable or CfnIpAccessSettings.IIpRuleProperty)[]

Methods

ArnForIpAccessSettings(IIpAccessSettingsRef)

This resource specifies IP access settings that can be associated with a web portal.

public static string ArnForIpAccessSettings(IIpAccessSettingsRef resource)

Parameters

resource IIpAccessSettingsRef

Returns

string

Remarks

For more information, see Set up IP access controls (optional) .

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

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"
                 } }
             });

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.

Remarks

For more information, see Set up IP access controls (optional) .

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

CloudformationResource: AWS::WorkSpacesWeb::IpAccessSettings

ExampleMetadata: fixture=_generated

IsCfnIpAccessSettings(object)

Checks whether the given object is a CfnIpAccessSettings.

public static bool IsCfnIpAccessSettings(object x)

Parameters

x object

Returns

bool

Remarks

For more information, see Set up IP access controls (optional) .

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

CloudformationResource: AWS::WorkSpacesWeb::IpAccessSettings

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

This resource specifies IP access settings that can be associated with a web portal.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

For more information, see Set up IP access controls (optional) .

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

CloudformationResource: AWS::WorkSpacesWeb::IpAccessSettings

ExampleMetadata: fixture=_generated

Implements

IInspectable

IIpAccessSettingsRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggableV2