sol_network_instances

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

Overview

Name	sol_network_instances
Type	Resource
Id	aws.tnb.sol_network_instances

Fields

The following fields are returned by SELECT queries:

get_sol_network_instance

Name	Datatype	Description
id	string	Network instance ID. (pattern: <code>^ni-[a-f0-9]{17}$</code>)
arn	string	Network instance ARN. (pattern: <code>^arn:(aws|aws-cn|aws-iso|aws-iso-b|aws-us-gov):tnb:([a-z]{2}(-(gov|isob|iso))?-(east|west|north|south|central){1,2}-[0-9]):\d{12}:(network-instance/ni-[a-f0-9]{17})$</code>)
lcm_op_info	object	Lifecycle management operation details on the network instance. Lifecycle management operations are deploy, update, or delete operations.
metadata	object	The metadata of a network instance. A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.
ns_instance_description	string	Network instance description.
ns_instance_name	string	Network instance name.
ns_state	string	Network instance state. (INSTANTIATED, NOT_INSTANTIATED, UPDATED, IMPAIRED, UPDATE_FAILED, STOPPED, DELETED, INSTANTIATE_IN_PROGRESS, INTENT_TO_UPDATE_IN_PROGRESS, UPDATE_IN_PROGRESS, TERMINATE_IN_PROGRESS)
nsd_id	string	Network service descriptor ID. (pattern: <code>^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$</code>)
nsd_info_id	string	Network service descriptor info ID. (pattern: <code>^np-[a-f0-9]{17}$</code>)
tags	object	A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.

list_sol_network_instances

Name	Datatype	Description
id	string	ID of the network instance. (pattern: <code>^ni-[a-f0-9]{17}$</code>)
arn	string	Network instance ARN. (pattern: <code>^arn:(aws|aws-cn|aws-iso|aws-iso-b|aws-us-gov):tnb:([a-z]{2}(-(gov|isob|iso))?-(east|west|north|south|central){1,2}-[0-9]):\d{12}:(network-instance/ni-[a-f0-9]{17})$</code>)
metadata	object	The metadata of the network instance.
ns_instance_description	string	Human-readable description of the network instance.
ns_instance_name	string	Human-readable name of the network instance.
ns_state	string	The state of the network instance. (INSTANTIATED, NOT_INSTANTIATED, UPDATED, IMPAIRED, UPDATE_FAILED, STOPPED, DELETED, INSTANTIATE_IN_PROGRESS, INTENT_TO_UPDATE_IN_PROGRESS, UPDATE_IN_PROGRESS, TERMINATE_IN_PROGRESS)
nsd_id	string	ID of the network service descriptor in the network package. (pattern: <code>^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$</code>)
nsd_info_id	string	ID of the network service descriptor in the network package. (pattern: <code>^np-[a-f0-9]{17}$</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_sol_network_instance	select	ns_instance_id, region		Gets the details of the network instance. A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.
list_sol_network_instances	select	region	max_results, nextpage_opaque_marker	Lists your network instances. A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.
create_sol_network_instance	insert	region, nsName, nsdInfoId		Creates a network instance. A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed. Creating a network instance is the third step after creating a network package. For more information about network instances, Network instances in the Amazon Web Services Telco Network Builder User Guide. Once you create a network instance, you can instantiate it. To instantiate a network, see InstantiateSolNetworkInstance.
update_sol_network_instance	update	ns_instance_id, region, updateType		Update a network instance. A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed. Choose the updateType parameter to target the necessary update of the network instance.
delete_sol_network_instance	delete	ns_instance_id, region		Deletes a network instance. A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed. To delete a network instance, the instance must be in a stopped or terminated state. To terminate a network instance, see TerminateSolNetworkInstance.
terminate_sol_network_instance	exec	ns_instance_id, region		Terminates a network instance. A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed. You must terminate a network instance before you can delete it.

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
ns_instance_id	string	ID of the network instance.
region	string	AWS region (default: us-east-1)
max_results	integer	The maximum number of results to include in the response.
nextpage_opaque_marker	string	The token for the next page of results.

SELECT examples

get_sol_network_instance

Gets the details of the network instance. A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.

SELECT
id,
arn,
lcm_op_info,
metadata,
ns_instance_description,
ns_instance_name,
ns_state,
nsd_id,
nsd_info_id,
tags
FROM aws.tnb.sol_network_instances
WHERE ns_instance_id = '{{ ns_instance_id }}' -- required
AND region = '{{ region }}' -- required
;

list_sol_network_instances

Lists your network instances. A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.

SELECT
id,
arn,
metadata,
ns_instance_description,
ns_instance_name,
ns_state,
nsd_id,
nsd_info_id
FROM aws.tnb.sol_network_instances
WHERE region = '{{ region }}' -- required
AND max_results = '{{ max_results }}'
AND nextpage_opaque_marker = '{{ nextpage_opaque_marker }}'
;

INSERT examples

create_sol_network_instance

Creates a network instance. A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed. Creating a network instance is the third step after creating a network package. For more information about network instances, Network instances in the Amazon Web Services Telco Network Builder User Guide. Once you create a network instance, you can instantiate it. To instantiate a network, see InstantiateSolNetworkInstance.

INSERT INTO aws.tnb.sol_network_instances (
nsDescription,
nsName,
nsdInfoId,
tags,
region
)
SELECT 
'{{ nsDescription }}',
'{{ nsName }}' /* required */,
'{{ nsdInfoId }}' /* required */,
'{{ tags }}',
'{{ region }}'
RETURNING
id,
arn,
ns_instance_name,
nsd_info_id,
tags
;

Manifest

# Description fields are for documentation purposes
- name: sol_network_instances
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the sol_network_instances resource.
  - name: nsDescription
    value: "{{ nsDescription }}"
  - name: nsName
    value: "{{ nsName }}"
  - name: nsdInfoId
    value: "{{ nsdInfoId }}"
  - name: tags
    value: "{{ tags }}"

UPDATE examples

update_sol_network_instance

Update a network instance. A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed. Choose the updateType parameter to target the necessary update of the network instance.

UPDATE aws.tnb.sol_network_instances
SET 
modifyVnfInfoData = '{{ modifyVnfInfoData }}',
tags = '{{ tags }}',
updateNs = '{{ updateNs }}',
updateType = '{{ updateType }}'
WHERE 
ns_instance_id = '{{ ns_instance_id }}' --required
AND region = '{{ region }}' --required
AND updateType = '{{ updateType }}' --required
RETURNING
ns_lcm_op_occ_id,
tags;

DELETE examples

delete_sol_network_instance

Deletes a network instance. A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed. To delete a network instance, the instance must be in a stopped or terminated state. To terminate a network instance, see TerminateSolNetworkInstance.

DELETE FROM aws.tnb.sol_network_instances
WHERE ns_instance_id = '{{ ns_instance_id }}' --required
AND region = '{{ region }}' --required
;

Lifecycle Methods

terminate_sol_network_instance

Terminates a network instance. A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed. You must terminate a network instance before you can delete it.

EXEC aws.tnb.sol_network_instances.terminate_sol_network_instance 
@ns_instance_id='{{ ns_instance_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"tags": "{{ tags }}"
}'
;