AssociateIpamResourceDiscoveryCommand

Suggest an Edit

Associates an IPAM resource discovery with an Amazon VPC IPAM. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { EC2Client, AssociateIpamResourceDiscoveryCommand } from "@aws-sdk/client-ec2"; // ES Modules import
// const { EC2Client, AssociateIpamResourceDiscoveryCommand } = require("@aws-sdk/client-ec2"); // CommonJS import
const client = new EC2Client(config);
const input = { // AssociateIpamResourceDiscoveryRequest
  DryRun: true || false,
  IpamId: "STRING_VALUE", // required
  IpamResourceDiscoveryId: "STRING_VALUE", // required
  TagSpecifications: [ // TagSpecificationList
    { // TagSpecification
      ResourceType: "capacity-reservation" || "client-vpn-endpoint" || "customer-gateway" || "carrier-gateway" || "coip-pool" || "declarative-policies-report" || "dedicated-host" || "dhcp-options" || "egress-only-internet-gateway" || "elastic-ip" || "elastic-gpu" || "export-image-task" || "export-instance-task" || "fleet" || "fpga-image" || "host-reservation" || "image" || "import-image-task" || "import-snapshot-task" || "instance" || "instance-event-window" || "internet-gateway" || "ipam" || "ipam-pool" || "ipam-scope" || "ipv4pool-ec2" || "ipv6pool-ec2" || "key-pair" || "launch-template" || "local-gateway" || "local-gateway-route-table" || "local-gateway-virtual-interface" || "local-gateway-virtual-interface-group" || "local-gateway-route-table-vpc-association" || "local-gateway-route-table-virtual-interface-group-association" || "natgateway" || "network-acl" || "network-interface" || "network-insights-analysis" || "network-insights-path" || "network-insights-access-scope" || "network-insights-access-scope-analysis" || "placement-group" || "prefix-list" || "replace-root-volume-task" || "reserved-instances" || "route-table" || "security-group" || "security-group-rule" || "snapshot" || "spot-fleet-request" || "spot-instances-request" || "subnet" || "subnet-cidr-reservation" || "traffic-mirror-filter" || "traffic-mirror-session" || "traffic-mirror-target" || "transit-gateway" || "transit-gateway-attachment" || "transit-gateway-connect-peer" || "transit-gateway-multicast-domain" || "transit-gateway-policy-table" || "transit-gateway-route-table" || "transit-gateway-route-table-announcement" || "volume" || "vpc" || "vpc-endpoint" || "vpc-endpoint-connection" || "vpc-endpoint-service" || "vpc-endpoint-service-permission" || "vpc-peering-connection" || "vpn-connection" || "vpn-gateway" || "vpc-flow-log" || "capacity-reservation-fleet" || "traffic-mirror-filter-rule" || "vpc-endpoint-connection-device-type" || "verified-access-instance" || "verified-access-group" || "verified-access-endpoint" || "verified-access-policy" || "verified-access-trust-provider" || "vpn-connection-device-type" || "vpc-block-public-access-exclusion" || "route-server" || "route-server-endpoint" || "route-server-peer" || "ipam-resource-discovery" || "ipam-resource-discovery-association" || "instance-connect-endpoint" || "verified-access-endpoint-target" || "ipam-external-resource-verification-token",
      Tags: [ // TagList
        { // Tag
          Key: "STRING_VALUE",
          Value: "STRING_VALUE",
        },
      ],
    },
  ],
  ClientToken: "STRING_VALUE",
};
const command = new AssociateIpamResourceDiscoveryCommand(input);
const response = await client.send(command);
// { // AssociateIpamResourceDiscoveryResult
//   IpamResourceDiscoveryAssociation: { // IpamResourceDiscoveryAssociation
//     OwnerId: "STRING_VALUE",
//     IpamResourceDiscoveryAssociationId: "STRING_VALUE",
//     IpamResourceDiscoveryAssociationArn: "STRING_VALUE",
//     IpamResourceDiscoveryId: "STRING_VALUE",
//     IpamId: "STRING_VALUE",
//     IpamArn: "STRING_VALUE",
//     IpamRegion: "STRING_VALUE",
//     IsDefault: true || false,
//     ResourceDiscoveryStatus: "active" || "not-found",
//     State: "associate-in-progress" || "associate-complete" || "associate-failed" || "disassociate-in-progress" || "disassociate-complete" || "disassociate-failed" || "isolate-in-progress" || "isolate-complete" || "restore-in-progress",
//     Tags: [ // TagList
//       { // Tag
//         Key: "STRING_VALUE",
//         Value: "STRING_VALUE",
//       },
//     ],
//   },
// };

AssociateIpamResourceDiscoveryCommand Input

See AssociateIpamResourceDiscoveryCommandInput for more details

Parameter
Type
Description
IpamId
Required
string | undefined

An IPAM ID.

IpamResourceDiscoveryId
Required
string | undefined

A resource discovery ID.

ClientToken
string | undefined

A client token.

DryRun
boolean | undefined

A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

TagSpecifications
TagSpecification[] | undefined

Tag specifications.

AssociateIpamResourceDiscoveryCommand Output

See AssociateIpamResourceDiscoveryCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
IpamResourceDiscoveryAssociation
IpamResourceDiscoveryAssociation | undefined

A resource discovery association. An associated resource discovery is a resource discovery that has been associated with an IPAM.

Throws

Name
Fault
Details
EC2ServiceException
Base exception class for all service exceptions from EC2 service.