Package software.amazon.awscdk.services.workspacesweb

Class CfnIpAccessSettings

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.workspacesweb.CfnIpAccessSettings
All Implemented Interfaces:
IEnvironmentAware, IInspectable, ITaggableV2, IIpAccessSettingsRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)", date="2025-11-10T13:40:17.170Z") @Stability(Stable) public class CfnIpAccessSettings extends CfnResource implements IInspectable, IIpAccessSettingsRef, ITaggableV2
This resource specifies IP access settings that can be associated with a web portal.

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

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.*;
 CfnIpAccessSettings cfnIpAccessSettings = CfnIpAccessSettings.Builder.create(this, "MyCfnIpAccessSettings")
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnIpAccessSettings

      protected CfnIpAccessSettings(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnIpAccessSettings

      protected CfnIpAccessSettings(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnIpAccessSettings

      @Stability(Stable) public CfnIpAccessSettings(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnIpAccessSettingsProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrAssociatedPortalArns

      @Stability(Stable) @NotNull public List<String> getAttrAssociatedPortalArns()
      A list of web portal ARNs that this IP access settings resource is associated with.

    • getAttrCreationDate

      @Stability(Stable) @NotNull public String getAttrCreationDate()
      The creation date timestamp of the IP access settings.

    • getAttrIpAccessSettingsArn

      @Stability(Stable) @NotNull public String getAttrIpAccessSettingsArn()
      The ARN of the IP access settings resource.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getIpAccessSettingsRef

      @Stability(Stable) @NotNull public IpAccessSettingsReference getIpAccessSettingsRef()
      A reference to a IpAccessSettings resource.
      Specified by:
      getIpAccessSettingsRef in interface IIpAccessSettingsRef

    • getIpRules

      @Stability(Stable) @NotNull public Object getIpRules()
      The IP rules of the IP access settings.

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

    • setIpRules

      @Stability(Stable) public void setIpRules(@NotNull IResolvable value)
      The IP rules of the IP access settings.

    • setIpRules

      @Stability(Stable) public void setIpRules(@NotNull List<Object> value)
      The IP rules of the IP access settings.

    • getAdditionalEncryptionContext

      @Stability(Stable) @Nullable public Object getAdditionalEncryptionContext()
      Additional encryption context of the IP access settings.

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

    • setAdditionalEncryptionContext

      @Stability(Stable) public void setAdditionalEncryptionContext(@Nullable Map<String,String> value)
      Additional encryption context of the IP access settings.

    • setAdditionalEncryptionContext

      @Stability(Stable) public void setAdditionalEncryptionContext(@Nullable IResolvable value)
      Additional encryption context of the IP access settings.

    • getCustomerManagedKey

      @Stability(Stable) @Nullable public String getCustomerManagedKey()
      The custom managed key of the IP access settings.

    • setCustomerManagedKey

      @Stability(Stable) public void setCustomerManagedKey(@Nullable String value)
      The custom managed key of the IP access settings.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of the IP access settings.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description of the IP access settings.

    • getDisplayName

      @Stability(Stable) @Nullable public String getDisplayName()
      The display name of the IP access settings.

    • setDisplayName

      @Stability(Stable) public void setDisplayName(@Nullable String value)
      The display name of the IP access settings.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      The tags to add to the IP access settings resource.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      The tags to add to the IP access settings resource.