AWS::WorkSpacesWeb::IpAccessSettings - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::WorkSpacesWeb::IpAccessSettings

This resource specifies IP access settings that can be associated with a web portal. For more information, see Set up IP access controls (optional).

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::WorkSpacesWeb::IpAccessSettings",
  "Properties" : {
      "AdditionalEncryptionContext" : {Key: Value, ...},
      "CustomerManagedKey" : String,
      "Description" : String,
      "DisplayName" : String,
      "IpRules" : [ IpRule, ... ],
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::WorkSpacesWeb::IpAccessSettings
Properties:
  AdditionalEncryptionContext: 
    Key: Value
  CustomerManagedKey: String
  Description: String
  DisplayName: String
  IpRules: 
    - IpRule
  Tags: 
    - Tag

Properties

AdditionalEncryptionContext

Additional encryption context of the IP access settings.

Required: No

Type: Object of String

Pattern: ^[\s\S]*$

Minimum: 0

Maximum: 131072

Update requires: Replacement

CustomerManagedKey

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-]+$

Required: No

Type: String

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

Minimum: 20

Maximum: 2048

Update requires: Replacement

Description

The description of the IP access settings.

Required: No

Type: String

Pattern: ^.+$

Minimum: 1

Maximum: 256

Update requires: No interruption

DisplayName

The display name of the IP access settings.

Required: No

Type: String

Pattern: ^.+$

Minimum: 1

Maximum: 64

Update requires: No interruption

IpRules

The IP rules of the IP access settings.

Required: Yes

Type: Array of IpRule

Minimum: 1

Maximum: 100

Update requires: No interruption

Tags

The tags to add to the IP access settings resource. A tag is a key-value pair.

Required: No

Type: Array of Tag

Minimum: 0

Maximum: 200

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the resource's Amazon Resource Name (ARN).

For more information about using the Ref function, see Ref.

Fn::GetAtt

AssociatedPortalArns

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

CreationDate

The creation date timestamp of the IP access settings.

IpAccessSettingsArn

The ARN of the IP access settings resource.