ip_sets

Creates, updates, deletes or gets an ip_set resource or lists ip_sets in a region

Overview

Name	ip_sets
Type	Resource
Description	Resource Type definition for AWS::GuardDuty::IPSet
Id	awscc.guardduty.ip_sets

Fields

get (all properties)

Name	Datatype	Description
id	string
format	string
activate	boolean
detector_id	string
name	string
location	string
expected_bucket_owner	string
▶tags	array
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
id	string
detector_id	string
region	string	AWS region.

For more information, see AWS::GuardDuty::IPSet.

Methods

Name	Resource	Accessible by	Required Params
create_resource	ip_sets	INSERT	Format, Location, region
delete_resource	ip_sets	DELETE	Identifier, region
update_resource	ip_sets	UPDATE	Identifier, PatchDocument, region
list_resources	ip_sets_list_only	SELECT	region
get_resource	ip_sets	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual ip_set.

SELECT
  region,
  id,
  format,
  activate,
  detector_id,
  name,
  location,
  expected_bucket_owner,
  tags
FROM awscc.guardduty.ip_sets
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ id }}|{{ detector_id }}';

list (identifiers only)

Lists all ip_sets in a region.

SELECT
  region,
  id,
  detector_id
FROM awscc.guardduty.ip_sets_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.guardduty.ip_sets (
  Format,
  Location,
  region
)
SELECT
  '{{ format }}',
  '{{ location }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.guardduty.ip_sets (
  Format,
  Activate,
  DetectorId,
  Name,
  Location,
  ExpectedBucketOwner,
  Tags,
  region
)
SELECT
  '{{ format }}',
  '{{ activate }}',
  '{{ detector_id }}',
  '{{ name }}',
  '{{ location }}',
  '{{ expected_bucket_owner }}',
  '{{ 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_set
  props:
    - name: format
      value: '{{ format }}'
    - name: activate
      value: '{{ activate }}'
    - name: detector_id
      value: '{{ detector_id }}'
    - name: name
      value: '{{ name }}'
    - name: location
      value: '{{ location }}'
    - name: expected_bucket_owner
      value: '{{ expected_bucket_owner }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.guardduty.ip_sets
SET PatchDocument = string('{{ {
    "Activate": activate,
    "Name": name,
    "Location": location,
    "ExpectedBucketOwner": expected_bucket_owner,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ id }}|{{ detector_id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.guardduty.ip_sets
WHERE
  Identifier = '{{ id }}|{{ detector_id }}' 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_sets resource, the following permissions are required:

Create

guardduty:CreateIPSet,
guardduty:GetIPSet,
guardduty:TagResource,
iam:PutRolePolicy

Read

guardduty:GetIPSet

Delete

guardduty:GetDetector,
guardduty:ListDetectors,
guardduty:ListIPSets,
guardduty:GetIPSet,
guardduty:DeleteIPSet,
iam:DeleteRolePolicy

Update

guardduty:UpdateIPSet,
guardduty:GetIPSet,
guardduty:ListIPSets,
iam:PutRolePolicy,
guardduty:TagResource,
guardduty:UntagResource

List

guardduty:ListIPSets