ipam_external_resource_verification_tokens

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

Overview

Name	ipam_external_resource_verification_tokens
Type	Resource
Id	aws.ec2.ipam_external_resource_verification_tokens

Fields

The following fields are returned by SELECT queries:

describe_ipam_external_resource_verification_tokens

Name	Datatype	Description
ipam_arn	string	ARN of the IPAM that created the token.
ipam_external_resource_verification_token_arn	string	Token ARN.
ipam_external_resource_verification_token_id	string	The ID of the token.
ipam_id	string	The ID of the IPAM that created the token.
ipam_region	string	Region of the IPAM that created the token.
not_after	string	Token expiration.
state	string	Token state.
status	string	Token status.
tags	string	Token tags.
token_name	string	Token name.
token_value	string	Token value.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_ipam_external_resource_verification_tokens	select	region	DryRun, Filter, NextToken, MaxResults, IpamExternalResourceVerificationTokenId	Describe verification tokens. A verification token is an Amazon Web Services-generated random value that you can use to prove ownership of an external resource. For example, you can use a verification token to validate that you control a public IP address range when you bring an IP address range to Amazon Web Services (BYOIP).
create_ipam_external_resource_verification_token	insert	IpamId, region	DryRun, TagSpecification, ClientToken	Create a verification token. A verification token is an Amazon Web Services-generated random value that you can use to prove ownership of an external resource. For example, you can use a verification token to validate that you control a public IP address range when you bring an IP address range to Amazon Web Services (BYOIP).
delete_ipam_external_resource_verification_token	delete	IpamExternalResourceVerificationTokenId, region	DryRun	Delete a verification token. A verification token is an Amazon Web Services-generated random value that you can use to prove ownership of an external resource. For example, you can use a verification token to validate that you control a public IP address range when you bring an IP address range to Amazon Web Services (BYOIP).

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.

Name	Datatype	Description
IpamExternalResourceVerificationTokenId	string	The token ID.
IpamId	string	The ID of the IPAM that will create the token.
region	string	AWS region (default: us-east-1)
ClientToken	string	A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
DryRun	boolean	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.
Filter	array	One or more filters for the request. For more information about filtering, see Filtering CLI output. Available filters: ipam-arn ipam-external-resource-verification-token-arn ipam-external-resource-verification-token-id ipam-id ipam-region state status token-name token-value
IpamExternalResourceVerificationTokenId	array	Verification token IDs.
MaxResults	integer	The maximum number of tokens to return in one page of results.
NextToken	string	The token for the next page of results.
TagSpecification	array	Token tags.

SELECT examples

describe_ipam_external_resource_verification_tokens

Describe verification tokens. A verification token is an Amazon Web Services-generated random value that you can use to prove ownership of an external resource. For example, you can use a verification token to validate that you control a public IP address range when you bring an IP address range to Amazon Web Services (BYOIP).

SELECT
ipam_arn,
ipam_external_resource_verification_token_arn,
ipam_external_resource_verification_token_id,
ipam_id,
ipam_region,
not_after,
state,
status,
tags,
token_name,
token_value
FROM aws.ec2.ipam_external_resource_verification_tokens
WHERE region = '{{ region }}' -- required
AND DryRun = '{{ DryRun }}'
AND Filter = '{{ Filter }}'
AND NextToken = '{{ NextToken }}'
AND MaxResults = '{{ MaxResults }}'
AND IpamExternalResourceVerificationTokenId = '{{ IpamExternalResourceVerificationTokenId }}'
;

INSERT examples

create_ipam_external_resource_verification_token

Create a verification token. A verification token is an Amazon Web Services-generated random value that you can use to prove ownership of an external resource. For example, you can use a verification token to validate that you control a public IP address range when you bring an IP address range to Amazon Web Services (BYOIP).

INSERT INTO aws.ec2.ipam_external_resource_verification_tokens (
IpamId,
region,
DryRun,
TagSpecification,
ClientToken
)
SELECT 
'{{ IpamId }}',
'{{ region }}',
'{{ DryRun }}',
'{{ TagSpecification }}',
'{{ ClientToken }}'
RETURNING
ipam_arn,
ipam_external_resource_verification_token_arn,
ipam_external_resource_verification_token_id,
ipam_id,
ipam_region,
not_after,
state,
status,
tags,
token_name,
token_value
;

Manifest

# Description fields are for documentation purposes
- name: ipam_external_resource_verification_tokens
props:
  - name: IpamId
    value: "{{ IpamId }}"
    description: Required parameter for the ipam_external_resource_verification_tokens resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the ipam_external_resource_verification_tokens resource.
  - name: DryRun
    value: {{ DryRun }}
    description: 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.
    description: 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.
  - name: TagSpecification
    value: "{{ TagSpecification }}"
    description: Token tags.
    description: Token tags.
  - name: ClientToken
    value: "{{ ClientToken }}"
    description: A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
    description: A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.

DELETE examples

delete_ipam_external_resource_verification_token

Delete a verification token. A verification token is an Amazon Web Services-generated random value that you can use to prove ownership of an external resource. For example, you can use a verification token to validate that you control a public IP address range when you bring an IP address range to Amazon Web Services (BYOIP).

DELETE FROM aws.ec2.ipam_external_resource_verification_tokens
WHERE IpamExternalResourceVerificationTokenId = '{{ IpamExternalResourceVerificationTokenId }}' --required
AND region = '{{ region }}' --required
AND DryRun = '{{ DryRun }}'
;