sol_network_packages

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

Overview

Name	sol_network_packages
Type	Resource
Id	aws.tnb.sol_network_packages

Fields

The following fields are returned by SELECT queries:

get_sol_network_package

Name	Datatype	Description
id	string	Network package ID. (pattern: <code>^np-[a-f0-9]{17}$</code>)
arn	string	Network 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}:(network-package/np-[a-f0-9]{17})$</code>)
metadata	object	Metadata associated with a network package. A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.
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_name	string	Network service descriptor name.
nsd_onboarding_state	string	Network service descriptor onboarding state. (CREATED, ONBOARDED, ERROR)
nsd_operational_state	string	Network service descriptor operational state. (ENABLED, DISABLED)
nsd_usage_state	string	Network service descriptor usage state. (IN_USE, NOT_IN_USE)
nsd_version	string	Network service descriptor version.
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_ids	array	Identifies the function package for the function package descriptor referenced by the onboarded network package.

list_sol_network_packages

Name	Datatype	Description
id	string	ID of the individual network package. (pattern: <code>^np-[a-f0-9]{17}$</code>)
arn	string	Network 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}:(network-package/np-[a-f0-9]{17})$</code>)
metadata	object	The metadata of the network package.
nsd_designer	string	Designer of the onboarded network service descriptor in the network package.
nsd_id	string	ID of the network service descriptor on which the network package is based.
nsd_invariant_id	string	Identifies a network service descriptor in a version independent manner.
nsd_name	string	Name of the onboarded network service descriptor in the network package.
nsd_onboarding_state	string	Onboarding state of the network service descriptor in the network package. (CREATED, ONBOARDED, ERROR)
nsd_operational_state	string	Operational state of the network service descriptor in the network package. (ENABLED, DISABLED)
nsd_usage_state	string	Usage state of the network service descriptor in the network package. (IN_USE, NOT_IN_USE)
nsd_version	string	Version of the onboarded network service descriptor in the network package.
vnf_pkg_ids	array	Identifies the function package for the function package descriptor referenced by the onboarded network package.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_sol_network_package	select	nsd_info_id, region		Gets the details of a network package. A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.
list_sol_network_packages	select	region	max_results, nextpage_opaque_marker	Lists network packages. A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.
create_sol_network_package	insert	region		Creates a network package. A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on. For more information, see Network instances in the Amazon Web Services Telco Network Builder User Guide. A network package consists of a network service descriptor (NSD) file (required) and any additional files (optional), such as scripts specific to your needs. For example, if you have multiple function packages in your network package, you can use the NSD to define which network functions should run in certain VPCs, subnets, or EKS clusters. This request creates an empty network package container with an ID. Once you create a network package, you can upload the network package content using PutSolNetworkPackageContent.
update_sol_network_package	update	nsd_info_id, region, nsdOperationalState		Updates the operational state of a network package. A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on. A network service descriptor is a .yaml file in a network package that uses the TOSCA standard to describe the network functions you want to deploy and the Amazon Web Services infrastructure you want to deploy the network functions on.
delete_sol_network_package	delete	nsd_info_id, region		Deletes network package. A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on. To delete a network package, the package must be in a disable state. To disable a network package, see UpdateSolNetworkPackage.
validate_sol_network_package_content	exec	nsd_info_id, region, file	Content-Type	Validates network package content. This can be used as a dry run before uploading network package content with PutSolNetworkPackageContent. A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.

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
nsd_info_id	string	Network service descriptor file.
region	string	AWS region (default: us-east-1)
Content-Type	string	Network 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_network_package

Gets the details of a network package. A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.

SELECT
id,
arn,
metadata,
nsd_id,
nsd_name,
nsd_onboarding_state,
nsd_operational_state,
nsd_usage_state,
nsd_version,
tags,
vnf_pkg_ids
FROM aws.tnb.sol_network_packages
WHERE nsd_info_id = '{{ nsd_info_id }}' -- required
AND region = '{{ region }}' -- required
;

list_sol_network_packages

Lists network packages. A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.

SELECT
id,
arn,
metadata,
nsd_designer,
nsd_id,
nsd_invariant_id,
nsd_name,
nsd_onboarding_state,
nsd_operational_state,
nsd_usage_state,
nsd_version,
vnf_pkg_ids
FROM aws.tnb.sol_network_packages
WHERE region = '{{ region }}' -- required
AND max_results = '{{ max_results }}'
AND nextpage_opaque_marker = '{{ nextpage_opaque_marker }}'
;

INSERT examples

create_sol_network_package

Creates a network package. A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on. For more information, see Network instances in the Amazon Web Services Telco Network Builder User Guide. A network package consists of a network service descriptor (NSD) file (required) and any additional files (optional), such as scripts specific to your needs. For example, if you have multiple function packages in your network package, you can use the NSD to define which network functions should run in certain VPCs, subnets, or EKS clusters. This request creates an empty network package container with an ID. Once you create a network package, you can upload the network package content using PutSolNetworkPackageContent.

INSERT INTO aws.tnb.sol_network_packages (
tags,
region
)
SELECT 
'{{ tags }}',
'{{ region }}'
RETURNING
id,
arn,
nsd_onboarding_state,
nsd_operational_state,
nsd_usage_state,
tags
;

Manifest

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

UPDATE examples

update_sol_network_package

Updates the operational state of a network package. A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on. A network service descriptor is a .yaml file in a network package that uses the TOSCA standard to describe the network functions you want to deploy and the Amazon Web Services infrastructure you want to deploy the network functions on.

UPDATE aws.tnb.sol_network_packages
SET 
nsdOperationalState = '{{ nsdOperationalState }}'
WHERE 
nsd_info_id = '{{ nsd_info_id }}' --required
AND region = '{{ region }}' --required
AND nsdOperationalState = '{{ nsdOperationalState }}' --required
RETURNING
nsd_operational_state;

DELETE examples

delete_sol_network_package

Deletes network package. A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on. To delete a network package, the package must be in a disable state. To disable a network package, see UpdateSolNetworkPackage.

DELETE FROM aws.tnb.sol_network_packages
WHERE nsd_info_id = '{{ nsd_info_id }}' --required
AND region = '{{ region }}' --required
;

Lifecycle Methods

validate_sol_network_package_content

Validates network package content. This can be used as a dry run before uploading network package content with PutSolNetworkPackageContent. A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.

EXEC aws.tnb.sol_network_packages.validate_sol_network_package_content 
@nsd_info_id='{{ nsd_info_id }}' --required, 
@region='{{ region }}' --required, 
@Content-Type='{{ Content-Type }}' 
@@json=
'{
"file": "{{ file }}"
}'
;