sol_function_instances

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

Overview

Name	sol_function_instances
Type	Resource
Id	aws.tnb.sol_function_instances

Fields

The following fields are returned by SELECT queries:

get_sol_function_instance

Name	Datatype	Description
id	string	Network function instance ID. (pattern: <code>^fi-[a-f0-9]{17}$</code>)
arn	string	Network function 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}:(function-instance/fi-[a-f0-9]{17})$</code>)
instantiated_vnf_info	object	Information about the network function. A network function instance is a function in a function package .
instantiation_state	string	Network function instantiation state. (INSTANTIATED, NOT_INSTANTIATED)
metadata	object	The metadata of a network function instance. A network function instance is a function in a function package .
ns_instance_id	string	Network instance ID. (pattern: <code>^ni-[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.
vnf_pkg_id	string	Function package ID. (pattern: <code>^fp-[a-f0-9]{17}$</code>)
vnf_product_name	string	Network function product name.
vnf_provider	string	Network function provider.
vnfd_id	string	Function package 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>)
vnfd_version	string	Function package descriptor version.

list_sol_function_instances

Name	Datatype	Description
id	string	Network function instance ID. (pattern: <code>^fi-[a-f0-9]{17}$</code>)
arn	string	Network function 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}:(function-instance/fi-[a-f0-9]{17})$</code>)
instantiated_vnf_info	object	Information about a network function. 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.
instantiation_state	string	Network function instance instantiation state. (INSTANTIATED, NOT_INSTANTIATED)
metadata	object	Network function instance metadata.
ns_instance_id	string	Network instance ID. (pattern: <code>^ni-[a-f0-9]{17}$</code>)
vnf_pkg_id	string	Function package ID. (pattern: <code>^fp-[a-f0-9]{17}$</code>)
vnf_pkg_name	string	Function package name.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_sol_function_instance	select	vnf_instance_id, region		Gets the details of a network function instance, including the instantiation state and metadata from the function package descriptor in the network function package. A network function instance is a function in a function package .
list_sol_function_instances	select	region	max_results, nextpage_opaque_marker	Lists network function instances. A network function instance is a function in a function package .

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
region	string	AWS region (default: us-east-1)
vnf_instance_id	string	ID of the network function.
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_function_instance

Gets the details of a network function instance, including the instantiation state and metadata from the function package descriptor in the network function package. A network function instance is a function in a function package .

SELECT
id,
arn,
instantiated_vnf_info,
instantiation_state,
metadata,
ns_instance_id,
tags,
vnf_pkg_id,
vnf_product_name,
vnf_provider,
vnfd_id,
vnfd_version
FROM aws.tnb.sol_function_instances
WHERE vnf_instance_id = '{{ vnf_instance_id }}' -- required
AND region = '{{ region }}' -- required
;

list_sol_function_instances

Lists network function instances. A network function instance is a function in a function package .

SELECT
id,
arn,
instantiated_vnf_info,
instantiation_state,
metadata,
ns_instance_id,
vnf_pkg_id,
vnf_pkg_name
FROM aws.tnb.sol_function_instances
WHERE region = '{{ region }}' -- required
AND max_results = '{{ max_results }}'
AND nextpage_opaque_marker = '{{ nextpage_opaque_marker }}'
;