Skip to main content

environment_vpcs

Creates, updates, deletes, gets or lists an environment_vpcs resource.

Overview

Nameenvironment_vpcs
TypeResource
Idaws.migration_hub_refactor_spaces.environment_vpcs

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
account_idstringThe Amazon Web Services account ID of the virtual private cloud (VPC) owner. (pattern: <code>^\d{12}$</code>)
cidr_blocksarrayThe list of Amazon Virtual Private Cloud (Amazon VPC) CIDR blocks.
created_timestring (date-time)A timestamp that indicates when the VPC is first added to the environment.
environment_idstringThe unique identifier of the environment. (pattern: <code>^env-[0-9A-Za-z]{10}$</code>)
last_updated_timestring (date-time)A timestamp that indicates when the VPC was last updated by the environment.
vpc_idstringThe ID of the VPC. (pattern: <code>^vpc-[-a-f0-9]{8}([-a-f0-9]{9})?$</code>)
vpc_namestringThe name of the VPC at the time it is added to the environment. (pattern: <code>^.*$</code>)

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
list_environment_vpcsselectenvironment_identifier, regionmaxResults, nextTokenLists all Amazon Web Services Migration Hub Refactor Spaces service virtual private clouds (VPCs) that are part of the environment.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
environment_identifierstringThe ID of the environment.
regionstringAWS region (default: us-east-1)
maxResultsintegerThe maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
nextTokenstringThe token for the next page of results.

SELECT examples

Lists all Amazon Web Services Migration Hub Refactor Spaces service virtual private clouds (VPCs) that are part of the environment.

SELECT
account_id,
cidr_blocks,
created_time,
environment_id,
last_updated_time,
vpc_id,
vpc_name
FROM aws.migration_hub_refactor_spaces.environment_vpcs
WHERE environment_identifier = '{{ environment_identifier }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;