decoder_manifests

Creates, updates, deletes or gets a decoder_manifest resource or lists decoder_manifests in a region

Overview

Name	decoder_manifests
Type	Resource
Description	Definition of AWS::IoTFleetWise::DecoderManifest Resource Type
Id	awscc.iotfleetwise.decoder_manifests

Fields

get (all properties)

Name	Datatype	Description
arn	string
creation_time	string
description	string
last_modification_time	string
model_manifest_arn	string
name	string
network_interfaces	array
signal_decoders	array
status	string
default_for_unmapped_signals	string
▶tags	array
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
name	string
region	string	AWS region.

For more information, see AWS::IoTFleetWise::DecoderManifest.

Methods

Name	Resource	Accessible by	Required Params
create_resource	decoder_manifests	INSERT	Name, ModelManifestArn, region
delete_resource	decoder_manifests	DELETE	Identifier, region
update_resource	decoder_manifests	UPDATE	Identifier, PatchDocument, region
list_resources	decoder_manifests_list_only	SELECT	region
get_resource	decoder_manifests	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual decoder_manifest.

SELECT
  region,
  arn,
  creation_time,
  description,
  last_modification_time,
  model_manifest_arn,
  name,
  network_interfaces,
  signal_decoders,
  status,
  default_for_unmapped_signals,
  tags
FROM awscc.iotfleetwise.decoder_manifests
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ name }}';

list (identifiers only)

Lists all decoder_manifests in a region.

SELECT
  region,
  name
FROM awscc.iotfleetwise.decoder_manifests_list_only
WHERE
  region = '{{ region }}';

INSERT example

Use the following StackQL query and manifest file to create a new decoder_manifest resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.iotfleetwise.decoder_manifests (
  ModelManifestArn,
  Name,
  region
)
SELECT
  '{{ model_manifest_arn }}',
  '{{ name }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.iotfleetwise.decoder_manifests (
  Description,
  ModelManifestArn,
  Name,
  NetworkInterfaces,
  SignalDecoders,
  Status,
  DefaultForUnmappedSignals,
  Tags,
  region
)
SELECT
  '{{ description }}',
  '{{ model_manifest_arn }}',
  '{{ name }}',
  '{{ network_interfaces }}',
  '{{ signal_decoders }}',
  '{{ status }}',
  '{{ default_for_unmapped_signals }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: decoder_manifest
  props:
    - name: description
      value: '{{ description }}'
    - name: model_manifest_arn
      value: '{{ model_manifest_arn }}'
    - name: name
      value: '{{ name }}'
    - name: network_interfaces
      value:
        - null
    - name: signal_decoders
      value:
        - null
    - name: status
      value: '{{ status }}'
    - name: default_for_unmapped_signals
      value: '{{ default_for_unmapped_signals }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

Use the following StackQL query and manifest file to update a decoder_manifest resource, using stack-deploy.

/*+ update */
UPDATE awscc.iotfleetwise.decoder_manifests
SET PatchDocument = string('{{ {
    "Description": description,
    "NetworkInterfaces": network_interfaces,
    "SignalDecoders": signal_decoders,
    "Status": status,
    "DefaultForUnmappedSignals": default_for_unmapped_signals,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ name }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.iotfleetwise.decoder_manifests
WHERE
  Identifier = '{{ name }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

To operate on the decoder_manifests resource, the following permissions are required:

Create

iotfleetwise:CreateDecoderManifest,
iotfleetwise:GetDecoderManifest,
iotfleetwise:UpdateDecoderManifest,
iotfleetwise:ListDecoderManifestSignals,
iotfleetwise:ListDecoderManifestNetworkInterfaces,
iotfleetwise:ListTagsForResource,
iotfleetwise:TagResource

Read

iotfleetwise:GetDecoderManifest,
iotfleetwise:ListDecoderManifestSignals,
iotfleetwise:ListDecoderManifestNetworkInterfaces,
iotfleetwise:ListTagsForResource

Update

iotfleetwise:UpdateDecoderManifest,
iotfleetwise:GetDecoderManifest,
iotfleetwise:ListDecoderManifestSignals,
iotfleetwise:ListDecoderManifestNetworkInterfaces,
iotfleetwise:ListTagsForResource,
iotfleetwise:TagResource,
iotfleetwise:UntagResource

Delete

iotfleetwise:DeleteDecoderManifest,
iotfleetwise:GetDecoderManifest

List

iotfleetwise:ListDecoderManifests