Package software.amazon.awscdk.services.workspacesweb

Interface CfnIpAccessSettingsProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnIpAccessSettingsProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-13T16:10:16.142Z")
@Stability(Stable)
public interface CfnIpAccessSettingsProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnIpAccessSettings.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.workspacesweb.*;
 CfnIpAccessSettingsProps cfnIpAccessSettingsProps = CfnIpAccessSettingsProps.builder()
         .ipRules(List.of(IpRuleProperty.builder()
                 .ipRange("ipRange")
                 // the properties below are optional
                 .description("description")
                 .build()))
         // the properties below are optional
         .additionalEncryptionContext(Map.of(
                 "additionalEncryptionContextKey", "additionalEncryptionContext"))
         .customerManagedKey("customerManagedKey")
         .description("description")
         .displayName("displayName")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnIpAccessSettingsProps.Builder	A builder for CfnIpAccessSettingsProps
static final class	CfnIpAccessSettingsProps.Jsii$Proxy	An implementation for CfnIpAccessSettingsProps

Method Summary

Modifier and Type	Method	Description
static CfnIpAccessSettingsProps.Builder	builder()
default Object	getAdditionalEncryptionContext()	Additional encryption context of the IP access settings.
default String	getCustomerManagedKey()	The custom managed key of the IP access settings.
default String	getDescription()	The description of the IP access settings.
default String	getDisplayName()	The display name of the IP access settings.
Object	getIpRules()	The IP rules of the IP access settings.
default List<CfnTag>	getTags()	The tags to add to the IP access settings resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getIpRules

@Stability(Stable)
@NotNull
Object getIpRules()

The IP rules of the IP access settings.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnIpAccessSettings.IpRuleProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-ipaccesssettings.html#cfn-workspacesweb-ipaccesssettings-iprules

getAdditionalEncryptionContext

@Stability(Stable)
@Nullable
default Object getAdditionalEncryptionContext()

Additional encryption context of the IP access settings.

Returns union: either Mapinvalid input: '<'String, String> or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-ipaccesssettings.html#cfn-workspacesweb-ipaccesssettings-additionalencryptioncontext

getCustomerManagedKey

@Stability(Stable)
@Nullable
default String getCustomerManagedKey()

The custom managed key of the IP access settings.

Pattern : ^arn:[\w+=\/,.@-]+:kms:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:key\/[a-zA-Z0-9-]+$

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-ipaccesssettings.html#cfn-workspacesweb-ipaccesssettings-customermanagedkey

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

The description of the IP access settings.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-ipaccesssettings.html#cfn-workspacesweb-ipaccesssettings-description

getDisplayName

@Stability(Stable)
@Nullable
default String getDisplayName()

The display name of the IP access settings.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-ipaccesssettings.html#cfn-workspacesweb-ipaccesssettings-displayname

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

The tags to add to the IP access settings resource.

A tag is a key-value pair.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-ipaccesssettings.html#cfn-workspacesweb-ipaccesssettings-tags

builder

@Stability(Stable)
static CfnIpAccessSettingsProps.Builder builder()

Returns:

a CfnIpAccessSettingsProps.Builder of CfnIpAccessSettingsProps