UNPKG

aws-cdk-lib

Version:

Version 2 of the AWS Cloud Development Kit library

1,248 lines 105 kB
import * as cdk from "../../core"; import * as constructs from "constructs"; import * as cfn_parse from "../../core/lib/helpers-internal"; /** * Creates a new destination that maps a device message to an AWS IoT rule. * * @cloudformationResource AWS::IoTWireless::Destination * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-destination.html */ export declare class CfnDestination extends cdk.CfnResource implements cdk.IInspectable, cdk.ITaggable { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnDestination from CloudFormation properties * * A factory method that creates a new instance of this class from an object * containing the CloudFormation properties of this resource. * Used in the @aws-cdk/cloudformation-include module. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnDestination; /** * The ARN of the destination created. * * @cloudformationAttribute Arn */ readonly attrArn: string; /** * The description of the new resource. */ description?: string; /** * The rule name to send messages to. */ expression: string; /** * The type of value in `Expression` . */ expressionType: string; /** * The name of the new resource. */ name: string; /** * The ARN of the IAM Role that authorizes the destination. */ roleArn?: string; /** * Tag Manager which manages the tags for this resource */ readonly tags: cdk.TagManager; /** * The tags are an array of key-value pairs to attach to the specified resource. */ tagsRaw?: Array<cdk.CfnTag>; /** * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props: CfnDestinationProps); protected get cfnProperties(): Record<string, any>; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record<string, any>): Record<string, any>; } /** * Properties for defining a `CfnDestination` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-destination.html */ export interface CfnDestinationProps { /** * The description of the new resource. * * Maximum length is 2048 characters. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-destination.html#cfn-iotwireless-destination-description */ readonly description?: string; /** * The rule name to send messages to. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-destination.html#cfn-iotwireless-destination-expression */ readonly expression: string; /** * The type of value in `Expression` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-destination.html#cfn-iotwireless-destination-expressiontype */ readonly expressionType: string; /** * The name of the new resource. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-destination.html#cfn-iotwireless-destination-name */ readonly name: string; /** * The ARN of the IAM Role that authorizes the destination. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-destination.html#cfn-iotwireless-destination-rolearn */ readonly roleArn?: string; /** * The tags are an array of key-value pairs to attach to the specified resource. * * Tags can have a minimum of 0 and a maximum of 50 items. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-destination.html#cfn-iotwireless-destination-tags */ readonly tags?: Array<cdk.CfnTag>; } /** * Creates a new device profile. * * @cloudformationResource AWS::IoTWireless::DeviceProfile * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-deviceprofile.html */ export declare class CfnDeviceProfile extends cdk.CfnResource implements cdk.IInspectable, cdk.ITaggable { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnDeviceProfile from CloudFormation properties * * A factory method that creates a new instance of this class from an object * containing the CloudFormation properties of this resource. * Used in the @aws-cdk/cloudformation-include module. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnDeviceProfile; /** * The ARN of the device profile created. * * @cloudformationAttribute Arn */ readonly attrArn: string; /** * The ID of the device profile created. * * @cloudformationAttribute Id */ readonly attrId: string; /** * LoRaWAN device profile object. */ loRaWan?: cdk.IResolvable | CfnDeviceProfile.LoRaWANDeviceProfileProperty; /** * The name of the new resource. */ name?: string; /** * Tag Manager which manages the tags for this resource */ readonly tags: cdk.TagManager; /** * The tags are an array of key-value pairs to attach to the specified resource. */ tagsRaw?: Array<cdk.CfnTag>; /** * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props?: CfnDeviceProfileProps); protected get cfnProperties(): Record<string, any>; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record<string, any>): Record<string, any>; } export declare namespace CfnDeviceProfile { /** * LoRaWAN device profile object. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-deviceprofile-lorawandeviceprofile.html */ interface LoRaWANDeviceProfileProperty { /** * The ClassBTimeout value. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-deviceprofile-lorawandeviceprofile.html#cfn-iotwireless-deviceprofile-lorawandeviceprofile-classbtimeout */ readonly classBTimeout?: number; /** * The ClassCTimeout value. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-deviceprofile-lorawandeviceprofile.html#cfn-iotwireless-deviceprofile-lorawandeviceprofile-classctimeout */ readonly classCTimeout?: number; /** * The list of values that make up the FactoryPresetFreqs value. * * Valid range of values include a minimum value of 1000000 and a maximum value of 16700000. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-deviceprofile-lorawandeviceprofile.html#cfn-iotwireless-deviceprofile-lorawandeviceprofile-factorypresetfreqslist */ readonly factoryPresetFreqsList?: Array<number> | cdk.IResolvable; /** * The MAC version (such as OTAA 1.1 or OTAA 1.0.3) to use with this device profile. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-deviceprofile-lorawandeviceprofile.html#cfn-iotwireless-deviceprofile-lorawandeviceprofile-macversion */ readonly macVersion?: string; /** * The MaxDutyCycle value. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-deviceprofile-lorawandeviceprofile.html#cfn-iotwireless-deviceprofile-lorawandeviceprofile-maxdutycycle */ readonly maxDutyCycle?: number; /** * The MaxEIRP value. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-deviceprofile-lorawandeviceprofile.html#cfn-iotwireless-deviceprofile-lorawandeviceprofile-maxeirp */ readonly maxEirp?: number; /** * The PingSlotDR value. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-deviceprofile-lorawandeviceprofile.html#cfn-iotwireless-deviceprofile-lorawandeviceprofile-pingslotdr */ readonly pingSlotDr?: number; /** * The PingSlotFreq value. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-deviceprofile-lorawandeviceprofile.html#cfn-iotwireless-deviceprofile-lorawandeviceprofile-pingslotfreq */ readonly pingSlotFreq?: number; /** * The PingSlotPeriod value. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-deviceprofile-lorawandeviceprofile.html#cfn-iotwireless-deviceprofile-lorawandeviceprofile-pingslotperiod */ readonly pingSlotPeriod?: number; /** * The version of regional parameters. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-deviceprofile-lorawandeviceprofile.html#cfn-iotwireless-deviceprofile-lorawandeviceprofile-regparamsrevision */ readonly regParamsRevision?: string; /** * The frequency band (RFRegion) value. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-deviceprofile-lorawandeviceprofile.html#cfn-iotwireless-deviceprofile-lorawandeviceprofile-rfregion */ readonly rfRegion?: string; /** * The RXDataRate2 value. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-deviceprofile-lorawandeviceprofile.html#cfn-iotwireless-deviceprofile-lorawandeviceprofile-rxdatarate2 */ readonly rxDataRate2?: number; /** * The RXDelay1 value. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-deviceprofile-lorawandeviceprofile.html#cfn-iotwireless-deviceprofile-lorawandeviceprofile-rxdelay1 */ readonly rxDelay1?: number; /** * The RXDROffset1 value. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-deviceprofile-lorawandeviceprofile.html#cfn-iotwireless-deviceprofile-lorawandeviceprofile-rxdroffset1 */ readonly rxDrOffset1?: number; /** * The RXFreq2 value. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-deviceprofile-lorawandeviceprofile.html#cfn-iotwireless-deviceprofile-lorawandeviceprofile-rxfreq2 */ readonly rxFreq2?: number; /** * The Supports32BitFCnt value. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-deviceprofile-lorawandeviceprofile.html#cfn-iotwireless-deviceprofile-lorawandeviceprofile-supports32bitfcnt */ readonly supports32BitFCnt?: boolean | cdk.IResolvable; /** * The SupportsClassB value. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-deviceprofile-lorawandeviceprofile.html#cfn-iotwireless-deviceprofile-lorawandeviceprofile-supportsclassb */ readonly supportsClassB?: boolean | cdk.IResolvable; /** * The SupportsClassC value. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-deviceprofile-lorawandeviceprofile.html#cfn-iotwireless-deviceprofile-lorawandeviceprofile-supportsclassc */ readonly supportsClassC?: boolean | cdk.IResolvable; /** * The SupportsJoin value. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-deviceprofile-lorawandeviceprofile.html#cfn-iotwireless-deviceprofile-lorawandeviceprofile-supportsjoin */ readonly supportsJoin?: boolean | cdk.IResolvable; } } /** * Properties for defining a `CfnDeviceProfile` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-deviceprofile.html */ export interface CfnDeviceProfileProps { /** * LoRaWAN device profile object. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-deviceprofile.html#cfn-iotwireless-deviceprofile-lorawan */ readonly loRaWan?: cdk.IResolvable | CfnDeviceProfile.LoRaWANDeviceProfileProperty; /** * The name of the new resource. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-deviceprofile.html#cfn-iotwireless-deviceprofile-name */ readonly name?: string; /** * The tags are an array of key-value pairs to attach to the specified resource. * * Tags can have a minimum of 0 and a maximum of 50 items. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-deviceprofile.html#cfn-iotwireless-deviceprofile-tags */ readonly tags?: Array<cdk.CfnTag>; } /** * A FUOTA task. * * @cloudformationResource AWS::IoTWireless::FuotaTask * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-fuotatask.html */ export declare class CfnFuotaTask extends cdk.CfnResource implements cdk.IInspectable, cdk.ITaggable { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnFuotaTask from CloudFormation properties * * A factory method that creates a new instance of this class from an object * containing the CloudFormation properties of this resource. * Used in the @aws-cdk/cloudformation-include module. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnFuotaTask; /** * The ARN of a FUOTA task * * @cloudformationAttribute Arn */ readonly attrArn: string; /** * The status of a FUOTA task. * * @cloudformationAttribute FuotaTaskStatus */ readonly attrFuotaTaskStatus: string; /** * The ID of a FUOTA task. * * @cloudformationAttribute Id */ readonly attrId: string; /** * Start time of a FUOTA task. * * @cloudformationAttribute LoRaWAN.StartTime */ readonly attrLoRaWanStartTime: string; /** * The ID of the multicast group to associate with a FUOTA task. */ associateMulticastGroup?: string; /** * The ID of the wireless device to associate with a multicast group. */ associateWirelessDevice?: string; /** * The description of the new resource. */ description?: string; /** * The ID of the multicast group to disassociate from a FUOTA task. */ disassociateMulticastGroup?: string; /** * The ID of the wireless device to disassociate from a FUOTA task. */ disassociateWirelessDevice?: string; /** * The S3 URI points to a firmware update image that is to be used with a FUOTA task. */ firmwareUpdateImage: string; /** * The firmware update role that is to be used with a FUOTA task. */ firmwareUpdateRole: string; /** * The LoRaWAN information used with a FUOTA task. */ loRaWan: cdk.IResolvable | CfnFuotaTask.LoRaWANProperty; /** * The name of a FUOTA task. */ name?: string; /** * Tag Manager which manages the tags for this resource */ readonly tags: cdk.TagManager; /** * The tags are an array of key-value pairs to attach to the specified resource. */ tagsRaw?: Array<cdk.CfnTag>; /** * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props: CfnFuotaTaskProps); protected get cfnProperties(): Record<string, any>; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record<string, any>): Record<string, any>; } export declare namespace CfnFuotaTask { /** * The LoRaWAN information used with a FUOTA task. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-fuotatask-lorawan.html */ interface LoRaWANProperty { /** * The frequency band (RFRegion) value. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-fuotatask-lorawan.html#cfn-iotwireless-fuotatask-lorawan-rfregion */ readonly rfRegion: string; /** * Start time of a FUOTA task. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-fuotatask-lorawan.html#cfn-iotwireless-fuotatask-lorawan-starttime */ readonly startTime?: string; } } /** * Properties for defining a `CfnFuotaTask` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-fuotatask.html */ export interface CfnFuotaTaskProps { /** * The ID of the multicast group to associate with a FUOTA task. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-fuotatask.html#cfn-iotwireless-fuotatask-associatemulticastgroup */ readonly associateMulticastGroup?: string; /** * The ID of the wireless device to associate with a multicast group. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-fuotatask.html#cfn-iotwireless-fuotatask-associatewirelessdevice */ readonly associateWirelessDevice?: string; /** * The description of the new resource. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-fuotatask.html#cfn-iotwireless-fuotatask-description */ readonly description?: string; /** * The ID of the multicast group to disassociate from a FUOTA task. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-fuotatask.html#cfn-iotwireless-fuotatask-disassociatemulticastgroup */ readonly disassociateMulticastGroup?: string; /** * The ID of the wireless device to disassociate from a FUOTA task. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-fuotatask.html#cfn-iotwireless-fuotatask-disassociatewirelessdevice */ readonly disassociateWirelessDevice?: string; /** * The S3 URI points to a firmware update image that is to be used with a FUOTA task. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-fuotatask.html#cfn-iotwireless-fuotatask-firmwareupdateimage */ readonly firmwareUpdateImage: string; /** * The firmware update role that is to be used with a FUOTA task. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-fuotatask.html#cfn-iotwireless-fuotatask-firmwareupdaterole */ readonly firmwareUpdateRole: string; /** * The LoRaWAN information used with a FUOTA task. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-fuotatask.html#cfn-iotwireless-fuotatask-lorawan */ readonly loRaWan: cdk.IResolvable | CfnFuotaTask.LoRaWANProperty; /** * The name of a FUOTA task. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-fuotatask.html#cfn-iotwireless-fuotatask-name */ readonly name?: string; /** * The tags are an array of key-value pairs to attach to the specified resource. * * Tags can have a minimum of 0 and a maximum of 50 items. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-fuotatask.html#cfn-iotwireless-fuotatask-tags */ readonly tags?: Array<cdk.CfnTag>; } /** * A multicast group. * * @cloudformationResource AWS::IoTWireless::MulticastGroup * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-multicastgroup.html */ export declare class CfnMulticastGroup extends cdk.CfnResource implements cdk.IInspectable, cdk.ITaggable { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnMulticastGroup from CloudFormation properties * * A factory method that creates a new instance of this class from an object * containing the CloudFormation properties of this resource. * Used in the @aws-cdk/cloudformation-include module. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnMulticastGroup; /** * The ARN of the multicast group. * * @cloudformationAttribute Arn */ readonly attrArn: string; /** * The ID of the multicast group. * * @cloudformationAttribute Id */ readonly attrId: string; /** * The number of devices that are associated to the multicast group. * * @cloudformationAttribute LoRaWAN.NumberOfDevicesInGroup */ readonly attrLoRaWanNumberOfDevicesInGroup: number; /** * The number of devices that are requested to be associated with the multicast group. * * @cloudformationAttribute LoRaWAN.NumberOfDevicesRequested */ readonly attrLoRaWanNumberOfDevicesRequested: number; /** * The status of a multicast group. * * @cloudformationAttribute Status */ readonly attrStatus: string; /** * The ID of the wireless device to associate with a multicast group. */ associateWirelessDevice?: string; /** * The description of the multicast group. */ description?: string; /** * The ID of the wireless device to disassociate from a multicast group. */ disassociateWirelessDevice?: string; /** * The LoRaWAN information that is to be used with the multicast group. */ loRaWan: cdk.IResolvable | CfnMulticastGroup.LoRaWANProperty; /** * The name of the multicast group. */ name?: string; /** * Tag Manager which manages the tags for this resource */ readonly tags: cdk.TagManager; /** * The tags are an array of key-value pairs to attach to the specified resource. */ tagsRaw?: Array<cdk.CfnTag>; /** * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props: CfnMulticastGroupProps); protected get cfnProperties(): Record<string, any>; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record<string, any>): Record<string, any>; } export declare namespace CfnMulticastGroup { /** * The LoRaWAN information that is to be used with the multicast group. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-multicastgroup-lorawan.html */ interface LoRaWANProperty { /** * DlClass for LoRaWAN. * * Valid values are ClassB and ClassC. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-multicastgroup-lorawan.html#cfn-iotwireless-multicastgroup-lorawan-dlclass */ readonly dlClass: string; /** * Number of devices that are associated to the multicast group. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-multicastgroup-lorawan.html#cfn-iotwireless-multicastgroup-lorawan-numberofdevicesingroup */ readonly numberOfDevicesInGroup?: number; /** * Number of devices that are requested to be associated with the multicast group. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-multicastgroup-lorawan.html#cfn-iotwireless-multicastgroup-lorawan-numberofdevicesrequested */ readonly numberOfDevicesRequested?: number; /** * The frequency band (RFRegion) value. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-multicastgroup-lorawan.html#cfn-iotwireless-multicastgroup-lorawan-rfregion */ readonly rfRegion: string; } } /** * Properties for defining a `CfnMulticastGroup` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-multicastgroup.html */ export interface CfnMulticastGroupProps { /** * The ID of the wireless device to associate with a multicast group. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-multicastgroup.html#cfn-iotwireless-multicastgroup-associatewirelessdevice */ readonly associateWirelessDevice?: string; /** * The description of the multicast group. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-multicastgroup.html#cfn-iotwireless-multicastgroup-description */ readonly description?: string; /** * The ID of the wireless device to disassociate from a multicast group. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-multicastgroup.html#cfn-iotwireless-multicastgroup-disassociatewirelessdevice */ readonly disassociateWirelessDevice?: string; /** * The LoRaWAN information that is to be used with the multicast group. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-multicastgroup.html#cfn-iotwireless-multicastgroup-lorawan */ readonly loRaWan: cdk.IResolvable | CfnMulticastGroup.LoRaWANProperty; /** * The name of the multicast group. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-multicastgroup.html#cfn-iotwireless-multicastgroup-name */ readonly name?: string; /** * The tags are an array of key-value pairs to attach to the specified resource. * * Tags can have a minimum of 0 and a maximum of 50 items. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-multicastgroup.html#cfn-iotwireless-multicastgroup-tags */ readonly tags?: Array<cdk.CfnTag>; } /** * Network analyzer configuration. * * @cloudformationResource AWS::IoTWireless::NetworkAnalyzerConfiguration * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-networkanalyzerconfiguration.html */ export declare class CfnNetworkAnalyzerConfiguration extends cdk.CfnResource implements cdk.IInspectable, cdk.ITaggable { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnNetworkAnalyzerConfiguration from CloudFormation properties * * A factory method that creates a new instance of this class from an object * containing the CloudFormation properties of this resource. * Used in the @aws-cdk/cloudformation-include module. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnNetworkAnalyzerConfiguration; /** * The Amazon Resource Name (ARN) of the resource. * * @cloudformationAttribute Arn */ readonly attrArn: string; /** * The description of the resource. */ description?: string; /** * Name of the network analyzer configuration. */ name: string; /** * Tag Manager which manages the tags for this resource */ readonly tags: cdk.TagManager; /** * The tags to attach to the specified resource. */ tagsRaw?: Array<cdk.CfnTag>; /** * Trace content for your wireless gateway and wireless device resources. */ traceContent?: any | cdk.IResolvable; /** * Wireless device resources to add to the network analyzer configuration. */ wirelessDevices?: Array<string>; /** * Wireless gateway resources to add to the network analyzer configuration. */ wirelessGateways?: Array<string>; /** * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props: CfnNetworkAnalyzerConfigurationProps); protected get cfnProperties(): Record<string, any>; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record<string, any>): Record<string, any>; } export declare namespace CfnNetworkAnalyzerConfiguration { /** * Trace content for your wireless gateway and wireless device resources. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-networkanalyzerconfiguration-tracecontent.html */ interface TraceContentProperty { /** * The log level for a log message. * * The log levels can be disabled, or set to `ERROR` to display less verbose logs containing only error information, or to `INFO` for more detailed logs * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-networkanalyzerconfiguration-tracecontent.html#cfn-iotwireless-networkanalyzerconfiguration-tracecontent-loglevel */ readonly logLevel?: string; /** * `FrameInfo` of your wireless device resources for the trace content. * * Use FrameInfo to debug the communication between your LoRaWAN end devices and the network server. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-networkanalyzerconfiguration-tracecontent.html#cfn-iotwireless-networkanalyzerconfiguration-tracecontent-wirelessdeviceframeinfo */ readonly wirelessDeviceFrameInfo?: string; } } /** * Properties for defining a `CfnNetworkAnalyzerConfiguration` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-networkanalyzerconfiguration.html */ export interface CfnNetworkAnalyzerConfigurationProps { /** * The description of the resource. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-networkanalyzerconfiguration.html#cfn-iotwireless-networkanalyzerconfiguration-description */ readonly description?: string; /** * Name of the network analyzer configuration. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-networkanalyzerconfiguration.html#cfn-iotwireless-networkanalyzerconfiguration-name */ readonly name: string; /** * The tags to attach to the specified resource. * * Tags are metadata that you can use to manage a resource. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-networkanalyzerconfiguration.html#cfn-iotwireless-networkanalyzerconfiguration-tags */ readonly tags?: Array<cdk.CfnTag>; /** * Trace content for your wireless gateway and wireless device resources. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-networkanalyzerconfiguration.html#cfn-iotwireless-networkanalyzerconfiguration-tracecontent */ readonly traceContent?: any | cdk.IResolvable; /** * Wireless device resources to add to the network analyzer configuration. * * Provide the `WirelessDeviceId` of the resource to add in the input array. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-networkanalyzerconfiguration.html#cfn-iotwireless-networkanalyzerconfiguration-wirelessdevices */ readonly wirelessDevices?: Array<string>; /** * Wireless gateway resources to add to the network analyzer configuration. * * Provide the `WirelessGatewayId` of the resource to add in the input array. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-networkanalyzerconfiguration.html#cfn-iotwireless-networkanalyzerconfiguration-wirelessgateways */ readonly wirelessGateways?: Array<string>; } /** * A partner account. * * If `PartnerAccountId` and `PartnerType` are `null` , returns all partner accounts. * * @cloudformationResource AWS::IoTWireless::PartnerAccount * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-partneraccount.html */ export declare class CfnPartnerAccount extends cdk.CfnResource implements cdk.IInspectable, cdk.ITaggable { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnPartnerAccount from CloudFormation properties * * A factory method that creates a new instance of this class from an object * containing the CloudFormation properties of this resource. * Used in the @aws-cdk/cloudformation-include module. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnPartnerAccount; /** * The Amazon Resource Name (ARN) of the resource. * * @cloudformationAttribute Arn */ readonly attrArn: string; /** * The fingerprint of the Sidewalk application server private key. * * @cloudformationAttribute Fingerprint */ readonly attrFingerprint: string; /** * Whether the partner account is linked to the AWS account. */ accountLinked?: boolean | cdk.IResolvable; /** * The ID of the partner account to update. */ partnerAccountId?: string; /** * The partner type. */ partnerType?: string; /** * The Sidewalk account credentials. */ sidewalk?: cdk.IResolvable | CfnPartnerAccount.SidewalkAccountInfoProperty; /** * Information about a Sidewalk account. */ sidewalkResponse?: cdk.IResolvable | CfnPartnerAccount.SidewalkAccountInfoWithFingerprintProperty; /** * Sidewalk update. */ sidewalkUpdate?: cdk.IResolvable | CfnPartnerAccount.SidewalkUpdateAccountProperty; /** * Tag Manager which manages the tags for this resource */ readonly tags: cdk.TagManager; /** * The tags are an array of key-value pairs to attach to the specified resource. */ tagsRaw?: Array<cdk.CfnTag>; /** * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props?: CfnPartnerAccountProps); protected get cfnProperties(): Record<string, any>; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record<string, any>): Record<string, any>; } export declare namespace CfnPartnerAccount { /** * Information about a Sidewalk account. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-partneraccount-sidewalkaccountinfowithfingerprint.html */ interface SidewalkAccountInfoWithFingerprintProperty { /** * The Sidewalk Amazon ID. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-partneraccount-sidewalkaccountinfowithfingerprint.html#cfn-iotwireless-partneraccount-sidewalkaccountinfowithfingerprint-amazonid */ readonly amazonId?: string; /** * The Amazon Resource Name (ARN) of the resource. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-partneraccount-sidewalkaccountinfowithfingerprint.html#cfn-iotwireless-partneraccount-sidewalkaccountinfowithfingerprint-arn */ readonly arn?: string; /** * The fingerprint of the Sidewalk application server private key. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-partneraccount-sidewalkaccountinfowithfingerprint.html#cfn-iotwireless-partneraccount-sidewalkaccountinfowithfingerprint-fingerprint */ readonly fingerprint?: string; } /** * Information about a Sidewalk account. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-partneraccount-sidewalkaccountinfo.html */ interface SidewalkAccountInfoProperty { /** * The Sidewalk application server private key. * * The application server private key is a secret key, which you should handle in a similar way as you would an application password. You can protect the application server private key by storing the value in the AWS Secrets Manager and use the [secretsmanager](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html#dynamic-references-secretsmanager) to reference this value. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-partneraccount-sidewalkaccountinfo.html#cfn-iotwireless-partneraccount-sidewalkaccountinfo-appserverprivatekey */ readonly appServerPrivateKey: string; } /** * Sidewalk update. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-partneraccount-sidewalkupdateaccount.html */ interface SidewalkUpdateAccountProperty { /** * The new Sidewalk application server private key. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-partneraccount-sidewalkupdateaccount.html#cfn-iotwireless-partneraccount-sidewalkupdateaccount-appserverprivatekey */ readonly appServerPrivateKey?: string; } } /** * Properties for defining a `CfnPartnerAccount` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-partneraccount.html */ export interface CfnPartnerAccountProps { /** * Whether the partner account is linked to the AWS account. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-partneraccount.html#cfn-iotwireless-partneraccount-accountlinked */ readonly accountLinked?: boolean | cdk.IResolvable; /** * The ID of the partner account to update. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-partneraccount.html#cfn-iotwireless-partneraccount-partneraccountid */ readonly partnerAccountId?: string; /** * The partner type. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-partneraccount.html#cfn-iotwireless-partneraccount-partnertype */ readonly partnerType?: string; /** * The Sidewalk account credentials. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-partneraccount.html#cfn-iotwireless-partneraccount-sidewalk */ readonly sidewalk?: cdk.IResolvable | CfnPartnerAccount.SidewalkAccountInfoProperty; /** * Information about a Sidewalk account. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-partneraccount.html#cfn-iotwireless-partneraccount-sidewalkresponse */ readonly sidewalkResponse?: cdk.IResolvable | CfnPartnerAccount.SidewalkAccountInfoWithFingerprintProperty; /** * Sidewalk update. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-partneraccount.html#cfn-iotwireless-partneraccount-sidewalkupdate */ readonly sidewalkUpdate?: cdk.IResolvable | CfnPartnerAccount.SidewalkUpdateAccountProperty; /** * The tags are an array of key-value pairs to attach to the specified resource. * * Tags can have a minimum of 0 and a maximum of 50 items. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-partneraccount.html#cfn-iotwireless-partneraccount-tags */ readonly tags?: Array<cdk.CfnTag>; } /** * Creates a new service profile. * * @cloudformationResource AWS::IoTWireless::ServiceProfile * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-serviceprofile.html */ export declare class CfnServiceProfile extends cdk.CfnResource implements cdk.IInspectable, cdk.ITaggable { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnServiceProfile from CloudFormation properties * * A factory method that creates a new instance of this class from an object * containing the CloudFormation properties of this resource. * Used in the @aws-cdk/cloudformation-include module. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnServiceProfile; /** * The ARN of the service profile created. * * @cloudformationAttribute Arn */ readonly attrArn: string; /** * The ID of the service profile created. * * @cloudformationAttribute Id */ readonly attrId: string; /** * The ChannelMask value. * * @cloudformationAttribute LoRaWAN.ChannelMask */ readonly attrLoRaWanChannelMask: string; /** * The DevStatusReqFreq value. * * @cloudformationAttribute LoRaWAN.DevStatusReqFreq */ readonly attrLoRaWanDevStatusReqFreq: number; /** * The DLBucketSize value. * * @cloudformationAttribute LoRaWAN.DlBucketSize */ readonly attrLoRaWanDlBucketSize: number; /** * The DLRate value. * * @cloudformationAttribute LoRaWAN.DlRate */ readonly attrLoRaWanDlRate: number; /** * The DLRatePolicy value. * * @cloudformationAttribute LoRaWAN.DlRatePolicy */ readonly attrLoRaWanDlRatePolicy: string; /** * The DRMax value. * * @cloudformationAttribute LoRaWAN.DrMax */ readonly attrLoRaWanDrMax: number; /** * The DRMin value. * * @cloudformationAttribute LoRaWAN.DrMin */ readonly attrLoRaWanDrMin: number; /** * The HRAllowed value that describes whether handover roaming is allowed. * * @cloudformationAttribute LoRaWAN.HrAllowed */ readonly attrLoRaWanHrAllowed: cdk.IResolvable; /** * The MinGwDiversity value. * * @cloudformationAttribute LoRaWAN.MinGwDiversity */ readonly attrLoRaWanMinGwDiversity: number; /** * The NwkGeoLoc value. * * @cloudformationAttribute LoRaWAN.NwkGeoLoc */ readonly attrLoRaWanNwkGeoLoc: cdk.IResolvable; /** * The ReportDevStatusBattery value. * * @cloudformationAttribute LoRaWAN.ReportDevStatusBattery */ readonly attrLoRaWanReportDevStatusBattery: cdk.IResolvable; /** * The ReportDevStatusMargin value. * * @cloudformationAttribute LoRaWAN.ReportDevStatusMargin */ readonly attrLoRaWanReportDevStatusMargin: cdk.IResolvable; /** * @cloudformationAttribute LoRaWANResponse */ readonly attrLoRaWanResponse: cdk.IResolvable; /** * The TargetPer value. * * @cloudformationAttribute LoRaWAN.TargetPer */ readonly attrLoRaWanTargetPer: number; /** * The UlBucketSize value. * * @cloudformationAttribute LoRaWAN.UlBucketSize */ readonly attrLoRaWanUlBucketSize: number; /** * The ULRate value. * * @cloudformationAttribute LoRaWAN.UlRate */ readonly attrLoRaWanUlRate: number; /** * The ULRatePolicy value. * * @cloudformationAttribute LoRaWAN.UlRatePolicy */ readonly attrLoRaWanUlRatePolicy: string; /** * LoRaWAN service profile object. */ loRaWan?: cdk.IResolvable | CfnServiceProfile.LoRaWANServiceProfileProperty; /** * The name of the new resource. */ name?: string; /** * Tag Manager which manages the tags for this resource */ readonly tags: cdk.TagManager; /** * The tags are an array of key-value pairs to attach to the specified resource. */ tagsRaw?: Array<cdk.CfnTag>; /** * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props?: CfnServiceProfileProps); protected get cfnProperties(): Record<string, any>; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record<string, any>): Record<string, any>; } export declare namespace CfnServiceProfile { /** * LoRaWANServiceProfile object. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-serviceprofile-lorawanserviceprofile.html */ interface LoRaWANServiceProfileProperty { /** * The AddGWMetaData value. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-serviceprofile-lorawanserviceprofile.html#cfn-iotwireless-serviceprofile-lorawanserviceprofile-addgwmetadata */ readonly addGwMetadata?: b