core_networks

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

Overview

Name	core_networks
Type	Resource
Id	aws.networkmanager.core_networks

Fields

The following fields are returned by SELECT queries:

get_core_network

Name	Datatype	Description
core_network_arn	string	The ARN of a core network. (pattern: <code>[\s\S]*</code>)
core_network_id	string	The ID of a core network. (pattern: <code>^core-network-([0-9a-f]{8,17})$</code>)
created_at	string (date-time)	The timestamp when a core network was created.
description	string	The description of a core network. (pattern: <code>[\s\S]*</code>)
edges	array	The edges within a core network.
global_network_id	string	The ID of the global network that your core network is a part of. (pattern: <code>[\s\S]*</code>)
network_function_groups	array	The network function groups associated with a core network.
segments	array	The segments within a core network.
state	string	The current state of a core network. (CREATING, UPDATING, AVAILABLE, DELETING)
tags	array	The list of key-value tags associated with a core network.

list_core_networks

Name	Datatype	Description
core_network_arn	string	a core network ARN. (pattern: <code>[\s\S]*</code>)
core_network_id	string	The ID of a core network. (pattern: <code>^core-network-([0-9a-f]{8,17})$</code>)
description	string	The description of a core network. (pattern: <code>[\s\S]*</code>)
global_network_id	string	The global network ID. (pattern: <code>[\s\S]*</code>)
owner_account_id	string	The ID of the account owner. (pattern: <code>[\s\S]*</code>)
state	string	The state of a core network. (CREATING, UPDATING, AVAILABLE, DELETING)
tags	array	The key-value tags associated with a core network summary.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_core_network	select	core_network_id, region		Returns information about the LIVE policy for a core network.
list_core_networks	select	region	maxResults, nextToken	Returns a list of owned and shared core networks.
create_core_network	insert	region, GlobalNetworkId		Creates a core network as part of your global network, and optionally, with a core network policy.
update_core_network	update	core_network_id, region		Updates the description of a core network.
delete_core_network	delete	core_network_id, region		Deletes a core network along with all core network policies. This can only be done if there are no attachments on a core network.
execute_core_network_change_set	exec	core_network_id, policy_version_id, region		Executes a change set on your core network. Deploys changes globally based on the policy submitted..

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 a core network.
policy_version_id	integer	The ID of the policy version.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of results to return.
nextToken	string	The token for the next page of results.

SELECT examples

get_core_network

Returns information about the LIVE policy for a core network.

SELECT
core_network_arn,
core_network_id,
created_at,
description,
edges,
global_network_id,
network_function_groups,
segments,
state,
tags
FROM aws.networkmanager.core_networks
WHERE core_network_id = '{{ core_network_id }}' -- required
AND region = '{{ region }}' -- required
;

list_core_networks

Returns a list of owned and shared core networks.

SELECT
core_network_arn,
core_network_id,
description,
global_network_id,
owner_account_id,
state,
tags
FROM aws.networkmanager.core_networks
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_core_network

Creates a core network as part of your global network, and optionally, with a core network policy.

INSERT INTO aws.networkmanager.core_networks (
GlobalNetworkId,
Description,
Tags,
PolicyDocument,
ClientToken,
region
)
SELECT 
'{{ GlobalNetworkId }}' /* required */,
'{{ Description }}',
'{{ Tags }}',
'{{ PolicyDocument }}',
'{{ ClientToken }}',
'{{ region }}'
RETURNING
core_network
;

Manifest

# Description fields are for documentation purposes
- name: core_networks
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the core_networks resource.
  - name: GlobalNetworkId
    value: "{{ GlobalNetworkId }}"
  - name: Description
    value: "{{ Description }}"
  - name: Tags
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"
  - name: PolicyDocument
    value: "{{ PolicyDocument }}"
  - name: ClientToken
    value: "{{ ClientToken }}"

UPDATE examples

update_core_network

Updates the description of a core network.

UPDATE aws.networkmanager.core_networks
SET 
Description = '{{ Description }}'
WHERE 
core_network_id = '{{ core_network_id }}' --required
AND region = '{{ region }}' --required
RETURNING
core_network;

DELETE examples

delete_core_network

Deletes a core network along with all core network policies. This can only be done if there are no attachments on a core network.

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

Lifecycle Methods

execute_core_network_change_set

Executes a change set on your core network. Deploys changes globally based on the policy submitted..

EXEC aws.networkmanager.core_networks.execute_core_network_change_set 
@core_network_id='{{ core_network_id }}' --required, 
@policy_version_id='{{ policy_version_id }}' --required, 
@region='{{ region }}' --required
;