ipam_resource_discoveries

Used to retrieve a list of ipam_resource_discoveries in a region or to create or delete a ipam_resource_discoveries resource, use ipam_resource_discovery to read or update an individual resource.

Overview

Name	ipam_resource_discoveries
Type	Resource
Description	Resource Schema of AWS::EC2::IPAMResourceDiscovery Type
Id	aws.ec2.ipam_resource_discoveries

Fields

Name	Datatype	Description
ipam_resource_discovery_id	string	Id of the IPAM Pool.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	, region
delete_resource	DELETE	data__Identifier, region
list_resource	SELECT	region

SELECT Example

SELECT
region,
ipam_resource_discovery_id
FROM aws.ec2.ipam_resource_discoveries
WHERE region = 'us-east-1';

INSERT Example

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

Required Properties

/*+ create */
INSERT INTO aws.ec2.ipam_resource_discoveries (
 ,
 region
)
SELECT 
'{{  }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.ec2.ipam_resource_discoveries (
 OperatingRegions,
 Description,
 Tags,
 region
)
SELECT 
 '{{ OperatingRegions }}',
 '{{ Description }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: ipam_resource_discovery
    props:
      - name: OperatingRegions
        value:
          - RegionName: '{{ RegionName }}'
      - name: Description
        value: '{{ Description }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE Example

/*+ delete */
DELETE FROM aws.ec2.ipam_resource_discoveries
WHERE data__Identifier = '<IpamResourceDiscoveryId>'
AND region = 'us-east-1';

Permissions

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

Create

ec2:CreateIpamResourceDiscovery,
ec2:DescribeIpamResourceDiscoveries,
ec2:CreateTags

Delete

ec2:DeleteIpamResourceDiscovery,
ec2:DescribeIpamResourceDiscoveries,
ec2:DeleteTags

List

ec2:DescribeIpamResourceDiscoveries