ipam_resource_discovery_associations

Creates, updates, deletes or gets an ipam_resource_discovery_association resource or lists ipam_resource_discovery_associations in a region

Overview

Name	ipam_resource_discovery_associations
Type	Resource
Description	Resource Schema of AWS::EC2::IPAMResourceDiscoveryAssociation Type
Id	awscc.ec2.ipam_resource_discovery_associations

Fields

get (all properties)

Name	Datatype	Description
ipam_arn	string	Arn of the IPAM.
ipam_region	string	The home region of the IPAM.
ipam_resource_discovery_association_id	string	Id of the IPAM Resource Discovery Association.
ipam_resource_discovery_id	string	The Amazon Resource Name (ARN) of the IPAM Resource Discovery Association.
ipam_id	string	The Id of the IPAM this Resource Discovery is associated to.
ipam_resource_discovery_association_arn	string	The Amazon Resource Name (ARN) of the resource discovery association is a part of.
is_default	boolean	If the Resource Discovery Association exists due as part of CreateIpam.
owner_id	string	The AWS Account ID for the account where the shared IPAM exists.
state	string	The operational state of the Resource Discovery Association. Related to Create/Delete activities.
resource_discovery_status	string	The status of the resource discovery.
▶tags	array	An array of key-value pairs to apply to this resource.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
ipam_resource_discovery_association_id	string	Id of the IPAM Resource Discovery Association.
region	string	AWS region.

For more information, see AWS::EC2::IPAMResourceDiscoveryAssociation.

Methods

Name	Resource	Accessible by	Required Params
create_resource	ipam_resource_discovery_associations	INSERT	IpamId, IpamResourceDiscoveryId, region
delete_resource	ipam_resource_discovery_associations	DELETE	Identifier, region
update_resource	ipam_resource_discovery_associations	UPDATE	Identifier, PatchDocument, region
list_resources	ipam_resource_discovery_associations_list_only	SELECT	region
get_resource	ipam_resource_discovery_associations	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual ipam_resource_discovery_association.

SELECT
  region,
  ipam_arn,
  ipam_region,
  ipam_resource_discovery_association_id,
  ipam_resource_discovery_id,
  ipam_id,
  ipam_resource_discovery_association_arn,
  is_default,
  owner_id,
  state,
  resource_discovery_status,
  tags
FROM awscc.ec2.ipam_resource_discovery_associations
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ ipam_resource_discovery_association_id }}';

list (identifiers only)

Lists all ipam_resource_discovery_associations in a region.

SELECT
  region,
  ipam_resource_discovery_association_id
FROM awscc.ec2.ipam_resource_discovery_associations_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.ec2.ipam_resource_discovery_associations (
  IpamResourceDiscoveryId,
  IpamId,
  region
)
SELECT
  '{{ ipam_resource_discovery_id }}',
  '{{ ipam_id }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.ec2.ipam_resource_discovery_associations (
  IpamResourceDiscoveryId,
  IpamId,
  Tags,
  region
)
SELECT
  '{{ ipam_resource_discovery_id }}',
  '{{ ipam_id }}',
  '{{ 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: ipam_resource_discovery_association
  props:
    - name: ipam_resource_discovery_id
      value: '{{ ipam_resource_discovery_id }}'
    - name: ipam_id
      value: '{{ ipam_id }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.ec2.ipam_resource_discovery_associations
SET PatchDocument = string('{{ {
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ ipam_resource_discovery_association_id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.ec2.ipam_resource_discovery_associations
WHERE
  Identifier = '{{ ipam_resource_discovery_association_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 ipam_resource_discovery_associations resource, the following permissions are required:

Create

ec2:AssociateIpamResourceDiscovery,
ec2:DescribeIpamResourceDiscoveryAssociations,
ec2:CreateTags

Read

ec2:DescribeIpamResourceDiscoveryAssociations

Update

ec2:DescribeIpamResourceDiscoveryAssociations,
ec2:CreateTags,
ec2:DeleteTags

Delete

ec2:DisassociateIpamResourceDiscovery,
ec2:DescribeIpamResourceDiscoveryAssociations,
ec2:DeleteTags

List

ec2:DescribeIpamResourceDiscoveryAssociations