@awboost/cfntypes 0.100.14 → 0.100.16
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/resources.generated.d.ts +688 -265
- package/lib/resources.generated.js.map +1 -1
- package/package.json +1 -1
@@ -14418,6 +14418,11 @@ export type B2BICapabilityAttributes = {
|
|
14418
14418
|
export type B2BICapabilityCapabilityConfiguration = {
|
14419
14419
|
Edi: B2BICapabilityEdiConfiguration;
|
14420
14420
|
};
|
14421
|
+
/**
|
14422
|
+
* Type definition for `AWS::B2BI::Capability.CapabilityDirection`.
|
14423
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-capability-capabilitydirection.html}
|
14424
|
+
*/
|
14425
|
+
export type B2BICapabilityCapabilityDirection = "INBOUND" | "OUTBOUND";
|
14421
14426
|
/**
|
14422
14427
|
* Type definition for `AWS::B2BI::Capability.CapabilityType`.
|
14423
14428
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-capability-capabilitytype.html}
|
@@ -14428,6 +14433,7 @@ export type B2BICapabilityCapabilityType = "edi";
|
|
14428
14433
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-capability-ediconfiguration.html}
|
14429
14434
|
*/
|
14430
14435
|
export type B2BICapabilityEdiConfiguration = {
|
14436
|
+
CapabilityDirection?: B2BICapabilityCapabilityDirection;
|
14431
14437
|
InputLocation: B2BICapabilityS3Location;
|
14432
14438
|
OutputLocation: B2BICapabilityS3Location;
|
14433
14439
|
/**
|
@@ -14500,7 +14506,8 @@ export type B2BICapabilityX12Version = "VERSION_4010" | "VERSION_4030" | "VERSIO
|
|
14500
14506
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-partnership.html}
|
14501
14507
|
*/
|
14502
14508
|
export type B2BIPartnershipProps = {
|
14503
|
-
Capabilities
|
14509
|
+
Capabilities: string[];
|
14510
|
+
CapabilityOptions?: B2BIPartnershipCapabilityOptions;
|
14504
14511
|
/**
|
14505
14512
|
* @minLength `5`
|
14506
14513
|
* @maxLength `254`
|
@@ -14555,6 +14562,20 @@ export type B2BIPartnershipAttributes = {
|
|
14555
14562
|
*/
|
14556
14563
|
TradingPartnerId: string;
|
14557
14564
|
};
|
14565
|
+
/**
|
14566
|
+
* Type definition for `AWS::B2BI::Partnership.CapabilityOptions`.
|
14567
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-capabilityoptions.html}
|
14568
|
+
*/
|
14569
|
+
export type B2BIPartnershipCapabilityOptions = {
|
14570
|
+
OutboundEdi?: B2BIPartnershipOutboundEdiOptions;
|
14571
|
+
};
|
14572
|
+
/**
|
14573
|
+
* Type definition for `AWS::B2BI::Partnership.OutboundEdiOptions`.
|
14574
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-outboundedioptions.html}
|
14575
|
+
*/
|
14576
|
+
export type B2BIPartnershipOutboundEdiOptions = {
|
14577
|
+
X12: B2BIPartnershipX12Envelope;
|
14578
|
+
};
|
14558
14579
|
/**
|
14559
14580
|
* Type definition for `AWS::B2BI::Partnership.Tag`.
|
14560
14581
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-tag.html}
|
@@ -14571,6 +14592,118 @@ export type B2BIPartnershipTag = {
|
|
14571
14592
|
*/
|
14572
14593
|
Value: string;
|
14573
14594
|
};
|
14595
|
+
/**
|
14596
|
+
* Type definition for `AWS::B2BI::Partnership.X12Delimiters`.
|
14597
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12delimiters.html}
|
14598
|
+
*/
|
14599
|
+
export type B2BIPartnershipX12Delimiters = {
|
14600
|
+
/**
|
14601
|
+
* @minLength `1`
|
14602
|
+
* @maxLength `1`
|
14603
|
+
* @pattern `^[!&'()*+,\-./:;?=%@\[\]_{}|<>~^`"]$`
|
14604
|
+
*/
|
14605
|
+
ComponentSeparator?: string;
|
14606
|
+
/**
|
14607
|
+
* @minLength `1`
|
14608
|
+
* @maxLength `1`
|
14609
|
+
* @pattern `^[!&'()*+,\-./:;?=%@\[\]_{}|<>~^`"]$`
|
14610
|
+
*/
|
14611
|
+
DataElementSeparator?: string;
|
14612
|
+
/**
|
14613
|
+
* @minLength `1`
|
14614
|
+
* @maxLength `1`
|
14615
|
+
* @pattern `^[!&'()*+,\-./:;?=%@\[\]_{}|<>~^`"]$`
|
14616
|
+
*/
|
14617
|
+
SegmentTerminator?: string;
|
14618
|
+
};
|
14619
|
+
/**
|
14620
|
+
* Type definition for `AWS::B2BI::Partnership.X12Envelope`.
|
14621
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12envelope.html}
|
14622
|
+
*/
|
14623
|
+
export type B2BIPartnershipX12Envelope = {
|
14624
|
+
Common?: B2BIPartnershipX12OutboundEdiHeaders;
|
14625
|
+
};
|
14626
|
+
/**
|
14627
|
+
* Type definition for `AWS::B2BI::Partnership.X12FunctionalGroupHeaders`.
|
14628
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12functionalgroupheaders.html}
|
14629
|
+
*/
|
14630
|
+
export type B2BIPartnershipX12FunctionalGroupHeaders = {
|
14631
|
+
/**
|
14632
|
+
* @minLength `2`
|
14633
|
+
* @maxLength `15`
|
14634
|
+
* @pattern `^[a-zA-Z0-9]*$`
|
14635
|
+
*/
|
14636
|
+
ApplicationReceiverCode?: string;
|
14637
|
+
/**
|
14638
|
+
* @minLength `2`
|
14639
|
+
* @maxLength `15`
|
14640
|
+
* @pattern `^[a-zA-Z0-9]*$`
|
14641
|
+
*/
|
14642
|
+
ApplicationSenderCode?: string;
|
14643
|
+
/**
|
14644
|
+
* @minLength `1`
|
14645
|
+
* @maxLength `2`
|
14646
|
+
* @pattern `^[a-zA-Z0-9]*$`
|
14647
|
+
*/
|
14648
|
+
ResponsibleAgencyCode?: string;
|
14649
|
+
};
|
14650
|
+
/**
|
14651
|
+
* Type definition for `AWS::B2BI::Partnership.X12InterchangeControlHeaders`.
|
14652
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12interchangecontrolheaders.html}
|
14653
|
+
*/
|
14654
|
+
export type B2BIPartnershipX12InterchangeControlHeaders = {
|
14655
|
+
/**
|
14656
|
+
* @minLength `1`
|
14657
|
+
* @maxLength `1`
|
14658
|
+
* @pattern `^[a-zA-Z0-9]*$`
|
14659
|
+
*/
|
14660
|
+
AcknowledgmentRequestedCode?: string;
|
14661
|
+
/**
|
14662
|
+
* @minLength `15`
|
14663
|
+
* @maxLength `15`
|
14664
|
+
* @pattern `^[a-zA-Z0-9]*$`
|
14665
|
+
*/
|
14666
|
+
ReceiverId?: string;
|
14667
|
+
/**
|
14668
|
+
* @minLength `2`
|
14669
|
+
* @maxLength `2`
|
14670
|
+
* @pattern `^[a-zA-Z0-9]*$`
|
14671
|
+
*/
|
14672
|
+
ReceiverIdQualifier?: string;
|
14673
|
+
/**
|
14674
|
+
* @minLength `1`
|
14675
|
+
* @maxLength `1`
|
14676
|
+
*/
|
14677
|
+
RepetitionSeparator?: string;
|
14678
|
+
/**
|
14679
|
+
* @minLength `15`
|
14680
|
+
* @maxLength `15`
|
14681
|
+
* @pattern `^[a-zA-Z0-9]*$`
|
14682
|
+
*/
|
14683
|
+
SenderId?: string;
|
14684
|
+
/**
|
14685
|
+
* @minLength `2`
|
14686
|
+
* @maxLength `2`
|
14687
|
+
* @pattern `^[a-zA-Z0-9]*$`
|
14688
|
+
*/
|
14689
|
+
SenderIdQualifier?: string;
|
14690
|
+
/**
|
14691
|
+
* @minLength `1`
|
14692
|
+
* @maxLength `1`
|
14693
|
+
* @pattern `^[a-zA-Z0-9]*$`
|
14694
|
+
*/
|
14695
|
+
UsageIndicatorCode?: string;
|
14696
|
+
};
|
14697
|
+
/**
|
14698
|
+
* Type definition for `AWS::B2BI::Partnership.X12OutboundEdiHeaders`.
|
14699
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12outboundediheaders.html}
|
14700
|
+
*/
|
14701
|
+
export type B2BIPartnershipX12OutboundEdiHeaders = {
|
14702
|
+
Delimiters?: B2BIPartnershipX12Delimiters;
|
14703
|
+
FunctionalGroupHeaders?: B2BIPartnershipX12FunctionalGroupHeaders;
|
14704
|
+
InterchangeControlHeaders?: B2BIPartnershipX12InterchangeControlHeaders;
|
14705
|
+
ValidateEdi?: boolean;
|
14706
|
+
};
|
14574
14707
|
/**
|
14575
14708
|
* Definition of AWS::B2BI::Profile Resource Type
|
14576
14709
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-profile.html}
|
@@ -14655,23 +14788,30 @@ export type B2BIProfileTag = {
|
|
14655
14788
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-b2bi-transformer.html}
|
14656
14789
|
*/
|
14657
14790
|
export type B2BITransformerProps = {
|
14658
|
-
EdiType
|
14659
|
-
FileFormat
|
14791
|
+
EdiType?: B2BITransformerEdiType;
|
14792
|
+
FileFormat?: B2BITransformerFileFormat;
|
14793
|
+
InputConversion?: B2BITransformerInputConversion;
|
14794
|
+
Mapping?: B2BITransformerMapping;
|
14660
14795
|
/**
|
14796
|
+
* This shape is deprecated: This is a legacy trait. Please use input-conversion or output-conversion.
|
14661
14797
|
* @minLength `0`
|
14662
14798
|
* @maxLength `350000`
|
14663
14799
|
*/
|
14664
|
-
MappingTemplate
|
14800
|
+
MappingTemplate?: string;
|
14665
14801
|
/**
|
14666
14802
|
* @minLength `1`
|
14667
14803
|
* @maxLength `254`
|
14804
|
+
* @pattern `^[a-zA-Z0-9_-]{1,512}$`
|
14668
14805
|
*/
|
14669
14806
|
Name: string;
|
14807
|
+
OutputConversion?: B2BITransformerOutputConversion;
|
14670
14808
|
/**
|
14809
|
+
* This shape is deprecated: This is a legacy trait. Please use input-conversion or output-conversion.
|
14671
14810
|
* @minLength `0`
|
14672
14811
|
* @maxLength `1024`
|
14673
14812
|
*/
|
14674
14813
|
SampleDocument?: string;
|
14814
|
+
SampleDocuments?: B2BITransformerSampleDocuments;
|
14675
14815
|
Status: B2BITransformerTransformerStatus;
|
14676
14816
|
/**
|
14677
14817
|
* @minLength `0`
|
@@ -14709,7 +14849,80 @@ export type B2BITransformerEdiType = {
|
|
14709
14849
|
* Type definition for `AWS::B2BI::Transformer.FileFormat`.
|
14710
14850
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-fileformat.html}
|
14711
14851
|
*/
|
14712
|
-
export type B2BITransformerFileFormat = "XML" | "JSON";
|
14852
|
+
export type B2BITransformerFileFormat = "XML" | "JSON" | "NOT_USED";
|
14853
|
+
/**
|
14854
|
+
* Type definition for `AWS::B2BI::Transformer.FormatOptions`.
|
14855
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-formatoptions.html}
|
14856
|
+
*/
|
14857
|
+
export type B2BITransformerFormatOptions = {
|
14858
|
+
X12: B2BITransformerX12Details;
|
14859
|
+
};
|
14860
|
+
/**
|
14861
|
+
* Type definition for `AWS::B2BI::Transformer.FromFormat`.
|
14862
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-fromformat.html}
|
14863
|
+
*/
|
14864
|
+
export type B2BITransformerFromFormat = "X12";
|
14865
|
+
/**
|
14866
|
+
* Type definition for `AWS::B2BI::Transformer.InputConversion`.
|
14867
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-inputconversion.html}
|
14868
|
+
*/
|
14869
|
+
export type B2BITransformerInputConversion = {
|
14870
|
+
FormatOptions?: B2BITransformerFormatOptions;
|
14871
|
+
FromFormat: B2BITransformerFromFormat;
|
14872
|
+
};
|
14873
|
+
/**
|
14874
|
+
* Type definition for `AWS::B2BI::Transformer.Mapping`.
|
14875
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-mapping.html}
|
14876
|
+
*/
|
14877
|
+
export type B2BITransformerMapping = {
|
14878
|
+
/**
|
14879
|
+
* @minLength `0`
|
14880
|
+
* @maxLength `350000`
|
14881
|
+
*/
|
14882
|
+
Template?: string;
|
14883
|
+
TemplateLanguage: B2BITransformerMappingTemplateLanguage;
|
14884
|
+
};
|
14885
|
+
/**
|
14886
|
+
* Type definition for `AWS::B2BI::Transformer.MappingTemplateLanguage`.
|
14887
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-mappingtemplatelanguage.html}
|
14888
|
+
*/
|
14889
|
+
export type B2BITransformerMappingTemplateLanguage = "XSLT" | "JSONATA";
|
14890
|
+
/**
|
14891
|
+
* Type definition for `AWS::B2BI::Transformer.OutputConversion`.
|
14892
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-outputconversion.html}
|
14893
|
+
*/
|
14894
|
+
export type B2BITransformerOutputConversion = {
|
14895
|
+
FormatOptions?: B2BITransformerFormatOptions;
|
14896
|
+
ToFormat: B2BITransformerToFormat;
|
14897
|
+
};
|
14898
|
+
/**
|
14899
|
+
* Type definition for `AWS::B2BI::Transformer.SampleDocumentKeys`.
|
14900
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-sampledocumentkeys.html}
|
14901
|
+
*/
|
14902
|
+
export type B2BITransformerSampleDocumentKeys = {
|
14903
|
+
/**
|
14904
|
+
* @minLength `0`
|
14905
|
+
* @maxLength `1024`
|
14906
|
+
*/
|
14907
|
+
Input?: string;
|
14908
|
+
/**
|
14909
|
+
* @minLength `0`
|
14910
|
+
* @maxLength `1024`
|
14911
|
+
*/
|
14912
|
+
Output?: string;
|
14913
|
+
};
|
14914
|
+
/**
|
14915
|
+
* Type definition for `AWS::B2BI::Transformer.SampleDocuments`.
|
14916
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-sampledocuments.html}
|
14917
|
+
*/
|
14918
|
+
export type B2BITransformerSampleDocuments = {
|
14919
|
+
/**
|
14920
|
+
* @minLength `3`
|
14921
|
+
* @maxLength `63`
|
14922
|
+
*/
|
14923
|
+
BucketName: string;
|
14924
|
+
Keys: B2BITransformerSampleDocumentKeys[];
|
14925
|
+
};
|
14713
14926
|
/**
|
14714
14927
|
* Type definition for `AWS::B2BI::Transformer.Tag`.
|
14715
14928
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-tag.html}
|
@@ -14726,6 +14939,11 @@ export type B2BITransformerTag = {
|
|
14726
14939
|
*/
|
14727
14940
|
Value: string;
|
14728
14941
|
};
|
14942
|
+
/**
|
14943
|
+
* Type definition for `AWS::B2BI::Transformer.ToFormat`.
|
14944
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-toformat.html}
|
14945
|
+
*/
|
14946
|
+
export type B2BITransformerToFormat = "X12";
|
14729
14947
|
/**
|
14730
14948
|
* Type definition for `AWS::B2BI::Transformer.TransformerStatus`.
|
14731
14949
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-transformer-transformerstatus.html}
|
@@ -22915,6 +23133,7 @@ export type Cloud9EnvironmentEC2Tag = {
|
|
22915
23133
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-customresource.html}
|
22916
23134
|
*/
|
22917
23135
|
export type CloudFormationCustomResourceProps = {
|
23136
|
+
ServiceTimeout?: number;
|
22918
23137
|
ServiceToken: string;
|
22919
23138
|
};
|
22920
23139
|
/**
|
@@ -57441,6 +57660,7 @@ export type EMRClusterInstanceFleetConfig = {
|
|
57441
57660
|
InstanceTypeConfigs?: EMRClusterInstanceTypeConfig[];
|
57442
57661
|
LaunchSpecifications?: EMRClusterInstanceFleetProvisioningSpecifications;
|
57443
57662
|
Name?: string;
|
57663
|
+
ResizeSpecifications?: EMRClusterInstanceFleetResizingSpecifications;
|
57444
57664
|
TargetOnDemandCapacity?: number;
|
57445
57665
|
TargetSpotCapacity?: number;
|
57446
57666
|
};
|
@@ -57452,6 +57672,14 @@ export type EMRClusterInstanceFleetProvisioningSpecifications = {
|
|
57452
57672
|
OnDemandSpecification?: EMRClusterOnDemandProvisioningSpecification;
|
57453
57673
|
SpotSpecification?: EMRClusterSpotProvisioningSpecification;
|
57454
57674
|
};
|
57675
|
+
/**
|
57676
|
+
* Type definition for `AWS::EMR::Cluster.InstanceFleetResizingSpecifications`.
|
57677
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emr-cluster-instancefleetresizingspecifications.html}
|
57678
|
+
*/
|
57679
|
+
export type EMRClusterInstanceFleetResizingSpecifications = {
|
57680
|
+
OnDemandResizeSpecification?: EMRClusterOnDemandResizingSpecification;
|
57681
|
+
SpotResizeSpecification?: EMRClusterSpotResizingSpecification;
|
57682
|
+
};
|
57455
57683
|
/**
|
57456
57684
|
* Type definition for `AWS::EMR::Cluster.InstanceGroupConfig`.
|
57457
57685
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emr-cluster-instancegroupconfig.html}
|
@@ -57478,6 +57706,7 @@ export type EMRClusterInstanceTypeConfig = {
|
|
57478
57706
|
CustomAmiId?: string;
|
57479
57707
|
EbsConfiguration?: EMRClusterEbsConfiguration;
|
57480
57708
|
InstanceType: string;
|
57709
|
+
Priority?: number;
|
57481
57710
|
WeightedCapacity?: number;
|
57482
57711
|
};
|
57483
57712
|
/**
|
@@ -57539,12 +57768,31 @@ export type EMRClusterMetricDimension = {
|
|
57539
57768
|
Key: string;
|
57540
57769
|
Value: string;
|
57541
57770
|
};
|
57771
|
+
/**
|
57772
|
+
* Type definition for `AWS::EMR::Cluster.OnDemandCapacityReservationOptions`.
|
57773
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emr-cluster-ondemandcapacityreservationoptions.html}
|
57774
|
+
*/
|
57775
|
+
export type EMRClusterOnDemandCapacityReservationOptions = {
|
57776
|
+
CapacityReservationPreference?: string;
|
57777
|
+
CapacityReservationResourceGroupArn?: string;
|
57778
|
+
UsageStrategy?: string;
|
57779
|
+
};
|
57542
57780
|
/**
|
57543
57781
|
* Type definition for `AWS::EMR::Cluster.OnDemandProvisioningSpecification`.
|
57544
57782
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emr-cluster-ondemandprovisioningspecification.html}
|
57545
57783
|
*/
|
57546
57784
|
export type EMRClusterOnDemandProvisioningSpecification = {
|
57547
57785
|
AllocationStrategy: string;
|
57786
|
+
CapacityReservationOptions?: EMRClusterOnDemandCapacityReservationOptions;
|
57787
|
+
};
|
57788
|
+
/**
|
57789
|
+
* Type definition for `AWS::EMR::Cluster.OnDemandResizingSpecification`.
|
57790
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emr-cluster-ondemandresizingspecification.html}
|
57791
|
+
*/
|
57792
|
+
export type EMRClusterOnDemandResizingSpecification = {
|
57793
|
+
AllocationStrategy?: string;
|
57794
|
+
CapacityReservationOptions?: EMRClusterOnDemandCapacityReservationOptions;
|
57795
|
+
TimeoutDurationMinutes?: number;
|
57548
57796
|
};
|
57549
57797
|
/**
|
57550
57798
|
* Type definition for `AWS::EMR::Cluster.PlacementGroupConfig`.
|
@@ -57621,6 +57869,14 @@ export type EMRClusterSpotProvisioningSpecification = {
|
|
57621
57869
|
TimeoutAction: string;
|
57622
57870
|
TimeoutDurationMinutes: number;
|
57623
57871
|
};
|
57872
|
+
/**
|
57873
|
+
* Type definition for `AWS::EMR::Cluster.SpotResizingSpecification`.
|
57874
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emr-cluster-spotresizingspecification.html}
|
57875
|
+
*/
|
57876
|
+
export type EMRClusterSpotResizingSpecification = {
|
57877
|
+
AllocationStrategy?: string;
|
57878
|
+
TimeoutDurationMinutes?: number;
|
57879
|
+
};
|
57624
57880
|
/**
|
57625
57881
|
* Type definition for `AWS::EMR::Cluster.StepConfig`.
|
57626
57882
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emr-cluster-stepconfig.html}
|
@@ -57658,6 +57914,7 @@ export type EMRInstanceFleetConfigProps = {
|
|
57658
57914
|
InstanceTypeConfigs?: EMRInstanceFleetConfigInstanceTypeConfig[];
|
57659
57915
|
LaunchSpecifications?: EMRInstanceFleetConfigInstanceFleetProvisioningSpecifications;
|
57660
57916
|
Name?: string;
|
57917
|
+
ResizeSpecifications?: EMRInstanceFleetConfigInstanceFleetResizingSpecifications;
|
57661
57918
|
TargetOnDemandCapacity?: number;
|
57662
57919
|
TargetSpotCapacity?: number;
|
57663
57920
|
};
|
@@ -57701,6 +57958,14 @@ export type EMRInstanceFleetConfigInstanceFleetProvisioningSpecifications = {
|
|
57701
57958
|
OnDemandSpecification?: EMRInstanceFleetConfigOnDemandProvisioningSpecification;
|
57702
57959
|
SpotSpecification?: EMRInstanceFleetConfigSpotProvisioningSpecification;
|
57703
57960
|
};
|
57961
|
+
/**
|
57962
|
+
* Type definition for `AWS::EMR::InstanceFleetConfig.InstanceFleetResizingSpecifications`.
|
57963
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emr-instancefleetconfig-instancefleetresizingspecifications.html}
|
57964
|
+
*/
|
57965
|
+
export type EMRInstanceFleetConfigInstanceFleetResizingSpecifications = {
|
57966
|
+
OnDemandResizeSpecification?: EMRInstanceFleetConfigOnDemandResizingSpecification;
|
57967
|
+
SpotResizeSpecification?: EMRInstanceFleetConfigSpotResizingSpecification;
|
57968
|
+
};
|
57704
57969
|
/**
|
57705
57970
|
* Type definition for `AWS::EMR::InstanceFleetConfig.InstanceTypeConfig`.
|
57706
57971
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emr-instancefleetconfig-instancetypeconfig.html}
|
@@ -57712,14 +57977,34 @@ export type EMRInstanceFleetConfigInstanceTypeConfig = {
|
|
57712
57977
|
CustomAmiId?: string;
|
57713
57978
|
EbsConfiguration?: EMRInstanceFleetConfigEbsConfiguration;
|
57714
57979
|
InstanceType: string;
|
57980
|
+
Priority?: number;
|
57715
57981
|
WeightedCapacity?: number;
|
57716
57982
|
};
|
57983
|
+
/**
|
57984
|
+
* Type definition for `AWS::EMR::InstanceFleetConfig.OnDemandCapacityReservationOptions`.
|
57985
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emr-instancefleetconfig-ondemandcapacityreservationoptions.html}
|
57986
|
+
*/
|
57987
|
+
export type EMRInstanceFleetConfigOnDemandCapacityReservationOptions = {
|
57988
|
+
CapacityReservationPreference?: string;
|
57989
|
+
CapacityReservationResourceGroupArn?: string;
|
57990
|
+
UsageStrategy?: string;
|
57991
|
+
};
|
57717
57992
|
/**
|
57718
57993
|
* Type definition for `AWS::EMR::InstanceFleetConfig.OnDemandProvisioningSpecification`.
|
57719
57994
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emr-instancefleetconfig-ondemandprovisioningspecification.html}
|
57720
57995
|
*/
|
57721
57996
|
export type EMRInstanceFleetConfigOnDemandProvisioningSpecification = {
|
57722
57997
|
AllocationStrategy: string;
|
57998
|
+
CapacityReservationOptions?: EMRInstanceFleetConfigOnDemandCapacityReservationOptions;
|
57999
|
+
};
|
58000
|
+
/**
|
58001
|
+
* Type definition for `AWS::EMR::InstanceFleetConfig.OnDemandResizingSpecification`.
|
58002
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emr-instancefleetconfig-ondemandresizingspecification.html}
|
58003
|
+
*/
|
58004
|
+
export type EMRInstanceFleetConfigOnDemandResizingSpecification = {
|
58005
|
+
AllocationStrategy?: string;
|
58006
|
+
CapacityReservationOptions?: EMRInstanceFleetConfigOnDemandCapacityReservationOptions;
|
58007
|
+
TimeoutDurationMinutes?: number;
|
57723
58008
|
};
|
57724
58009
|
/**
|
57725
58010
|
* Type definition for `AWS::EMR::InstanceFleetConfig.SpotProvisioningSpecification`.
|
@@ -57731,6 +58016,14 @@ export type EMRInstanceFleetConfigSpotProvisioningSpecification = {
|
|
57731
58016
|
TimeoutAction: string;
|
57732
58017
|
TimeoutDurationMinutes: number;
|
57733
58018
|
};
|
58019
|
+
/**
|
58020
|
+
* Type definition for `AWS::EMR::InstanceFleetConfig.SpotResizingSpecification`.
|
58021
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emr-instancefleetconfig-spotresizingspecification.html}
|
58022
|
+
*/
|
58023
|
+
export type EMRInstanceFleetConfigSpotResizingSpecification = {
|
58024
|
+
AllocationStrategy?: string;
|
58025
|
+
TimeoutDurationMinutes?: number;
|
58026
|
+
};
|
57734
58027
|
/**
|
57735
58028
|
* Type definition for `AWS::EMR::InstanceFleetConfig.VolumeSpecification`.
|
57736
58029
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emr-instancefleetconfig-volumespecification.html}
|
@@ -72283,7 +72576,10 @@ export type IoTDimensionTag = {
|
|
72283
72576
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-domainconfiguration.html}
|
72284
72577
|
*/
|
72285
72578
|
export type IoTDomainConfigurationProps = {
|
72579
|
+
ApplicationProtocol?: "SECURE_MQTT" | "MQTT_WSS" | "HTTPS" | "DEFAULT";
|
72580
|
+
AuthenticationType?: "AWS_X509" | "CUSTOM_AUTH" | "AWS_SIGV4" | "CUSTOM_AUTH_X509" | "DEFAULT";
|
72286
72581
|
AuthorizerConfig?: IoTDomainConfigurationAuthorizerConfig;
|
72582
|
+
ClientCertificateConfig?: IoTDomainConfigurationClientCertificateConfig;
|
72287
72583
|
/**
|
72288
72584
|
* @minLength `1`
|
72289
72585
|
* @maxLength `128`
|
@@ -72341,6 +72637,17 @@ export type IoTDomainConfigurationAuthorizerConfig = {
|
|
72341
72637
|
*/
|
72342
72638
|
DefaultAuthorizerName?: string;
|
72343
72639
|
};
|
72640
|
+
/**
|
72641
|
+
* Type definition for `AWS::IoT::DomainConfiguration.ClientCertificateConfig`.
|
72642
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-domainconfiguration-clientcertificateconfig.html}
|
72643
|
+
*/
|
72644
|
+
export type IoTDomainConfigurationClientCertificateConfig = {
|
72645
|
+
/**
|
72646
|
+
* @minLength `1`
|
72647
|
+
* @maxLength `170`
|
72648
|
+
*/
|
72649
|
+
ClientCertificateCallbackArn?: string;
|
72650
|
+
};
|
72344
72651
|
/**
|
72345
72652
|
* Type definition for `AWS::IoT::DomainConfiguration.ServerCertificateConfig`.
|
72346
72653
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-domainconfiguration-servercertificateconfig.html}
|
@@ -75280,14 +75587,13 @@ export type IoTCoreDeviceAdvisorSuiteDefinitionTag = {
|
|
75280
75587
|
Value: string;
|
75281
75588
|
};
|
75282
75589
|
/**
|
75283
|
-
*
|
75284
|
-
|
75285
|
-
Alarms are instances of alarm models. The alarm model specifies what to detect, when to send notifications, who gets notified, and more. You can also specify one or more supported actions that occur when the alarm state changes. AWS IoT Events routes input attributes derived from your data to the appropriate alarms. If the data that you're monitoring is outside the specified range, the alarm is invoked. You can also acknowledge the alarms or set them to the snooze mode.
|
75590
|
+
* Resource type definition for `AWS::IoTEvents::AlarmModel`.
|
75591
|
+
* Represents an alarm model to monitor an ITE input attribute. You can use the alarm to get notified when the value is outside a specified range. For more information, see [Create an alarm model](https://docs.aws.amazon.com/iotevents/latest/developerguide/create-alarms.html) in the *Developer Guide*.
|
75286
75592
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-alarmmodel.html}
|
75287
75593
|
*/
|
75288
75594
|
export type IoTEventsAlarmModelProps = {
|
75289
75595
|
/**
|
75290
|
-
* Contains the configuration information of alarm state changes
|
75596
|
+
* Contains the configuration information of alarm state changes.
|
75291
75597
|
*/
|
75292
75598
|
AlarmCapabilities?: IoTEventsAlarmModelAlarmCapabilities;
|
75293
75599
|
/**
|
@@ -75295,7 +75601,7 @@ export type IoTEventsAlarmModelProps = {
|
|
75295
75601
|
*/
|
75296
75602
|
AlarmEventActions?: IoTEventsAlarmModelAlarmEventActions;
|
75297
75603
|
/**
|
75298
|
-
*
|
75604
|
+
* The description of the alarm model.
|
75299
75605
|
* @maxLength `1024`
|
75300
75606
|
*/
|
75301
75607
|
AlarmModelDescription?: string;
|
@@ -75311,32 +75617,27 @@ export type IoTEventsAlarmModelProps = {
|
|
75311
75617
|
*/
|
75312
75618
|
AlarmRule: IoTEventsAlarmModelAlarmRule;
|
75313
75619
|
/**
|
75314
|
-
|
75315
|
-
|
75316
|
-
|
75317
|
-
|
75318
|
-
|
75319
|
-
* @pattern `^((`[\w\- ]+`)|([\w\-]+))(\.((`[\w\- ]+`)|([\w\-]+)))*$`
|
75320
|
-
*/
|
75620
|
+
* An input attribute used as a key to create an alarm. ITE routes [inputs](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Input.html) associated with this key to the alarm.
|
75621
|
+
* @minLength `1`
|
75622
|
+
* @maxLength `128`
|
75623
|
+
* @pattern `^((`[\w\- ]+`)|([\w\-]+))(\.((`[\w\- ]+`)|([\w\-]+)))*$`
|
75624
|
+
*/
|
75321
75625
|
Key?: string;
|
75322
75626
|
/**
|
75323
|
-
* The ARN of the role that
|
75627
|
+
* The ARN of the IAM role that allows the alarm to perform actions and access AWS resources. For more information, see [Amazon Resource Names (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference*.
|
75324
75628
|
* @minLength `1`
|
75325
75629
|
* @maxLength `2048`
|
75326
75630
|
*/
|
75327
75631
|
RoleArn: string;
|
75328
75632
|
/**
|
75329
|
-
|
75330
|
-
|
75331
|
-
|
75332
|
-
|
75333
|
-
* @max `2147483647`
|
75334
|
-
*/
|
75633
|
+
* A non-negative integer that reflects the severity level of the alarm.
|
75634
|
+
* @min `0`
|
75635
|
+
* @max `2147483647`
|
75636
|
+
*/
|
75335
75637
|
Severity?: number;
|
75336
75638
|
/**
|
75337
|
-
*
|
75338
|
-
|
75339
|
-
For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).
|
75639
|
+
* A list of key-value pairs that contain metadata for the alarm model. The tags help you manage the alarm model. For more information, see [Tagging your resources](https://docs.aws.amazon.com/iotevents/latest/developerguide/tagging-iotevents.html) in the *Developer Guide*.
|
75640
|
+
You can create up to 50 tags for one alarm model.
|
75340
75641
|
*/
|
75341
75642
|
Tags?: IoTEventsAlarmModelTag[];
|
75342
75643
|
};
|
@@ -75347,52 +75648,92 @@ export type IoTEventsAlarmModelProps = {
|
|
75347
75648
|
*/
|
75348
75649
|
export type IoTEventsAlarmModelAcknowledgeFlow = {
|
75349
75650
|
/**
|
75350
|
-
* The value must be TRUE or FALSE
|
75651
|
+
* The value must be ``TRUE`` or ``FALSE``. If ``TRUE``, you receive a notification when the alarm state changes. You must choose to acknowledge the notification before the alarm state can return to ``NORMAL``. If ``FALSE``, you won't receive notifications. The alarm automatically changes to the ``NORMAL`` state when the input property value returns to the specified range.
|
75351
75652
|
*/
|
75352
75653
|
Enabled?: boolean;
|
75353
75654
|
};
|
75354
75655
|
/**
|
75355
75656
|
* Type definition for `AWS::IoTEvents::AlarmModel.AlarmAction`.
|
75356
|
-
*
|
75657
|
+
* Specifies one of the following actions to receive notifications when the alarm state changes.
|
75357
75658
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-alarmaction.html}
|
75358
75659
|
*/
|
75359
75660
|
export type IoTEventsAlarmModelAlarmAction = {
|
75360
75661
|
/**
|
75361
|
-
|
75362
|
-
|
75662
|
+
* Defines an action to write to the Amazon DynamoDB table that you created. The standard action payload contains all the information about the detector model instance and the event that triggered the action. You can customize the [payload](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html). One column of the DynamoDB table receives all attribute-value pairs in the payload that you specify.
|
75663
|
+
You must use expressions for all parameters in ``DynamoDBAction``. The expressions accept literals, operators, functions, references, and substitution templates.
|
75664
|
+
**Examples**
|
75665
|
+
+ For literal values, the expressions must contain single quotes. For example, the value for the ``hashKeyType`` parameter can be ``'STRING'``.
|
75666
|
+
+ For references, you must specify either variables or input values. For example, the value for the ``hashKeyField`` parameter can be ``$input.GreenhouseInput.name``.
|
75667
|
+
+ For a substitution template, you must use ``${}``, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.
|
75668
|
+
In the following example, the value for the ``hashKeyValue`` parameter uses a substitution template.
|
75669
|
+
``'${$input.GreenhouseInput.temperature * 6 / 5 + 32} in Fahrenheit'``
|
75670
|
+
+ For a string concatenation, you must use ``+``. A string concatenation can also contain a combination of literals, operators, functions, references, and substitution templates.
|
75671
|
+
In the following example, the value for the ``tableName`` parameter uses a string concatenation.
|
75672
|
+
``'GreenhouseTemperatureTable ' + $input.GreenhouseInput.date``
|
75673
|
+
|
75674
|
+
For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *Developer Guide*.
|
75675
|
+
If the defined payload type is a string, ``DynamoDBAction`` writes non-JSON data to the DynamoDB table as binary data. The DynamoDB console displays the data as Base64-encoded text. The value for the ``payloadField`` parameter is ``<payload-field>_raw``.
|
75676
|
+
*/
|
75363
75677
|
DynamoDB?: IoTEventsAlarmModelDynamoDB;
|
75364
75678
|
/**
|
75365
|
-
* Defines an action to write to the Amazon DynamoDB table that you created. The default action payload contains all
|
75366
|
-
|
75367
|
-
|
75679
|
+
* Defines an action to write to the Amazon DynamoDB table that you created. The default action payload contains all the information about the detector model instance and the event that triggered the action. You can customize the [payload](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html). A separate column of the DynamoDB table receives one attribute-value pair in the payload that you specify.
|
75680
|
+
You must use expressions for all parameters in ``DynamoDBv2Action``. The expressions accept literals, operators, functions, references, and substitution templates.
|
75681
|
+
**Examples**
|
75682
|
+
+ For literal values, the expressions must contain single quotes. For example, the value for the ``tableName`` parameter can be ``'GreenhouseTemperatureTable'``.
|
75683
|
+
+ For references, you must specify either variables or input values. For example, the value for the ``tableName`` parameter can be ``$variable.ddbtableName``.
|
75684
|
+
+ For a substitution template, you must use ``${}``, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.
|
75685
|
+
In the following example, the value for the ``contentExpression`` parameter in ``Payload`` uses a substitution template.
|
75686
|
+
``'{\"sensorID\": \"${$input.GreenhouseInput.sensor_id}\", \"temperature\": \"${$input.GreenhouseInput.temperature * 9 / 5 + 32}\"}'``
|
75687
|
+
+ For a string concatenation, you must use ``+``. A string concatenation can also contain a combination of literals, operators, functions, references, and substitution templates.
|
75688
|
+
In the following example, the value for the ``tableName`` parameter uses a string concatenation.
|
75689
|
+
``'GreenhouseTemperatureTable ' + $input.GreenhouseInput.date``
|
75690
|
+
|
75691
|
+
For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *Developer Guide*.
|
75692
|
+
The value for the ``type`` parameter in ``Payload`` must be ``JSON``.
|
75368
75693
|
*/
|
75369
75694
|
DynamoDBv2?: IoTEventsAlarmModelDynamoDBv2;
|
75370
75695
|
/**
|
75371
|
-
* Sends information about the
|
75696
|
+
* Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.
|
75372
75697
|
*/
|
75373
75698
|
Firehose?: IoTEventsAlarmModelFirehose;
|
75374
75699
|
/**
|
75375
|
-
* Sends an
|
75700
|
+
* Sends an ITE input, passing in information about the detector model instance and the event that triggered the action.
|
75376
75701
|
*/
|
75377
75702
|
IotEvents?: IoTEventsAlarmModelIotEvents;
|
75378
75703
|
/**
|
75379
|
-
|
75380
|
-
|
75704
|
+
* Sends information about the detector model instance and the event that triggered the action to a specified asset property in ITSW.
|
75705
|
+
You must use expressions for all parameters in ``IotSiteWiseAction``. The expressions accept literals, operators, functions, references, and substitutions templates.
|
75706
|
+
**Examples**
|
75707
|
+
+ For literal values, the expressions must contain single quotes. For example, the value for the ``propertyAlias`` parameter can be ``'/company/windfarm/3/turbine/7/temperature'``.
|
75708
|
+
+ For references, you must specify either variables or input values. For example, the value for the ``assetId`` parameter can be ``$input.TurbineInput.assetId1``.
|
75709
|
+
+ For a substitution template, you must use ``${}``, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.
|
75710
|
+
In the following example, the value for the ``propertyAlias`` parameter uses a substitution template.
|
75711
|
+
``'company/windfarm/${$input.TemperatureInput.sensorData.windfarmID}/turbine/ ${$input.TemperatureInput.sensorData.turbineID}/temperature'``
|
75712
|
+
|
75713
|
+
You must specify either ``propertyAlias`` or both ``assetId`` and ``propertyId`` to identify the target asset property in ITSW.
|
75714
|
+
For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *Developer Guide*.
|
75715
|
+
*/
|
75381
75716
|
IotSiteWise?: IoTEventsAlarmModelIotSiteWise;
|
75382
75717
|
/**
|
75383
|
-
* Information required to publish the MQTT message through the
|
75718
|
+
* Information required to publish the MQTT message through the IoT message broker.
|
75384
75719
|
*/
|
75385
75720
|
IotTopicPublish?: IoTEventsAlarmModelIotTopicPublish;
|
75721
|
+
/**
|
75722
|
+
* Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action.
|
75723
|
+
*/
|
75386
75724
|
Lambda?: IoTEventsAlarmModelLambda;
|
75387
75725
|
/**
|
75388
75726
|
* Information required to publish the Amazon SNS message.
|
75389
75727
|
*/
|
75390
75728
|
Sns?: IoTEventsAlarmModelSns;
|
75729
|
+
/**
|
75730
|
+
* Sends information about the detector model instance and the event that triggered the action to an Amazon SQS queue.
|
75731
|
+
*/
|
75391
75732
|
Sqs?: IoTEventsAlarmModelSqs;
|
75392
75733
|
};
|
75393
75734
|
/**
|
75394
75735
|
* Type definition for `AWS::IoTEvents::AlarmModel.AlarmCapabilities`.
|
75395
|
-
* Contains the configuration information of alarm state changes
|
75736
|
+
* Contains the configuration information of alarm state changes.
|
75396
75737
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-alarmcapabilities.html}
|
75397
75738
|
*/
|
75398
75739
|
export type IoTEventsAlarmModelAlarmCapabilities = {
|
@@ -75429,79 +75770,115 @@ export type IoTEventsAlarmModelAlarmRule = {
|
|
75429
75770
|
};
|
75430
75771
|
/**
|
75431
75772
|
* Type definition for `AWS::IoTEvents::AlarmModel.AssetPropertyTimestamp`.
|
75432
|
-
* A structure that contains timestamp information. For more information, see [TimeInNanos](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_TimeInNanos.html) in the *
|
75773
|
+
* A structure that contains timestamp information. For more information, see [TimeInNanos](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_TimeInNanos.html) in the *API Reference*.
|
75774
|
+
You must use expressions for all parameters in ``AssetPropertyTimestamp``. The expressions accept literals, operators, functions, references, and substitution templates.
|
75775
|
+
**Examples**
|
75776
|
+
+ For literal values, the expressions must contain single quotes. For example, the value for the ``timeInSeconds`` parameter can be ``'1586400675'``.
|
75777
|
+
+ For references, you must specify either variables or input values. For example, the value for the ``offsetInNanos`` parameter can be ``$variable.time``.
|
75778
|
+
+ For a substitution template, you must use ``${}``, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.
|
75779
|
+
In the following example, the value for the ``timeInSeconds`` parameter uses a substitution template.
|
75780
|
+
``'${$input.TemperatureInput.sensorData.timestamp / 1000}'``
|
75781
|
+
|
75782
|
+
For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *Developer Guide*.
|
75433
75783
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-assetpropertytimestamp.html}
|
75434
75784
|
*/
|
75435
75785
|
export type IoTEventsAlarmModelAssetPropertyTimestamp = {
|
75436
75786
|
/**
|
75437
|
-
* The
|
75787
|
+
* The nanosecond offset converted from ``timeInSeconds``. The valid range is between 0-999999999.
|
75438
75788
|
*/
|
75439
75789
|
OffsetInNanos?: string;
|
75440
75790
|
/**
|
75441
|
-
* The
|
75791
|
+
* The timestamp, in seconds, in the Unix epoch format. The valid range is between 1-31556889864403199.
|
75442
75792
|
*/
|
75443
75793
|
TimeInSeconds: string;
|
75444
75794
|
};
|
75445
75795
|
/**
|
75446
75796
|
* Type definition for `AWS::IoTEvents::AlarmModel.AssetPropertyValue`.
|
75447
|
-
* A structure that contains value information. For more information, see [AssetPropertyValue](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_AssetPropertyValue.html) in the *
|
75797
|
+
* A structure that contains value information. For more information, see [AssetPropertyValue](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_AssetPropertyValue.html) in the *API Reference*.
|
75798
|
+
You must use expressions for all parameters in ``AssetPropertyValue``. The expressions accept literals, operators, functions, references, and substitution templates.
|
75799
|
+
**Examples**
|
75800
|
+
+ For literal values, the expressions must contain single quotes. For example, the value for the ``quality`` parameter can be ``'GOOD'``.
|
75801
|
+
+ For references, you must specify either variables or input values. For example, the value for the ``quality`` parameter can be ``$input.TemperatureInput.sensorData.quality``.
|
75802
|
+
|
75803
|
+
For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *Developer Guide*.
|
75448
75804
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-assetpropertyvalue.html}
|
75449
75805
|
*/
|
75450
75806
|
export type IoTEventsAlarmModelAssetPropertyValue = {
|
75451
75807
|
/**
|
75452
|
-
* The quality of the asset property value. The value must be
|
75808
|
+
* The quality of the asset property value. The value must be ``'GOOD'``, ``'BAD'``, or ``'UNCERTAIN'``.
|
75453
75809
|
*/
|
75454
75810
|
Quality?: string;
|
75455
75811
|
/**
|
75456
|
-
*
|
75812
|
+
* The timestamp associated with the asset property value. The default is the current event time.
|
75457
75813
|
*/
|
75458
75814
|
Timestamp?: IoTEventsAlarmModelAssetPropertyTimestamp;
|
75459
75815
|
/**
|
75460
|
-
*
|
75816
|
+
* The value to send to an asset property.
|
75461
75817
|
*/
|
75462
75818
|
Value: IoTEventsAlarmModelAssetPropertyVariant;
|
75463
75819
|
};
|
75464
75820
|
/**
|
75465
75821
|
* Type definition for `AWS::IoTEvents::AlarmModel.AssetPropertyVariant`.
|
75466
|
-
* A structure that contains an asset property value. For more information, see [Variant](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_Variant.html) in the *
|
75822
|
+
* A structure that contains an asset property value. For more information, see [Variant](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_Variant.html) in the *API Reference*.
|
75823
|
+
You must use expressions for all parameters in ``AssetPropertyVariant``. The expressions accept literals, operators, functions, references, and substitution templates.
|
75824
|
+
**Examples**
|
75825
|
+
+ For literal values, the expressions must contain single quotes. For example, the value for the ``integerValue`` parameter can be ``'100'``.
|
75826
|
+
+ For references, you must specify either variables or parameters. For example, the value for the ``booleanValue`` parameter can be ``$variable.offline``.
|
75827
|
+
+ For a substitution template, you must use ``${}``, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.
|
75828
|
+
In the following example, the value for the ``doubleValue`` parameter uses a substitution template.
|
75829
|
+
``'${$input.TemperatureInput.sensorData.temperature * 6 / 5 + 32}'``
|
75830
|
+
|
75831
|
+
For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *Developer Guide*.
|
75832
|
+
You must specify one of the following value types, depending on the ``dataType`` of the specified asset property. For more information, see [AssetProperty](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_AssetProperty.html) in the *API Reference*.
|
75467
75833
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-assetpropertyvariant.html}
|
75468
75834
|
*/
|
75469
75835
|
export type IoTEventsAlarmModelAssetPropertyVariant = {
|
75470
75836
|
/**
|
75471
|
-
* The asset property value is a Boolean value that must be
|
75837
|
+
* The asset property value is a Boolean value that must be ``'TRUE'`` or ``'FALSE'``. You must use an expression, and the evaluated result should be a Boolean value.
|
75472
75838
|
*/
|
75473
75839
|
BooleanValue?: string;
|
75474
75840
|
/**
|
75475
|
-
* The asset property value is a double. You
|
75841
|
+
* The asset property value is a double. You must use an expression, and the evaluated result should be a double.
|
75476
75842
|
*/
|
75477
75843
|
DoubleValue?: string;
|
75478
75844
|
/**
|
75479
|
-
* The asset property value is an integer. You
|
75845
|
+
* The asset property value is an integer. You must use an expression, and the evaluated result should be an integer.
|
75480
75846
|
*/
|
75481
75847
|
IntegerValue?: string;
|
75482
75848
|
/**
|
75483
|
-
* The asset property value is a string. You
|
75849
|
+
* The asset property value is a string. You must use an expression, and the evaluated result should be a string.
|
75484
75850
|
*/
|
75485
75851
|
StringValue?: string;
|
75486
75852
|
};
|
75487
75853
|
/**
|
75488
75854
|
* Type definition for `AWS::IoTEvents::AlarmModel.DynamoDB`.
|
75489
|
-
*
|
75855
|
+
* Defines an action to write to the Amazon DynamoDB table that you created. The standard action payload contains all the information about the detector model instance and the event that triggered the action. You can customize the [payload](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html). One column of the DynamoDB table receives all attribute-value pairs in the payload that you specify.
|
75856
|
+
You must use expressions for all parameters in ``DynamoDBAction``. The expressions accept literals, operators, functions, references, and substitution templates.
|
75857
|
+
**Examples**
|
75858
|
+
+ For literal values, the expressions must contain single quotes. For example, the value for the ``hashKeyType`` parameter can be ``'STRING'``.
|
75859
|
+
+ For references, you must specify either variables or input values. For example, the value for the ``hashKeyField`` parameter can be ``$input.GreenhouseInput.name``.
|
75860
|
+
+ For a substitution template, you must use ``${}``, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.
|
75861
|
+
In the following example, the value for the ``hashKeyValue`` parameter uses a substitution template.
|
75862
|
+
``'${$input.GreenhouseInput.temperature * 6 / 5 + 32} in Fahrenheit'``
|
75863
|
+
+ For a string concatenation, you must use ``+``. A string concatenation can also contain a combination of literals, operators, functions, references, and substitution templates.
|
75864
|
+
In the following example, the value for the ``tableName`` parameter uses a string concatenation.
|
75865
|
+
``'GreenhouseTemperatureTable ' + $input.GreenhouseInput.date``
|
75866
|
+
|
75867
|
+
For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *Developer Guide*.
|
75868
|
+
If the defined payload type is a string, ``DynamoDBAction`` writes non-JSON data to the DynamoDB table as binary data. The DynamoDB console displays the data as Base64-encoded text. The value for the ``payloadField`` parameter is ``<payload-field>_raw``.
|
75490
75869
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-dynamodb.html}
|
75491
75870
|
*/
|
75492
75871
|
export type IoTEventsAlarmModelDynamoDB = {
|
75493
75872
|
/**
|
75494
|
-
* The name of the hash key (also called the partition key).
|
75873
|
+
* The name of the hash key (also called the partition key). The ``hashKeyField`` value must match the partition key of the target DynamoDB table.
|
75495
75874
|
*/
|
75496
75875
|
HashKeyField: string;
|
75497
75876
|
/**
|
75498
75877
|
* The data type for the hash key (also called the partition key). You can specify the following values:
|
75499
|
-
|
75500
|
-
|
75501
|
-
|
75502
|
-
|
75503
|
-
|
75504
|
-
If you don't specify `hashKeyType`, the default value is `STRING`.
|
75878
|
+
+ ``'STRING'`` - The hash key is a string.
|
75879
|
+
+ ``'NUMBER'`` - The hash key is a number.
|
75880
|
+
|
75881
|
+
If you don't specify ``hashKeyType``, the default value is ``'STRING'``.
|
75505
75882
|
*/
|
75506
75883
|
HashKeyType?: string;
|
75507
75884
|
/**
|
@@ -75510,40 +75887,33 @@ export type IoTEventsAlarmModelDynamoDB = {
|
|
75510
75887
|
HashKeyValue: string;
|
75511
75888
|
/**
|
75512
75889
|
* The type of operation to perform. You can specify the following values:
|
75513
|
-
|
75514
|
-
|
75515
|
-
|
75516
|
-
|
75517
|
-
|
75518
|
-
* `DELETE` - Delete an existing item of the DynamoDB table. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key.
|
75519
|
-
|
75520
|
-
If you don't specify this parameter, AWS IoT Events triggers the `INSERT` operation.
|
75890
|
+
+ ``'INSERT'`` - Insert data as a new item into the DynamoDB table. This item uses the specified hash key as a partition key. If you specified a range key, the item uses the range key as a sort key.
|
75891
|
+
+ ``'UPDATE'`` - Update an existing item of the DynamoDB table with new data. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key.
|
75892
|
+
+ ``'DELETE'`` - Delete an existing item of the DynamoDB table. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key.
|
75893
|
+
|
75894
|
+
If you don't specify this parameter, ITE triggers the ``'INSERT'`` operation.
|
75521
75895
|
*/
|
75522
75896
|
Operation?: string;
|
75523
75897
|
/**
|
75524
75898
|
* Information needed to configure the payload.
|
75525
|
-
|
75526
|
-
By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the alarm model instance and the event triggered the action. To configure the action payload, you can use `contentExpression`.
|
75899
|
+
By default, ITE generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use ``contentExpression``.
|
75527
75900
|
*/
|
75528
75901
|
Payload?: IoTEventsAlarmModelPayload;
|
75529
75902
|
/**
|
75530
75903
|
* The name of the DynamoDB column that receives the action payload.
|
75531
|
-
|
75532
|
-
If you don't specify this parameter, the name of the DynamoDB column is `payload`.
|
75904
|
+
If you don't specify this parameter, the name of the DynamoDB column is ``payload``.
|
75533
75905
|
*/
|
75534
75906
|
PayloadField?: string;
|
75535
75907
|
/**
|
75536
|
-
* The name of the range key (also called the sort key).
|
75908
|
+
* The name of the range key (also called the sort key). The ``rangeKeyField`` value must match the sort key of the target DynamoDB table.
|
75537
75909
|
*/
|
75538
75910
|
RangeKeyField?: string;
|
75539
75911
|
/**
|
75540
75912
|
* The data type for the range key (also called the sort key), You can specify the following values:
|
75541
|
-
|
75542
|
-
|
75543
|
-
|
75544
|
-
|
75545
|
-
|
75546
|
-
If you don't specify `rangeKeyField`, the default value is `STRING`.
|
75913
|
+
+ ``'STRING'`` - The range key is a string.
|
75914
|
+
+ ``'NUMBER'`` - The range key is number.
|
75915
|
+
|
75916
|
+
If you don't specify ``rangeKeyField``, the default value is ``'STRING'``.
|
75547
75917
|
*/
|
75548
75918
|
RangeKeyType?: string;
|
75549
75919
|
/**
|
@@ -75551,22 +75921,32 @@ export type IoTEventsAlarmModelDynamoDB = {
|
|
75551
75921
|
*/
|
75552
75922
|
RangeKeyValue?: string;
|
75553
75923
|
/**
|
75554
|
-
* The name of the DynamoDB table.
|
75924
|
+
* The name of the DynamoDB table. The ``tableName`` value must match the table name of the target DynamoDB table.
|
75555
75925
|
*/
|
75556
75926
|
TableName: string;
|
75557
75927
|
};
|
75558
75928
|
/**
|
75559
75929
|
* Type definition for `AWS::IoTEvents::AlarmModel.DynamoDBv2`.
|
75560
|
-
* Defines an action to write to the Amazon DynamoDB table that you created. The default action payload contains all
|
75561
|
-
|
75562
|
-
|
75930
|
+
* Defines an action to write to the Amazon DynamoDB table that you created. The default action payload contains all the information about the detector model instance and the event that triggered the action. You can customize the [payload](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html). A separate column of the DynamoDB table receives one attribute-value pair in the payload that you specify.
|
75931
|
+
You must use expressions for all parameters in ``DynamoDBv2Action``. The expressions accept literals, operators, functions, references, and substitution templates.
|
75932
|
+
**Examples**
|
75933
|
+
+ For literal values, the expressions must contain single quotes. For example, the value for the ``tableName`` parameter can be ``'GreenhouseTemperatureTable'``.
|
75934
|
+
+ For references, you must specify either variables or input values. For example, the value for the ``tableName`` parameter can be ``$variable.ddbtableName``.
|
75935
|
+
+ For a substitution template, you must use ``${}``, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.
|
75936
|
+
In the following example, the value for the ``contentExpression`` parameter in ``Payload`` uses a substitution template.
|
75937
|
+
``'{\"sensorID\": \"${$input.GreenhouseInput.sensor_id}\", \"temperature\": \"${$input.GreenhouseInput.temperature * 9 / 5 + 32}\"}'``
|
75938
|
+
+ For a string concatenation, you must use ``+``. A string concatenation can also contain a combination of literals, operators, functions, references, and substitution templates.
|
75939
|
+
In the following example, the value for the ``tableName`` parameter uses a string concatenation.
|
75940
|
+
``'GreenhouseTemperatureTable ' + $input.GreenhouseInput.date``
|
75941
|
+
|
75942
|
+
For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *Developer Guide*.
|
75943
|
+
The value for the ``type`` parameter in ``Payload`` must be ``JSON``.
|
75563
75944
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-dynamodbv2.html}
|
75564
75945
|
*/
|
75565
75946
|
export type IoTEventsAlarmModelDynamoDBv2 = {
|
75566
75947
|
/**
|
75567
75948
|
* Information needed to configure the payload.
|
75568
|
-
|
75569
|
-
By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the alarm model instance and the event triggered the action. To configure the action payload, you can use `contentExpression`.
|
75949
|
+
By default, ITE generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use ``contentExpression``.
|
75570
75950
|
*/
|
75571
75951
|
Payload?: IoTEventsAlarmModelPayload;
|
75572
75952
|
/**
|
@@ -75576,7 +75956,7 @@ export type IoTEventsAlarmModelDynamoDBv2 = {
|
|
75576
75956
|
};
|
75577
75957
|
/**
|
75578
75958
|
* Type definition for `AWS::IoTEvents::AlarmModel.Firehose`.
|
75579
|
-
* Sends information about the
|
75959
|
+
* Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.
|
75580
75960
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-firehose.html}
|
75581
75961
|
*/
|
75582
75962
|
export type IoTEventsAlarmModelFirehose = {
|
@@ -75585,10 +75965,8 @@ export type IoTEventsAlarmModelFirehose = {
|
|
75585
75965
|
*/
|
75586
75966
|
DeliveryStreamName: string;
|
75587
75967
|
/**
|
75588
|
-
|
75589
|
-
|
75590
|
-
By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the alarm model instance and the event triggered the action. To configure the action payload, you can use `contentExpression`.
|
75591
|
-
*/
|
75968
|
+
* You can configure the action payload when you send a message to an Amazon Data Firehose delivery stream.
|
75969
|
+
*/
|
75592
75970
|
Payload?: IoTEventsAlarmModelPayload;
|
75593
75971
|
/**
|
75594
75972
|
* A character separator that is used to separate records written to the Kinesis Data Firehose delivery stream. Valid values are: '\n' (newline), '\t' (tab), '\r\n' (Windows newline), ',' (comma).
|
@@ -75603,78 +75981,85 @@ export type IoTEventsAlarmModelFirehose = {
|
|
75603
75981
|
*/
|
75604
75982
|
export type IoTEventsAlarmModelInitializationConfiguration = {
|
75605
75983
|
/**
|
75606
|
-
* The value must be TRUE or FALSE
|
75984
|
+
* The value must be ``TRUE`` or ``FALSE``. If ``FALSE``, all alarm instances created based on the alarm model are activated. The default value is ``TRUE``.
|
75607
75985
|
*/
|
75608
75986
|
DisabledOnInitialization: boolean;
|
75609
75987
|
};
|
75610
75988
|
/**
|
75611
75989
|
* Type definition for `AWS::IoTEvents::AlarmModel.IotEvents`.
|
75612
|
-
* Sends an
|
75990
|
+
* Sends an ITE input, passing in information about the detector model instance and the event that triggered the action.
|
75613
75991
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-iotevents.html}
|
75614
75992
|
*/
|
75615
75993
|
export type IoTEventsAlarmModelIotEvents = {
|
75616
75994
|
/**
|
75617
|
-
* The name of the
|
75995
|
+
* The name of the ITE input where the data is sent.
|
75618
75996
|
* @minLength `1`
|
75619
75997
|
* @maxLength `128`
|
75620
75998
|
* @pattern `^[a-zA-Z][a-zA-Z0-9_]*$`
|
75621
75999
|
*/
|
75622
76000
|
InputName: string;
|
75623
76001
|
/**
|
75624
|
-
|
75625
|
-
|
75626
|
-
By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the alarm model instance and the event triggered the action. To configure the action payload, you can use `contentExpression`.
|
75627
|
-
*/
|
76002
|
+
* You can configure the action payload when you send a message to an ITE input.
|
76003
|
+
*/
|
75628
76004
|
Payload?: IoTEventsAlarmModelPayload;
|
75629
76005
|
};
|
75630
76006
|
/**
|
75631
76007
|
* Type definition for `AWS::IoTEvents::AlarmModel.IotSiteWise`.
|
75632
|
-
* Sends information about the
|
76008
|
+
* Sends information about the detector model instance and the event that triggered the action to a specified asset property in ITSW.
|
76009
|
+
You must use expressions for all parameters in ``IotSiteWiseAction``. The expressions accept literals, operators, functions, references, and substitutions templates.
|
76010
|
+
**Examples**
|
76011
|
+
+ For literal values, the expressions must contain single quotes. For example, the value for the ``propertyAlias`` parameter can be ``'/company/windfarm/3/turbine/7/temperature'``.
|
76012
|
+
+ For references, you must specify either variables or input values. For example, the value for the ``assetId`` parameter can be ``$input.TurbineInput.assetId1``.
|
76013
|
+
+ For a substitution template, you must use ``${}``, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.
|
76014
|
+
In the following example, the value for the ``propertyAlias`` parameter uses a substitution template.
|
76015
|
+
``'company/windfarm/${$input.TemperatureInput.sensorData.windfarmID}/turbine/ ${$input.TemperatureInput.sensorData.turbineID}/temperature'``
|
76016
|
+
|
76017
|
+
You must specify either ``propertyAlias`` or both ``assetId`` and ``propertyId`` to identify the target asset property in ITSW.
|
76018
|
+
For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *Developer Guide*.
|
75633
76019
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-iotsitewise.html}
|
75634
76020
|
*/
|
75635
76021
|
export type IoTEventsAlarmModelIotSiteWise = {
|
75636
76022
|
/**
|
75637
|
-
* The ID of the asset that has the specified property.
|
76023
|
+
* The ID of the asset that has the specified property.
|
75638
76024
|
*/
|
75639
76025
|
AssetId?: string;
|
75640
76026
|
/**
|
75641
|
-
* A unique identifier for this entry. You can use the entry ID to track which data entry causes an error in case of failure. The default is a new unique identifier.
|
76027
|
+
* A unique identifier for this entry. You can use the entry ID to track which data entry causes an error in case of failure. The default is a new unique identifier.
|
75642
76028
|
*/
|
75643
76029
|
EntryId?: string;
|
75644
76030
|
/**
|
75645
|
-
* The alias of the asset property.
|
76031
|
+
* The alias of the asset property.
|
75646
76032
|
*/
|
75647
76033
|
PropertyAlias?: string;
|
75648
76034
|
/**
|
75649
|
-
* The ID of the asset property.
|
76035
|
+
* The ID of the asset property.
|
75650
76036
|
*/
|
75651
76037
|
PropertyId?: string;
|
75652
76038
|
/**
|
75653
|
-
*
|
76039
|
+
* The value to send to the asset property. This value contains timestamp, quality, and value (TQV) information.
|
75654
76040
|
*/
|
75655
76041
|
PropertyValue?: IoTEventsAlarmModelAssetPropertyValue;
|
75656
76042
|
};
|
75657
76043
|
/**
|
75658
76044
|
* Type definition for `AWS::IoTEvents::AlarmModel.IotTopicPublish`.
|
75659
|
-
* Information required to publish the MQTT message through the
|
76045
|
+
* Information required to publish the MQTT message through the IoT message broker.
|
75660
76046
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-iottopicpublish.html}
|
75661
76047
|
*/
|
75662
76048
|
export type IoTEventsAlarmModelIotTopicPublish = {
|
75663
76049
|
/**
|
75664
|
-
* The MQTT topic of the message. You can use a string expression that includes variables (
|
76050
|
+
* The MQTT topic of the message. You can use a string expression that includes variables (``$variable.<variable-name>``) and input values (``$input.<input-name>.<path-to-datum>``) as the topic string.
|
75665
76051
|
* @minLength `1`
|
75666
76052
|
* @maxLength `128`
|
75667
76053
|
*/
|
75668
76054
|
MqttTopic: string;
|
75669
76055
|
/**
|
75670
|
-
|
75671
|
-
|
75672
|
-
By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the alarm model instance and the event triggered the action. To configure the action payload, you can use `contentExpression`.
|
75673
|
-
*/
|
76056
|
+
* You can configure the action payload when you publish a message to an IoTCore topic.
|
76057
|
+
*/
|
75674
76058
|
Payload?: IoTEventsAlarmModelPayload;
|
75675
76059
|
};
|
75676
76060
|
/**
|
75677
76061
|
* Type definition for `AWS::IoTEvents::AlarmModel.Lambda`.
|
76062
|
+
* Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action.
|
75678
76063
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-lambda.html}
|
75679
76064
|
*/
|
75680
76065
|
export type IoTEventsAlarmModelLambda = {
|
@@ -75685,27 +76070,24 @@ export type IoTEventsAlarmModelLambda = {
|
|
75685
76070
|
*/
|
75686
76071
|
FunctionArn: string;
|
75687
76072
|
/**
|
75688
|
-
|
75689
|
-
|
75690
|
-
By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the alarm model instance and the event triggered the action. To configure the action payload, you can use `contentExpression`.
|
75691
|
-
*/
|
76073
|
+
* You can configure the action payload when you send a message to a Lambda function.
|
76074
|
+
*/
|
75692
76075
|
Payload?: IoTEventsAlarmModelPayload;
|
75693
76076
|
};
|
75694
76077
|
/**
|
75695
76078
|
* Type definition for `AWS::IoTEvents::AlarmModel.Payload`.
|
75696
76079
|
* Information needed to configure the payload.
|
75697
|
-
|
75698
|
-
By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the alarm model instance and the event triggered the action. To configure the action payload, you can use `contentExpression`.
|
76080
|
+
By default, ITE generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use ``contentExpression``.
|
75699
76081
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-payload.html}
|
75700
76082
|
*/
|
75701
76083
|
export type IoTEventsAlarmModelPayload = {
|
75702
76084
|
/**
|
75703
|
-
* The content of the payload. You can use a string expression that includes quoted strings (
|
76085
|
+
* The content of the payload. You can use a string expression that includes quoted strings (``'<string>'``), variables (``$variable.<variable-name>``), input values (``$input.<input-name>.<path-to-datum>``), string concatenations, and quoted strings that contain ``${}`` as the content. The recommended maximum size of a content expression is 1 KB.
|
75704
76086
|
* @minLength `1`
|
75705
76087
|
*/
|
75706
76088
|
ContentExpression: string;
|
75707
76089
|
/**
|
75708
|
-
* The value of the payload type can be either
|
76090
|
+
* The value of the payload type can be either ``STRING`` or ``JSON``.
|
75709
76091
|
*/
|
75710
76092
|
Type: string;
|
75711
76093
|
};
|
@@ -75720,13 +76102,13 @@ export type IoTEventsAlarmModelSimpleRule = {
|
|
75720
76102
|
*/
|
75721
76103
|
ComparisonOperator: "GREATER" | "GREATER_OR_EQUAL" | "LESS" | "LESS_OR_EQUAL" | "EQUAL" | "NOT_EQUAL";
|
75722
76104
|
/**
|
75723
|
-
* The value on the left side of the comparison operator. You can specify an
|
76105
|
+
* The value on the left side of the comparison operator. You can specify an ITE input attribute as an input property.
|
75724
76106
|
* @minLength `1`
|
75725
76107
|
* @maxLength `512`
|
75726
76108
|
*/
|
75727
76109
|
InputProperty: string;
|
75728
76110
|
/**
|
75729
|
-
* The value on the right side of the comparison operator. You can enter a number or specify an
|
76111
|
+
* The value on the right side of the comparison operator. You can enter a number or specify an ITE input attribute.
|
75730
76112
|
* @minLength `1`
|
75731
76113
|
* @maxLength `512`
|
75732
76114
|
*/
|
@@ -75739,10 +76121,8 @@ export type IoTEventsAlarmModelSimpleRule = {
|
|
75739
76121
|
*/
|
75740
76122
|
export type IoTEventsAlarmModelSns = {
|
75741
76123
|
/**
|
75742
|
-
|
75743
|
-
|
75744
|
-
By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the alarm model instance and the event triggered the action. To configure the action payload, you can use `contentExpression`.
|
75745
|
-
*/
|
76124
|
+
* You can configure the action payload when you send a message as an Amazon SNS push notification.
|
76125
|
+
*/
|
75746
76126
|
Payload?: IoTEventsAlarmModelPayload;
|
75747
76127
|
/**
|
75748
76128
|
* The ARN of the Amazon SNS target where the message is sent.
|
@@ -75753,41 +76133,44 @@ export type IoTEventsAlarmModelSns = {
|
|
75753
76133
|
};
|
75754
76134
|
/**
|
75755
76135
|
* Type definition for `AWS::IoTEvents::AlarmModel.Sqs`.
|
76136
|
+
* Sends information about the detector model instance and the event that triggered the action to an Amazon SQS queue.
|
75756
76137
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-sqs.html}
|
75757
76138
|
*/
|
75758
76139
|
export type IoTEventsAlarmModelSqs = {
|
75759
76140
|
/**
|
75760
|
-
|
75761
|
-
|
75762
|
-
By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the alarm model instance and the event triggered the action. To configure the action payload, you can use `contentExpression`.
|
75763
|
-
*/
|
76141
|
+
* You can configure the action payload when you send a message to an Amazon SQS queue.
|
76142
|
+
*/
|
75764
76143
|
Payload?: IoTEventsAlarmModelPayload;
|
75765
76144
|
/**
|
75766
76145
|
* The URL of the SQS queue where the data is written.
|
75767
76146
|
*/
|
75768
76147
|
QueueUrl: string;
|
75769
76148
|
/**
|
75770
|
-
* Set this to
|
76149
|
+
* Set this to TRUE if you want the data to be base-64 encoded before it is written to the queue. Otherwise, set this to FALSE.
|
75771
76150
|
*/
|
75772
76151
|
UseBase64?: boolean;
|
75773
76152
|
};
|
75774
76153
|
/**
|
75775
76154
|
* Type definition for `AWS::IoTEvents::AlarmModel.Tag`.
|
75776
|
-
*
|
76155
|
+
* Metadata that can be used to manage the resource.
|
75777
76156
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-tag.html}
|
75778
76157
|
*/
|
75779
76158
|
export type IoTEventsAlarmModelTag = {
|
75780
76159
|
/**
|
75781
|
-
*
|
76160
|
+
* The tag's key.
|
75782
76161
|
*/
|
75783
76162
|
Key: string;
|
75784
76163
|
/**
|
75785
|
-
*
|
76164
|
+
* The tag's value.
|
75786
76165
|
*/
|
75787
76166
|
Value: string;
|
75788
76167
|
};
|
75789
76168
|
/**
|
75790
|
-
* The AWS::IoTEvents::DetectorModel resource creates a detector model. You create a *detector model* (a model of your equipment or process) using *states*. For each state, you define conditional (Boolean) logic that evaluates the incoming inputs to detect significant events. When an event is detected, it can change the state or trigger custom-built or predefined actions using other AWS services. You can define additional events that trigger actions when entering or exiting a state and, optionally, when a condition is met. For more information, see [How to Use
|
76169
|
+
* The AWS::IoTEvents::DetectorModel resource creates a detector model. You create a *detector model* (a model of your equipment or process) using *states*. For each state, you define conditional (Boolean) logic that evaluates the incoming inputs to detect significant events. When an event is detected, it can change the state or trigger custom-built or predefined actions using other AWS services. You can define additional events that trigger actions when entering or exiting a state and, optionally, when a condition is met. For more information, see [How to Use](https://docs.aws.amazon.com/iotevents/latest/developerguide/how-to-use-iotevents.html) in the *Developer Guide*.
|
76170
|
+
When you successfully update a detector model (using the ITE console, ITE API or CLI commands, or CFN) all detector instances created by the model are reset to their initial states. (The detector's ``state``, and the values of any variables and timers are reset.)
|
76171
|
+
When you successfully update a detector model (using the ITE console, ITE API or CLI commands, or CFN) the version number of the detector model is incremented. (A detector model with version number 1 before the update has version number 2 after the update succeeds.)
|
76172
|
+
If you attempt to update a detector model using CFN and the update does not succeed, the system may, in some cases, restore the original detector model. When this occurs, the detector model's version is incremented twice (for example, from version 1 to version 3) and the detector instances are reset.
|
76173
|
+
Also, be aware that if you attempt to update several detector models at once using CFN, some updates may succeed and others fail. In this case, the effects on each detector model's detector instances and version number depend on whether the update succeeded or failed, with the results as stated.
|
75791
76174
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-detectormodel.html}
|
75792
76175
|
*/
|
75793
76176
|
export type IoTEventsDetectorModelProps = {
|
@@ -75812,30 +76195,28 @@ export type IoTEventsDetectorModelProps = {
|
|
75812
76195
|
*/
|
75813
76196
|
EvaluationMethod?: "BATCH" | "SERIAL";
|
75814
76197
|
/**
|
75815
|
-
* The value used to identify a detector instance. When a device or system sends input, a new detector instance with a unique key value is created.
|
75816
|
-
|
75817
|
-
This parameter uses a JSON-path expression to select the attribute-value pair in the message payload that is used for identification. To route the message to the correct detector instance, the device must send a message payload that contains the same attribute-value.
|
76198
|
+
* The value used to identify a detector instance. When a device or system sends input, a new detector instance with a unique key value is created. ITE can continue to route input to its corresponding detector instance based on this identifying information.
|
76199
|
+
This parameter uses a JSON-path expression to select the attribute-value pair in the message payload that is used for identification. To route the message to the correct detector instance, the device must send a message payload that contains the same attribute-value.
|
75818
76200
|
* @minLength `1`
|
75819
76201
|
* @maxLength `128`
|
75820
76202
|
* @pattern `^((`[\w\- ]+`)|([\w\-]+))(\.((`[\w\- ]+`)|([\w\-]+)))*$`
|
75821
76203
|
*/
|
75822
76204
|
Key?: string;
|
75823
76205
|
/**
|
75824
|
-
* The ARN of the role that grants permission to
|
76206
|
+
* The ARN of the role that grants permission to ITE to perform its operations.
|
75825
76207
|
* @minLength `1`
|
75826
76208
|
* @maxLength `2048`
|
75827
76209
|
*/
|
75828
76210
|
RoleArn: string;
|
75829
76211
|
/**
|
75830
76212
|
* An array of key-value pairs to apply to this resource.
|
75831
|
-
|
75832
|
-
For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).
|
76213
|
+
For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).
|
75833
76214
|
*/
|
75834
76215
|
Tags?: IoTEventsDetectorModelTag[];
|
75835
76216
|
};
|
75836
76217
|
/**
|
75837
76218
|
* Type definition for `AWS::IoTEvents::DetectorModel.Action`.
|
75838
|
-
*
|
76219
|
+
* An action to be performed when the ``condition`` is TRUE.
|
75839
76220
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-action.html}
|
75840
76221
|
*/
|
75841
76222
|
export type IoTEventsDetectorModelAction = {
|
@@ -75844,34 +76225,35 @@ export type IoTEventsDetectorModelAction = {
|
|
75844
76225
|
*/
|
75845
76226
|
ClearTimer?: IoTEventsDetectorModelClearTimer;
|
75846
76227
|
/**
|
75847
|
-
* Writes to the DynamoDB table that you created. The default action payload contains all attribute-value pairs that have the information about the detector model instance and the event that triggered the action. You can
|
76228
|
+
* Writes to the DynamoDB table that you created. The default action payload contains all attribute-value pairs that have the information about the detector model instance and the event that triggered the action. You can customize the [payload](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html). One column of the DynamoDB table receives all attribute-value pairs in the payload that you specify. For more information, see [Actions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-event-actions.html) in *Developer Guide*.
|
75848
76229
|
*/
|
75849
76230
|
DynamoDB?: IoTEventsDetectorModelDynamoDB;
|
75850
76231
|
/**
|
75851
|
-
|
75852
|
-
|
75853
|
-
You can use expressions for parameters that are strings. For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *AWS IoT Events Developer Guide*.
|
75854
|
-
*/
|
76232
|
+
* Writes to the DynamoDB table that you created. The default action payload contains all attribute-value pairs that have the information about the detector model instance and the event that triggered the action. You can customize the [payload](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html). A separate column of the DynamoDB table receives one attribute-value pair in the payload that you specify. For more information, see [Actions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-event-actions.html) in *Developer Guide*.
|
76233
|
+
*/
|
75855
76234
|
DynamoDBv2?: IoTEventsDetectorModelDynamoDBv2;
|
75856
76235
|
/**
|
75857
76236
|
* Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.
|
75858
76237
|
*/
|
75859
76238
|
Firehose?: IoTEventsDetectorModelFirehose;
|
75860
76239
|
/**
|
75861
|
-
* Sends
|
76240
|
+
* Sends ITE input, which passes information about the detector model instance and the event that triggered the action.
|
75862
76241
|
*/
|
75863
76242
|
IotEvents?: IoTEventsDetectorModelIotEvents;
|
75864
76243
|
/**
|
75865
|
-
* Sends information about the detector model instance and the event that triggered the action to
|
76244
|
+
* Sends information about the detector model instance and the event that triggered the action to an asset property in ITSW .
|
75866
76245
|
*/
|
75867
76246
|
IotSiteWise?: IoTEventsDetectorModelIotSiteWise;
|
75868
76247
|
/**
|
75869
|
-
*
|
76248
|
+
* Publishes an MQTT message with the given topic to the IoT message broker.
|
75870
76249
|
*/
|
75871
76250
|
IotTopicPublish?: IoTEventsDetectorModelIotTopicPublish;
|
76251
|
+
/**
|
76252
|
+
* Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action.
|
76253
|
+
*/
|
75872
76254
|
Lambda?: IoTEventsDetectorModelLambda;
|
75873
76255
|
/**
|
75874
|
-
* Information
|
76256
|
+
* Information needed to reset the timer.
|
75875
76257
|
*/
|
75876
76258
|
ResetTimer?: IoTEventsDetectorModelResetTimer;
|
75877
76259
|
/**
|
@@ -75879,69 +76261,97 @@ export type IoTEventsDetectorModelAction = {
|
|
75879
76261
|
*/
|
75880
76262
|
SetTimer?: IoTEventsDetectorModelSetTimer;
|
75881
76263
|
/**
|
75882
|
-
*
|
76264
|
+
* Sets a variable to a specified value.
|
75883
76265
|
*/
|
75884
76266
|
SetVariable?: IoTEventsDetectorModelSetVariable;
|
75885
76267
|
/**
|
75886
|
-
*
|
76268
|
+
* Sends an Amazon SNS message.
|
75887
76269
|
*/
|
75888
76270
|
Sns?: IoTEventsDetectorModelSns;
|
76271
|
+
/**
|
76272
|
+
* Sends an Amazon SNS message.
|
76273
|
+
*/
|
75889
76274
|
Sqs?: IoTEventsDetectorModelSqs;
|
75890
76275
|
};
|
75891
76276
|
/**
|
75892
76277
|
* Type definition for `AWS::IoTEvents::DetectorModel.AssetPropertyTimestamp`.
|
75893
|
-
* A structure that contains timestamp information. For more information, see [TimeInNanos](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_TimeInNanos.html) in the *
|
76278
|
+
* A structure that contains timestamp information. For more information, see [TimeInNanos](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_TimeInNanos.html) in the *API Reference*.
|
76279
|
+
You must use expressions for all parameters in ``AssetPropertyTimestamp``. The expressions accept literals, operators, functions, references, and substitution templates.
|
76280
|
+
**Examples**
|
76281
|
+
+ For literal values, the expressions must contain single quotes. For example, the value for the ``timeInSeconds`` parameter can be ``'1586400675'``.
|
76282
|
+
+ For references, you must specify either variables or input values. For example, the value for the ``offsetInNanos`` parameter can be ``$variable.time``.
|
76283
|
+
+ For a substitution template, you must use ``${}``, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.
|
76284
|
+
In the following example, the value for the ``timeInSeconds`` parameter uses a substitution template.
|
76285
|
+
``'${$input.TemperatureInput.sensorData.timestamp / 1000}'``
|
76286
|
+
|
76287
|
+
For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *Developer Guide*.
|
75894
76288
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-assetpropertytimestamp.html}
|
75895
76289
|
*/
|
75896
76290
|
export type IoTEventsDetectorModelAssetPropertyTimestamp = {
|
75897
76291
|
/**
|
75898
|
-
* The
|
76292
|
+
* The nanosecond offset converted from ``timeInSeconds``. The valid range is between 0-999999999.
|
75899
76293
|
*/
|
75900
76294
|
OffsetInNanos?: string;
|
75901
76295
|
/**
|
75902
|
-
* The
|
76296
|
+
* The timestamp, in seconds, in the Unix epoch format. The valid range is between 1-31556889864403199.
|
75903
76297
|
*/
|
75904
76298
|
TimeInSeconds: string;
|
75905
76299
|
};
|
75906
76300
|
/**
|
75907
76301
|
* Type definition for `AWS::IoTEvents::DetectorModel.AssetPropertyValue`.
|
75908
|
-
* A structure that contains value information. For more information, see [AssetPropertyValue](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_AssetPropertyValue.html) in the *
|
76302
|
+
* A structure that contains value information. For more information, see [AssetPropertyValue](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_AssetPropertyValue.html) in the *API Reference*.
|
76303
|
+
You must use expressions for all parameters in ``AssetPropertyValue``. The expressions accept literals, operators, functions, references, and substitution templates.
|
76304
|
+
**Examples**
|
76305
|
+
+ For literal values, the expressions must contain single quotes. For example, the value for the ``quality`` parameter can be ``'GOOD'``.
|
76306
|
+
+ For references, you must specify either variables or input values. For example, the value for the ``quality`` parameter can be ``$input.TemperatureInput.sensorData.quality``.
|
76307
|
+
|
76308
|
+
For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *Developer Guide*.
|
75909
76309
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-assetpropertyvalue.html}
|
75910
76310
|
*/
|
75911
76311
|
export type IoTEventsDetectorModelAssetPropertyValue = {
|
75912
76312
|
/**
|
75913
|
-
* The quality of the asset property value. The value must be
|
76313
|
+
* The quality of the asset property value. The value must be ``'GOOD'``, ``'BAD'``, or ``'UNCERTAIN'``.
|
75914
76314
|
*/
|
75915
76315
|
Quality?: string;
|
75916
76316
|
/**
|
75917
|
-
*
|
76317
|
+
* The timestamp associated with the asset property value. The default is the current event time.
|
75918
76318
|
*/
|
75919
76319
|
Timestamp?: IoTEventsDetectorModelAssetPropertyTimestamp;
|
75920
76320
|
/**
|
75921
|
-
*
|
76321
|
+
* The value to send to an asset property.
|
75922
76322
|
*/
|
75923
76323
|
Value: IoTEventsDetectorModelAssetPropertyVariant;
|
75924
76324
|
};
|
75925
76325
|
/**
|
75926
76326
|
* Type definition for `AWS::IoTEvents::DetectorModel.AssetPropertyVariant`.
|
75927
|
-
* A structure that contains an asset property value. For more information, see [Variant](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_Variant.html) in the *
|
76327
|
+
* A structure that contains an asset property value. For more information, see [Variant](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_Variant.html) in the *API Reference*.
|
76328
|
+
You must use expressions for all parameters in ``AssetPropertyVariant``. The expressions accept literals, operators, functions, references, and substitution templates.
|
76329
|
+
**Examples**
|
76330
|
+
+ For literal values, the expressions must contain single quotes. For example, the value for the ``integerValue`` parameter can be ``'100'``.
|
76331
|
+
+ For references, you must specify either variables or parameters. For example, the value for the ``booleanValue`` parameter can be ``$variable.offline``.
|
76332
|
+
+ For a substitution template, you must use ``${}``, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.
|
76333
|
+
In the following example, the value for the ``doubleValue`` parameter uses a substitution template.
|
76334
|
+
``'${$input.TemperatureInput.sensorData.temperature * 6 / 5 + 32}'``
|
76335
|
+
|
76336
|
+
For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *Developer Guide*.
|
76337
|
+
You must specify one of the following value types, depending on the ``dataType`` of the specified asset property. For more information, see [AssetProperty](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_AssetProperty.html) in the *API Reference*.
|
75928
76338
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-assetpropertyvariant.html}
|
75929
76339
|
*/
|
75930
76340
|
export type IoTEventsDetectorModelAssetPropertyVariant = {
|
75931
76341
|
/**
|
75932
|
-
* The asset property value is a Boolean value that must be
|
76342
|
+
* The asset property value is a Boolean value that must be ``'TRUE'`` or ``'FALSE'``. You must use an expression, and the evaluated result should be a Boolean value.
|
75933
76343
|
*/
|
75934
76344
|
BooleanValue?: string;
|
75935
76345
|
/**
|
75936
|
-
* The asset property value is a double. You
|
76346
|
+
* The asset property value is a double. You must use an expression, and the evaluated result should be a double.
|
75937
76347
|
*/
|
75938
76348
|
DoubleValue?: string;
|
75939
76349
|
/**
|
75940
|
-
* The asset property value is an integer. You
|
76350
|
+
* The asset property value is an integer. You must use an expression, and the evaluated result should be an integer.
|
75941
76351
|
*/
|
75942
76352
|
IntegerValue?: string;
|
75943
76353
|
/**
|
75944
|
-
* The asset property value is a string. You
|
76354
|
+
* The asset property value is a string. You must use an expression, and the evaluated result should be a string.
|
75945
76355
|
*/
|
75946
76356
|
StringValue?: string;
|
75947
76357
|
};
|
@@ -75952,6 +76362,7 @@ export type IoTEventsDetectorModelAssetPropertyVariant = {
|
|
75952
76362
|
*/
|
75953
76363
|
export type IoTEventsDetectorModelClearTimer = {
|
75954
76364
|
/**
|
76365
|
+
* The name of the timer to clear.
|
75955
76366
|
* @minLength `1`
|
75956
76367
|
* @maxLength `128`
|
75957
76368
|
*/
|
@@ -75977,22 +76388,33 @@ export type IoTEventsDetectorModelDetectorModelDefinition = {
|
|
75977
76388
|
};
|
75978
76389
|
/**
|
75979
76390
|
* Type definition for `AWS::IoTEvents::DetectorModel.DynamoDB`.
|
75980
|
-
*
|
76391
|
+
* Defines an action to write to the Amazon DynamoDB table that you created. The standard action payload contains all the information about the detector model instance and the event that triggered the action. You can customize the [payload](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html). One column of the DynamoDB table receives all attribute-value pairs in the payload that you specify.
|
76392
|
+
You must use expressions for all parameters in ``DynamoDBAction``. The expressions accept literals, operators, functions, references, and substitution templates.
|
76393
|
+
**Examples**
|
76394
|
+
+ For literal values, the expressions must contain single quotes. For example, the value for the ``hashKeyType`` parameter can be ``'STRING'``.
|
76395
|
+
+ For references, you must specify either variables or input values. For example, the value for the ``hashKeyField`` parameter can be ``$input.GreenhouseInput.name``.
|
76396
|
+
+ For a substitution template, you must use ``${}``, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.
|
76397
|
+
In the following example, the value for the ``hashKeyValue`` parameter uses a substitution template.
|
76398
|
+
``'${$input.GreenhouseInput.temperature * 6 / 5 + 32} in Fahrenheit'``
|
76399
|
+
+ For a string concatenation, you must use ``+``. A string concatenation can also contain a combination of literals, operators, functions, references, and substitution templates.
|
76400
|
+
In the following example, the value for the ``tableName`` parameter uses a string concatenation.
|
76401
|
+
``'GreenhouseTemperatureTable ' + $input.GreenhouseInput.date``
|
76402
|
+
|
76403
|
+
For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *Developer Guide*.
|
76404
|
+
If the defined payload type is a string, ``DynamoDBAction`` writes non-JSON data to the DynamoDB table as binary data. The DynamoDB console displays the data as Base64-encoded text. The value for the ``payloadField`` parameter is ``<payload-field>_raw``.
|
75981
76405
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-dynamodb.html}
|
75982
76406
|
*/
|
75983
76407
|
export type IoTEventsDetectorModelDynamoDB = {
|
75984
76408
|
/**
|
75985
|
-
* The name of the hash key (also called the partition key).
|
76409
|
+
* The name of the hash key (also called the partition key). The ``hashKeyField`` value must match the partition key of the target DynamoDB table.
|
75986
76410
|
*/
|
75987
76411
|
HashKeyField: string;
|
75988
76412
|
/**
|
75989
76413
|
* The data type for the hash key (also called the partition key). You can specify the following values:
|
75990
|
-
|
75991
|
-
|
75992
|
-
|
75993
|
-
|
75994
|
-
|
75995
|
-
If you don't specify `hashKeyType`, the default value is `STRING`.
|
76414
|
+
+ ``'STRING'`` - The hash key is a string.
|
76415
|
+
+ ``'NUMBER'`` - The hash key is a number.
|
76416
|
+
|
76417
|
+
If you don't specify ``hashKeyType``, the default value is ``'STRING'``.
|
75996
76418
|
*/
|
75997
76419
|
HashKeyType?: string;
|
75998
76420
|
/**
|
@@ -76001,40 +76423,33 @@ export type IoTEventsDetectorModelDynamoDB = {
|
|
76001
76423
|
HashKeyValue: string;
|
76002
76424
|
/**
|
76003
76425
|
* The type of operation to perform. You can specify the following values:
|
76004
|
-
|
76005
|
-
|
76006
|
-
|
76007
|
-
|
76008
|
-
|
76009
|
-
* `DELETE` - Delete an existing item of the DynamoDB table. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key.
|
76010
|
-
|
76011
|
-
If you don't specify this parameter, AWS IoT Events triggers the `INSERT` operation.
|
76426
|
+
+ ``'INSERT'`` - Insert data as a new item into the DynamoDB table. This item uses the specified hash key as a partition key. If you specified a range key, the item uses the range key as a sort key.
|
76427
|
+
+ ``'UPDATE'`` - Update an existing item of the DynamoDB table with new data. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key.
|
76428
|
+
+ ``'DELETE'`` - Delete an existing item of the DynamoDB table. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key.
|
76429
|
+
|
76430
|
+
If you don't specify this parameter, ITE triggers the ``'INSERT'`` operation.
|
76012
76431
|
*/
|
76013
76432
|
Operation?: string;
|
76014
76433
|
/**
|
76015
76434
|
* Information needed to configure the payload.
|
76016
|
-
|
76017
|
-
By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use `contentExpression`.
|
76435
|
+
By default, ITE generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use ``contentExpression``.
|
76018
76436
|
*/
|
76019
76437
|
Payload?: IoTEventsDetectorModelPayload;
|
76020
76438
|
/**
|
76021
76439
|
* The name of the DynamoDB column that receives the action payload.
|
76022
|
-
|
76023
|
-
If you don't specify this parameter, the name of the DynamoDB column is `payload`.
|
76440
|
+
If you don't specify this parameter, the name of the DynamoDB column is ``payload``.
|
76024
76441
|
*/
|
76025
76442
|
PayloadField?: string;
|
76026
76443
|
/**
|
76027
|
-
* The name of the range key (also called the sort key).
|
76444
|
+
* The name of the range key (also called the sort key). The ``rangeKeyField`` value must match the sort key of the target DynamoDB table.
|
76028
76445
|
*/
|
76029
76446
|
RangeKeyField?: string;
|
76030
76447
|
/**
|
76031
76448
|
* The data type for the range key (also called the sort key), You can specify the following values:
|
76032
|
-
|
76033
|
-
|
76034
|
-
|
76035
|
-
|
76036
|
-
|
76037
|
-
If you don't specify `rangeKeyField`, the default value is `STRING`.
|
76449
|
+
+ ``'STRING'`` - The range key is a string.
|
76450
|
+
+ ``'NUMBER'`` - The range key is number.
|
76451
|
+
|
76452
|
+
If you don't specify ``rangeKeyField``, the default value is ``'STRING'``.
|
76038
76453
|
*/
|
76039
76454
|
RangeKeyType?: string;
|
76040
76455
|
/**
|
@@ -76042,22 +76457,32 @@ export type IoTEventsDetectorModelDynamoDB = {
|
|
76042
76457
|
*/
|
76043
76458
|
RangeKeyValue?: string;
|
76044
76459
|
/**
|
76045
|
-
* The name of the DynamoDB table.
|
76460
|
+
* The name of the DynamoDB table. The ``tableName`` value must match the table name of the target DynamoDB table.
|
76046
76461
|
*/
|
76047
76462
|
TableName: string;
|
76048
76463
|
};
|
76049
76464
|
/**
|
76050
76465
|
* Type definition for `AWS::IoTEvents::DetectorModel.DynamoDBv2`.
|
76051
|
-
* Defines an action to write to the Amazon DynamoDB table that you created. The default action payload contains all
|
76052
|
-
|
76053
|
-
|
76466
|
+
* Defines an action to write to the Amazon DynamoDB table that you created. The default action payload contains all the information about the detector model instance and the event that triggered the action. You can customize the [payload](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html). A separate column of the DynamoDB table receives one attribute-value pair in the payload that you specify.
|
76467
|
+
You must use expressions for all parameters in ``DynamoDBv2Action``. The expressions accept literals, operators, functions, references, and substitution templates.
|
76468
|
+
**Examples**
|
76469
|
+
+ For literal values, the expressions must contain single quotes. For example, the value for the ``tableName`` parameter can be ``'GreenhouseTemperatureTable'``.
|
76470
|
+
+ For references, you must specify either variables or input values. For example, the value for the ``tableName`` parameter can be ``$variable.ddbtableName``.
|
76471
|
+
+ For a substitution template, you must use ``${}``, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.
|
76472
|
+
In the following example, the value for the ``contentExpression`` parameter in ``Payload`` uses a substitution template.
|
76473
|
+
``'{\"sensorID\": \"${$input.GreenhouseInput.sensor_id}\", \"temperature\": \"${$input.GreenhouseInput.temperature * 9 / 5 + 32}\"}'``
|
76474
|
+
+ For a string concatenation, you must use ``+``. A string concatenation can also contain a combination of literals, operators, functions, references, and substitution templates.
|
76475
|
+
In the following example, the value for the ``tableName`` parameter uses a string concatenation.
|
76476
|
+
``'GreenhouseTemperatureTable ' + $input.GreenhouseInput.date``
|
76477
|
+
|
76478
|
+
For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *Developer Guide*.
|
76479
|
+
The value for the ``type`` parameter in ``Payload`` must be ``JSON``.
|
76054
76480
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-dynamodbv2.html}
|
76055
76481
|
*/
|
76056
76482
|
export type IoTEventsDetectorModelDynamoDBv2 = {
|
76057
76483
|
/**
|
76058
76484
|
* Information needed to configure the payload.
|
76059
|
-
|
76060
|
-
By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use `contentExpression`.
|
76485
|
+
By default, ITE generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use ``contentExpression``.
|
76061
76486
|
*/
|
76062
76487
|
Payload?: IoTEventsDetectorModelPayload;
|
76063
76488
|
/**
|
@@ -76067,7 +76492,7 @@ export type IoTEventsDetectorModelDynamoDBv2 = {
|
|
76067
76492
|
};
|
76068
76493
|
/**
|
76069
76494
|
* Type definition for `AWS::IoTEvents::DetectorModel.Event`.
|
76070
|
-
* Specifies the
|
76495
|
+
* Specifies the ``actions`` to be performed when the ``condition`` evaluates to TRUE.
|
76071
76496
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-event.html}
|
76072
76497
|
*/
|
76073
76498
|
export type IoTEventsDetectorModelEvent = {
|
@@ -76076,7 +76501,7 @@ export type IoTEventsDetectorModelEvent = {
|
|
76076
76501
|
*/
|
76077
76502
|
Actions?: IoTEventsDetectorModelAction[];
|
76078
76503
|
/**
|
76079
|
-
* The Boolean expression that, when
|
76504
|
+
* Optional. The Boolean expression that, when TRUE, causes the ``actions`` to be performed. If not present, the actions are performed (=TRUE). If the expression result is not a Boolean value, the actions are not performed (=FALSE).
|
76080
76505
|
* @maxLength `512`
|
76081
76506
|
*/
|
76082
76507
|
Condition?: string;
|
@@ -76097,10 +76522,8 @@ export type IoTEventsDetectorModelFirehose = {
|
|
76097
76522
|
*/
|
76098
76523
|
DeliveryStreamName: string;
|
76099
76524
|
/**
|
76100
|
-
|
76101
|
-
|
76102
|
-
By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use `contentExpression`.
|
76103
|
-
*/
|
76525
|
+
* You can configure the action payload when you send a message to an Amazon Data Firehose delivery stream.
|
76526
|
+
*/
|
76104
76527
|
Payload?: IoTEventsDetectorModelPayload;
|
76105
76528
|
/**
|
76106
76529
|
* A character separator that is used to separate records written to the Kinesis Data Firehose delivery stream. Valid values are: '\n' (newline), '\t' (tab), '\r\n' (Windows newline), ',' (comma).
|
@@ -76110,72 +76533,79 @@ export type IoTEventsDetectorModelFirehose = {
|
|
76110
76533
|
};
|
76111
76534
|
/**
|
76112
76535
|
* Type definition for `AWS::IoTEvents::DetectorModel.IotEvents`.
|
76113
|
-
* Sends an
|
76536
|
+
* Sends an ITE input, passing in information about the detector model instance and the event that triggered the action.
|
76114
76537
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-iotevents.html}
|
76115
76538
|
*/
|
76116
76539
|
export type IoTEventsDetectorModelIotEvents = {
|
76117
76540
|
/**
|
76118
|
-
* The name of the
|
76541
|
+
* The name of the ITE input where the data is sent.
|
76119
76542
|
* @minLength `1`
|
76120
76543
|
* @maxLength `128`
|
76121
76544
|
* @pattern `^[a-zA-Z][a-zA-Z0-9_]*$`
|
76122
76545
|
*/
|
76123
76546
|
InputName: string;
|
76124
76547
|
/**
|
76125
|
-
|
76126
|
-
|
76127
|
-
By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use `contentExpression`.
|
76128
|
-
*/
|
76548
|
+
* You can configure the action payload when you send a message to an ITE input.
|
76549
|
+
*/
|
76129
76550
|
Payload?: IoTEventsDetectorModelPayload;
|
76130
76551
|
};
|
76131
76552
|
/**
|
76132
76553
|
* Type definition for `AWS::IoTEvents::DetectorModel.IotSiteWise`.
|
76133
|
-
* Sends information about the detector model instance and the event that triggered the action to a specified asset property in
|
76554
|
+
* Sends information about the detector model instance and the event that triggered the action to a specified asset property in ITSW.
|
76555
|
+
You must use expressions for all parameters in ``IotSiteWiseAction``. The expressions accept literals, operators, functions, references, and substitutions templates.
|
76556
|
+
**Examples**
|
76557
|
+
+ For literal values, the expressions must contain single quotes. For example, the value for the ``propertyAlias`` parameter can be ``'/company/windfarm/3/turbine/7/temperature'``.
|
76558
|
+
+ For references, you must specify either variables or input values. For example, the value for the ``assetId`` parameter can be ``$input.TurbineInput.assetId1``.
|
76559
|
+
+ For a substitution template, you must use ``${}``, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.
|
76560
|
+
In the following example, the value for the ``propertyAlias`` parameter uses a substitution template.
|
76561
|
+
``'company/windfarm/${$input.TemperatureInput.sensorData.windfarmID}/turbine/ ${$input.TemperatureInput.sensorData.turbineID}/temperature'``
|
76562
|
+
|
76563
|
+
You must specify either ``propertyAlias`` or both ``assetId`` and ``propertyId`` to identify the target asset property in ITSW.
|
76564
|
+
For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *Developer Guide*.
|
76134
76565
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-iotsitewise.html}
|
76135
76566
|
*/
|
76136
76567
|
export type IoTEventsDetectorModelIotSiteWise = {
|
76137
76568
|
/**
|
76138
|
-
* The ID of the asset that has the specified property.
|
76569
|
+
* The ID of the asset that has the specified property.
|
76139
76570
|
*/
|
76140
76571
|
AssetId?: string;
|
76141
76572
|
/**
|
76142
|
-
* A unique identifier for this entry. You can use the entry ID to track which data entry causes an error in case of failure. The default is a new unique identifier.
|
76573
|
+
* A unique identifier for this entry. You can use the entry ID to track which data entry causes an error in case of failure. The default is a new unique identifier.
|
76143
76574
|
*/
|
76144
76575
|
EntryId?: string;
|
76145
76576
|
/**
|
76146
|
-
* The alias of the asset property.
|
76577
|
+
* The alias of the asset property.
|
76147
76578
|
*/
|
76148
76579
|
PropertyAlias?: string;
|
76149
76580
|
/**
|
76150
|
-
* The ID of the asset property.
|
76581
|
+
* The ID of the asset property.
|
76151
76582
|
*/
|
76152
76583
|
PropertyId?: string;
|
76153
76584
|
/**
|
76154
|
-
*
|
76585
|
+
* The value to send to the asset property. This value contains timestamp, quality, and value (TQV) information.
|
76155
76586
|
*/
|
76156
76587
|
PropertyValue: IoTEventsDetectorModelAssetPropertyValue;
|
76157
76588
|
};
|
76158
76589
|
/**
|
76159
76590
|
* Type definition for `AWS::IoTEvents::DetectorModel.IotTopicPublish`.
|
76160
|
-
* Information required to publish the MQTT message through the
|
76591
|
+
* Information required to publish the MQTT message through the IoT message broker.
|
76161
76592
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-iottopicpublish.html}
|
76162
76593
|
*/
|
76163
76594
|
export type IoTEventsDetectorModelIotTopicPublish = {
|
76164
76595
|
/**
|
76165
|
-
* The MQTT topic of the message. You can use a string expression that includes variables (
|
76596
|
+
* The MQTT topic of the message. You can use a string expression that includes variables (``$variable.<variable-name>``) and input values (``$input.<input-name>.<path-to-datum>``) as the topic string.
|
76166
76597
|
* @minLength `1`
|
76167
76598
|
* @maxLength `128`
|
76168
76599
|
*/
|
76169
76600
|
MqttTopic: string;
|
76170
76601
|
/**
|
76171
|
-
|
76172
|
-
|
76173
|
-
By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use `contentExpression`.
|
76174
|
-
*/
|
76602
|
+
* You can configure the action payload when you publish a message to an IoTCore topic.
|
76603
|
+
*/
|
76175
76604
|
Payload?: IoTEventsDetectorModelPayload;
|
76176
76605
|
};
|
76177
76606
|
/**
|
76178
76607
|
* Type definition for `AWS::IoTEvents::DetectorModel.Lambda`.
|
76608
|
+
* Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action.
|
76179
76609
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-lambda.html}
|
76180
76610
|
*/
|
76181
76611
|
export type IoTEventsDetectorModelLambda = {
|
@@ -76186,64 +76616,61 @@ export type IoTEventsDetectorModelLambda = {
|
|
76186
76616
|
*/
|
76187
76617
|
FunctionArn: string;
|
76188
76618
|
/**
|
76189
|
-
|
76190
|
-
|
76191
|
-
By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use `contentExpression`.
|
76192
|
-
*/
|
76619
|
+
* You can configure the action payload when you send a message to a Lambda function.
|
76620
|
+
*/
|
76193
76621
|
Payload?: IoTEventsDetectorModelPayload;
|
76194
76622
|
};
|
76195
76623
|
/**
|
76196
76624
|
* Type definition for `AWS::IoTEvents::DetectorModel.OnEnter`.
|
76197
|
-
* When entering this state, perform these
|
76625
|
+
* When entering this state, perform these ``actions`` if the ``condition`` is TRUE.
|
76198
76626
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-onenter.html}
|
76199
76627
|
*/
|
76200
76628
|
export type IoTEventsDetectorModelOnEnter = {
|
76201
76629
|
/**
|
76202
|
-
* Specifies the
|
76630
|
+
* Specifies the actions that are performed when the state is entered and the ``condition`` is ``TRUE``.
|
76203
76631
|
*/
|
76204
76632
|
Events?: IoTEventsDetectorModelEvent[];
|
76205
76633
|
};
|
76206
76634
|
/**
|
76207
76635
|
* Type definition for `AWS::IoTEvents::DetectorModel.OnExit`.
|
76208
|
-
* When exiting this state, perform these
|
76636
|
+
* When exiting this state, perform these ``actions`` if the specified ``condition`` is ``TRUE``.
|
76209
76637
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-onexit.html}
|
76210
76638
|
*/
|
76211
76639
|
export type IoTEventsDetectorModelOnExit = {
|
76212
76640
|
/**
|
76213
|
-
* Specifies the
|
76641
|
+
* Specifies the ``actions`` that are performed when the state is exited and the ``condition`` is ``TRUE``.
|
76214
76642
|
*/
|
76215
76643
|
Events?: IoTEventsDetectorModelEvent[];
|
76216
76644
|
};
|
76217
76645
|
/**
|
76218
76646
|
* Type definition for `AWS::IoTEvents::DetectorModel.OnInput`.
|
76219
|
-
*
|
76647
|
+
* Specifies the actions performed when the ``condition`` evaluates to TRUE.
|
76220
76648
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-oninput.html}
|
76221
76649
|
*/
|
76222
76650
|
export type IoTEventsDetectorModelOnInput = {
|
76223
76651
|
/**
|
76224
|
-
* Specifies the
|
76652
|
+
* Specifies the actions performed when the ``condition`` evaluates to TRUE.
|
76225
76653
|
*/
|
76226
76654
|
Events?: IoTEventsDetectorModelEvent[];
|
76227
76655
|
/**
|
76228
|
-
* Specifies the
|
76656
|
+
* Specifies the actions performed, and the next state entered, when a ``condition`` evaluates to TRUE.
|
76229
76657
|
*/
|
76230
76658
|
TransitionEvents?: IoTEventsDetectorModelTransitionEvent[];
|
76231
76659
|
};
|
76232
76660
|
/**
|
76233
76661
|
* Type definition for `AWS::IoTEvents::DetectorModel.Payload`.
|
76234
76662
|
* Information needed to configure the payload.
|
76235
|
-
|
76236
|
-
By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use `contentExpression`.
|
76663
|
+
By default, ITE generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use ``contentExpression``.
|
76237
76664
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-payload.html}
|
76238
76665
|
*/
|
76239
76666
|
export type IoTEventsDetectorModelPayload = {
|
76240
76667
|
/**
|
76241
|
-
* The content of the payload. You can use a string expression that includes quoted strings (
|
76668
|
+
* The content of the payload. You can use a string expression that includes quoted strings (``'<string>'``), variables (``$variable.<variable-name>``), input values (``$input.<input-name>.<path-to-datum>``), string concatenations, and quoted strings that contain ``${}`` as the content. The recommended maximum size of a content expression is 1 KB.
|
76242
76669
|
* @minLength `1`
|
76243
76670
|
*/
|
76244
76671
|
ContentExpression: string;
|
76245
76672
|
/**
|
76246
|
-
* The value of the payload type can be either
|
76673
|
+
* The value of the payload type can be either ``STRING`` or ``JSON``.
|
76247
76674
|
*/
|
76248
76675
|
Type: string;
|
76249
76676
|
};
|
@@ -76267,13 +76694,13 @@ export type IoTEventsDetectorModelResetTimer = {
|
|
76267
76694
|
*/
|
76268
76695
|
export type IoTEventsDetectorModelSetTimer = {
|
76269
76696
|
/**
|
76270
|
-
* The duration of the timer, in seconds. You can use a string expression that includes numbers, variables (
|
76697
|
+
* The duration of the timer, in seconds. You can use a string expression that includes numbers, variables (``$variable.<variable-name>``), and input values (``$input.<input-name>.<path-to-datum>``) as the duration. The range of the duration is 1-31622400 seconds. To ensure accuracy, the minimum duration is 60 seconds. The evaluated result of the duration is rounded down to the nearest whole number.
|
76271
76698
|
* @minLength `1`
|
76272
76699
|
* @maxLength `1024`
|
76273
76700
|
*/
|
76274
76701
|
DurationExpression?: string;
|
76275
76702
|
/**
|
76276
|
-
* The number of seconds until the timer expires. The minimum value is
|
76703
|
+
* The number of seconds until the timer expires. The minimum value is 60 seconds to ensure accuracy. The maximum value is 31622400 seconds.
|
76277
76704
|
* @min `60`
|
76278
76705
|
* @max `31622400`
|
76279
76706
|
*/
|
@@ -76312,10 +76739,8 @@ export type IoTEventsDetectorModelSetVariable = {
|
|
76312
76739
|
*/
|
76313
76740
|
export type IoTEventsDetectorModelSns = {
|
76314
76741
|
/**
|
76315
|
-
|
76316
|
-
|
76317
|
-
By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use `contentExpression`.
|
76318
|
-
*/
|
76742
|
+
* You can configure the action payload when you send a message as an Amazon SNS push notification.
|
76743
|
+
*/
|
76319
76744
|
Payload?: IoTEventsDetectorModelPayload;
|
76320
76745
|
/**
|
76321
76746
|
* The ARN of the Amazon SNS target where the message is sent.
|
@@ -76326,21 +76751,20 @@ export type IoTEventsDetectorModelSns = {
|
|
76326
76751
|
};
|
76327
76752
|
/**
|
76328
76753
|
* Type definition for `AWS::IoTEvents::DetectorModel.Sqs`.
|
76754
|
+
* Sends information about the detector model instance and the event that triggered the action to an Amazon SQS queue.
|
76329
76755
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-sqs.html}
|
76330
76756
|
*/
|
76331
76757
|
export type IoTEventsDetectorModelSqs = {
|
76332
76758
|
/**
|
76333
|
-
|
76334
|
-
|
76335
|
-
By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use `contentExpression`.
|
76336
|
-
*/
|
76759
|
+
* You can configure the action payload when you send a message to an Amazon SQS queue.
|
76760
|
+
*/
|
76337
76761
|
Payload?: IoTEventsDetectorModelPayload;
|
76338
76762
|
/**
|
76339
76763
|
* The URL of the SQS queue where the data is written.
|
76340
76764
|
*/
|
76341
76765
|
QueueUrl: string;
|
76342
76766
|
/**
|
76343
|
-
* Set this to
|
76767
|
+
* Set this to TRUE if you want the data to be base-64 encoded before it is written to the queue. Otherwise, set this to FALSE.
|
76344
76768
|
*/
|
76345
76769
|
UseBase64?: boolean;
|
76346
76770
|
};
|
@@ -76351,15 +76775,15 @@ export type IoTEventsDetectorModelSqs = {
|
|
76351
76775
|
*/
|
76352
76776
|
export type IoTEventsDetectorModelState = {
|
76353
76777
|
/**
|
76354
|
-
* When entering this state, perform these
|
76778
|
+
* When entering this state, perform these ``actions`` if the ``condition`` is TRUE.
|
76355
76779
|
*/
|
76356
76780
|
OnEnter?: IoTEventsDetectorModelOnEnter;
|
76357
76781
|
/**
|
76358
|
-
* When exiting this state, perform these
|
76782
|
+
* When exiting this state, perform these ``actions`` if the specified ``condition`` is ``TRUE``.
|
76359
76783
|
*/
|
76360
76784
|
OnExit?: IoTEventsDetectorModelOnExit;
|
76361
76785
|
/**
|
76362
|
-
* When an input is received and the
|
76786
|
+
* When an input is received and the ``condition`` is TRUE, perform the specified ``actions``.
|
76363
76787
|
*/
|
76364
76788
|
OnInput?: IoTEventsDetectorModelOnInput;
|
76365
76789
|
/**
|
@@ -76371,22 +76795,22 @@ export type IoTEventsDetectorModelState = {
|
|
76371
76795
|
};
|
76372
76796
|
/**
|
76373
76797
|
* Type definition for `AWS::IoTEvents::DetectorModel.Tag`.
|
76374
|
-
*
|
76798
|
+
* Metadata that can be used to manage the resource.
|
76375
76799
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-tag.html}
|
76376
76800
|
*/
|
76377
76801
|
export type IoTEventsDetectorModelTag = {
|
76378
76802
|
/**
|
76379
|
-
*
|
76803
|
+
* The tag's key.
|
76380
76804
|
*/
|
76381
76805
|
Key: string;
|
76382
76806
|
/**
|
76383
|
-
*
|
76807
|
+
* The tag's value.
|
76384
76808
|
*/
|
76385
76809
|
Value: string;
|
76386
76810
|
};
|
76387
76811
|
/**
|
76388
76812
|
* Type definition for `AWS::IoTEvents::DetectorModel.TransitionEvent`.
|
76389
|
-
* Specifies the
|
76813
|
+
* Specifies the actions performed and the next state entered when a ``condition`` evaluates to TRUE.
|
76390
76814
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-transitionevent.html}
|
76391
76815
|
*/
|
76392
76816
|
export type IoTEventsDetectorModelTransitionEvent = {
|
@@ -76395,12 +76819,12 @@ export type IoTEventsDetectorModelTransitionEvent = {
|
|
76395
76819
|
*/
|
76396
76820
|
Actions?: IoTEventsDetectorModelAction[];
|
76397
76821
|
/**
|
76398
|
-
* A Boolean expression that when
|
76822
|
+
* Required. A Boolean expression that when TRUE causes the actions to be performed and the ``nextState`` to be entered.
|
76399
76823
|
* @maxLength `512`
|
76400
76824
|
*/
|
76401
76825
|
Condition: string;
|
76402
76826
|
/**
|
76403
|
-
* The name of the event.
|
76827
|
+
* The name of the transition event.
|
76404
76828
|
* @minLength `1`
|
76405
76829
|
* @maxLength `128`
|
76406
76830
|
*/
|
@@ -76413,7 +76837,7 @@ export type IoTEventsDetectorModelTransitionEvent = {
|
|
76413
76837
|
NextState: string;
|
76414
76838
|
};
|
76415
76839
|
/**
|
76416
|
-
* The AWS::IoTEvents::Input resource creates an input. To monitor your devices and processes, they must have a way to get telemetry data into
|
76840
|
+
* The AWS::IoTEvents::Input resource creates an input. To monitor your devices and processes, they must have a way to get telemetry data into ITE. This is done by sending messages as *inputs* to ITE. For more information, see [How to Use](https://docs.aws.amazon.com/iotevents/latest/developerguide/how-to-use-iotevents.html) in the *Developer Guide*.
|
76417
76841
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-input.html}
|
76418
76842
|
*/
|
76419
76843
|
export type IoTEventsInputProps = {
|
@@ -76436,21 +76860,19 @@ export type IoTEventsInputProps = {
|
|
76436
76860
|
InputName?: string;
|
76437
76861
|
/**
|
76438
76862
|
* An array of key-value pairs to apply to this resource.
|
76439
|
-
|
76440
|
-
For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).
|
76863
|
+
For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).
|
76441
76864
|
*/
|
76442
76865
|
Tags?: IoTEventsInputTag[];
|
76443
76866
|
};
|
76444
76867
|
/**
|
76445
76868
|
* Type definition for `AWS::IoTEvents::Input.Attribute`.
|
76446
|
-
* The attributes from the JSON payload that are made available by the input. Inputs are derived from messages sent to the
|
76869
|
+
* The attributes from the JSON payload that are made available by the input. Inputs are derived from messages sent to the ITE system using ``BatchPutMessage``. Each such message contains a JSON payload. Those attributes (and their paired values) specified here are available for use in the ``condition`` expressions used by detectors.
|
76447
76870
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-input-attribute.html}
|
76448
76871
|
*/
|
76449
76872
|
export type IoTEventsInputAttribute = {
|
76450
76873
|
/**
|
76451
|
-
* An expression that specifies an attribute-value pair in a JSON structure. Use this to specify an attribute from the JSON payload that is made available by the input. Inputs are derived from messages sent to
|
76452
|
-
|
76453
|
-
_Syntax_: `<field-name>.<field-name>...`
|
76874
|
+
* An expression that specifies an attribute-value pair in a JSON structure. Use this to specify an attribute from the JSON payload that is made available by the input. Inputs are derived from messages sent to ITE (``BatchPutMessage``). Each such message contains a JSON payload. The attribute (and its paired value) specified here are available for use in the ``condition`` expressions used by detectors.
|
76875
|
+
Syntax: ``<field-name>.<field-name>...``
|
76454
76876
|
* @minLength `1`
|
76455
76877
|
* @maxLength `128`
|
76456
76878
|
* @pattern `^((`[a-zA-Z0-9_\- ]+`)|([a-zA-Z0-9_\-]+))(\.((`[a-zA-Z0-9_\- ]+`)|([a-zA-Z0-9_\-]+)))*$`
|
@@ -76464,7 +76886,7 @@ export type IoTEventsInputAttribute = {
|
|
76464
76886
|
*/
|
76465
76887
|
export type IoTEventsInputInputDefinition = {
|
76466
76888
|
/**
|
76467
|
-
* The attributes from the JSON payload that are made available by the input. Inputs are derived from messages sent to the
|
76889
|
+
* The attributes from the JSON payload that are made available by the input. Inputs are derived from messages sent to the ITE system using ``BatchPutMessage``. Each such message contains a JSON payload, and those attributes (and their paired values) specified here are available for use in the ``condition`` expressions used by detectors that monitor this input.
|
76468
76890
|
* @minLength `1`
|
76469
76891
|
* @maxLength `200`
|
76470
76892
|
*/
|
@@ -76472,16 +76894,16 @@ export type IoTEventsInputInputDefinition = {
|
|
76472
76894
|
};
|
76473
76895
|
/**
|
76474
76896
|
* Type definition for `AWS::IoTEvents::Input.Tag`.
|
76475
|
-
*
|
76897
|
+
* Metadata that can be used to manage the resource.
|
76476
76898
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-input-tag.html}
|
76477
76899
|
*/
|
76478
76900
|
export type IoTEventsInputTag = {
|
76479
76901
|
/**
|
76480
|
-
*
|
76902
|
+
* The tag's key.
|
76481
76903
|
*/
|
76482
76904
|
Key: string;
|
76483
76905
|
/**
|
76484
|
-
*
|
76906
|
+
* The tag's value.
|
76485
76907
|
*/
|
76486
76908
|
Value: string;
|
76487
76909
|
};
|
@@ -148180,6 +148602,7 @@ export type S3BucketLifecycleConfiguration = {
|
|
148180
148602
|
* A lifecycle rule for individual objects in an Amazon S3 bucket.
|
148181
148603
|
*/
|
148182
148604
|
Rules: S3BucketRule[];
|
148605
|
+
TransitionDefaultMinimumObjectSize?: "varies_by_storage_class" | "all_storage_classes_128K";
|
148183
148606
|
};
|
148184
148607
|
/**
|
148185
148608
|
* Type definition for `AWS::S3::Bucket.LoggingConfiguration`.
|