Class CfnSoftwarePackageVersion
Use the AWS::IoT::SoftwarePackageVersion
resource to create a software package version.
Inherited Members
Namespace: Amazon.CDK.AWS.IoT
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnSoftwarePackageVersion : CfnResource, IInspectable, ITaggableV2
Syntax (vb)
Public Class CfnSoftwarePackageVersion
Inherits CfnResource
Implements IInspectable, ITaggableV2
Remarks
For information about working with software package versions, see AWS IoT Device Management Software Package Catalog and Creating a software package and package version in the AWS IoT Developer Guide . See also, CreatePackageVersion in the API Guide .
The associated software package must exist before the package version is created. If you create a software package and package version in the same CloudFormation template, set the software package as a dependency of the package version. If they are created out of sequence, you will receive an error.
Package versions and created in a draft
state, for more information, see Package version lifecycle . To change the package version state after it’s created, use the UpdatePackageVersionAPI command.
CloudformationResource: AWS::IoT::SoftwarePackageVersion
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.IoT;
var cfnSoftwarePackageVersion = new CfnSoftwarePackageVersion(this, "MyCfnSoftwarePackageVersion", new CfnSoftwarePackageVersionProps {
PackageName = "packageName",
// the properties below are optional
Attributes = new Dictionary<string, string> {
{ "attributesKey", "attributes" }
},
Description = "description",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
VersionName = "versionName"
});
Synopsis
Constructors
CfnSoftwarePackageVersion(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnSoftwarePackageVersion(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnSoftwarePackageVersion(Construct, String, ICfnSoftwarePackageVersionProps) |
Properties
AttrErrorReason | Error reason for a package version failure during creation or update. |
Attributes | |
AttrPackageVersionArn | The Amazon Resource Name (ARN) for the package. |
AttrStatus | The status of the package version. |
CdkTagManager | Tag Manager which manages the tags for this resource. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Description | |
PackageName | |
Tags | An array of key-value pairs to apply to this resource. |
VersionName |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnSoftwarePackageVersion(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnSoftwarePackageVersion(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnSoftwarePackageVersion(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnSoftwarePackageVersion(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnSoftwarePackageVersion(Construct, String, ICfnSoftwarePackageVersionProps)
public CfnSoftwarePackageVersion(Construct scope, string id, ICfnSoftwarePackageVersionProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnSoftwarePackageVersionProps
Resource properties.
Properties
AttrErrorReason
Error reason for a package version failure during creation or update.
public virtual string AttrErrorReason { get; }
Property Value
System.String
Remarks
CloudformationAttribute: ErrorReason
Attributes
public virtual object Attributes { get; set; }
Property Value
System.Object
AttrPackageVersionArn
The Amazon Resource Name (ARN) for the package.
public virtual string AttrPackageVersionArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: PackageVersionArn
AttrStatus
The status of the package version.
public virtual string AttrStatus { get; }
Property Value
System.String
Remarks
For more information, see Package version lifecycle .
CloudformationAttribute: Status
CdkTagManager
Tag Manager which manages the tags for this resource.
public virtual TagManager CdkTagManager { get; }
Property Value
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Description
public virtual string Description { get; set; }
Property Value
System.String
PackageName
public virtual string PackageName { get; set; }
Property Value
System.String
Tags
An array of key-value pairs to apply to this resource.
public virtual ICfnTag[] Tags { get; set; }
Property Value
ICfnTag[]
VersionName
public virtual string VersionName { get; set; }
Property Value
System.String
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>