AWS::IoT::SoftwarePackage - AWS CloudFormation
SyntaxPropertiesReturn valuesExamples

This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::IoT::SoftwarePackage

Use the AWS::IoT::SoftwarePackage resource to create a software package.

For information about working with software packages, see AWS IoT Device Management Software Package Catalog and Creating a software package and package version in the AWS IoT Developer Guide. See also, CreatePackage in the API Guide.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::IoT::SoftwarePackage",
  "Properties" : {
      "Description" : String,
      "PackageName" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::IoT::SoftwarePackage
Properties:
  Description: String
  PackageName: String
  Tags: 
    - Tag

Properties

Description

A summary of the package being created. This can be used to outline the package's contents or purpose.

Required: No

Type: String

Pattern: ^[^\p{C}]+$

Minimum: 0

Maximum: 1024

Update requires: No interruption

PackageName

The name of the new software package.

Required: No

Type: String

Pattern: ^[a-zA-Z0-9-_.]+$

Minimum: 1

Maximum: 128

Update requires: Replacement

Tags

Metadata that can be used to manage the package.

Required: No

Type: Array of Tag

Maximum: 50

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the software package name. For example:

{ "Ref": "MyPackage" }

Response:

package-name

For a stack named MyStack, a value that is similar to the following is returned:

MyStack-MySoftwarePackage-AB1CDEFGHIJK

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

For example:

{ "GetAtt": "MySoftwarePackage.PackageArn" }

PackageArn

The Amazon Resource Name (ARN) for the package.

Examples

The following example declares a software package and the values of its attributes.

JSON

{
  "AWSTemplateFormatVersion": "2010-09-09",
  "Resources": {
    "MySoftwarePackage": {
      "Type": "AWS::IoT::SoftwarePackage",
      "Properties": {
        "PackageName": "Package",
        "Description": "description",
        "Tags": [
          {
            "Key": "TagKey",
            "Value": "TagValue"
          }
        ]
      }
    }
  }
}

YAML

AWSTemplateFormatVersion: '2010-09-09'
Resources:
  MySoftwarePackage:
    Type: AWS::IoT::SoftwarePackage
    Properties:
      PackageName: "Package"
      Description: "description"
      Tags:
        - Key: "TagKey"
          Value: "TagValue"