sol_function_packages

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

Overview

Name	sol_function_packages
Type	Resource
Id	aws.tnb.sol_function_packages

Fields

The following fields are returned by SELECT queries:

get_sol_function_package

Name	Datatype	Description
id	string	Function package ID. (pattern: <code>^fp-[a-f0-9]{17}$</code>)
arn	string	Function package 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-package/fp-[a-f0-9]{17})$</code>)
metadata	object	Metadata related to the function package. A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.
onboarding_state	string	Function package onboarding state. (CREATED, ONBOARDED, ERROR)
operational_state	string	Function package operational state. (ENABLED, DISABLED)
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.
usage_state	string	Function package usage state. (IN_USE, NOT_IN_USE)
vnf_product_name	string	Network function product name.
vnf_provider	string	Network function provider.
vnfd_id	string	Function package descriptor ID.
vnfd_version	string	Function package descriptor version.

list_sol_function_packages

Name	Datatype	Description
id	string	ID of the function package. (pattern: <code>^fp-[a-f0-9]{17}$</code>)
arn	string	Function package 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-package/fp-[a-f0-9]{17})$</code>)
metadata	object	The metadata of the function package.
onboarding_state	string	Onboarding state of the function package. (CREATED, ONBOARDED, ERROR)
operational_state	string	Operational state of the function package. (ENABLED, DISABLED)
usage_state	string	Usage state of the function package. (IN_USE, NOT_IN_USE)
vnf_product_name	string	The product name for the network function.
vnf_provider	string	Provider of the function package and the function package descriptor.
vnfd_id	string	Identifies the function package and the function package descriptor.
vnfd_version	string	Identifies the version of the function package descriptor.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_sol_function_package	select	vnf_pkg_id, region		Gets the details of an individual function package, such as the operational state and whether the package is in use. A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network..
list_sol_function_packages	select	region	max_results, nextpage_opaque_marker	Lists information about function packages. A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.
create_sol_function_package	insert	region		Creates a function package. A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network. For more information, see Function packages in the Amazon Web Services Telco Network Builder User Guide. Creating a function package is the first step for creating a network in AWS TNB. This request creates an empty container with an ID. The next step is to upload the actual CSAR zip file into that empty container. To upload function package content, see PutSolFunctionPackageContent.
update_sol_function_package	update	vnf_pkg_id, region, operationalState		Updates the operational state of function package. A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.
delete_sol_function_package	delete	vnf_pkg_id, region		Deletes a function package. A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network. To delete a function package, the package must be in a disabled state. To disable a function package, see UpdateSolFunctionPackage.
validate_sol_function_package_content	exec	vnf_pkg_id, region, file	Content-Type	Validates function package content. This can be used as a dry run before uploading function package content with PutSolFunctionPackageContent. A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.

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_pkg_id	string	Function package ID.
Content-Type	string	Function package content type.
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_package

Gets the details of an individual function package, such as the operational state and whether the package is in use. A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network..

SELECT
id,
arn,
metadata,
onboarding_state,
operational_state,
tags,
usage_state,
vnf_product_name,
vnf_provider,
vnfd_id,
vnfd_version
FROM aws.tnb.sol_function_packages
WHERE vnf_pkg_id = '{{ vnf_pkg_id }}' -- required
AND region = '{{ region }}' -- required
;

list_sol_function_packages

Lists information about function packages. A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.

SELECT
id,
arn,
metadata,
onboarding_state,
operational_state,
usage_state,
vnf_product_name,
vnf_provider,
vnfd_id,
vnfd_version
FROM aws.tnb.sol_function_packages
WHERE region = '{{ region }}' -- required
AND max_results = '{{ max_results }}'
AND nextpage_opaque_marker = '{{ nextpage_opaque_marker }}'
;

INSERT examples

create_sol_function_package

Creates a function package. A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network. For more information, see Function packages in the Amazon Web Services Telco Network Builder User Guide. Creating a function package is the first step for creating a network in AWS TNB. This request creates an empty container with an ID. The next step is to upload the actual CSAR zip file into that empty container. To upload function package content, see PutSolFunctionPackageContent.

INSERT INTO aws.tnb.sol_function_packages (
tags,
region
)
SELECT 
'{{ tags }}',
'{{ region }}'
RETURNING
id,
arn,
onboarding_state,
operational_state,
tags,
usage_state
;

Manifest

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

UPDATE examples

update_sol_function_package

Updates the operational state of function package. A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.

UPDATE aws.tnb.sol_function_packages
SET 
operationalState = '{{ operationalState }}'
WHERE 
vnf_pkg_id = '{{ vnf_pkg_id }}' --required
AND region = '{{ region }}' --required
AND operationalState = '{{ operationalState }}' --required
RETURNING
operational_state;

DELETE examples

delete_sol_function_package

Deletes a function package. A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network. To delete a function package, the package must be in a disabled state. To disable a function package, see UpdateSolFunctionPackage.

DELETE FROM aws.tnb.sol_function_packages
WHERE vnf_pkg_id = '{{ vnf_pkg_id }}' --required
AND region = '{{ region }}' --required
;

Lifecycle Methods

validate_sol_function_package_content

Validates function package content. This can be used as a dry run before uploading function package content with PutSolFunctionPackageContent. A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.

EXEC aws.tnb.sol_function_packages.validate_sol_function_package_content 
@vnf_pkg_id='{{ vnf_pkg_id }}' --required, 
@region='{{ region }}' --required, 
@Content-Type='{{ Content-Type }}' 
@@json=
'{
"file": "{{ file }}"
}'
;