Documentation ¶
Index ¶
- func CfnDestination_CFN_RESOURCE_TYPE_NAME() *string
- func CfnDestination_IsCfnElement(x interface{}) *bool
- func CfnDestination_IsCfnResource(x interface{}) *bool
- func CfnDestination_IsConstruct(x interface{}) *bool
- func CfnDeviceProfile_CFN_RESOURCE_TYPE_NAME() *string
- func CfnDeviceProfile_IsCfnElement(x interface{}) *bool
- func CfnDeviceProfile_IsCfnResource(x interface{}) *bool
- func CfnDeviceProfile_IsConstruct(x interface{}) *bool
- func CfnFuotaTask_CFN_RESOURCE_TYPE_NAME() *string
- func CfnFuotaTask_IsCfnElement(x interface{}) *bool
- func CfnFuotaTask_IsCfnResource(x interface{}) *bool
- func CfnFuotaTask_IsConstruct(x interface{}) *bool
- func CfnMulticastGroup_CFN_RESOURCE_TYPE_NAME() *string
- func CfnMulticastGroup_IsCfnElement(x interface{}) *bool
- func CfnMulticastGroup_IsCfnResource(x interface{}) *bool
- func CfnMulticastGroup_IsConstruct(x interface{}) *bool
- func CfnNetworkAnalyzerConfiguration_CFN_RESOURCE_TYPE_NAME() *string
- func CfnNetworkAnalyzerConfiguration_IsCfnElement(x interface{}) *bool
- func CfnNetworkAnalyzerConfiguration_IsCfnResource(x interface{}) *bool
- func CfnNetworkAnalyzerConfiguration_IsConstruct(x interface{}) *bool
- func CfnPartnerAccount_CFN_RESOURCE_TYPE_NAME() *string
- func CfnPartnerAccount_IsCfnElement(x interface{}) *bool
- func CfnPartnerAccount_IsCfnResource(x interface{}) *bool
- func CfnPartnerAccount_IsConstruct(x interface{}) *bool
- func CfnServiceProfile_CFN_RESOURCE_TYPE_NAME() *string
- func CfnServiceProfile_IsCfnElement(x interface{}) *bool
- func CfnServiceProfile_IsCfnResource(x interface{}) *bool
- func CfnServiceProfile_IsConstruct(x interface{}) *bool
- func CfnTaskDefinition_CFN_RESOURCE_TYPE_NAME() *string
- func CfnTaskDefinition_IsCfnElement(x interface{}) *bool
- func CfnTaskDefinition_IsCfnResource(x interface{}) *bool
- func CfnTaskDefinition_IsConstruct(x interface{}) *bool
- func CfnWirelessDeviceImportTask_CFN_RESOURCE_TYPE_NAME() *string
- func CfnWirelessDeviceImportTask_IsCfnElement(x interface{}) *bool
- func CfnWirelessDeviceImportTask_IsCfnResource(x interface{}) *bool
- func CfnWirelessDeviceImportTask_IsConstruct(x interface{}) *bool
- func CfnWirelessDevice_CFN_RESOURCE_TYPE_NAME() *string
- func CfnWirelessDevice_IsCfnElement(x interface{}) *bool
- func CfnWirelessDevice_IsCfnResource(x interface{}) *bool
- func CfnWirelessDevice_IsConstruct(x interface{}) *bool
- func CfnWirelessGateway_CFN_RESOURCE_TYPE_NAME() *string
- func CfnWirelessGateway_IsCfnElement(x interface{}) *bool
- func CfnWirelessGateway_IsCfnResource(x interface{}) *bool
- func CfnWirelessGateway_IsConstruct(x interface{}) *bool
- func NewCfnDestination_Override(c CfnDestination, scope constructs.Construct, id *string, ...)
- func NewCfnDeviceProfile_Override(c CfnDeviceProfile, scope constructs.Construct, id *string, ...)
- func NewCfnFuotaTask_Override(c CfnFuotaTask, scope constructs.Construct, id *string, ...)
- func NewCfnMulticastGroup_Override(c CfnMulticastGroup, scope constructs.Construct, id *string, ...)
- func NewCfnNetworkAnalyzerConfiguration_Override(c CfnNetworkAnalyzerConfiguration, scope constructs.Construct, id *string, ...)
- func NewCfnPartnerAccount_Override(c CfnPartnerAccount, scope constructs.Construct, id *string, ...)
- func NewCfnServiceProfile_Override(c CfnServiceProfile, scope constructs.Construct, id *string, ...)
- func NewCfnTaskDefinition_Override(c CfnTaskDefinition, scope constructs.Construct, id *string, ...)
- func NewCfnWirelessDeviceImportTask_Override(c CfnWirelessDeviceImportTask, scope constructs.Construct, id *string, ...)
- func NewCfnWirelessDevice_Override(c CfnWirelessDevice, scope constructs.Construct, id *string, ...)
- func NewCfnWirelessGateway_Override(c CfnWirelessGateway, scope constructs.Construct, id *string, ...)
- type CfnDestination
- type CfnDestinationProps
- type CfnDeviceProfile
- type CfnDeviceProfileProps
- type CfnDeviceProfile_LoRaWANDeviceProfileProperty
- type CfnFuotaTask
- type CfnFuotaTaskProps
- type CfnFuotaTask_LoRaWANProperty
- type CfnMulticastGroup
- type CfnMulticastGroupProps
- type CfnMulticastGroup_LoRaWANProperty
- type CfnNetworkAnalyzerConfiguration
- type CfnNetworkAnalyzerConfigurationProps
- type CfnNetworkAnalyzerConfiguration_TraceContentProperty
- type CfnPartnerAccount
- type CfnPartnerAccountProps
- type CfnPartnerAccount_SidewalkAccountInfoProperty
- type CfnPartnerAccount_SidewalkAccountInfoWithFingerprintProperty
- type CfnPartnerAccount_SidewalkUpdateAccountProperty
- type CfnServiceProfile
- type CfnServiceProfileProps
- type CfnServiceProfile_LoRaWANServiceProfileProperty
- type CfnTaskDefinition
- type CfnTaskDefinitionProps
- type CfnTaskDefinition_LoRaWANGatewayVersionProperty
- type CfnTaskDefinition_LoRaWANUpdateGatewayTaskCreateProperty
- type CfnTaskDefinition_LoRaWANUpdateGatewayTaskEntryProperty
- type CfnTaskDefinition_UpdateWirelessGatewayTaskCreateProperty
- type CfnWirelessDevice
- type CfnWirelessDeviceImportTask
- type CfnWirelessDeviceImportTaskProps
- type CfnWirelessDeviceImportTask_SidewalkProperty
- type CfnWirelessDeviceProps
- type CfnWirelessDevice_AbpV10xProperty
- type CfnWirelessDevice_AbpV11Property
- type CfnWirelessDevice_ApplicationProperty
- type CfnWirelessDevice_FPortsProperty
- type CfnWirelessDevice_LoRaWANDeviceProperty
- type CfnWirelessDevice_OtaaV10xProperty
- type CfnWirelessDevice_OtaaV11Property
- type CfnWirelessDevice_SessionKeysAbpV10xProperty
- type CfnWirelessDevice_SessionKeysAbpV11Property
- type CfnWirelessGateway
- type CfnWirelessGatewayProps
- type CfnWirelessGateway_LoRaWANGatewayProperty
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CfnDestination_CFN_RESOURCE_TYPE_NAME ¶
func CfnDestination_CFN_RESOURCE_TYPE_NAME() *string
func CfnDestination_IsCfnElement ¶
func CfnDestination_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnDestination_IsCfnResource ¶
func CfnDestination_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnDestination_IsConstruct ¶
func CfnDestination_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnDeviceProfile_CFN_RESOURCE_TYPE_NAME ¶
func CfnDeviceProfile_CFN_RESOURCE_TYPE_NAME() *string
func CfnDeviceProfile_IsCfnElement ¶
func CfnDeviceProfile_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnDeviceProfile_IsCfnResource ¶
func CfnDeviceProfile_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnDeviceProfile_IsConstruct ¶
func CfnDeviceProfile_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnFuotaTask_CFN_RESOURCE_TYPE_NAME ¶
func CfnFuotaTask_CFN_RESOURCE_TYPE_NAME() *string
func CfnFuotaTask_IsCfnElement ¶
func CfnFuotaTask_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnFuotaTask_IsCfnResource ¶
func CfnFuotaTask_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnFuotaTask_IsConstruct ¶
func CfnFuotaTask_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnMulticastGroup_CFN_RESOURCE_TYPE_NAME ¶
func CfnMulticastGroup_CFN_RESOURCE_TYPE_NAME() *string
func CfnMulticastGroup_IsCfnElement ¶
func CfnMulticastGroup_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnMulticastGroup_IsCfnResource ¶
func CfnMulticastGroup_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnMulticastGroup_IsConstruct ¶
func CfnMulticastGroup_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnNetworkAnalyzerConfiguration_CFN_RESOURCE_TYPE_NAME ¶ added in v2.27.0
func CfnNetworkAnalyzerConfiguration_CFN_RESOURCE_TYPE_NAME() *string
func CfnNetworkAnalyzerConfiguration_IsCfnElement ¶ added in v2.27.0
func CfnNetworkAnalyzerConfiguration_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnNetworkAnalyzerConfiguration_IsCfnResource ¶ added in v2.27.0
func CfnNetworkAnalyzerConfiguration_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnNetworkAnalyzerConfiguration_IsConstruct ¶ added in v2.27.0
func CfnNetworkAnalyzerConfiguration_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnPartnerAccount_CFN_RESOURCE_TYPE_NAME ¶
func CfnPartnerAccount_CFN_RESOURCE_TYPE_NAME() *string
func CfnPartnerAccount_IsCfnElement ¶
func CfnPartnerAccount_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnPartnerAccount_IsCfnResource ¶
func CfnPartnerAccount_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnPartnerAccount_IsConstruct ¶
func CfnPartnerAccount_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnServiceProfile_CFN_RESOURCE_TYPE_NAME ¶
func CfnServiceProfile_CFN_RESOURCE_TYPE_NAME() *string
func CfnServiceProfile_IsCfnElement ¶
func CfnServiceProfile_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnServiceProfile_IsCfnResource ¶
func CfnServiceProfile_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnServiceProfile_IsConstruct ¶
func CfnServiceProfile_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnTaskDefinition_CFN_RESOURCE_TYPE_NAME ¶
func CfnTaskDefinition_CFN_RESOURCE_TYPE_NAME() *string
func CfnTaskDefinition_IsCfnElement ¶
func CfnTaskDefinition_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnTaskDefinition_IsCfnResource ¶
func CfnTaskDefinition_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnTaskDefinition_IsConstruct ¶
func CfnTaskDefinition_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnWirelessDeviceImportTask_CFN_RESOURCE_TYPE_NAME ¶ added in v2.78.0
func CfnWirelessDeviceImportTask_CFN_RESOURCE_TYPE_NAME() *string
func CfnWirelessDeviceImportTask_IsCfnElement ¶ added in v2.78.0
func CfnWirelessDeviceImportTask_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnWirelessDeviceImportTask_IsCfnResource ¶ added in v2.78.0
func CfnWirelessDeviceImportTask_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnWirelessDeviceImportTask_IsConstruct ¶ added in v2.78.0
func CfnWirelessDeviceImportTask_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnWirelessDevice_CFN_RESOURCE_TYPE_NAME ¶
func CfnWirelessDevice_CFN_RESOURCE_TYPE_NAME() *string
func CfnWirelessDevice_IsCfnElement ¶
func CfnWirelessDevice_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnWirelessDevice_IsCfnResource ¶
func CfnWirelessDevice_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnWirelessDevice_IsConstruct ¶
func CfnWirelessDevice_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnWirelessGateway_CFN_RESOURCE_TYPE_NAME ¶
func CfnWirelessGateway_CFN_RESOURCE_TYPE_NAME() *string
func CfnWirelessGateway_IsCfnElement ¶
func CfnWirelessGateway_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnWirelessGateway_IsCfnResource ¶
func CfnWirelessGateway_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnWirelessGateway_IsConstruct ¶
func CfnWirelessGateway_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func NewCfnDestination_Override ¶
func NewCfnDestination_Override(c CfnDestination, scope constructs.Construct, id *string, props *CfnDestinationProps)
func NewCfnDeviceProfile_Override ¶
func NewCfnDeviceProfile_Override(c CfnDeviceProfile, scope constructs.Construct, id *string, props *CfnDeviceProfileProps)
func NewCfnFuotaTask_Override ¶
func NewCfnFuotaTask_Override(c CfnFuotaTask, scope constructs.Construct, id *string, props *CfnFuotaTaskProps)
func NewCfnMulticastGroup_Override ¶
func NewCfnMulticastGroup_Override(c CfnMulticastGroup, scope constructs.Construct, id *string, props *CfnMulticastGroupProps)
func NewCfnNetworkAnalyzerConfiguration_Override ¶ added in v2.27.0
func NewCfnNetworkAnalyzerConfiguration_Override(c CfnNetworkAnalyzerConfiguration, scope constructs.Construct, id *string, props *CfnNetworkAnalyzerConfigurationProps)
func NewCfnPartnerAccount_Override ¶
func NewCfnPartnerAccount_Override(c CfnPartnerAccount, scope constructs.Construct, id *string, props *CfnPartnerAccountProps)
func NewCfnServiceProfile_Override ¶
func NewCfnServiceProfile_Override(c CfnServiceProfile, scope constructs.Construct, id *string, props *CfnServiceProfileProps)
func NewCfnTaskDefinition_Override ¶
func NewCfnTaskDefinition_Override(c CfnTaskDefinition, scope constructs.Construct, id *string, props *CfnTaskDefinitionProps)
func NewCfnWirelessDeviceImportTask_Override ¶ added in v2.78.0
func NewCfnWirelessDeviceImportTask_Override(c CfnWirelessDeviceImportTask, scope constructs.Construct, id *string, props *CfnWirelessDeviceImportTaskProps)
func NewCfnWirelessDevice_Override ¶
func NewCfnWirelessDevice_Override(c CfnWirelessDevice, scope constructs.Construct, id *string, props *CfnWirelessDeviceProps)
func NewCfnWirelessGateway_Override ¶
func NewCfnWirelessGateway_Override(c CfnWirelessGateway, scope constructs.Construct, id *string, props *CfnWirelessGatewayProps)
Types ¶
type CfnDestination ¶
type CfnDestination interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // The ARN of the destination created. AttrArn() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The description of the new resource. Description() *string SetDescription(val *string) // The rule name to send messages to. Expression() *string SetExpression(val *string) // The type of value in `Expression` . ExpressionType() *string SetExpressionType(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The name of the new resource. Name() *string SetName(val *string) // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The ARN of the IAM Role that authorizes the destination. RoleArn() *string SetRoleArn(val *string) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // The tags are an array of key-value pairs to attach to the specified resource. TagsRaw() *[]*awscdk.CfnTag SetTagsRaw(val *[]*awscdk.CfnTag) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
Creates a new destination that maps a device message to an AWS IoT rule.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnDestination := awscdk.Aws_iotwireless.NewCfnDestination(this, jsii.String("MyCfnDestination"), &CfnDestinationProps{ Expression: jsii.String("expression"), ExpressionType: jsii.String("expressionType"), Name: jsii.String("name"), // the properties below are optional Description: jsii.String("description"), RoleArn: jsii.String("roleArn"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
func NewCfnDestination ¶
func NewCfnDestination(scope constructs.Construct, id *string, props *CfnDestinationProps) CfnDestination
type CfnDestinationProps ¶
type CfnDestinationProps struct { // The rule name to send messages to. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-destination.html#cfn-iotwireless-destination-expression // Expression *string `field:"required" json:"expression" yaml:"expression"` // The type of value in `Expression` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-destination.html#cfn-iotwireless-destination-expressiontype // ExpressionType *string `field:"required" json:"expressionType" yaml:"expressionType"` // The name of the new resource. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-destination.html#cfn-iotwireless-destination-name // Name *string `field:"required" json:"name" yaml:"name"` // The description of the new resource. // // Maximum length is 2048 characters. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-destination.html#cfn-iotwireless-destination-description // Description *string `field:"optional" json:"description" yaml:"description"` // The ARN of the IAM Role that authorizes the destination. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-destination.html#cfn-iotwireless-destination-rolearn // RoleArn *string `field:"optional" json:"roleArn" yaml:"roleArn"` // The tags are an array of key-value pairs to attach to the specified resource. // // Tags can have a minimum of 0 and a maximum of 50 items. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-destination.html#cfn-iotwireless-destination-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnDestination`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnDestinationProps := &CfnDestinationProps{ Expression: jsii.String("expression"), ExpressionType: jsii.String("expressionType"), Name: jsii.String("name"), // the properties below are optional Description: jsii.String("description"), RoleArn: jsii.String("roleArn"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
type CfnDeviceProfile ¶
type CfnDeviceProfile interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // The ARN of the device profile created. AttrArn() *string // The ID of the device profile created. AttrId() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // LoRaWAN device profile object. LoRaWan() interface{} SetLoRaWan(val interface{}) // The name of the new resource. Name() *string SetName(val *string) // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // The tags are an array of key-value pairs to attach to the specified resource. TagsRaw() *[]*awscdk.CfnTag SetTagsRaw(val *[]*awscdk.CfnTag) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
Creates a new device profile.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnDeviceProfile := awscdk.Aws_iotwireless.NewCfnDeviceProfile(this, jsii.String("MyCfnDeviceProfile"), &CfnDeviceProfileProps{ LoRaWan: &LoRaWANDeviceProfileProperty{ ClassBTimeout: jsii.Number(123), ClassCTimeout: jsii.Number(123), FactoryPresetFreqsList: []interface{}{ jsii.Number(123), }, MacVersion: jsii.String("macVersion"), MaxDutyCycle: jsii.Number(123), MaxEirp: jsii.Number(123), PingSlotDr: jsii.Number(123), PingSlotFreq: jsii.Number(123), PingSlotPeriod: jsii.Number(123), RegParamsRevision: jsii.String("regParamsRevision"), RfRegion: jsii.String("rfRegion"), RxDataRate2: jsii.Number(123), RxDelay1: jsii.Number(123), RxDrOffset1: jsii.Number(123), RxFreq2: jsii.Number(123), Supports32BitFCnt: jsii.Boolean(false), SupportsClassB: jsii.Boolean(false), SupportsClassC: jsii.Boolean(false), SupportsJoin: jsii.Boolean(false), }, Name: jsii.String("name"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
func NewCfnDeviceProfile ¶
func NewCfnDeviceProfile(scope constructs.Construct, id *string, props *CfnDeviceProfileProps) CfnDeviceProfile
type CfnDeviceProfileProps ¶
type CfnDeviceProfileProps struct { // LoRaWAN device profile object. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-deviceprofile.html#cfn-iotwireless-deviceprofile-lorawan // LoRaWan interface{} `field:"optional" json:"loRaWan" yaml:"loRaWan"` // The name of the new resource. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-deviceprofile.html#cfn-iotwireless-deviceprofile-name // Name *string `field:"optional" json:"name" yaml:"name"` // The tags are an array of key-value pairs to attach to the specified resource. // // Tags can have a minimum of 0 and a maximum of 50 items. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-deviceprofile.html#cfn-iotwireless-deviceprofile-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnDeviceProfile`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnDeviceProfileProps := &CfnDeviceProfileProps{ LoRaWan: &LoRaWANDeviceProfileProperty{ ClassBTimeout: jsii.Number(123), ClassCTimeout: jsii.Number(123), FactoryPresetFreqsList: []interface{}{ jsii.Number(123), }, MacVersion: jsii.String("macVersion"), MaxDutyCycle: jsii.Number(123), MaxEirp: jsii.Number(123), PingSlotDr: jsii.Number(123), PingSlotFreq: jsii.Number(123), PingSlotPeriod: jsii.Number(123), RegParamsRevision: jsii.String("regParamsRevision"), RfRegion: jsii.String("rfRegion"), RxDataRate2: jsii.Number(123), RxDelay1: jsii.Number(123), RxDrOffset1: jsii.Number(123), RxFreq2: jsii.Number(123), Supports32BitFCnt: jsii.Boolean(false), SupportsClassB: jsii.Boolean(false), SupportsClassC: jsii.Boolean(false), SupportsJoin: jsii.Boolean(false), }, Name: jsii.String("name"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
type CfnDeviceProfile_LoRaWANDeviceProfileProperty ¶
type CfnDeviceProfile_LoRaWANDeviceProfileProperty struct { // The ClassBTimeout value. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-deviceprofile-lorawandeviceprofile.html#cfn-iotwireless-deviceprofile-lorawandeviceprofile-classbtimeout // ClassBTimeout *float64 `field:"optional" json:"classBTimeout" yaml:"classBTimeout"` // The ClassCTimeout value. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-deviceprofile-lorawandeviceprofile.html#cfn-iotwireless-deviceprofile-lorawandeviceprofile-classctimeout // ClassCTimeout *float64 `field:"optional" json:"classCTimeout" yaml:"classCTimeout"` // The list of values that make up the FactoryPresetFreqs value. // // Valid range of values include a minimum value of 1000000 and a maximum value of 16700000. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-deviceprofile-lorawandeviceprofile.html#cfn-iotwireless-deviceprofile-lorawandeviceprofile-factorypresetfreqslist // FactoryPresetFreqsList interface{} `field:"optional" json:"factoryPresetFreqsList" yaml:"factoryPresetFreqsList"` // The MAC version (such as OTAA 1.1 or OTAA 1.0.3) to use with this device profile. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-deviceprofile-lorawandeviceprofile.html#cfn-iotwireless-deviceprofile-lorawandeviceprofile-macversion // MacVersion *string `field:"optional" json:"macVersion" yaml:"macVersion"` // The MaxDutyCycle value. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-deviceprofile-lorawandeviceprofile.html#cfn-iotwireless-deviceprofile-lorawandeviceprofile-maxdutycycle // MaxDutyCycle *float64 `field:"optional" json:"maxDutyCycle" yaml:"maxDutyCycle"` // The MaxEIRP value. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-deviceprofile-lorawandeviceprofile.html#cfn-iotwireless-deviceprofile-lorawandeviceprofile-maxeirp // MaxEirp *float64 `field:"optional" json:"maxEirp" yaml:"maxEirp"` // The PingSlotDR value. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-deviceprofile-lorawandeviceprofile.html#cfn-iotwireless-deviceprofile-lorawandeviceprofile-pingslotdr // PingSlotDr *float64 `field:"optional" json:"pingSlotDr" yaml:"pingSlotDr"` // The PingSlotFreq value. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-deviceprofile-lorawandeviceprofile.html#cfn-iotwireless-deviceprofile-lorawandeviceprofile-pingslotfreq // PingSlotFreq *float64 `field:"optional" json:"pingSlotFreq" yaml:"pingSlotFreq"` // The PingSlotPeriod value. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-deviceprofile-lorawandeviceprofile.html#cfn-iotwireless-deviceprofile-lorawandeviceprofile-pingslotperiod // PingSlotPeriod *float64 `field:"optional" json:"pingSlotPeriod" yaml:"pingSlotPeriod"` // The version of regional parameters. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-deviceprofile-lorawandeviceprofile.html#cfn-iotwireless-deviceprofile-lorawandeviceprofile-regparamsrevision // RegParamsRevision *string `field:"optional" json:"regParamsRevision" yaml:"regParamsRevision"` // The frequency band (RFRegion) value. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-deviceprofile-lorawandeviceprofile.html#cfn-iotwireless-deviceprofile-lorawandeviceprofile-rfregion // RfRegion *string `field:"optional" json:"rfRegion" yaml:"rfRegion"` // The RXDataRate2 value. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-deviceprofile-lorawandeviceprofile.html#cfn-iotwireless-deviceprofile-lorawandeviceprofile-rxdatarate2 // RxDataRate2 *float64 `field:"optional" json:"rxDataRate2" yaml:"rxDataRate2"` // The RXDelay1 value. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-deviceprofile-lorawandeviceprofile.html#cfn-iotwireless-deviceprofile-lorawandeviceprofile-rxdelay1 // RxDelay1 *float64 `field:"optional" json:"rxDelay1" yaml:"rxDelay1"` // The RXDROffset1 value. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-deviceprofile-lorawandeviceprofile.html#cfn-iotwireless-deviceprofile-lorawandeviceprofile-rxdroffset1 // RxDrOffset1 *float64 `field:"optional" json:"rxDrOffset1" yaml:"rxDrOffset1"` // The RXFreq2 value. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-deviceprofile-lorawandeviceprofile.html#cfn-iotwireless-deviceprofile-lorawandeviceprofile-rxfreq2 // RxFreq2 *float64 `field:"optional" json:"rxFreq2" yaml:"rxFreq2"` // The Supports32BitFCnt value. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-deviceprofile-lorawandeviceprofile.html#cfn-iotwireless-deviceprofile-lorawandeviceprofile-supports32bitfcnt // Supports32BitFCnt interface{} `field:"optional" json:"supports32BitFCnt" yaml:"supports32BitFCnt"` // The SupportsClassB value. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-deviceprofile-lorawandeviceprofile.html#cfn-iotwireless-deviceprofile-lorawandeviceprofile-supportsclassb // SupportsClassB interface{} `field:"optional" json:"supportsClassB" yaml:"supportsClassB"` // The SupportsClassC value. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-deviceprofile-lorawandeviceprofile.html#cfn-iotwireless-deviceprofile-lorawandeviceprofile-supportsclassc // SupportsClassC interface{} `field:"optional" json:"supportsClassC" yaml:"supportsClassC"` // The SupportsJoin value. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-deviceprofile-lorawandeviceprofile.html#cfn-iotwireless-deviceprofile-lorawandeviceprofile-supportsjoin // SupportsJoin interface{} `field:"optional" json:"supportsJoin" yaml:"supportsJoin"` }
LoRaWAN device profile object.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" loRaWANDeviceProfileProperty := &LoRaWANDeviceProfileProperty{ ClassBTimeout: jsii.Number(123), ClassCTimeout: jsii.Number(123), FactoryPresetFreqsList: []interface{}{ jsii.Number(123), }, MacVersion: jsii.String("macVersion"), MaxDutyCycle: jsii.Number(123), MaxEirp: jsii.Number(123), PingSlotDr: jsii.Number(123), PingSlotFreq: jsii.Number(123), PingSlotPeriod: jsii.Number(123), RegParamsRevision: jsii.String("regParamsRevision"), RfRegion: jsii.String("rfRegion"), RxDataRate2: jsii.Number(123), RxDelay1: jsii.Number(123), RxDrOffset1: jsii.Number(123), RxFreq2: jsii.Number(123), Supports32BitFCnt: jsii.Boolean(false), SupportsClassB: jsii.Boolean(false), SupportsClassC: jsii.Boolean(false), SupportsJoin: jsii.Boolean(false), }
type CfnFuotaTask ¶
type CfnFuotaTask interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // The ID of the multicast group to associate with a FUOTA task. AssociateMulticastGroup() *string SetAssociateMulticastGroup(val *string) // The ID of the wireless device to associate with a multicast group. AssociateWirelessDevice() *string SetAssociateWirelessDevice(val *string) // The ARN of a FUOTA task. AttrArn() *string // The status of a FUOTA task. AttrFuotaTaskStatus() *string // The ID of a FUOTA task. AttrId() *string // Start time of a FUOTA task. AttrLoRaWanStartTime() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The description of the new resource. Description() *string SetDescription(val *string) // The ID of the multicast group to disassociate from a FUOTA task. DisassociateMulticastGroup() *string SetDisassociateMulticastGroup(val *string) // The ID of the wireless device to disassociate from a FUOTA task. DisassociateWirelessDevice() *string SetDisassociateWirelessDevice(val *string) // The S3 URI points to a firmware update image that is to be used with a FUOTA task. FirmwareUpdateImage() *string SetFirmwareUpdateImage(val *string) // The firmware update role that is to be used with a FUOTA task. FirmwareUpdateRole() *string SetFirmwareUpdateRole(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The LoRaWAN information used with a FUOTA task. LoRaWan() interface{} SetLoRaWan(val interface{}) // The name of a FUOTA task. Name() *string SetName(val *string) // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // The tags are an array of key-value pairs to attach to the specified resource. TagsRaw() *[]*awscdk.CfnTag SetTagsRaw(val *[]*awscdk.CfnTag) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
A FUOTA task.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnFuotaTask := awscdk.Aws_iotwireless.NewCfnFuotaTask(this, jsii.String("MyCfnFuotaTask"), &CfnFuotaTaskProps{ FirmwareUpdateImage: jsii.String("firmwareUpdateImage"), FirmwareUpdateRole: jsii.String("firmwareUpdateRole"), LoRaWan: &LoRaWANProperty{ RfRegion: jsii.String("rfRegion"), // the properties below are optional StartTime: jsii.String("startTime"), }, // the properties below are optional AssociateMulticastGroup: jsii.String("associateMulticastGroup"), AssociateWirelessDevice: jsii.String("associateWirelessDevice"), Description: jsii.String("description"), DisassociateMulticastGroup: jsii.String("disassociateMulticastGroup"), DisassociateWirelessDevice: jsii.String("disassociateWirelessDevice"), Name: jsii.String("name"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
func NewCfnFuotaTask ¶
func NewCfnFuotaTask(scope constructs.Construct, id *string, props *CfnFuotaTaskProps) CfnFuotaTask
type CfnFuotaTaskProps ¶
type CfnFuotaTaskProps struct { // The S3 URI points to a firmware update image that is to be used with a FUOTA task. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-fuotatask.html#cfn-iotwireless-fuotatask-firmwareupdateimage // FirmwareUpdateImage *string `field:"required" json:"firmwareUpdateImage" yaml:"firmwareUpdateImage"` // The firmware update role that is to be used with a FUOTA task. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-fuotatask.html#cfn-iotwireless-fuotatask-firmwareupdaterole // FirmwareUpdateRole *string `field:"required" json:"firmwareUpdateRole" yaml:"firmwareUpdateRole"` // The LoRaWAN information used with a FUOTA task. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-fuotatask.html#cfn-iotwireless-fuotatask-lorawan // LoRaWan interface{} `field:"required" json:"loRaWan" yaml:"loRaWan"` // The ID of the multicast group to associate with a FUOTA task. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-fuotatask.html#cfn-iotwireless-fuotatask-associatemulticastgroup // AssociateMulticastGroup *string `field:"optional" json:"associateMulticastGroup" yaml:"associateMulticastGroup"` // The ID of the wireless device to associate with a multicast group. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-fuotatask.html#cfn-iotwireless-fuotatask-associatewirelessdevice // AssociateWirelessDevice *string `field:"optional" json:"associateWirelessDevice" yaml:"associateWirelessDevice"` // The description of the new resource. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-fuotatask.html#cfn-iotwireless-fuotatask-description // Description *string `field:"optional" json:"description" yaml:"description"` // The ID of the multicast group to disassociate from a FUOTA task. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-fuotatask.html#cfn-iotwireless-fuotatask-disassociatemulticastgroup // DisassociateMulticastGroup *string `field:"optional" json:"disassociateMulticastGroup" yaml:"disassociateMulticastGroup"` // The ID of the wireless device to disassociate from a FUOTA task. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-fuotatask.html#cfn-iotwireless-fuotatask-disassociatewirelessdevice // DisassociateWirelessDevice *string `field:"optional" json:"disassociateWirelessDevice" yaml:"disassociateWirelessDevice"` // The name of a FUOTA task. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-fuotatask.html#cfn-iotwireless-fuotatask-name // Name *string `field:"optional" json:"name" yaml:"name"` // The tags are an array of key-value pairs to attach to the specified resource. // // Tags can have a minimum of 0 and a maximum of 50 items. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-fuotatask.html#cfn-iotwireless-fuotatask-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnFuotaTask`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnFuotaTaskProps := &CfnFuotaTaskProps{ FirmwareUpdateImage: jsii.String("firmwareUpdateImage"), FirmwareUpdateRole: jsii.String("firmwareUpdateRole"), LoRaWan: &LoRaWANProperty{ RfRegion: jsii.String("rfRegion"), // the properties below are optional StartTime: jsii.String("startTime"), }, // the properties below are optional AssociateMulticastGroup: jsii.String("associateMulticastGroup"), AssociateWirelessDevice: jsii.String("associateWirelessDevice"), Description: jsii.String("description"), DisassociateMulticastGroup: jsii.String("disassociateMulticastGroup"), DisassociateWirelessDevice: jsii.String("disassociateWirelessDevice"), Name: jsii.String("name"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
type CfnFuotaTask_LoRaWANProperty ¶
type CfnFuotaTask_LoRaWANProperty struct { // The frequency band (RFRegion) value. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-fuotatask-lorawan.html#cfn-iotwireless-fuotatask-lorawan-rfregion // RfRegion *string `field:"required" json:"rfRegion" yaml:"rfRegion"` // Start time of a FUOTA task. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-fuotatask-lorawan.html#cfn-iotwireless-fuotatask-lorawan-starttime // StartTime *string `field:"optional" json:"startTime" yaml:"startTime"` }
The LoRaWAN information used with a FUOTA task.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" loRaWANProperty := &LoRaWANProperty{ RfRegion: jsii.String("rfRegion"), // the properties below are optional StartTime: jsii.String("startTime"), }
type CfnMulticastGroup ¶
type CfnMulticastGroup interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // The ID of the wireless device to associate with a multicast group. AssociateWirelessDevice() *string SetAssociateWirelessDevice(val *string) // The ARN of the multicast group. AttrArn() *string // The ID of the multicast group. AttrId() *string // The number of devices that are associated to the multicast group. AttrLoRaWanNumberOfDevicesInGroup() *float64 // The number of devices that are requested to be associated with the multicast group. AttrLoRaWanNumberOfDevicesRequested() *float64 // The status of a multicast group. AttrStatus() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The description of the multicast group. Description() *string SetDescription(val *string) // The ID of the wireless device to disassociate from a multicast group. DisassociateWirelessDevice() *string SetDisassociateWirelessDevice(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The LoRaWAN information that is to be used with the multicast group. LoRaWan() interface{} SetLoRaWan(val interface{}) // The name of the multicast group. Name() *string SetName(val *string) // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // The tags are an array of key-value pairs to attach to the specified resource. TagsRaw() *[]*awscdk.CfnTag SetTagsRaw(val *[]*awscdk.CfnTag) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
A multicast group.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnMulticastGroup := awscdk.Aws_iotwireless.NewCfnMulticastGroup(this, jsii.String("MyCfnMulticastGroup"), &CfnMulticastGroupProps{ LoRaWan: &LoRaWANProperty{ DlClass: jsii.String("dlClass"), RfRegion: jsii.String("rfRegion"), // the properties below are optional NumberOfDevicesInGroup: jsii.Number(123), NumberOfDevicesRequested: jsii.Number(123), }, // the properties below are optional AssociateWirelessDevice: jsii.String("associateWirelessDevice"), Description: jsii.String("description"), DisassociateWirelessDevice: jsii.String("disassociateWirelessDevice"), Name: jsii.String("name"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
func NewCfnMulticastGroup ¶
func NewCfnMulticastGroup(scope constructs.Construct, id *string, props *CfnMulticastGroupProps) CfnMulticastGroup
type CfnMulticastGroupProps ¶
type CfnMulticastGroupProps struct { // The LoRaWAN information that is to be used with the multicast group. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-multicastgroup.html#cfn-iotwireless-multicastgroup-lorawan // LoRaWan interface{} `field:"required" json:"loRaWan" yaml:"loRaWan"` // The ID of the wireless device to associate with a multicast group. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-multicastgroup.html#cfn-iotwireless-multicastgroup-associatewirelessdevice // AssociateWirelessDevice *string `field:"optional" json:"associateWirelessDevice" yaml:"associateWirelessDevice"` // The description of the multicast group. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-multicastgroup.html#cfn-iotwireless-multicastgroup-description // Description *string `field:"optional" json:"description" yaml:"description"` // The ID of the wireless device to disassociate from a multicast group. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-multicastgroup.html#cfn-iotwireless-multicastgroup-disassociatewirelessdevice // DisassociateWirelessDevice *string `field:"optional" json:"disassociateWirelessDevice" yaml:"disassociateWirelessDevice"` // The name of the multicast group. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-multicastgroup.html#cfn-iotwireless-multicastgroup-name // Name *string `field:"optional" json:"name" yaml:"name"` // The tags are an array of key-value pairs to attach to the specified resource. // // Tags can have a minimum of 0 and a maximum of 50 items. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-multicastgroup.html#cfn-iotwireless-multicastgroup-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnMulticastGroup`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnMulticastGroupProps := &CfnMulticastGroupProps{ LoRaWan: &LoRaWANProperty{ DlClass: jsii.String("dlClass"), RfRegion: jsii.String("rfRegion"), // the properties below are optional NumberOfDevicesInGroup: jsii.Number(123), NumberOfDevicesRequested: jsii.Number(123), }, // the properties below are optional AssociateWirelessDevice: jsii.String("associateWirelessDevice"), Description: jsii.String("description"), DisassociateWirelessDevice: jsii.String("disassociateWirelessDevice"), Name: jsii.String("name"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
type CfnMulticastGroup_LoRaWANProperty ¶
type CfnMulticastGroup_LoRaWANProperty struct { // DlClass for LoRaWAN. // // Valid values are ClassB and ClassC. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-multicastgroup-lorawan.html#cfn-iotwireless-multicastgroup-lorawan-dlclass // DlClass *string `field:"required" json:"dlClass" yaml:"dlClass"` // The frequency band (RFRegion) value. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-multicastgroup-lorawan.html#cfn-iotwireless-multicastgroup-lorawan-rfregion // RfRegion *string `field:"required" json:"rfRegion" yaml:"rfRegion"` // Number of devices that are associated to the multicast group. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-multicastgroup-lorawan.html#cfn-iotwireless-multicastgroup-lorawan-numberofdevicesingroup // NumberOfDevicesInGroup *float64 `field:"optional" json:"numberOfDevicesInGroup" yaml:"numberOfDevicesInGroup"` // Number of devices that are requested to be associated with the multicast group. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-multicastgroup-lorawan.html#cfn-iotwireless-multicastgroup-lorawan-numberofdevicesrequested // NumberOfDevicesRequested *float64 `field:"optional" json:"numberOfDevicesRequested" yaml:"numberOfDevicesRequested"` }
The LoRaWAN information that is to be used with the multicast group.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" loRaWANProperty := &LoRaWANProperty{ DlClass: jsii.String("dlClass"), RfRegion: jsii.String("rfRegion"), // the properties below are optional NumberOfDevicesInGroup: jsii.Number(123), NumberOfDevicesRequested: jsii.Number(123), }
type CfnNetworkAnalyzerConfiguration ¶ added in v2.27.0
type CfnNetworkAnalyzerConfiguration interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // The Amazon Resource Name (ARN) of the resource. AttrArn() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The description of the resource. Description() *string SetDescription(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // Name of the network analyzer configuration. Name() *string SetName(val *string) // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // The tags to attach to the specified resource. TagsRaw() *[]*awscdk.CfnTag SetTagsRaw(val *[]*awscdk.CfnTag) // Trace content for your wireless gateway and wireless device resources. TraceContent() interface{} SetTraceContent(val interface{}) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Wireless device resources to add to the network analyzer configuration. WirelessDevices() *[]*string SetWirelessDevices(val *[]*string) // Wireless gateway resources to add to the network analyzer configuration. WirelessGateways() *[]*string SetWirelessGateways(val *[]*string) // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
Network analyzer configuration.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var traceContent interface{} cfnNetworkAnalyzerConfiguration := awscdk.Aws_iotwireless.NewCfnNetworkAnalyzerConfiguration(this, jsii.String("MyCfnNetworkAnalyzerConfiguration"), &CfnNetworkAnalyzerConfigurationProps{ Name: jsii.String("name"), // the properties below are optional Description: jsii.String("description"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, TraceContent: traceContent, WirelessDevices: []*string{ jsii.String("wirelessDevices"), }, WirelessGateways: []*string{ jsii.String("wirelessGateways"), }, })
func NewCfnNetworkAnalyzerConfiguration ¶ added in v2.27.0
func NewCfnNetworkAnalyzerConfiguration(scope constructs.Construct, id *string, props *CfnNetworkAnalyzerConfigurationProps) CfnNetworkAnalyzerConfiguration
type CfnNetworkAnalyzerConfigurationProps ¶ added in v2.27.0
type CfnNetworkAnalyzerConfigurationProps struct { // Name of the network analyzer configuration. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-networkanalyzerconfiguration.html#cfn-iotwireless-networkanalyzerconfiguration-name // Name *string `field:"required" json:"name" yaml:"name"` // The description of the resource. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-networkanalyzerconfiguration.html#cfn-iotwireless-networkanalyzerconfiguration-description // Description *string `field:"optional" json:"description" yaml:"description"` // The tags to attach to the specified resource. // // Tags are metadata that you can use to manage a resource. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-networkanalyzerconfiguration.html#cfn-iotwireless-networkanalyzerconfiguration-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` // Trace content for your wireless gateway and wireless device resources. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-networkanalyzerconfiguration.html#cfn-iotwireless-networkanalyzerconfiguration-tracecontent // TraceContent interface{} `field:"optional" json:"traceContent" yaml:"traceContent"` // Wireless device resources to add to the network analyzer configuration. // // Provide the `WirelessDeviceId` of the resource to add in the input array. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-networkanalyzerconfiguration.html#cfn-iotwireless-networkanalyzerconfiguration-wirelessdevices // WirelessDevices *[]*string `field:"optional" json:"wirelessDevices" yaml:"wirelessDevices"` // Wireless gateway resources to add to the network analyzer configuration. // // Provide the `WirelessGatewayId` of the resource to add in the input array. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-networkanalyzerconfiguration.html#cfn-iotwireless-networkanalyzerconfiguration-wirelessgateways // WirelessGateways *[]*string `field:"optional" json:"wirelessGateways" yaml:"wirelessGateways"` }
Properties for defining a `CfnNetworkAnalyzerConfiguration`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var traceContent interface{} cfnNetworkAnalyzerConfigurationProps := &CfnNetworkAnalyzerConfigurationProps{ Name: jsii.String("name"), // the properties below are optional Description: jsii.String("description"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, TraceContent: traceContent, WirelessDevices: []*string{ jsii.String("wirelessDevices"), }, WirelessGateways: []*string{ jsii.String("wirelessGateways"), }, }
type CfnNetworkAnalyzerConfiguration_TraceContentProperty ¶ added in v2.55.0
type CfnNetworkAnalyzerConfiguration_TraceContentProperty struct { // The log level for a log message. // // The log levels can be disabled, or set to `ERROR` to display less verbose logs containing only error information, or to `INFO` for more detailed logs. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-networkanalyzerconfiguration-tracecontent.html#cfn-iotwireless-networkanalyzerconfiguration-tracecontent-loglevel // LogLevel *string `field:"optional" json:"logLevel" yaml:"logLevel"` // `FrameInfo` of your wireless device resources for the trace content. // // Use FrameInfo to debug the communication between your LoRaWAN end devices and the network server. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-networkanalyzerconfiguration-tracecontent.html#cfn-iotwireless-networkanalyzerconfiguration-tracecontent-wirelessdeviceframeinfo // WirelessDeviceFrameInfo *string `field:"optional" json:"wirelessDeviceFrameInfo" yaml:"wirelessDeviceFrameInfo"` }
Trace content for your wireless gateway and wireless device resources.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" traceContentProperty := &TraceContentProperty{ LogLevel: jsii.String("logLevel"), WirelessDeviceFrameInfo: jsii.String("wirelessDeviceFrameInfo"), }
type CfnPartnerAccount ¶
type CfnPartnerAccount interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // Whether the partner account is linked to the AWS account. AccountLinked() interface{} SetAccountLinked(val interface{}) // The Amazon Resource Name (ARN) of the resource. AttrArn() *string // The fingerprint of the Sidewalk application server private key. AttrFingerprint() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // The ID of the partner account to update. PartnerAccountId() *string SetPartnerAccountId(val *string) // The partner type. PartnerType() *string SetPartnerType(val *string) // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The Sidewalk account credentials. Sidewalk() interface{} SetSidewalk(val interface{}) // Information about a Sidewalk account. SidewalkResponse() interface{} SetSidewalkResponse(val interface{}) // Sidewalk update. SidewalkUpdate() interface{} SetSidewalkUpdate(val interface{}) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // The tags are an array of key-value pairs to attach to the specified resource. TagsRaw() *[]*awscdk.CfnTag SetTagsRaw(val *[]*awscdk.CfnTag) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
A partner account.
If `PartnerAccountId` and `PartnerType` are `null` , returns all partner accounts.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnPartnerAccount := awscdk.Aws_iotwireless.NewCfnPartnerAccount(this, jsii.String("MyCfnPartnerAccount"), &CfnPartnerAccountProps{ AccountLinked: jsii.Boolean(false), PartnerAccountId: jsii.String("partnerAccountId"), PartnerType: jsii.String("partnerType"), Sidewalk: &SidewalkAccountInfoProperty{ AppServerPrivateKey: jsii.String("appServerPrivateKey"), }, SidewalkResponse: &SidewalkAccountInfoWithFingerprintProperty{ AmazonId: jsii.String("amazonId"), Arn: jsii.String("arn"), Fingerprint: jsii.String("fingerprint"), }, SidewalkUpdate: &SidewalkUpdateAccountProperty{ AppServerPrivateKey: jsii.String("appServerPrivateKey"), }, Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
func NewCfnPartnerAccount ¶
func NewCfnPartnerAccount(scope constructs.Construct, id *string, props *CfnPartnerAccountProps) CfnPartnerAccount
type CfnPartnerAccountProps ¶
type CfnPartnerAccountProps struct { // Whether the partner account is linked to the AWS account. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-partneraccount.html#cfn-iotwireless-partneraccount-accountlinked // AccountLinked interface{} `field:"optional" json:"accountLinked" yaml:"accountLinked"` // The ID of the partner account to update. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-partneraccount.html#cfn-iotwireless-partneraccount-partneraccountid // PartnerAccountId *string `field:"optional" json:"partnerAccountId" yaml:"partnerAccountId"` // The partner type. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-partneraccount.html#cfn-iotwireless-partneraccount-partnertype // PartnerType *string `field:"optional" json:"partnerType" yaml:"partnerType"` // The Sidewalk account credentials. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-partneraccount.html#cfn-iotwireless-partneraccount-sidewalk // Sidewalk interface{} `field:"optional" json:"sidewalk" yaml:"sidewalk"` // Information about a Sidewalk account. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-partneraccount.html#cfn-iotwireless-partneraccount-sidewalkresponse // SidewalkResponse interface{} `field:"optional" json:"sidewalkResponse" yaml:"sidewalkResponse"` // Sidewalk update. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-partneraccount.html#cfn-iotwireless-partneraccount-sidewalkupdate // SidewalkUpdate interface{} `field:"optional" json:"sidewalkUpdate" yaml:"sidewalkUpdate"` // The tags are an array of key-value pairs to attach to the specified resource. // // Tags can have a minimum of 0 and a maximum of 50 items. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-partneraccount.html#cfn-iotwireless-partneraccount-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnPartnerAccount`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnPartnerAccountProps := &CfnPartnerAccountProps{ AccountLinked: jsii.Boolean(false), PartnerAccountId: jsii.String("partnerAccountId"), PartnerType: jsii.String("partnerType"), Sidewalk: &SidewalkAccountInfoProperty{ AppServerPrivateKey: jsii.String("appServerPrivateKey"), }, SidewalkResponse: &SidewalkAccountInfoWithFingerprintProperty{ AmazonId: jsii.String("amazonId"), Arn: jsii.String("arn"), Fingerprint: jsii.String("fingerprint"), }, SidewalkUpdate: &SidewalkUpdateAccountProperty{ AppServerPrivateKey: jsii.String("appServerPrivateKey"), }, Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
type CfnPartnerAccount_SidewalkAccountInfoProperty ¶
type CfnPartnerAccount_SidewalkAccountInfoProperty struct { // The Sidewalk application server private key. // // The application server private key is a secret key, which you should handle in a similar way as you would an application password. You can protect the application server private key by storing the value in the AWS Secrets Manager and use the [secretsmanager](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html#dynamic-references-secretsmanager) to reference this value. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-partneraccount-sidewalkaccountinfo.html#cfn-iotwireless-partneraccount-sidewalkaccountinfo-appserverprivatekey // AppServerPrivateKey *string `field:"required" json:"appServerPrivateKey" yaml:"appServerPrivateKey"` }
Information about a Sidewalk account.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" sidewalkAccountInfoProperty := &SidewalkAccountInfoProperty{ AppServerPrivateKey: jsii.String("appServerPrivateKey"), }
type CfnPartnerAccount_SidewalkAccountInfoWithFingerprintProperty ¶ added in v2.55.0
type CfnPartnerAccount_SidewalkAccountInfoWithFingerprintProperty struct { // The Sidewalk Amazon ID. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-partneraccount-sidewalkaccountinfowithfingerprint.html#cfn-iotwireless-partneraccount-sidewalkaccountinfowithfingerprint-amazonid // AmazonId *string `field:"optional" json:"amazonId" yaml:"amazonId"` // The Amazon Resource Name (ARN) of the resource. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-partneraccount-sidewalkaccountinfowithfingerprint.html#cfn-iotwireless-partneraccount-sidewalkaccountinfowithfingerprint-arn // Arn *string `field:"optional" json:"arn" yaml:"arn"` // The fingerprint of the Sidewalk application server private key. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-partneraccount-sidewalkaccountinfowithfingerprint.html#cfn-iotwireless-partneraccount-sidewalkaccountinfowithfingerprint-fingerprint // Fingerprint *string `field:"optional" json:"fingerprint" yaml:"fingerprint"` }
Information about a Sidewalk account.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" sidewalkAccountInfoWithFingerprintProperty := &SidewalkAccountInfoWithFingerprintProperty{ AmazonId: jsii.String("amazonId"), Arn: jsii.String("arn"), Fingerprint: jsii.String("fingerprint"), }
type CfnPartnerAccount_SidewalkUpdateAccountProperty ¶
type CfnPartnerAccount_SidewalkUpdateAccountProperty struct { // The new Sidewalk application server private key. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-partneraccount-sidewalkupdateaccount.html#cfn-iotwireless-partneraccount-sidewalkupdateaccount-appserverprivatekey // AppServerPrivateKey *string `field:"optional" json:"appServerPrivateKey" yaml:"appServerPrivateKey"` }
Sidewalk update.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" sidewalkUpdateAccountProperty := &SidewalkUpdateAccountProperty{ AppServerPrivateKey: jsii.String("appServerPrivateKey"), }
type CfnServiceProfile ¶
type CfnServiceProfile interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // The ARN of the service profile created. AttrArn() *string // The ID of the service profile created. AttrId() *string // The ChannelMask value. AttrLoRaWanChannelMask() *string // The DevStatusReqFreq value. AttrLoRaWanDevStatusReqFreq() *float64 // The DLBucketSize value. AttrLoRaWanDlBucketSize() *float64 // The DLRate value. AttrLoRaWanDlRate() *float64 // The DLRatePolicy value. AttrLoRaWanDlRatePolicy() *string // The DRMax value. AttrLoRaWanDrMax() *float64 // The DRMin value. AttrLoRaWanDrMin() *float64 // The HRAllowed value that describes whether handover roaming is allowed. AttrLoRaWanHrAllowed() awscdk.IResolvable // The MinGwDiversity value. AttrLoRaWanMinGwDiversity() *float64 // The NwkGeoLoc value. AttrLoRaWanNwkGeoLoc() awscdk.IResolvable // The ReportDevStatusBattery value. AttrLoRaWanReportDevStatusBattery() awscdk.IResolvable // The ReportDevStatusMargin value. AttrLoRaWanReportDevStatusMargin() awscdk.IResolvable AttrLoRaWanResponse() awscdk.IResolvable // The TargetPer value. AttrLoRaWanTargetPer() *float64 // The UlBucketSize value. AttrLoRaWanUlBucketSize() *float64 // The ULRate value. AttrLoRaWanUlRate() *float64 // The ULRatePolicy value. AttrLoRaWanUlRatePolicy() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // LoRaWAN service profile object. LoRaWan() interface{} SetLoRaWan(val interface{}) // The name of the new resource. Name() *string SetName(val *string) // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // The tags are an array of key-value pairs to attach to the specified resource. TagsRaw() *[]*awscdk.CfnTag SetTagsRaw(val *[]*awscdk.CfnTag) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
Creates a new service profile.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnServiceProfile := awscdk.Aws_iotwireless.NewCfnServiceProfile(this, jsii.String("MyCfnServiceProfile"), &CfnServiceProfileProps{ LoRaWan: &LoRaWANServiceProfileProperty{ AddGwMetadata: jsii.Boolean(false), ChannelMask: jsii.String("channelMask"), DevStatusReqFreq: jsii.Number(123), DlBucketSize: jsii.Number(123), DlRate: jsii.Number(123), DlRatePolicy: jsii.String("dlRatePolicy"), DrMax: jsii.Number(123), DrMin: jsii.Number(123), HrAllowed: jsii.Boolean(false), MinGwDiversity: jsii.Number(123), NwkGeoLoc: jsii.Boolean(false), PrAllowed: jsii.Boolean(false), RaAllowed: jsii.Boolean(false), ReportDevStatusBattery: jsii.Boolean(false), ReportDevStatusMargin: jsii.Boolean(false), TargetPer: jsii.Number(123), UlBucketSize: jsii.Number(123), UlRate: jsii.Number(123), UlRatePolicy: jsii.String("ulRatePolicy"), }, Name: jsii.String("name"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
func NewCfnServiceProfile ¶
func NewCfnServiceProfile(scope constructs.Construct, id *string, props *CfnServiceProfileProps) CfnServiceProfile
type CfnServiceProfileProps ¶
type CfnServiceProfileProps struct { // LoRaWAN service profile object. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-serviceprofile.html#cfn-iotwireless-serviceprofile-lorawan // LoRaWan interface{} `field:"optional" json:"loRaWan" yaml:"loRaWan"` // The name of the new resource. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-serviceprofile.html#cfn-iotwireless-serviceprofile-name // Name *string `field:"optional" json:"name" yaml:"name"` // The tags are an array of key-value pairs to attach to the specified resource. // // Tags can have a minimum of 0 and a maximum of 50 items. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-serviceprofile.html#cfn-iotwireless-serviceprofile-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnServiceProfile`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnServiceProfileProps := &CfnServiceProfileProps{ LoRaWan: &LoRaWANServiceProfileProperty{ AddGwMetadata: jsii.Boolean(false), ChannelMask: jsii.String("channelMask"), DevStatusReqFreq: jsii.Number(123), DlBucketSize: jsii.Number(123), DlRate: jsii.Number(123), DlRatePolicy: jsii.String("dlRatePolicy"), DrMax: jsii.Number(123), DrMin: jsii.Number(123), HrAllowed: jsii.Boolean(false), MinGwDiversity: jsii.Number(123), NwkGeoLoc: jsii.Boolean(false), PrAllowed: jsii.Boolean(false), RaAllowed: jsii.Boolean(false), ReportDevStatusBattery: jsii.Boolean(false), ReportDevStatusMargin: jsii.Boolean(false), TargetPer: jsii.Number(123), UlBucketSize: jsii.Number(123), UlRate: jsii.Number(123), UlRatePolicy: jsii.String("ulRatePolicy"), }, Name: jsii.String("name"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
type CfnServiceProfile_LoRaWANServiceProfileProperty ¶
type CfnServiceProfile_LoRaWANServiceProfileProperty struct { // The AddGWMetaData value. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-serviceprofile-lorawanserviceprofile.html#cfn-iotwireless-serviceprofile-lorawanserviceprofile-addgwmetadata // AddGwMetadata interface{} `field:"optional" json:"addGwMetadata" yaml:"addGwMetadata"` // The ChannelMask value. // // This property is `ReadOnly` and can't be inputted for create. It's returned with `Fn::GetAtt` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-serviceprofile-lorawanserviceprofile.html#cfn-iotwireless-serviceprofile-lorawanserviceprofile-channelmask // ChannelMask *string `field:"optional" json:"channelMask" yaml:"channelMask"` // The DevStatusReqFreq value. // // This property is `ReadOnly` and can't be inputted for create. It's returned with `Fn::GetAtt` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-serviceprofile-lorawanserviceprofile.html#cfn-iotwireless-serviceprofile-lorawanserviceprofile-devstatusreqfreq // DevStatusReqFreq *float64 `field:"optional" json:"devStatusReqFreq" yaml:"devStatusReqFreq"` // The DLBucketSize value. // // This property is `ReadOnly` and can't be inputted for create. It's returned with `Fn::GetAtt` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-serviceprofile-lorawanserviceprofile.html#cfn-iotwireless-serviceprofile-lorawanserviceprofile-dlbucketsize // DlBucketSize *float64 `field:"optional" json:"dlBucketSize" yaml:"dlBucketSize"` // The DLRate value. // // This property is `ReadOnly` and can't be inputted for create. It's returned with `Fn::GetAtt` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-serviceprofile-lorawanserviceprofile.html#cfn-iotwireless-serviceprofile-lorawanserviceprofile-dlrate // DlRate *float64 `field:"optional" json:"dlRate" yaml:"dlRate"` // The DLRatePolicy value. // // This property is `ReadOnly` and can't be inputted for create. It's returned with `Fn::GetAtt` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-serviceprofile-lorawanserviceprofile.html#cfn-iotwireless-serviceprofile-lorawanserviceprofile-dlratepolicy // DlRatePolicy *string `field:"optional" json:"dlRatePolicy" yaml:"dlRatePolicy"` // The DRMax value. // // This property is `ReadOnly` and can't be inputted for create. It's returned with `Fn::GetAtt` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-serviceprofile-lorawanserviceprofile.html#cfn-iotwireless-serviceprofile-lorawanserviceprofile-drmax // DrMax *float64 `field:"optional" json:"drMax" yaml:"drMax"` // The DRMin value. // // This property is `ReadOnly` and can't be inputted for create. It's returned with `Fn::GetAtt` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-serviceprofile-lorawanserviceprofile.html#cfn-iotwireless-serviceprofile-lorawanserviceprofile-drmin // DrMin *float64 `field:"optional" json:"drMin" yaml:"drMin"` // The HRAllowed value that describes whether handover roaming is allowed. // // This property is `ReadOnly` and can't be inputted for create. It's returned with `Fn::GetAtt` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-serviceprofile-lorawanserviceprofile.html#cfn-iotwireless-serviceprofile-lorawanserviceprofile-hrallowed // HrAllowed interface{} `field:"optional" json:"hrAllowed" yaml:"hrAllowed"` // The MinGwDiversity value. // // This property is `ReadOnly` and can't be inputted for create. It's returned with `Fn::GetAtt` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-serviceprofile-lorawanserviceprofile.html#cfn-iotwireless-serviceprofile-lorawanserviceprofile-mingwdiversity // MinGwDiversity *float64 `field:"optional" json:"minGwDiversity" yaml:"minGwDiversity"` // The NwkGeoLoc value. // // This property is `ReadOnly` and can't be inputted for create. It's returned with `Fn::GetAtt` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-serviceprofile-lorawanserviceprofile.html#cfn-iotwireless-serviceprofile-lorawanserviceprofile-nwkgeoloc // NwkGeoLoc interface{} `field:"optional" json:"nwkGeoLoc" yaml:"nwkGeoLoc"` // The PRAllowed value that describes whether passive roaming is allowed. // // This property is `ReadOnly` and can't be inputted for create. It's returned with `Fn::GetAtt` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-serviceprofile-lorawanserviceprofile.html#cfn-iotwireless-serviceprofile-lorawanserviceprofile-prallowed // PrAllowed interface{} `field:"optional" json:"prAllowed" yaml:"prAllowed"` // The RAAllowed value that describes whether roaming activation is allowed. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-serviceprofile-lorawanserviceprofile.html#cfn-iotwireless-serviceprofile-lorawanserviceprofile-raallowed // RaAllowed interface{} `field:"optional" json:"raAllowed" yaml:"raAllowed"` // The ReportDevStatusBattery value. // // This property is `ReadOnly` and can't be inputted for create. It's returned with `Fn::GetAtt` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-serviceprofile-lorawanserviceprofile.html#cfn-iotwireless-serviceprofile-lorawanserviceprofile-reportdevstatusbattery // ReportDevStatusBattery interface{} `field:"optional" json:"reportDevStatusBattery" yaml:"reportDevStatusBattery"` // The ReportDevStatusMargin value. // // This property is `ReadOnly` and can't be inputted for create. It's returned with `Fn::GetAtt` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-serviceprofile-lorawanserviceprofile.html#cfn-iotwireless-serviceprofile-lorawanserviceprofile-reportdevstatusmargin // ReportDevStatusMargin interface{} `field:"optional" json:"reportDevStatusMargin" yaml:"reportDevStatusMargin"` // The TargetPer value. // // This property is `ReadOnly` and can't be inputted for create. It's returned with `Fn::GetAtt` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-serviceprofile-lorawanserviceprofile.html#cfn-iotwireless-serviceprofile-lorawanserviceprofile-targetper // TargetPer *float64 `field:"optional" json:"targetPer" yaml:"targetPer"` // The UlBucketSize value. // // This property is `ReadOnly` and can't be inputted for create. It's returned with `Fn::GetAtt` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-serviceprofile-lorawanserviceprofile.html#cfn-iotwireless-serviceprofile-lorawanserviceprofile-ulbucketsize // UlBucketSize *float64 `field:"optional" json:"ulBucketSize" yaml:"ulBucketSize"` // The ULRate value. // // This property is `ReadOnly` and can't be inputted for create. It's returned with `Fn::GetAtt` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-serviceprofile-lorawanserviceprofile.html#cfn-iotwireless-serviceprofile-lorawanserviceprofile-ulrate // UlRate *float64 `field:"optional" json:"ulRate" yaml:"ulRate"` // The ULRatePolicy value. // // This property is `ReadOnly` and can't be inputted for create. It's returned with `Fn::GetAtt` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-serviceprofile-lorawanserviceprofile.html#cfn-iotwireless-serviceprofile-lorawanserviceprofile-ulratepolicy // UlRatePolicy *string `field:"optional" json:"ulRatePolicy" yaml:"ulRatePolicy"` }
LoRaWANServiceProfile object.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" loRaWANServiceProfileProperty := &LoRaWANServiceProfileProperty{ AddGwMetadata: jsii.Boolean(false), ChannelMask: jsii.String("channelMask"), DevStatusReqFreq: jsii.Number(123), DlBucketSize: jsii.Number(123), DlRate: jsii.Number(123), DlRatePolicy: jsii.String("dlRatePolicy"), DrMax: jsii.Number(123), DrMin: jsii.Number(123), HrAllowed: jsii.Boolean(false), MinGwDiversity: jsii.Number(123), NwkGeoLoc: jsii.Boolean(false), PrAllowed: jsii.Boolean(false), RaAllowed: jsii.Boolean(false), ReportDevStatusBattery: jsii.Boolean(false), ReportDevStatusMargin: jsii.Boolean(false), TargetPer: jsii.Number(123), UlBucketSize: jsii.Number(123), UlRate: jsii.Number(123), UlRatePolicy: jsii.String("ulRatePolicy"), }
type CfnTaskDefinition ¶
type CfnTaskDefinition interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // The Amazon Resource Name of the resource. AttrArn() *string // The ID of the new wireless gateway task definition. AttrId() *string // Whether to automatically create tasks using this task definition for all gateways with the specified current version. AutoCreateTasks() interface{} SetAutoCreateTasks(val interface{}) // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // LoRaWANUpdateGatewayTaskEntry object. LoRaWanUpdateGatewayTaskEntry() interface{} SetLoRaWanUpdateGatewayTaskEntry(val interface{}) // The name of the new resource. Name() *string SetName(val *string) // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // The tags are an array of key-value pairs to attach to the specified resource. TagsRaw() *[]*awscdk.CfnTag SetTagsRaw(val *[]*awscdk.CfnTag) // A filter to list only the wireless gateway task definitions that use this task definition type. TaskDefinitionType() *string SetTaskDefinitionType(val *string) // Information about the gateways to update. Update() interface{} SetUpdate(val interface{}) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
Creates a gateway task definition.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnTaskDefinition := awscdk.Aws_iotwireless.NewCfnTaskDefinition(this, jsii.String("MyCfnTaskDefinition"), &CfnTaskDefinitionProps{ AutoCreateTasks: jsii.Boolean(false), // the properties below are optional LoRaWanUpdateGatewayTaskEntry: &LoRaWANUpdateGatewayTaskEntryProperty{ CurrentVersion: &LoRaWANGatewayVersionProperty{ Model: jsii.String("model"), PackageVersion: jsii.String("packageVersion"), Station: jsii.String("station"), }, UpdateVersion: &LoRaWANGatewayVersionProperty{ Model: jsii.String("model"), PackageVersion: jsii.String("packageVersion"), Station: jsii.String("station"), }, }, Name: jsii.String("name"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, TaskDefinitionType: jsii.String("taskDefinitionType"), Update: &UpdateWirelessGatewayTaskCreateProperty{ LoRaWan: &LoRaWANUpdateGatewayTaskCreateProperty{ CurrentVersion: &LoRaWANGatewayVersionProperty{ Model: jsii.String("model"), PackageVersion: jsii.String("packageVersion"), Station: jsii.String("station"), }, SigKeyCrc: jsii.Number(123), UpdateSignature: jsii.String("updateSignature"), UpdateVersion: &LoRaWANGatewayVersionProperty{ Model: jsii.String("model"), PackageVersion: jsii.String("packageVersion"), Station: jsii.String("station"), }, }, UpdateDataRole: jsii.String("updateDataRole"), UpdateDataSource: jsii.String("updateDataSource"), }, })
func NewCfnTaskDefinition ¶
func NewCfnTaskDefinition(scope constructs.Construct, id *string, props *CfnTaskDefinitionProps) CfnTaskDefinition
type CfnTaskDefinitionProps ¶
type CfnTaskDefinitionProps struct { // Whether to automatically create tasks using this task definition for all gateways with the specified current version. // // If `false` , the task must be created by calling `CreateWirelessGatewayTask` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-taskdefinition.html#cfn-iotwireless-taskdefinition-autocreatetasks // AutoCreateTasks interface{} `field:"required" json:"autoCreateTasks" yaml:"autoCreateTasks"` // LoRaWANUpdateGatewayTaskEntry object. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-taskdefinition.html#cfn-iotwireless-taskdefinition-lorawanupdategatewaytaskentry // LoRaWanUpdateGatewayTaskEntry interface{} `field:"optional" json:"loRaWanUpdateGatewayTaskEntry" yaml:"loRaWanUpdateGatewayTaskEntry"` // The name of the new resource. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-taskdefinition.html#cfn-iotwireless-taskdefinition-name // Name *string `field:"optional" json:"name" yaml:"name"` // The tags are an array of key-value pairs to attach to the specified resource. // // Tags can have a minimum of 0 and a maximum of 50 items. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-taskdefinition.html#cfn-iotwireless-taskdefinition-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` // A filter to list only the wireless gateway task definitions that use this task definition type. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-taskdefinition.html#cfn-iotwireless-taskdefinition-taskdefinitiontype // TaskDefinitionType *string `field:"optional" json:"taskDefinitionType" yaml:"taskDefinitionType"` // Information about the gateways to update. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-taskdefinition.html#cfn-iotwireless-taskdefinition-update // Update interface{} `field:"optional" json:"update" yaml:"update"` }
Properties for defining a `CfnTaskDefinition`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnTaskDefinitionProps := &CfnTaskDefinitionProps{ AutoCreateTasks: jsii.Boolean(false), // the properties below are optional LoRaWanUpdateGatewayTaskEntry: &LoRaWANUpdateGatewayTaskEntryProperty{ CurrentVersion: &LoRaWANGatewayVersionProperty{ Model: jsii.String("model"), PackageVersion: jsii.String("packageVersion"), Station: jsii.String("station"), }, UpdateVersion: &LoRaWANGatewayVersionProperty{ Model: jsii.String("model"), PackageVersion: jsii.String("packageVersion"), Station: jsii.String("station"), }, }, Name: jsii.String("name"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, TaskDefinitionType: jsii.String("taskDefinitionType"), Update: &UpdateWirelessGatewayTaskCreateProperty{ LoRaWan: &LoRaWANUpdateGatewayTaskCreateProperty{ CurrentVersion: &LoRaWANGatewayVersionProperty{ Model: jsii.String("model"), PackageVersion: jsii.String("packageVersion"), Station: jsii.String("station"), }, SigKeyCrc: jsii.Number(123), UpdateSignature: jsii.String("updateSignature"), UpdateVersion: &LoRaWANGatewayVersionProperty{ Model: jsii.String("model"), PackageVersion: jsii.String("packageVersion"), Station: jsii.String("station"), }, }, UpdateDataRole: jsii.String("updateDataRole"), UpdateDataSource: jsii.String("updateDataSource"), }, }
type CfnTaskDefinition_LoRaWANGatewayVersionProperty ¶
type CfnTaskDefinition_LoRaWANGatewayVersionProperty struct { // The model number of the wireless gateway. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-taskdefinition-lorawangatewayversion.html#cfn-iotwireless-taskdefinition-lorawangatewayversion-model // Model *string `field:"optional" json:"model" yaml:"model"` // The version of the wireless gateway firmware. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-taskdefinition-lorawangatewayversion.html#cfn-iotwireless-taskdefinition-lorawangatewayversion-packageversion // PackageVersion *string `field:"optional" json:"packageVersion" yaml:"packageVersion"` // The basic station version of the wireless gateway. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-taskdefinition-lorawangatewayversion.html#cfn-iotwireless-taskdefinition-lorawangatewayversion-station // Station *string `field:"optional" json:"station" yaml:"station"` }
LoRaWANGatewayVersion object.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" loRaWANGatewayVersionProperty := &LoRaWANGatewayVersionProperty{ Model: jsii.String("model"), PackageVersion: jsii.String("packageVersion"), Station: jsii.String("station"), }
type CfnTaskDefinition_LoRaWANUpdateGatewayTaskCreateProperty ¶
type CfnTaskDefinition_LoRaWANUpdateGatewayTaskCreateProperty struct { // The version of the gateways that should receive the update. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-taskdefinition-lorawanupdategatewaytaskcreate.html#cfn-iotwireless-taskdefinition-lorawanupdategatewaytaskcreate-currentversion // CurrentVersion interface{} `field:"optional" json:"currentVersion" yaml:"currentVersion"` // The CRC of the signature private key to check. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-taskdefinition-lorawanupdategatewaytaskcreate.html#cfn-iotwireless-taskdefinition-lorawanupdategatewaytaskcreate-sigkeycrc // SigKeyCrc *float64 `field:"optional" json:"sigKeyCrc" yaml:"sigKeyCrc"` // The signature used to verify the update firmware. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-taskdefinition-lorawanupdategatewaytaskcreate.html#cfn-iotwireless-taskdefinition-lorawanupdategatewaytaskcreate-updatesignature // UpdateSignature *string `field:"optional" json:"updateSignature" yaml:"updateSignature"` // The firmware version to update the gateway to. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-taskdefinition-lorawanupdategatewaytaskcreate.html#cfn-iotwireless-taskdefinition-lorawanupdategatewaytaskcreate-updateversion // UpdateVersion interface{} `field:"optional" json:"updateVersion" yaml:"updateVersion"` }
The signature used to verify the update firmware.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" loRaWANUpdateGatewayTaskCreateProperty := &LoRaWANUpdateGatewayTaskCreateProperty{ CurrentVersion: &LoRaWANGatewayVersionProperty{ Model: jsii.String("model"), PackageVersion: jsii.String("packageVersion"), Station: jsii.String("station"), }, SigKeyCrc: jsii.Number(123), UpdateSignature: jsii.String("updateSignature"), UpdateVersion: &LoRaWANGatewayVersionProperty{ Model: jsii.String("model"), PackageVersion: jsii.String("packageVersion"), Station: jsii.String("station"), }, }
type CfnTaskDefinition_LoRaWANUpdateGatewayTaskEntryProperty ¶
type CfnTaskDefinition_LoRaWANUpdateGatewayTaskEntryProperty struct { // The version of the gateways that should receive the update. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-taskdefinition-lorawanupdategatewaytaskentry.html#cfn-iotwireless-taskdefinition-lorawanupdategatewaytaskentry-currentversion // CurrentVersion interface{} `field:"optional" json:"currentVersion" yaml:"currentVersion"` // The firmware version to update the gateway to. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-taskdefinition-lorawanupdategatewaytaskentry.html#cfn-iotwireless-taskdefinition-lorawanupdategatewaytaskentry-updateversion // UpdateVersion interface{} `field:"optional" json:"updateVersion" yaml:"updateVersion"` }
LoRaWANUpdateGatewayTaskEntry object.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" loRaWANUpdateGatewayTaskEntryProperty := &LoRaWANUpdateGatewayTaskEntryProperty{ CurrentVersion: &LoRaWANGatewayVersionProperty{ Model: jsii.String("model"), PackageVersion: jsii.String("packageVersion"), Station: jsii.String("station"), }, UpdateVersion: &LoRaWANGatewayVersionProperty{ Model: jsii.String("model"), PackageVersion: jsii.String("packageVersion"), Station: jsii.String("station"), }, }
type CfnTaskDefinition_UpdateWirelessGatewayTaskCreateProperty ¶
type CfnTaskDefinition_UpdateWirelessGatewayTaskCreateProperty struct { // The properties that relate to the LoRaWAN wireless gateway. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-taskdefinition-updatewirelessgatewaytaskcreate.html#cfn-iotwireless-taskdefinition-updatewirelessgatewaytaskcreate-lorawan // LoRaWan interface{} `field:"optional" json:"loRaWan" yaml:"loRaWan"` // The IAM role used to read data from the S3 bucket. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-taskdefinition-updatewirelessgatewaytaskcreate.html#cfn-iotwireless-taskdefinition-updatewirelessgatewaytaskcreate-updatedatarole // UpdateDataRole *string `field:"optional" json:"updateDataRole" yaml:"updateDataRole"` // The link to the S3 bucket. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-taskdefinition-updatewirelessgatewaytaskcreate.html#cfn-iotwireless-taskdefinition-updatewirelessgatewaytaskcreate-updatedatasource // UpdateDataSource *string `field:"optional" json:"updateDataSource" yaml:"updateDataSource"` }
UpdateWirelessGatewayTaskCreate object.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" updateWirelessGatewayTaskCreateProperty := &UpdateWirelessGatewayTaskCreateProperty{ LoRaWan: &LoRaWANUpdateGatewayTaskCreateProperty{ CurrentVersion: &LoRaWANGatewayVersionProperty{ Model: jsii.String("model"), PackageVersion: jsii.String("packageVersion"), Station: jsii.String("station"), }, SigKeyCrc: jsii.Number(123), UpdateSignature: jsii.String("updateSignature"), UpdateVersion: &LoRaWANGatewayVersionProperty{ Model: jsii.String("model"), PackageVersion: jsii.String("packageVersion"), Station: jsii.String("station"), }, }, UpdateDataRole: jsii.String("updateDataRole"), UpdateDataSource: jsii.String("updateDataSource"), }
type CfnWirelessDevice ¶
type CfnWirelessDevice interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // The ARN of the wireless device created. AttrArn() *string // The ID of the wireless device created. AttrId() *string // The name of the thing associated with the wireless device. // // The value is empty if a thing isn't associated with the device. AttrThingName() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The description of the new resource. Description() *string SetDescription(val *string) // The name of the destination to assign to the new wireless device. DestinationName() *string SetDestinationName(val *string) // The date and time when the most recent uplink was received. LastUplinkReceivedAt() *string SetLastUplinkReceivedAt(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The device configuration information to use to create the wireless device. LoRaWan() interface{} SetLoRaWan(val interface{}) // The name of the new resource. Name() *string SetName(val *string) // The tree node. Node() constructs.Node // FPort values for the GNSS, Stream, and ClockSync functions of the positioning information. Positioning() *string SetPositioning(val *string) // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // The tags are an array of key-value pairs to attach to the specified resource. TagsRaw() *[]*awscdk.CfnTag SetTagsRaw(val *[]*awscdk.CfnTag) // The ARN of the thing to associate with the wireless device. ThingArn() *string SetThingArn(val *string) // The wireless device type. Type() *string SetType(val *string) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
Provisions a wireless device.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnWirelessDevice := awscdk.Aws_iotwireless.NewCfnWirelessDevice(this, jsii.String("MyCfnWirelessDevice"), &CfnWirelessDeviceProps{ DestinationName: jsii.String("destinationName"), Type: jsii.String("type"), // the properties below are optional Description: jsii.String("description"), LastUplinkReceivedAt: jsii.String("lastUplinkReceivedAt"), LoRaWan: &LoRaWANDeviceProperty{ AbpV10X: &AbpV10xProperty{ DevAddr: jsii.String("devAddr"), SessionKeys: &SessionKeysAbpV10xProperty{ AppSKey: jsii.String("appSKey"), NwkSKey: jsii.String("nwkSKey"), }, }, AbpV11: &AbpV11Property{ DevAddr: jsii.String("devAddr"), SessionKeys: &SessionKeysAbpV11Property{ AppSKey: jsii.String("appSKey"), FNwkSIntKey: jsii.String("fNwkSIntKey"), NwkSEncKey: jsii.String("nwkSEncKey"), SNwkSIntKey: jsii.String("sNwkSIntKey"), }, }, DevEui: jsii.String("devEui"), DeviceProfileId: jsii.String("deviceProfileId"), FPorts: &FPortsProperty{ Applications: []interface{}{ &ApplicationProperty{ DestinationName: jsii.String("destinationName"), FPort: jsii.Number(123), Type: jsii.String("type"), }, }, }, OtaaV10X: &OtaaV10xProperty{ AppEui: jsii.String("appEui"), AppKey: jsii.String("appKey"), }, OtaaV11: &OtaaV11Property{ AppKey: jsii.String("appKey"), JoinEui: jsii.String("joinEui"), NwkKey: jsii.String("nwkKey"), }, ServiceProfileId: jsii.String("serviceProfileId"), }, Name: jsii.String("name"), Positioning: jsii.String("positioning"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, ThingArn: jsii.String("thingArn"), })
func NewCfnWirelessDevice ¶
func NewCfnWirelessDevice(scope constructs.Construct, id *string, props *CfnWirelessDeviceProps) CfnWirelessDevice
type CfnWirelessDeviceImportTask ¶ added in v2.78.0
type CfnWirelessDeviceImportTask interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // The ARN (Amazon Resource Name) of the import task. AttrArn() *string // The date and time at which the wireless device import task was created. AttrCreationDate() *string // The summary information of count of wireless devices that failed to onboard to the import task. AttrFailedImportedDevicesCount() *float64 // The import task ID. AttrId() *string // The summary information of count of wireless devices that are waiting for the control log to be added to an import task. AttrInitializedImportedDevicesCount() *float64 // The summary information of count of wireless devices that have been onboarded to the import task. AttrOnboardedImportedDevicesCount() *float64 // The summary information of count of wireless devices that are waiting in the queue to be onboarded to the import task. AttrPendingImportedDevicesCount() *float64 // List of Sidewalk devices that are added to the import task. AttrSidewalkDeviceCreationFileList() *[]*string // The status of a wireless device import task. // // The status can be `INITIALIZING` , `INITIALIZED` , `PENDING` , `COMPLETE` , `FAILED` , or `DELETING` . AttrStatus() *string // The reason that provides additional information about the import task status. AttrStatusReason() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The name of the destination that describes the IoT rule to route messages from the Sidewalk devices in the import task to other applications. DestinationName() *string SetDestinationName(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The Sidewalk-related information of the wireless device import task. Sidewalk() interface{} SetSidewalk(val interface{}) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // Adds to or modifies the tags of the given resource. TagsRaw() *[]*awscdk.CfnTag SetTagsRaw(val *[]*awscdk.CfnTag) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
Information about an import task for wireless devices.
When creating the resource, either create a single wireless device import task using the Sidewalk manufacturing serial number (SMSN) of the wireless device, or create an import task for multiple devices by specifying both the `DeviceCreationFile` and the `Role` .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnWirelessDeviceImportTask := awscdk.Aws_iotwireless.NewCfnWirelessDeviceImportTask(this, jsii.String("MyCfnWirelessDeviceImportTask"), &CfnWirelessDeviceImportTaskProps{ DestinationName: jsii.String("destinationName"), Sidewalk: &SidewalkProperty{ DeviceCreationFile: jsii.String("deviceCreationFile"), DeviceCreationFileList: []*string{ jsii.String("deviceCreationFileList"), }, Role: jsii.String("role"), SidewalkManufacturingSn: jsii.String("sidewalkManufacturingSn"), }, // the properties below are optional Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
func NewCfnWirelessDeviceImportTask ¶ added in v2.78.0
func NewCfnWirelessDeviceImportTask(scope constructs.Construct, id *string, props *CfnWirelessDeviceImportTaskProps) CfnWirelessDeviceImportTask
type CfnWirelessDeviceImportTaskProps ¶ added in v2.78.0
type CfnWirelessDeviceImportTaskProps struct { // The name of the destination that describes the IoT rule to route messages from the Sidewalk devices in the import task to other applications. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-wirelessdeviceimporttask.html#cfn-iotwireless-wirelessdeviceimporttask-destinationname // DestinationName *string `field:"required" json:"destinationName" yaml:"destinationName"` // The Sidewalk-related information of the wireless device import task. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-wirelessdeviceimporttask.html#cfn-iotwireless-wirelessdeviceimporttask-sidewalk // Sidewalk interface{} `field:"required" json:"sidewalk" yaml:"sidewalk"` // Adds to or modifies the tags of the given resource. // // Tags are metadata that you can use to manage a resource. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-wirelessdeviceimporttask.html#cfn-iotwireless-wirelessdeviceimporttask-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnWirelessDeviceImportTask`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnWirelessDeviceImportTaskProps := &CfnWirelessDeviceImportTaskProps{ DestinationName: jsii.String("destinationName"), Sidewalk: &SidewalkProperty{ DeviceCreationFile: jsii.String("deviceCreationFile"), DeviceCreationFileList: []*string{ jsii.String("deviceCreationFileList"), }, Role: jsii.String("role"), SidewalkManufacturingSn: jsii.String("sidewalkManufacturingSn"), }, // the properties below are optional Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
type CfnWirelessDeviceImportTask_SidewalkProperty ¶ added in v2.78.0
type CfnWirelessDeviceImportTask_SidewalkProperty struct { // The CSV file contained in an S3 bucket that's used for adding devices to an import task. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-wirelessdeviceimporttask-sidewalk.html#cfn-iotwireless-wirelessdeviceimporttask-sidewalk-devicecreationfile // DeviceCreationFile *string `field:"optional" json:"deviceCreationFile" yaml:"deviceCreationFile"` // List of Sidewalk devices that are added to the import task. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-wirelessdeviceimporttask-sidewalk.html#cfn-iotwireless-wirelessdeviceimporttask-sidewalk-devicecreationfilelist // DeviceCreationFileList *[]*string `field:"optional" json:"deviceCreationFileList" yaml:"deviceCreationFileList"` // The IAM role that allows to access the CSV file in the S3 bucket. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-wirelessdeviceimporttask-sidewalk.html#cfn-iotwireless-wirelessdeviceimporttask-sidewalk-role // Role *string `field:"optional" json:"role" yaml:"role"` // The Sidewalk manufacturing serial number (SMSN) of the Sidewalk device. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-wirelessdeviceimporttask-sidewalk.html#cfn-iotwireless-wirelessdeviceimporttask-sidewalk-sidewalkmanufacturingsn // SidewalkManufacturingSn *string `field:"optional" json:"sidewalkManufacturingSn" yaml:"sidewalkManufacturingSn"` }
Sidewalk-related information about a wireless device import task.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" sidewalkProperty := &SidewalkProperty{ DeviceCreationFile: jsii.String("deviceCreationFile"), DeviceCreationFileList: []*string{ jsii.String("deviceCreationFileList"), }, Role: jsii.String("role"), SidewalkManufacturingSn: jsii.String("sidewalkManufacturingSn"), }
type CfnWirelessDeviceProps ¶
type CfnWirelessDeviceProps struct { // The name of the destination to assign to the new wireless device. // // Can have only have alphanumeric, - (hyphen) and _ (underscore) characters and it can't have any spaces. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-wirelessdevice.html#cfn-iotwireless-wirelessdevice-destinationname // DestinationName *string `field:"required" json:"destinationName" yaml:"destinationName"` // The wireless device type. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-wirelessdevice.html#cfn-iotwireless-wirelessdevice-type // Type *string `field:"required" json:"type" yaml:"type"` // The description of the new resource. // // Maximum length is 2048. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-wirelessdevice.html#cfn-iotwireless-wirelessdevice-description // Description *string `field:"optional" json:"description" yaml:"description"` // The date and time when the most recent uplink was received. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-wirelessdevice.html#cfn-iotwireless-wirelessdevice-lastuplinkreceivedat // LastUplinkReceivedAt *string `field:"optional" json:"lastUplinkReceivedAt" yaml:"lastUplinkReceivedAt"` // The device configuration information to use to create the wireless device. // // Must be at least one of OtaaV10x, OtaaV11, AbpV11, or AbpV10x. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-wirelessdevice.html#cfn-iotwireless-wirelessdevice-lorawan // LoRaWan interface{} `field:"optional" json:"loRaWan" yaml:"loRaWan"` // The name of the new resource. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-wirelessdevice.html#cfn-iotwireless-wirelessdevice-name // Name *string `field:"optional" json:"name" yaml:"name"` // FPort values for the GNSS, Stream, and ClockSync functions of the positioning information. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-wirelessdevice.html#cfn-iotwireless-wirelessdevice-positioning // Positioning *string `field:"optional" json:"positioning" yaml:"positioning"` // The tags are an array of key-value pairs to attach to the specified resource. // // Tags can have a minimum of 0 and a maximum of 50 items. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-wirelessdevice.html#cfn-iotwireless-wirelessdevice-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` // The ARN of the thing to associate with the wireless device. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-wirelessdevice.html#cfn-iotwireless-wirelessdevice-thingarn // ThingArn *string `field:"optional" json:"thingArn" yaml:"thingArn"` }
Properties for defining a `CfnWirelessDevice`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnWirelessDeviceProps := &CfnWirelessDeviceProps{ DestinationName: jsii.String("destinationName"), Type: jsii.String("type"), // the properties below are optional Description: jsii.String("description"), LastUplinkReceivedAt: jsii.String("lastUplinkReceivedAt"), LoRaWan: &LoRaWANDeviceProperty{ AbpV10X: &AbpV10xProperty{ DevAddr: jsii.String("devAddr"), SessionKeys: &SessionKeysAbpV10xProperty{ AppSKey: jsii.String("appSKey"), NwkSKey: jsii.String("nwkSKey"), }, }, AbpV11: &AbpV11Property{ DevAddr: jsii.String("devAddr"), SessionKeys: &SessionKeysAbpV11Property{ AppSKey: jsii.String("appSKey"), FNwkSIntKey: jsii.String("fNwkSIntKey"), NwkSEncKey: jsii.String("nwkSEncKey"), SNwkSIntKey: jsii.String("sNwkSIntKey"), }, }, DevEui: jsii.String("devEui"), DeviceProfileId: jsii.String("deviceProfileId"), FPorts: &FPortsProperty{ Applications: []interface{}{ &ApplicationProperty{ DestinationName: jsii.String("destinationName"), FPort: jsii.Number(123), Type: jsii.String("type"), }, }, }, OtaaV10X: &OtaaV10xProperty{ AppEui: jsii.String("appEui"), AppKey: jsii.String("appKey"), }, OtaaV11: &OtaaV11Property{ AppKey: jsii.String("appKey"), JoinEui: jsii.String("joinEui"), NwkKey: jsii.String("nwkKey"), }, ServiceProfileId: jsii.String("serviceProfileId"), }, Name: jsii.String("name"), Positioning: jsii.String("positioning"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, ThingArn: jsii.String("thingArn"), }
type CfnWirelessDevice_AbpV10xProperty ¶
type CfnWirelessDevice_AbpV10xProperty struct { // The DevAddr value. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-wirelessdevice-abpv10x.html#cfn-iotwireless-wirelessdevice-abpv10x-devaddr // DevAddr *string `field:"required" json:"devAddr" yaml:"devAddr"` // Session keys for ABP v1.0.x. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-wirelessdevice-abpv10x.html#cfn-iotwireless-wirelessdevice-abpv10x-sessionkeys // SessionKeys interface{} `field:"required" json:"sessionKeys" yaml:"sessionKeys"` }
ABP device object for LoRaWAN specification v1.0.x.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" abpV10xProperty := &AbpV10xProperty{ DevAddr: jsii.String("devAddr"), SessionKeys: &SessionKeysAbpV10xProperty{ AppSKey: jsii.String("appSKey"), NwkSKey: jsii.String("nwkSKey"), }, }
type CfnWirelessDevice_AbpV11Property ¶
type CfnWirelessDevice_AbpV11Property struct { // The DevAddr value. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-wirelessdevice-abpv11.html#cfn-iotwireless-wirelessdevice-abpv11-devaddr // DevAddr *string `field:"required" json:"devAddr" yaml:"devAddr"` // Session keys for ABP v1.1. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-wirelessdevice-abpv11.html#cfn-iotwireless-wirelessdevice-abpv11-sessionkeys // SessionKeys interface{} `field:"required" json:"sessionKeys" yaml:"sessionKeys"` }
ABP device object for create APIs for v1.1.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" abpV11Property := &AbpV11Property{ DevAddr: jsii.String("devAddr"), SessionKeys: &SessionKeysAbpV11Property{ AppSKey: jsii.String("appSKey"), FNwkSIntKey: jsii.String("fNwkSIntKey"), NwkSEncKey: jsii.String("nwkSEncKey"), SNwkSIntKey: jsii.String("sNwkSIntKey"), }, }
type CfnWirelessDevice_ApplicationProperty ¶ added in v2.159.0
type CfnWirelessDevice_ApplicationProperty struct { // The name of the position data destination that describes the IoT rule that processes the device's position data. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-wirelessdevice-application.html#cfn-iotwireless-wirelessdevice-application-destinationname // DestinationName *string `field:"optional" json:"destinationName" yaml:"destinationName"` // The name of the new destination for the device. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-wirelessdevice-application.html#cfn-iotwireless-wirelessdevice-application-fport // FPort *float64 `field:"optional" json:"fPort" yaml:"fPort"` // Application type, which can be specified to obtain real-time position information of your LoRaWAN device. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-wirelessdevice-application.html#cfn-iotwireless-wirelessdevice-application-type // Type *string `field:"optional" json:"type" yaml:"type"` }
A list of optional LoRaWAN application information, which can be used for geolocation.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" applicationProperty := &ApplicationProperty{ DestinationName: jsii.String("destinationName"), FPort: jsii.Number(123), Type: jsii.String("type"), }
type CfnWirelessDevice_FPortsProperty ¶ added in v2.159.0
type CfnWirelessDevice_FPortsProperty struct { // LoRaWAN application configuration, which can be used to perform geolocation. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-wirelessdevice-fports.html#cfn-iotwireless-wirelessdevice-fports-applications // Applications interface{} `field:"optional" json:"applications" yaml:"applications"` }
List of FPorts assigned for different LoRaWAN application packages to use.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" fPortsProperty := &FPortsProperty{ Applications: []interface{}{ &ApplicationProperty{ DestinationName: jsii.String("destinationName"), FPort: jsii.Number(123), Type: jsii.String("type"), }, }, }
type CfnWirelessDevice_LoRaWANDeviceProperty ¶
type CfnWirelessDevice_LoRaWANDeviceProperty struct { // ABP device object for LoRaWAN specification v1.0.x. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-wirelessdevice-lorawandevice.html#cfn-iotwireless-wirelessdevice-lorawandevice-abpv10x // AbpV10X interface{} `field:"optional" json:"abpV10X" yaml:"abpV10X"` // ABP device object for create APIs for v1.1. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-wirelessdevice-lorawandevice.html#cfn-iotwireless-wirelessdevice-lorawandevice-abpv11 // AbpV11 interface{} `field:"optional" json:"abpV11" yaml:"abpV11"` // The DevEUI value. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-wirelessdevice-lorawandevice.html#cfn-iotwireless-wirelessdevice-lorawandevice-deveui // DevEui *string `field:"optional" json:"devEui" yaml:"devEui"` // The ID of the device profile for the new wireless device. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-wirelessdevice-lorawandevice.html#cfn-iotwireless-wirelessdevice-lorawandevice-deviceprofileid // DeviceProfileId *string `field:"optional" json:"deviceProfileId" yaml:"deviceProfileId"` // List of FPort assigned for different LoRaWAN application packages to use. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-wirelessdevice-lorawandevice.html#cfn-iotwireless-wirelessdevice-lorawandevice-fports // FPorts interface{} `field:"optional" json:"fPorts" yaml:"fPorts"` // OTAA device object for create APIs for v1.0.x. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-wirelessdevice-lorawandevice.html#cfn-iotwireless-wirelessdevice-lorawandevice-otaav10x // OtaaV10X interface{} `field:"optional" json:"otaaV10X" yaml:"otaaV10X"` // OTAA device object for v1.1 for create APIs. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-wirelessdevice-lorawandevice.html#cfn-iotwireless-wirelessdevice-lorawandevice-otaav11 // OtaaV11 interface{} `field:"optional" json:"otaaV11" yaml:"otaaV11"` // The ID of the service profile. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-wirelessdevice-lorawandevice.html#cfn-iotwireless-wirelessdevice-lorawandevice-serviceprofileid // ServiceProfileId *string `field:"optional" json:"serviceProfileId" yaml:"serviceProfileId"` }
LoRaWAN object for create functions.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" loRaWANDeviceProperty := &LoRaWANDeviceProperty{ AbpV10X: &AbpV10xProperty{ DevAddr: jsii.String("devAddr"), SessionKeys: &SessionKeysAbpV10xProperty{ AppSKey: jsii.String("appSKey"), NwkSKey: jsii.String("nwkSKey"), }, }, AbpV11: &AbpV11Property{ DevAddr: jsii.String("devAddr"), SessionKeys: &SessionKeysAbpV11Property{ AppSKey: jsii.String("appSKey"), FNwkSIntKey: jsii.String("fNwkSIntKey"), NwkSEncKey: jsii.String("nwkSEncKey"), SNwkSIntKey: jsii.String("sNwkSIntKey"), }, }, DevEui: jsii.String("devEui"), DeviceProfileId: jsii.String("deviceProfileId"), FPorts: &FPortsProperty{ Applications: []interface{}{ &ApplicationProperty{ DestinationName: jsii.String("destinationName"), FPort: jsii.Number(123), Type: jsii.String("type"), }, }, }, OtaaV10X: &OtaaV10xProperty{ AppEui: jsii.String("appEui"), AppKey: jsii.String("appKey"), }, OtaaV11: &OtaaV11Property{ AppKey: jsii.String("appKey"), JoinEui: jsii.String("joinEui"), NwkKey: jsii.String("nwkKey"), }, ServiceProfileId: jsii.String("serviceProfileId"), }
type CfnWirelessDevice_OtaaV10xProperty ¶
type CfnWirelessDevice_OtaaV10xProperty struct { // The AppEUI value. // // You specify this value when using LoRaWAN versions v1.0.2 or v1.0.3. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-wirelessdevice-otaav10x.html#cfn-iotwireless-wirelessdevice-otaav10x-appeui // AppEui *string `field:"required" json:"appEui" yaml:"appEui"` // The AppKey value. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-wirelessdevice-otaav10x.html#cfn-iotwireless-wirelessdevice-otaav10x-appkey // AppKey *string `field:"required" json:"appKey" yaml:"appKey"` }
OTAA device object for v1.0.x.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" otaaV10xProperty := &OtaaV10xProperty{ AppEui: jsii.String("appEui"), AppKey: jsii.String("appKey"), }
type CfnWirelessDevice_OtaaV11Property ¶
type CfnWirelessDevice_OtaaV11Property struct { // The AppKey is a secret key, which you should handle in a similar way as you would an application password. // // You can protect the AppKey value by storing it in the AWS Secrets Manager and use the [secretsmanager](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html#dynamic-references-secretsmanager) to reference this value. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-wirelessdevice-otaav11.html#cfn-iotwireless-wirelessdevice-otaav11-appkey // AppKey *string `field:"required" json:"appKey" yaml:"appKey"` // The JoinEUI value. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-wirelessdevice-otaav11.html#cfn-iotwireless-wirelessdevice-otaav11-joineui // JoinEui *string `field:"required" json:"joinEui" yaml:"joinEui"` // The NwkKey is a secret key, which you should handle in a similar way as you would an application password. // // You can protect the NwkKey value by storing it in the AWS Secrets Manager and use the [secretsmanager](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html#dynamic-references-secretsmanager) to reference this value. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-wirelessdevice-otaav11.html#cfn-iotwireless-wirelessdevice-otaav11-nwkkey // NwkKey *string `field:"required" json:"nwkKey" yaml:"nwkKey"` }
OTAA device object for v1.1 for create APIs.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" otaaV11Property := &OtaaV11Property{ AppKey: jsii.String("appKey"), JoinEui: jsii.String("joinEui"), NwkKey: jsii.String("nwkKey"), }
type CfnWirelessDevice_SessionKeysAbpV10xProperty ¶
type CfnWirelessDevice_SessionKeysAbpV10xProperty struct { // The AppSKey value. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-wirelessdevice-sessionkeysabpv10x.html#cfn-iotwireless-wirelessdevice-sessionkeysabpv10x-appskey // AppSKey *string `field:"required" json:"appSKey" yaml:"appSKey"` // The NwkKey value. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-wirelessdevice-sessionkeysabpv10x.html#cfn-iotwireless-wirelessdevice-sessionkeysabpv10x-nwkskey // NwkSKey *string `field:"required" json:"nwkSKey" yaml:"nwkSKey"` }
Session keys for ABP v1.0.x.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" sessionKeysAbpV10xProperty := &SessionKeysAbpV10xProperty{ AppSKey: jsii.String("appSKey"), NwkSKey: jsii.String("nwkSKey"), }
type CfnWirelessDevice_SessionKeysAbpV11Property ¶
type CfnWirelessDevice_SessionKeysAbpV11Property struct { // The AppSKey is a secret key, which you should handle in a similar way as you would an application password. // // You can protect the AppSKey value by storing it in the AWS Secrets Manager and use the [secretsmanager](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html#dynamic-references-secretsmanager) to reference this value. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-wirelessdevice-sessionkeysabpv11.html#cfn-iotwireless-wirelessdevice-sessionkeysabpv11-appskey // AppSKey *string `field:"required" json:"appSKey" yaml:"appSKey"` // The FNwkSIntKey is a secret key, which you should handle in a similar way as you would an application password. // // You can protect the FNwkSIntKey value by storing it in the AWS Secrets Manager and use the [secretsmanager](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html#dynamic-references-secretsmanager) to reference this value. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-wirelessdevice-sessionkeysabpv11.html#cfn-iotwireless-wirelessdevice-sessionkeysabpv11-fnwksintkey // FNwkSIntKey *string `field:"required" json:"fNwkSIntKey" yaml:"fNwkSIntKey"` // The NwkSEncKey is a secret key, which you should handle in a similar way as you would an application password. // // You can protect the NwkSEncKey value by storing it in the AWS Secrets Manager and use the [secretsmanager](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html#dynamic-references-secretsmanager) to reference this value. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-wirelessdevice-sessionkeysabpv11.html#cfn-iotwireless-wirelessdevice-sessionkeysabpv11-nwksenckey // NwkSEncKey *string `field:"required" json:"nwkSEncKey" yaml:"nwkSEncKey"` // The SNwkSIntKey is a secret key, which you should handle in a similar way as you would an application password. // // You can protect the SNwkSIntKey value by storing it in the AWS Secrets Manager and use the [secretsmanager](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html#dynamic-references-secretsmanager) to reference this value. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-wirelessdevice-sessionkeysabpv11.html#cfn-iotwireless-wirelessdevice-sessionkeysabpv11-snwksintkey // SNwkSIntKey *string `field:"required" json:"sNwkSIntKey" yaml:"sNwkSIntKey"` }
Session keys for ABP v1.1.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" sessionKeysAbpV11Property := &SessionKeysAbpV11Property{ AppSKey: jsii.String("appSKey"), FNwkSIntKey: jsii.String("fNwkSIntKey"), NwkSEncKey: jsii.String("nwkSEncKey"), SNwkSIntKey: jsii.String("sNwkSIntKey"), }
type CfnWirelessGateway ¶
type CfnWirelessGateway interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // The ARN of the wireless gateway created. AttrArn() *string // The ID of the wireless gateway created. AttrId() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The description of the new resource. Description() *string SetDescription(val *string) // The date and time when the most recent uplink was received. LastUplinkReceivedAt() *string SetLastUplinkReceivedAt(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The gateway configuration information to use to create the wireless gateway. LoRaWan() interface{} SetLoRaWan(val interface{}) // The name of the new resource. Name() *string SetName(val *string) // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // The tags are an array of key-value pairs to attach to the specified resource. TagsRaw() *[]*awscdk.CfnTag SetTagsRaw(val *[]*awscdk.CfnTag) // The ARN of the thing to associate with the wireless gateway. ThingArn() *string SetThingArn(val *string) // The name of the thing associated with the wireless gateway. ThingName() *string SetThingName(val *string) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
Provisions a wireless gateway.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnWirelessGateway := awscdk.Aws_iotwireless.NewCfnWirelessGateway(this, jsii.String("MyCfnWirelessGateway"), &CfnWirelessGatewayProps{ LoRaWan: &LoRaWANGatewayProperty{ GatewayEui: jsii.String("gatewayEui"), RfRegion: jsii.String("rfRegion"), }, // the properties below are optional Description: jsii.String("description"), LastUplinkReceivedAt: jsii.String("lastUplinkReceivedAt"), Name: jsii.String("name"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, ThingArn: jsii.String("thingArn"), ThingName: jsii.String("thingName"), })
func NewCfnWirelessGateway ¶
func NewCfnWirelessGateway(scope constructs.Construct, id *string, props *CfnWirelessGatewayProps) CfnWirelessGateway
type CfnWirelessGatewayProps ¶
type CfnWirelessGatewayProps struct { // The gateway configuration information to use to create the wireless gateway. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-wirelessgateway.html#cfn-iotwireless-wirelessgateway-lorawan // LoRaWan interface{} `field:"required" json:"loRaWan" yaml:"loRaWan"` // The description of the new resource. // // The maximum length is 2048 characters. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-wirelessgateway.html#cfn-iotwireless-wirelessgateway-description // Description *string `field:"optional" json:"description" yaml:"description"` // The date and time when the most recent uplink was received. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-wirelessgateway.html#cfn-iotwireless-wirelessgateway-lastuplinkreceivedat // LastUplinkReceivedAt *string `field:"optional" json:"lastUplinkReceivedAt" yaml:"lastUplinkReceivedAt"` // The name of the new resource. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-wirelessgateway.html#cfn-iotwireless-wirelessgateway-name // Name *string `field:"optional" json:"name" yaml:"name"` // The tags are an array of key-value pairs to attach to the specified resource. // // Tags can have a minimum of 0 and a maximum of 50 items. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-wirelessgateway.html#cfn-iotwireless-wirelessgateway-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` // The ARN of the thing to associate with the wireless gateway. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-wirelessgateway.html#cfn-iotwireless-wirelessgateway-thingarn // ThingArn *string `field:"optional" json:"thingArn" yaml:"thingArn"` // The name of the thing associated with the wireless gateway. // // The value is empty if a thing isn't associated with the gateway. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-wirelessgateway.html#cfn-iotwireless-wirelessgateway-thingname // ThingName *string `field:"optional" json:"thingName" yaml:"thingName"` }
Properties for defining a `CfnWirelessGateway`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnWirelessGatewayProps := &CfnWirelessGatewayProps{ LoRaWan: &LoRaWANGatewayProperty{ GatewayEui: jsii.String("gatewayEui"), RfRegion: jsii.String("rfRegion"), }, // the properties below are optional Description: jsii.String("description"), LastUplinkReceivedAt: jsii.String("lastUplinkReceivedAt"), Name: jsii.String("name"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, ThingArn: jsii.String("thingArn"), ThingName: jsii.String("thingName"), }
type CfnWirelessGateway_LoRaWANGatewayProperty ¶
type CfnWirelessGateway_LoRaWANGatewayProperty struct { // The gateway's EUI value. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-wirelessgateway-lorawangateway.html#cfn-iotwireless-wirelessgateway-lorawangateway-gatewayeui // GatewayEui *string `field:"required" json:"gatewayEui" yaml:"gatewayEui"` // The frequency band (RFRegion) value. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-wirelessgateway-lorawangateway.html#cfn-iotwireless-wirelessgateway-lorawangateway-rfregion // RfRegion *string `field:"required" json:"rfRegion" yaml:"rfRegion"` }
LoRaWAN wireless gateway object.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" loRaWANGatewayProperty := &LoRaWANGatewayProperty{ GatewayEui: jsii.String("gatewayEui"), RfRegion: jsii.String("rfRegion"), }
Source Files ¶
- CfnDestination.go
- CfnDestinationProps.go
- CfnDestination__checks.go
- CfnDeviceProfile.go
- CfnDeviceProfileProps.go
- CfnDeviceProfile_LoRaWANDeviceProfileProperty.go
- CfnDeviceProfile__checks.go
- CfnFuotaTask.go
- CfnFuotaTaskProps.go
- CfnFuotaTask_LoRaWANProperty.go
- CfnFuotaTask__checks.go
- CfnMulticastGroup.go
- CfnMulticastGroupProps.go
- CfnMulticastGroup_LoRaWANProperty.go
- CfnMulticastGroup__checks.go
- CfnNetworkAnalyzerConfiguration.go
- CfnNetworkAnalyzerConfigurationProps.go
- CfnNetworkAnalyzerConfiguration_TraceContentProperty.go
- CfnNetworkAnalyzerConfiguration__checks.go
- CfnPartnerAccount.go
- CfnPartnerAccountProps.go
- CfnPartnerAccount_SidewalkAccountInfoProperty.go
- CfnPartnerAccount_SidewalkAccountInfoWithFingerprintProperty.go
- CfnPartnerAccount_SidewalkUpdateAccountProperty.go
- CfnPartnerAccount__checks.go
- CfnServiceProfile.go
- CfnServiceProfileProps.go
- CfnServiceProfile_LoRaWANServiceProfileProperty.go
- CfnServiceProfile__checks.go
- CfnTaskDefinition.go
- CfnTaskDefinitionProps.go
- CfnTaskDefinition_LoRaWANGatewayVersionProperty.go
- CfnTaskDefinition_LoRaWANUpdateGatewayTaskCreateProperty.go
- CfnTaskDefinition_LoRaWANUpdateGatewayTaskEntryProperty.go
- CfnTaskDefinition_UpdateWirelessGatewayTaskCreateProperty.go
- CfnTaskDefinition__checks.go
- CfnWirelessDevice.go
- CfnWirelessDeviceImportTask.go
- CfnWirelessDeviceImportTaskProps.go
- CfnWirelessDeviceImportTask_SidewalkProperty.go
- CfnWirelessDeviceImportTask__checks.go
- CfnWirelessDeviceProps.go
- CfnWirelessDevice_AbpV10xProperty.go
- CfnWirelessDevice_AbpV11Property.go
- CfnWirelessDevice_ApplicationProperty.go
- CfnWirelessDevice_FPortsProperty.go
- CfnWirelessDevice_LoRaWANDeviceProperty.go
- CfnWirelessDevice_OtaaV10xProperty.go
- CfnWirelessDevice_OtaaV11Property.go
- CfnWirelessDevice_SessionKeysAbpV10xProperty.go
- CfnWirelessDevice_SessionKeysAbpV11Property.go
- CfnWirelessDevice__checks.go
- CfnWirelessGateway.go
- CfnWirelessGatewayProps.go
- CfnWirelessGateway_LoRaWANGatewayProperty.go
- CfnWirelessGateway__checks.go
- main.go