ip_access_settings

Creates, updates, deletes, gets or lists an ip_access_settings resource.

Overview

Name	ip_access_settings
Type	Resource
Id	aws.workspaces_web.ip_access_settings

Fields

The following fields are returned by SELECT queries:

get_ip_access_settings

Name	Datatype	Description
additional_encryption_context	object	The additional encryption context of the IP access settings.
associated_portal_arns	array	A list of web portal ARNs that this IP access settings resource is associated with.
creation_date	string (date-time)	The creation date timestamp of the IP access settings.
customer_managed_key	string	The customer managed key used to encrypt sensitive information in the IP access settings. (pattern: <code>arn:[\w+=/,.@-]+:kms:[a-zA-Z0-9-]*:[a-zA-Z0-9]{1,12}:key/[a-zA-Z0-9-]+</code>)
description	string	The description of the IP access settings. (pattern: <code>.+</code>)
display_name	string	The display name of the IP access settings. (pattern: <code>.+</code>)
ip_access_settings_arn	string	The ARN of the IP access settings resource. (pattern: <code>arn:[\w+=/,.@-]+:[a-zA-Z0-9-]+:[a-zA-Z0-9-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(/[a-fA-F0-9-]{36})+</code>)
ip_rules	array	The IP rules of the IP access settings.

list_ip_access_settings

Name	Datatype	Description
ip_access_settings	array	The IP access settings.
next_token	string	The pagination token used to retrieve the next page of results for this operation. (pattern: <code>\S+</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_ip_access_settings	select	ip_access_settings_arn, region		Gets the IP access settings.
list_ip_access_settings	select	region	nextToken, maxResults	Retrieves a list of IP access settings.
create_ip_access_settings	insert	region, ipRules		Creates an IP access settings resource that can be associated with a web portal.
associate_ip_access_settings	update	portal_arn, ipAccessSettingsArn, region		Associates an IP access settings resource with a web portal.
disassociate_ip_access_settings	update	portal_arn, region		Disassociates IP access settings from a web portal.
update_ip_access_settings	update	ip_access_settings_arn, region		Updates IP access settings.
delete_ip_access_settings	delete	ip_access_settings_arn, region		Deletes IP access settings.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
ipAccessSettingsArn	string	The ARN of the IP access settings.
ip_access_settings_arn	string	The ARN of the IP access settings.
portal_arn	string	The ARN of the web portal.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of results to be included in the next page.
nextToken	string	The pagination token used to retrieve the next page of results for this operation.

SELECT examples

get_ip_access_settings

Gets the IP access settings.

SELECT
additional_encryption_context,
associated_portal_arns,
creation_date,
customer_managed_key,
description,
display_name,
ip_access_settings_arn,
ip_rules
FROM aws.workspaces_web.ip_access_settings
WHERE ip_access_settings_arn = '{{ ip_access_settings_arn }}' -- required
AND region = '{{ region }}' -- required
;

list_ip_access_settings

Retrieves a list of IP access settings.

SELECT
ip_access_settings,
next_token
FROM aws.workspaces_web.ip_access_settings
WHERE region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

INSERT examples

create_ip_access_settings

Creates an IP access settings resource that can be associated with a web portal.

INSERT INTO aws.workspaces_web.ip_access_settings (
displayName,
description,
tags,
customerManagedKey,
additionalEncryptionContext,
ipRules,
clientToken,
region
)
SELECT 
'{{ displayName }}',
'{{ description }}',
'{{ tags }}',
'{{ customerManagedKey }}',
'{{ additionalEncryptionContext }}',
'{{ ipRules }}' /* required */,
'{{ clientToken }}',
'{{ region }}'
RETURNING
ip_access_settings_arn
;

Manifest

# Description fields are for documentation purposes
- name: ip_access_settings
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the ip_access_settings resource.
  - name: displayName
    value: "{{ displayName }}"
  - name: description
    value: "{{ description }}"
  - name: tags
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"
  - name: customerManagedKey
    value: "{{ customerManagedKey }}"
  - name: additionalEncryptionContext
    value: "{{ additionalEncryptionContext }}"
  - name: ipRules
    value:
      - ipRange: "{{ ipRange }}"
        description: "{{ description }}"
  - name: clientToken
    value: "{{ clientToken }}"

UPDATE examples

associate_ip_access_settings

Associates an IP access settings resource with a web portal.

UPDATE aws.workspaces_web.ip_access_settings
SET 
-- No updatable properties
WHERE 
portal_arn = '{{ portal_arn }}' --required
AND ipAccessSettingsArn = '{{ ipAccessSettingsArn }}' --required
AND region = '{{ region }}' --required
RETURNING
ip_access_settings_arn,
portal_arn;

disassociate_ip_access_settings

Disassociates IP access settings from a web portal.

UPDATE aws.workspaces_web.ip_access_settings
SET 
-- No updatable properties
WHERE 
portal_arn = '{{ portal_arn }}' --required
AND region = '{{ region }}' --required;

update_ip_access_settings

Updates IP access settings.

UPDATE aws.workspaces_web.ip_access_settings
SET 
displayName = '{{ displayName }}',
description = '{{ description }}',
ipRules = '{{ ipRules }}',
clientToken = '{{ clientToken }}'
WHERE 
ip_access_settings_arn = '{{ ip_access_settings_arn }}' --required
AND region = '{{ region }}' --required
RETURNING
ip_access_settings;

DELETE examples

delete_ip_access_settings

Deletes IP access settings.

DELETE FROM aws.workspaces_web.ip_access_settings
WHERE ip_access_settings_arn = '{{ ip_access_settings_arn }}' --required
AND region = '{{ region }}' --required
;