core_network_prefix_list_associations

Creates, updates, deletes, gets or lists a core_network_prefix_list_associations resource.

Overview

Name	core_network_prefix_list_associations
Type	Resource
Id	aws.networkmanager.core_network_prefix_list_associations

Fields

The following fields are returned by SELECT queries:

list_core_network_prefix_list_associations

Name	Datatype	Description
core_network_id	string	The core network id in the association. (pattern: <code>^core-network-([0-9a-f]{8,17})$</code>)
prefix_list_alias	string	The alias of the prefix list in the association. (pattern: <code>[\s\S]*</code>)
prefix_list_arn	string	The ARN of the prefix list in the association. (pattern: <code>[\s\S]*</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_core_network_prefix_list_associations	select	core_network_id, region	prefixListArn, maxResults, nextToken	Lists the prefix list associations for a core network.
create_core_network_prefix_list_association	insert	region, CoreNetworkId, PrefixListArn, PrefixListAlias		Creates an association between a core network and a prefix list for routing control.
delete_core_network_prefix_list_association	delete	core_network_id, prefix_list_arn, region		Deletes an association between a core network and a prefix list.

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
core_network_id	string	The ID of the core network from which to delete the prefix list association.
prefix_list_arn	string	The ARN of the prefix list to disassociate from the core network.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of results to return in a single page.
nextToken	string	The token for the next page of results.
prefixListArn	string	The ARN of a specific prefix list to filter the associations.

SELECT examples

list_core_network_prefix_list_associations

Lists the prefix list associations for a core network.

SELECT
core_network_id,
prefix_list_alias,
prefix_list_arn
FROM aws.networkmanager.core_network_prefix_list_associations
WHERE core_network_id = '{{ core_network_id }}' -- required
AND region = '{{ region }}' -- required
AND prefixListArn = '{{ prefixListArn }}'
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_core_network_prefix_list_association

Creates an association between a core network and a prefix list for routing control.

INSERT INTO aws.networkmanager.core_network_prefix_list_associations (
CoreNetworkId,
PrefixListArn,
PrefixListAlias,
ClientToken,
region
)
SELECT 
'{{ CoreNetworkId }}' /* required */,
'{{ PrefixListArn }}' /* required */,
'{{ PrefixListAlias }}' /* required */,
'{{ ClientToken }}',
'{{ region }}'
RETURNING
core_network_id,
prefix_list_alias,
prefix_list_arn
;

Manifest

# Description fields are for documentation purposes
- name: core_network_prefix_list_associations
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the core_network_prefix_list_associations resource.
  - name: CoreNetworkId
    value: "{{ CoreNetworkId }}"
  - name: PrefixListArn
    value: "{{ PrefixListArn }}"
  - name: PrefixListAlias
    value: "{{ PrefixListAlias }}"
  - name: ClientToken
    value: "{{ ClientToken }}"

DELETE examples

delete_core_network_prefix_list_association

Deletes an association between a core network and a prefix list.

DELETE FROM aws.networkmanager.core_network_prefix_list_associations
WHERE core_network_id = '{{ core_network_id }}' --required
AND prefix_list_arn = '{{ prefix_list_arn }}' --required
AND region = '{{ region }}' --required
;