aws-cdk-lib.aws_iot.CfnOTAUpdate.OTAUpdateFileProperty

OTAUpdateFileProperty Struct Added in v2.276.0

Source

Generated code

Type last changed

v2.276.0 · 10 Nov 2026

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_iot as iot } from 'aws-cdk-lib';
const oTAUpdateFileProperty: iot.CfnOTAUpdate.OTAUpdateFileProperty = {
  attributes: {
    attributesKey: 'attributes',
  },
  codeSigning: {
    awsSignerJobId: 'awsSignerJobId',
    customCodeSigning: {
      certificateChain: {
        certificateName: 'certificateName',
        inlineDocument: 'inlineDocument',
      },
      hashAlgorithm: 'hashAlgorithm',
      signature: {
        inlineDocument: 'inlineDocument',
      },
      signatureAlgorithm: 'signatureAlgorithm',
    },
    startSigningJobParameter: {
      destination: {
        s3Destination: {
          bucket: 'bucket',
          prefix: 'prefix',
        },
      },
      signingProfileName: 'signingProfileName',
      signingProfileParameter: {
        certificateArn: 'certificateArn',
        certificatePathOnDevice: 'certificatePathOnDevice',
        platform: 'platform',
      },
    },
  },
  fileLocation: {
    s3Location: {
      bucket: 'bucket',
      key: 'key',
      version: 'version',
    },
    stream: {
      fileId: 123,
      streamId: 'streamId',
    },
  },
  fileName: 'fileName',
  fileType: 123,
  fileVersion: 'fileVersion',
};

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_iot as iot

o_ta_update_file_property = iot.CfnOTAUpdate.OTAUpdateFileProperty(
    attributes={
        "attributes_key": "attributes"
    },
    code_signing=iot.CfnOTAUpdate.CodeSigningProperty(
        aws_signer_job_id="awsSignerJobId",
        custom_code_signing=iot.CfnOTAUpdate.CustomCodeSigningProperty(
            certificate_chain=iot.CfnOTAUpdate.CodeSigningCertificateChainProperty(
                certificate_name="certificateName",
                inline_document="inlineDocument"
            ),
            hash_algorithm="hashAlgorithm",
            signature=iot.CfnOTAUpdate.CodeSigningSignatureProperty(
                inline_document="inlineDocument"
            ),
            signature_algorithm="signatureAlgorithm"
        ),
        start_signing_job_parameter=iot.CfnOTAUpdate.StartSigningJobParameterProperty(
            destination=iot.CfnOTAUpdate.DestinationProperty(
                s3_destination=iot.CfnOTAUpdate.S3DestinationProperty(
                    bucket="bucket",
                    prefix="prefix"
                )
            ),
            signing_profile_name="signingProfileName",
            signing_profile_parameter=iot.CfnOTAUpdate.SigningProfileParameterProperty(
                certificate_arn="certificateArn",
                certificate_path_on_device="certificatePathOnDevice",
                platform="platform"
            )
        )
    ),
    file_location=iot.CfnOTAUpdate.FileLocationProperty(
        s3_location=iot.CfnOTAUpdate.S3LocationProperty(
            bucket="bucket",
            key="key",
            version="version"
        ),
        stream=iot.CfnOTAUpdate.StreamProperty(
            file_id=123,
            stream_id="streamId"
        )
    ),
    file_name="fileName",
    file_type=123,
    file_version="fileVersion"
)

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.iot.*;

OTAUpdateFileProperty oTAUpdateFileProperty = OTAUpdateFileProperty.builder()
        .attributes(Map.of(
                "attributesKey", "attributes"))
        .codeSigning(CodeSigningProperty.builder()
                .awsSignerJobId("awsSignerJobId")
                .customCodeSigning(CustomCodeSigningProperty.builder()
                        .certificateChain(CodeSigningCertificateChainProperty.builder()
                                .certificateName("certificateName")
                                .inlineDocument("inlineDocument")
                                .build())
                        .hashAlgorithm("hashAlgorithm")
                        .signature(CodeSigningSignatureProperty.builder()
                                .inlineDocument("inlineDocument")
                                .build())
                        .signatureAlgorithm("signatureAlgorithm")
                        .build())
                .startSigningJobParameter(StartSigningJobParameterProperty.builder()
                        .destination(DestinationProperty.builder()
                                .s3Destination(S3DestinationProperty.builder()
                                        .bucket("bucket")
                                        .prefix("prefix")
                                        .build())
                                .build())
                        .signingProfileName("signingProfileName")
                        .signingProfileParameter(SigningProfileParameterProperty.builder()
                                .certificateArn("certificateArn")
                                .certificatePathOnDevice("certificatePathOnDevice")
                                .platform("platform")
                                .build())
                        .build())
                .build())
        .fileLocation(FileLocationProperty.builder()
                .s3Location(S3LocationProperty.builder()
                        .bucket("bucket")
                        .key("key")
                        .version("version")
                        .build())
                .stream(StreamProperty.builder()
                        .fileId(123)
                        .streamId("streamId")
                        .build())
                .build())
        .fileName("fileName")
        .fileType(123)
        .fileVersion("fileVersion")
        .build();

// Install: dotnet add package Amazon.CDK.Lib
// 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 oTAUpdateFileProperty = new OTAUpdateFileProperty {
    Attributes = new Dictionary<string, string> {
        { "attributesKey", "attributes" }
    },
    CodeSigning = new CodeSigningProperty {
        AwsSignerJobId = "awsSignerJobId",
        CustomCodeSigning = new CustomCodeSigningProperty {
            CertificateChain = new CodeSigningCertificateChainProperty {
                CertificateName = "certificateName",
                InlineDocument = "inlineDocument"
            },
            HashAlgorithm = "hashAlgorithm",
            Signature = new CodeSigningSignatureProperty {
                InlineDocument = "inlineDocument"
            },
            SignatureAlgorithm = "signatureAlgorithm"
        },
        StartSigningJobParameter = new StartSigningJobParameterProperty {
            Destination = new DestinationProperty {
                S3Destination = new S3DestinationProperty {
                    Bucket = "bucket",
                    Prefix = "prefix"
                }
            },
            SigningProfileName = "signingProfileName",
            SigningProfileParameter = new SigningProfileParameterProperty {
                CertificateArn = "certificateArn",
                CertificatePathOnDevice = "certificatePathOnDevice",
                Platform = "platform"
            }
        }
    },
    FileLocation = new FileLocationProperty {
        S3Location = new S3LocationProperty {
            Bucket = "bucket",
            Key = "key",
            Version = "version"
        },
        Stream = new StreamProperty {
            FileId = 123,
            StreamId = "streamId"
        }
    },
    FileName = "fileName",
    FileType = 123,
    FileVersion = "fileVersion"
};

// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

oTAUpdateFileProperty := &OTAUpdateFileProperty{
	Attributes: map[string]*string{
		"attributesKey": jsii.String("attributes"),
	},
	CodeSigning: &CodeSigningProperty{
		AwsSignerJobId: jsii.String("awsSignerJobId"),
		CustomCodeSigning: &CustomCodeSigningProperty{
			CertificateChain: &CodeSigningCertificateChainProperty{
				CertificateName: jsii.String("certificateName"),
				InlineDocument: jsii.String("inlineDocument"),
			},
			HashAlgorithm: jsii.String("hashAlgorithm"),
			Signature: &CodeSigningSignatureProperty{
				InlineDocument: jsii.String("inlineDocument"),
			},
			SignatureAlgorithm: jsii.String("signatureAlgorithm"),
		},
		StartSigningJobParameter: &StartSigningJobParameterProperty{
			Destination: &DestinationProperty{
				S3Destination: &S3DestinationProperty{
					Bucket: jsii.String("bucket"),
					Prefix: jsii.String("prefix"),
				},
			},
			SigningProfileName: jsii.String("signingProfileName"),
			SigningProfileParameter: &SigningProfileParameterProperty{
				CertificateArn: jsii.String("certificateArn"),
				CertificatePathOnDevice: jsii.String("certificatePathOnDevice"),
				Platform: jsii.String("platform"),
			},
		},
	},
	FileLocation: &FileLocationProperty{
		S3Location: &S3LocationProperty{
			Bucket: jsii.String("bucket"),
			Key: jsii.String("key"),
			Version: jsii.String("version"),
		},
		Stream: &StreamProperty{
			FileId: jsii.Number(123),
			StreamId: jsii.String("streamId"),
		},
	},
	FileName: jsii.String("fileName"),
	FileType: jsii.Number(123),
	FileVersion: jsii.String("fileVersion"),
}

Properties

attributes?optionalIResolvable | { [key: string]: string }attributes?optionaltyping.Union[IResolvable, typing.Mapping[str, str]]attributes?optionalIResolvableAttributes?optionalIResolvableAttributes?optionalinterface{}#

A list of name-attribute pairs.

codeSigning?optionalIResolvable | CfnOTAUpdate.CodeSigningPropertycode_signing?optionaltyping.Union[IResolvable, CodeSigningProperty]codeSigning?optionalIResolvableCodeSigning?optionalIResolvableCodeSigning?optionalinterface{}#

fileLocation?optionalIResolvable | CfnOTAUpdate.FileLocationPropertyfile_location?optionaltyping.Union[IResolvable, FileLocationProperty]fileLocation?optionalIResolvableFileLocation?optionalIResolvableFileLocation?optionalinterface{}#

fileName?optionalstringfile_name?optionalstrfileName?optionalStringFileName?optionalstringFileName?optional*string#

The name of the file.

fileType?optionalnumberfile_type?optionalint | floatfileType?optionalNumberFileType?optionaldoubleFileType?optional*float64#

An integer value you can include in the job document to allow your devices to identify the type of file received from the cloud.

fileVersion?optionalstringfile_version?optionalstrfileVersion?optionalStringFileVersion?optionalstringFileVersion?optional*string#

The file version.