ip_access_settings

Creates, updates, deletes or gets an ip_access_setting resource or lists ip_access_settings in a region

Overview

Name	ip_access_settings
Type	Resource
Description	Definition of AWS::WorkSpacesWeb::IpAccessSettings Resource Type
Id	awscc.workspacesweb.ip_access_settings

Fields

get (all properties)

Name	Datatype	Description
additional_encryption_context	object
associated_portal_arns	array
creation_date	string
customer_managed_key	string
description	string
display_name	string
ip_access_settings_arn	string
▶ip_rules	array
▶tags	array
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
ip_access_settings_arn	string
region	string	AWS region.

For more information, see AWS::WorkSpacesWeb::IpAccessSettings.

Methods

Name	Resource	Accessible by	Required Params
create_resource	ip_access_settings	INSERT	IpRules, region
delete_resource	ip_access_settings	DELETE	Identifier, region
update_resource	ip_access_settings	UPDATE	Identifier, PatchDocument, region
list_resources	ip_access_settings_list_only	SELECT	region
get_resource	ip_access_settings	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual ip_access_setting.

SELECT
  region,
  additional_encryption_context,
  associated_portal_arns,
  creation_date,
  customer_managed_key,
  description,
  display_name,
  ip_access_settings_arn,
  ip_rules,
  tags
FROM awscc.workspacesweb.ip_access_settings
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ ip_access_settings_arn }}';

list (identifiers only)

Lists all ip_access_settings in a region.

SELECT
  region,
  ip_access_settings_arn
FROM awscc.workspacesweb.ip_access_settings_list_only
WHERE
  region = '{{ region }}';

INSERT example

Use the following StackQL query and manifest file to create a new ip_access_setting resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.workspacesweb.ip_access_settings (
  IpRules,
  region
)
SELECT
  '{{ ip_rules }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.workspacesweb.ip_access_settings (
  AdditionalEncryptionContext,
  CustomerManagedKey,
  Description,
  DisplayName,
  IpRules,
  Tags,
  region
)
SELECT
  '{{ additional_encryption_context }}',
  '{{ customer_managed_key }}',
  '{{ description }}',
  '{{ display_name }}',
  '{{ ip_rules }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: ip_access_setting
  props:
    - name: additional_encryption_context
      value: {}
    - name: customer_managed_key
      value: '{{ customer_managed_key }}'
    - name: description
      value: '{{ description }}'
    - name: display_name
      value: '{{ display_name }}'
    - name: ip_rules
      value:
        - ip_range: '{{ ip_range }}'
          description: '{{ description }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

Use the following StackQL query and manifest file to update a ip_access_setting resource, using stack-deploy.

/*+ update */
UPDATE awscc.workspacesweb.ip_access_settings
SET PatchDocument = string('{{ {
    "Description": description,
    "DisplayName": display_name,
    "IpRules": ip_rules,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ ip_access_settings_arn }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.workspacesweb.ip_access_settings
WHERE
  Identifier = '{{ ip_access_settings_arn }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

To operate on the ip_access_settings resource, the following permissions are required:

Create

workspaces-web:CreateIpAccessSettings,
workspaces-web:GetIpAccessSettings,
workspaces-web:ListIpAccessSettings,
workspaces-web:ListTagsForResource,
workspaces-web:TagResource,
kms:DescribeKey,
kms:GenerateDataKey,
kms:Decrypt,
kms:GenerateDataKeyWithoutPlaintext,
kms:ReEncryptTo,
kms:ReEncryptFrom

Read

workspaces-web:GetIpAccessSettings,
workspaces-web:ListIpAccessSettings,
workspaces-web:ListTagsForResource,
kms:CreateGrant,
kms:DescribeKey,
kms:GenerateDataKey,
kms:Decrypt

Update

workspaces-web:UpdateIpAccessSettings,
workspaces-web:TagResource,
workspaces-web:UntagResource,
workspaces-web:GetIpAccessSettings,
workspaces-web:ListIpAccessSettings,
workspaces-web:ListTagsForResource,
kms:CreateGrant,
kms:DescribeKey,
kms:GenerateDataKey,
kms:Decrypt

Delete

workspaces-web:GetIpAccessSettings,
workspaces-web:ListIpAccessSettings,
workspaces-web:DeleteIpAccessSettings,
kms:CreateGrant,
kms:DescribeKey,
kms:GenerateDataKey,
kms:Decrypt

List

workspaces-web:ListIpAccessSettings,
kms:Decrypt,
kms:DescribeKey