Documentation ¶
Index ¶
- func CfnDestination_CFN_RESOURCE_TYPE_NAME() *string
- func CfnDestination_IsCfnElement(x interface{}) *bool
- func CfnDestination_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnDestination_IsConstruct(x interface{}) *bool
- func CfnDeviceProfile_CFN_RESOURCE_TYPE_NAME() *string
- func CfnDeviceProfile_IsCfnElement(x interface{}) *bool
- func CfnDeviceProfile_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnDeviceProfile_IsConstruct(x interface{}) *bool
- func CfnFuotaTask_CFN_RESOURCE_TYPE_NAME() *string
- func CfnFuotaTask_IsCfnElement(x interface{}) *bool
- func CfnFuotaTask_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnFuotaTask_IsConstruct(x interface{}) *bool
- func CfnMulticastGroup_CFN_RESOURCE_TYPE_NAME() *string
- func CfnMulticastGroup_IsCfnElement(x interface{}) *bool
- func CfnMulticastGroup_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnMulticastGroup_IsConstruct(x interface{}) *bool
- func CfnPartnerAccount_CFN_RESOURCE_TYPE_NAME() *string
- func CfnPartnerAccount_IsCfnElement(x interface{}) *bool
- func CfnPartnerAccount_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnPartnerAccount_IsConstruct(x interface{}) *bool
- func CfnServiceProfile_CFN_RESOURCE_TYPE_NAME() *string
- func CfnServiceProfile_IsCfnElement(x interface{}) *bool
- func CfnServiceProfile_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnServiceProfile_IsConstruct(x interface{}) *bool
- func CfnTaskDefinition_CFN_RESOURCE_TYPE_NAME() *string
- func CfnTaskDefinition_IsCfnElement(x interface{}) *bool
- func CfnTaskDefinition_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnTaskDefinition_IsConstruct(x interface{}) *bool
- func CfnWirelessDevice_CFN_RESOURCE_TYPE_NAME() *string
- func CfnWirelessDevice_IsCfnElement(x interface{}) *bool
- func CfnWirelessDevice_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnWirelessDevice_IsConstruct(x interface{}) *bool
- func CfnWirelessGateway_CFN_RESOURCE_TYPE_NAME() *string
- func CfnWirelessGateway_IsCfnElement(x interface{}) *bool
- func CfnWirelessGateway_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnWirelessGateway_IsConstruct(x interface{}) *bool
- func NewCfnDestination_Override(c CfnDestination, scope awscdk.Construct, id *string, ...)
- func NewCfnDeviceProfile_Override(c CfnDeviceProfile, scope awscdk.Construct, id *string, ...)
- func NewCfnFuotaTask_Override(c CfnFuotaTask, scope awscdk.Construct, id *string, props *CfnFuotaTaskProps)
- func NewCfnMulticastGroup_Override(c CfnMulticastGroup, scope awscdk.Construct, id *string, ...)
- func NewCfnPartnerAccount_Override(c CfnPartnerAccount, scope awscdk.Construct, id *string, ...)
- func NewCfnServiceProfile_Override(c CfnServiceProfile, scope awscdk.Construct, id *string, ...)
- func NewCfnTaskDefinition_Override(c CfnTaskDefinition, scope awscdk.Construct, id *string, ...)
- func NewCfnWirelessDevice_Override(c CfnWirelessDevice, scope awscdk.Construct, id *string, ...)
- func NewCfnWirelessGateway_Override(c CfnWirelessGateway, scope awscdk.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 CfnPartnerAccount
- type CfnPartnerAccountProps
- type CfnPartnerAccount_SidewalkAccountInfoProperty
- 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 CfnWirelessDeviceProps
- type CfnWirelessDevice_AbpV10xProperty
- type CfnWirelessDevice_AbpV11Property
- 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. Experimental.
func CfnDestination_IsCfnResource ¶
func CfnDestination_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnDestination_IsConstruct ¶
func CfnDestination_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
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. Experimental.
func CfnDeviceProfile_IsCfnResource ¶
func CfnDeviceProfile_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnDeviceProfile_IsConstruct ¶
func CfnDeviceProfile_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
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. Experimental.
func CfnFuotaTask_IsCfnResource ¶
func CfnFuotaTask_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnFuotaTask_IsConstruct ¶
func CfnFuotaTask_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
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. Experimental.
func CfnMulticastGroup_IsCfnResource ¶
func CfnMulticastGroup_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnMulticastGroup_IsConstruct ¶
func CfnMulticastGroup_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
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. Experimental.
func CfnPartnerAccount_IsCfnResource ¶
func CfnPartnerAccount_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnPartnerAccount_IsConstruct ¶
func CfnPartnerAccount_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
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. Experimental.
func CfnServiceProfile_IsCfnResource ¶
func CfnServiceProfile_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnServiceProfile_IsConstruct ¶
func CfnServiceProfile_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
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. Experimental.
func CfnTaskDefinition_IsCfnResource ¶
func CfnTaskDefinition_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnTaskDefinition_IsConstruct ¶
func CfnTaskDefinition_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
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. Experimental.
func CfnWirelessDevice_IsCfnResource ¶
func CfnWirelessDevice_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnWirelessDevice_IsConstruct ¶
func CfnWirelessDevice_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
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. Experimental.
func CfnWirelessGateway_IsCfnResource ¶
func CfnWirelessGateway_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnWirelessGateway_IsConstruct ¶
func CfnWirelessGateway_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func NewCfnDestination_Override ¶
func NewCfnDestination_Override(c CfnDestination, scope awscdk.Construct, id *string, props *CfnDestinationProps)
Create a new `AWS::IoTWireless::Destination`.
func NewCfnDeviceProfile_Override ¶
func NewCfnDeviceProfile_Override(c CfnDeviceProfile, scope awscdk.Construct, id *string, props *CfnDeviceProfileProps)
Create a new `AWS::IoTWireless::DeviceProfile`.
func NewCfnFuotaTask_Override ¶
func NewCfnFuotaTask_Override(c CfnFuotaTask, scope awscdk.Construct, id *string, props *CfnFuotaTaskProps)
Create a new `AWS::IoTWireless::FuotaTask`.
func NewCfnMulticastGroup_Override ¶
func NewCfnMulticastGroup_Override(c CfnMulticastGroup, scope awscdk.Construct, id *string, props *CfnMulticastGroupProps)
Create a new `AWS::IoTWireless::MulticastGroup`.
func NewCfnPartnerAccount_Override ¶
func NewCfnPartnerAccount_Override(c CfnPartnerAccount, scope awscdk.Construct, id *string, props *CfnPartnerAccountProps)
Create a new `AWS::IoTWireless::PartnerAccount`.
func NewCfnServiceProfile_Override ¶
func NewCfnServiceProfile_Override(c CfnServiceProfile, scope awscdk.Construct, id *string, props *CfnServiceProfileProps)
Create a new `AWS::IoTWireless::ServiceProfile`.
func NewCfnTaskDefinition_Override ¶
func NewCfnTaskDefinition_Override(c CfnTaskDefinition, scope awscdk.Construct, id *string, props *CfnTaskDefinitionProps)
Create a new `AWS::IoTWireless::TaskDefinition`.
func NewCfnWirelessDevice_Override ¶
func NewCfnWirelessDevice_Override(c CfnWirelessDevice, scope awscdk.Construct, id *string, props *CfnWirelessDeviceProps)
Create a new `AWS::IoTWireless::WirelessDevice`.
func NewCfnWirelessGateway_Override ¶
func NewCfnWirelessGateway_Override(c CfnWirelessGateway, scope awscdk.Construct, id *string, props *CfnWirelessGatewayProps)
Create a new `AWS::IoTWireless::WirelessGateway`.
Types ¶
type CfnDestination ¶
type CfnDestination interface { awscdk.CfnResource awscdk.IInspectable // The ARN of the destination created. AttrArn() *string // Options for this resource, such as condition, update policy etc. // Experimental. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. // Experimental. 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. // Experimental. CreationStack() *[]*string // The description of the new resource. // // Maximum length is 2048 characters. 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. // Experimental. LogicalId() *string // The name of the new resource. Name() *string SetName(val *string) // The construct tree node associated with this construct. // Experimental. Node() awscdk.ConstructNode // 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 })`. // Experimental. 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). // Experimental. Stack() awscdk.Stack // 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. Tags() awscdk.TagManager // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. // Experimental. UpdatedProperites() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. // Experimental. 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. // Experimental. 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. // // Experimental. 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. // Experimental. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. // Experimental. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. // Experimental. 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`). // Experimental. 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. // Experimental. GetAtt(attributeName *string) 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. // // Experimental. GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. // Experimental. OnPrepare() // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. // Experimental. OnSynthesize(session constructs.ISynthesisSession) // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. // Experimental. OnValidate() *[]*string // Overrides the auto-generated logical ID with a specific ID. // Experimental. OverrideLogicalId(newLogicalId *string) // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. // Experimental. Prepare() RenderProperties(props *map[string]interface{}) *map[string]interface{} // 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. // Experimental. ShouldSynthesize() *bool // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. // Experimental. Synthesize(session awscdk.ISynthesisSession) // Returns a string representation of this construct. // // Returns: a string representation of this resource. // Experimental. ToString() *string // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. // Experimental. Validate() *[]*string // Experimental. ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::IoTWireless::Destination`.
Creates a new destination that maps a device message to an AWS IoT rule.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import iotwireless "github.com/aws/aws-cdk-go/awscdk/aws_iotwireless" cfnDestination := iotwireless.NewCfnDestination(this, jsii.String("MyCfnDestination"), &cfnDestinationProps{ expression: jsii.String("expression"), expressionType: jsii.String("expressionType"), name: jsii.String("name"), roleArn: jsii.String("roleArn"), // the properties below are optional description: jsii.String("description"), tags: []cfnTag{ &cfnTag{ key: jsii.String("key"), value: jsii.String("value"), }, }, })
func NewCfnDestination ¶
func NewCfnDestination(scope awscdk.Construct, id *string, props *CfnDestinationProps) CfnDestination
Create a new `AWS::IoTWireless::Destination`.
type CfnDestinationProps ¶
type CfnDestinationProps struct { // The rule name to send messages to. Expression *string `json:"expression" yaml:"expression"` // The type of value in `Expression` . ExpressionType *string `json:"expressionType" yaml:"expressionType"` // The name of the new resource. Name *string `json:"name" yaml:"name"` // The ARN of the IAM Role that authorizes the destination. RoleArn *string `json:"roleArn" yaml:"roleArn"` // The description of the new resource. // // Maximum length is 2048 characters. Description *string `json:"description" yaml:"description"` // 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. Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"` }
Properties for defining a `CfnDestination`.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import iotwireless "github.com/aws/aws-cdk-go/awscdk/aws_iotwireless" cfnDestinationProps := &cfnDestinationProps{ expression: jsii.String("expression"), expressionType: jsii.String("expressionType"), name: jsii.String("name"), roleArn: jsii.String("roleArn"), // the properties below are optional description: jsii.String("description"), tags: []cfnTag{ &cfnTag{ key: jsii.String("key"), value: jsii.String("value"), }, }, }
type CfnDeviceProfile ¶
type CfnDeviceProfile interface { awscdk.CfnResource awscdk.IInspectable // 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. // Experimental. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. // Experimental. 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. // Experimental. 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. // Experimental. LogicalId() *string // LoRaWAN device profile object. LoRaWan() interface{} SetLoRaWan(val interface{}) // The name of the new resource. Name() *string SetName(val *string) // The construct tree node associated with this construct. // Experimental. Node() awscdk.ConstructNode // 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 })`. // Experimental. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). // Experimental. Stack() awscdk.Stack // 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. Tags() awscdk.TagManager // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. // Experimental. UpdatedProperites() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. // Experimental. 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. // Experimental. 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. // // Experimental. 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. // Experimental. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. // Experimental. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. // Experimental. 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`). // Experimental. 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. // Experimental. GetAtt(attributeName *string) 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. // // Experimental. GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. // Experimental. OnPrepare() // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. // Experimental. OnSynthesize(session constructs.ISynthesisSession) // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. // Experimental. OnValidate() *[]*string // Overrides the auto-generated logical ID with a specific ID. // Experimental. OverrideLogicalId(newLogicalId *string) // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. // Experimental. Prepare() RenderProperties(props *map[string]interface{}) *map[string]interface{} // 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. // Experimental. ShouldSynthesize() *bool // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. // Experimental. Synthesize(session awscdk.ISynthesisSession) // Returns a string representation of this construct. // // Returns: a string representation of this resource. // Experimental. ToString() *string // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. // Experimental. Validate() *[]*string // Experimental. ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::IoTWireless::DeviceProfile`.
Creates a new device profile.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import iotwireless "github.com/aws/aws-cdk-go/awscdk/aws_iotwireless" cfnDeviceProfile := iotwireless.NewCfnDeviceProfile(this, jsii.String("MyCfnDeviceProfile"), &cfnDeviceProfileProps{ loRaWan: &loRaWANDeviceProfileProperty{ classBTimeout: jsii.Number(123), classCTimeout: 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"), 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 awscdk.Construct, id *string, props *CfnDeviceProfileProps) CfnDeviceProfile
Create a new `AWS::IoTWireless::DeviceProfile`.
type CfnDeviceProfileProps ¶
type CfnDeviceProfileProps struct { // LoRaWAN device profile object. LoRaWan interface{} `json:"loRaWan" yaml:"loRaWan"` // The name of the new resource. Name *string `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. Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"` }
Properties for defining a `CfnDeviceProfile`.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import iotwireless "github.com/aws/aws-cdk-go/awscdk/aws_iotwireless" cfnDeviceProfileProps := &cfnDeviceProfileProps{ loRaWan: &loRaWANDeviceProfileProperty{ classBTimeout: jsii.Number(123), classCTimeout: 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"), 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. ClassBTimeout *float64 `json:"classBTimeout" yaml:"classBTimeout"` // The ClassCTimeout value. ClassCTimeout *float64 `json:"classCTimeout" yaml:"classCTimeout"` // The MAC version (such as OTAA 1.1 or OTAA 1.0.3) to use with this device profile. MacVersion *string `json:"macVersion" yaml:"macVersion"` // The MaxDutyCycle value. MaxDutyCycle *float64 `json:"maxDutyCycle" yaml:"maxDutyCycle"` // The MaxEIRP value. MaxEirp *float64 `json:"maxEirp" yaml:"maxEirp"` // The PingSlotDR value. PingSlotDr *float64 `json:"pingSlotDr" yaml:"pingSlotDr"` // The PingSlotFreq value. PingSlotFreq *float64 `json:"pingSlotFreq" yaml:"pingSlotFreq"` // The PingSlotPeriod value. PingSlotPeriod *float64 `json:"pingSlotPeriod" yaml:"pingSlotPeriod"` // The version of regional parameters. RegParamsRevision *string `json:"regParamsRevision" yaml:"regParamsRevision"` // The frequency band (RFRegion) value. RfRegion *string `json:"rfRegion" yaml:"rfRegion"` // The Supports32BitFCnt value. Supports32BitFCnt interface{} `json:"supports32BitFCnt" yaml:"supports32BitFCnt"` // The SupportsClassB value. SupportsClassB interface{} `json:"supportsClassB" yaml:"supportsClassB"` // The SupportsClassC value. SupportsClassC interface{} `json:"supportsClassC" yaml:"supportsClassC"` // The SupportsJoin value. SupportsJoin interface{} `json:"supportsJoin" yaml:"supportsJoin"` }
LoRaWAN device profile object.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import iotwireless "github.com/aws/aws-cdk-go/awscdk/aws_iotwireless" loRaWANDeviceProfileProperty := &loRaWANDeviceProfileProperty{ classBTimeout: jsii.Number(123), classCTimeout: 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"), 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 // 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. // Experimental. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. // Experimental. 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. // Experimental. 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. // Experimental. 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 construct tree node associated with this construct. // Experimental. Node() awscdk.ConstructNode // 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 })`. // Experimental. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). // Experimental. Stack() awscdk.Stack // 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. Tags() awscdk.TagManager // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. // Experimental. UpdatedProperites() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. // Experimental. 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. // Experimental. 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. // // Experimental. 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. // Experimental. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. // Experimental. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. // Experimental. 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`). // Experimental. 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. // Experimental. GetAtt(attributeName *string) 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. // // Experimental. GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. // Experimental. OnPrepare() // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. // Experimental. OnSynthesize(session constructs.ISynthesisSession) // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. // Experimental. OnValidate() *[]*string // Overrides the auto-generated logical ID with a specific ID. // Experimental. OverrideLogicalId(newLogicalId *string) // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. // Experimental. Prepare() RenderProperties(props *map[string]interface{}) *map[string]interface{} // 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. // Experimental. ShouldSynthesize() *bool // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. // Experimental. Synthesize(session awscdk.ISynthesisSession) // Returns a string representation of this construct. // // Returns: a string representation of this resource. // Experimental. ToString() *string // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. // Experimental. Validate() *[]*string // Experimental. ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::IoTWireless::FuotaTask`.
A FUOTA task.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import iotwireless "github.com/aws/aws-cdk-go/awscdk/aws_iotwireless" cfnFuotaTask := 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 awscdk.Construct, id *string, props *CfnFuotaTaskProps) CfnFuotaTask
Create a new `AWS::IoTWireless::FuotaTask`.
type CfnFuotaTaskProps ¶
type CfnFuotaTaskProps struct { // The S3 URI points to a firmware update image that is to be used with a FUOTA task. FirmwareUpdateImage *string `json:"firmwareUpdateImage" yaml:"firmwareUpdateImage"` // The firmware update role that is to be used with a FUOTA task. FirmwareUpdateRole *string `json:"firmwareUpdateRole" yaml:"firmwareUpdateRole"` // The LoRaWAN information used with a FUOTA task. LoRaWan interface{} `json:"loRaWan" yaml:"loRaWan"` // The ID of the multicast group to associate with a FUOTA task. AssociateMulticastGroup *string `json:"associateMulticastGroup" yaml:"associateMulticastGroup"` // The ID of the wireless device to associate with a multicast group. AssociateWirelessDevice *string `json:"associateWirelessDevice" yaml:"associateWirelessDevice"` // The description of the new resource. Description *string `json:"description" yaml:"description"` // The ID of the multicast group to disassociate from a FUOTA task. DisassociateMulticastGroup *string `json:"disassociateMulticastGroup" yaml:"disassociateMulticastGroup"` // The ID of the wireless device to disassociate from a FUOTA task. DisassociateWirelessDevice *string `json:"disassociateWirelessDevice" yaml:"disassociateWirelessDevice"` // The name of a FUOTA task. Name *string `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. Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"` }
Properties for defining a `CfnFuotaTask`.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import iotwireless "github.com/aws/aws-cdk-go/awscdk/aws_iotwireless" 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. RfRegion *string `json:"rfRegion" yaml:"rfRegion"` // Start time of a FUOTA task. StartTime *string `json:"startTime" yaml:"startTime"` }
The LoRaWAN information used with a FUOTA task.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import iotwireless "github.com/aws/aws-cdk-go/awscdk/aws_iotwireless" loRaWANProperty := &loRaWANProperty{ rfRegion: jsii.String("rfRegion"), // the properties below are optional startTime: jsii.String("startTime"), }
type CfnMulticastGroup ¶
type CfnMulticastGroup interface { awscdk.CfnResource awscdk.IInspectable // 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. // Experimental. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. // Experimental. 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. // Experimental. 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. // Experimental. 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 construct tree node associated with this construct. // Experimental. Node() awscdk.ConstructNode // 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 })`. // Experimental. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). // Experimental. Stack() awscdk.Stack // 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. Tags() awscdk.TagManager // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. // Experimental. UpdatedProperites() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. // Experimental. 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. // Experimental. 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. // // Experimental. 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. // Experimental. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. // Experimental. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. // Experimental. 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`). // Experimental. 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. // Experimental. GetAtt(attributeName *string) 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. // // Experimental. GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. // Experimental. OnPrepare() // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. // Experimental. OnSynthesize(session constructs.ISynthesisSession) // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. // Experimental. OnValidate() *[]*string // Overrides the auto-generated logical ID with a specific ID. // Experimental. OverrideLogicalId(newLogicalId *string) // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. // Experimental. Prepare() RenderProperties(props *map[string]interface{}) *map[string]interface{} // 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. // Experimental. ShouldSynthesize() *bool // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. // Experimental. Synthesize(session awscdk.ISynthesisSession) // Returns a string representation of this construct. // // Returns: a string representation of this resource. // Experimental. ToString() *string // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. // Experimental. Validate() *[]*string // Experimental. ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::IoTWireless::MulticastGroup`.
A multicast group.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import iotwireless "github.com/aws/aws-cdk-go/awscdk/aws_iotwireless" cfnMulticastGroup := 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 awscdk.Construct, id *string, props *CfnMulticastGroupProps) CfnMulticastGroup
Create a new `AWS::IoTWireless::MulticastGroup`.
type CfnMulticastGroupProps ¶
type CfnMulticastGroupProps struct { // The LoRaWAN information that is to be used with the multicast group. LoRaWan interface{} `json:"loRaWan" yaml:"loRaWan"` // The ID of the wireless device to associate with a multicast group. AssociateWirelessDevice *string `json:"associateWirelessDevice" yaml:"associateWirelessDevice"` // The description of the multicast group. Description *string `json:"description" yaml:"description"` // The ID of the wireless device to disassociate from a multicast group. DisassociateWirelessDevice *string `json:"disassociateWirelessDevice" yaml:"disassociateWirelessDevice"` // The name of the multicast group. Name *string `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. Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"` }
Properties for defining a `CfnMulticastGroup`.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import iotwireless "github.com/aws/aws-cdk-go/awscdk/aws_iotwireless" 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. DlClass *string `json:"dlClass" yaml:"dlClass"` // The frequency band (RFRegion) value. RfRegion *string `json:"rfRegion" yaml:"rfRegion"` // Number of devices that are associated to the multicast group. NumberOfDevicesInGroup *float64 `json:"numberOfDevicesInGroup" yaml:"numberOfDevicesInGroup"` // Number of devices that are requested to be associated with the multicast group. NumberOfDevicesRequested *float64 `json:"numberOfDevicesRequested" yaml:"numberOfDevicesRequested"` }
The LoRaWAN information that is to be used with the multicast group.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import iotwireless "github.com/aws/aws-cdk-go/awscdk/aws_iotwireless" loRaWANProperty := &loRaWANProperty{ dlClass: jsii.String("dlClass"), rfRegion: jsii.String("rfRegion"), // the properties below are optional numberOfDevicesInGroup: jsii.Number(123), numberOfDevicesRequested: jsii.Number(123), }
type CfnPartnerAccount ¶
type CfnPartnerAccount interface { awscdk.CfnResource awscdk.IInspectable // `AWS::IoTWireless::PartnerAccount.AccountLinked`. AccountLinked() interface{} SetAccountLinked(val interface{}) // The Amazon Resource Name (ARN) of the resource. AttrArn() *string // Options for this resource, such as condition, update policy etc. // Experimental. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. // Experimental. 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. // Experimental. CreationStack() *[]*string // `AWS::IoTWireless::PartnerAccount.Fingerprint`. Fingerprint() *string SetFingerprint(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. // Experimental. LogicalId() *string // The construct tree node associated with this construct. // Experimental. Node() awscdk.ConstructNode // The ID of the partner account to update. PartnerAccountId() *string SetPartnerAccountId(val *string) // `AWS::IoTWireless::PartnerAccount.PartnerType`. 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 })`. // Experimental. Ref() *string // The Sidewalk account credentials. Sidewalk() interface{} SetSidewalk(val interface{}) // `AWS::IoTWireless::PartnerAccount.SidewalkUpdate`. SidewalkUpdate() interface{} SetSidewalkUpdate(val interface{}) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). // Experimental. Stack() awscdk.Stack // 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. Tags() awscdk.TagManager // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. // Experimental. UpdatedProperites() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. // Experimental. 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. // Experimental. 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. // // Experimental. 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. // Experimental. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. // Experimental. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. // Experimental. 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`). // Experimental. 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. // Experimental. GetAtt(attributeName *string) 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. // // Experimental. GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. // Experimental. OnPrepare() // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. // Experimental. OnSynthesize(session constructs.ISynthesisSession) // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. // Experimental. OnValidate() *[]*string // Overrides the auto-generated logical ID with a specific ID. // Experimental. OverrideLogicalId(newLogicalId *string) // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. // Experimental. Prepare() RenderProperties(props *map[string]interface{}) *map[string]interface{} // 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. // Experimental. ShouldSynthesize() *bool // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. // Experimental. Synthesize(session awscdk.ISynthesisSession) // Returns a string representation of this construct. // // Returns: a string representation of this resource. // Experimental. ToString() *string // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. // Experimental. Validate() *[]*string // Experimental. ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::IoTWireless::PartnerAccount`.
A partner account. If `PartnerAccountId` and `PartnerType` are `null` , returns all partner accounts.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import iotwireless "github.com/aws/aws-cdk-go/awscdk/aws_iotwireless" cfnPartnerAccount := iotwireless.NewCfnPartnerAccount(this, jsii.String("MyCfnPartnerAccount"), &cfnPartnerAccountProps{ accountLinked: jsii.Boolean(false), fingerprint: jsii.String("fingerprint"), partnerAccountId: jsii.String("partnerAccountId"), partnerType: jsii.String("partnerType"), sidewalk: &sidewalkAccountInfoProperty{ appServerPrivateKey: jsii.String("appServerPrivateKey"), }, sidewalkUpdate: &sidewalkUpdateAccountProperty{ appServerPrivateKey: jsii.String("appServerPrivateKey"), }, tags: []cfnTag{ &cfnTag{ key: jsii.String("key"), value: jsii.String("value"), }, }, })
func NewCfnPartnerAccount ¶
func NewCfnPartnerAccount(scope awscdk.Construct, id *string, props *CfnPartnerAccountProps) CfnPartnerAccount
Create a new `AWS::IoTWireless::PartnerAccount`.
type CfnPartnerAccountProps ¶
type CfnPartnerAccountProps struct { // `AWS::IoTWireless::PartnerAccount.AccountLinked`. AccountLinked interface{} `json:"accountLinked" yaml:"accountLinked"` // `AWS::IoTWireless::PartnerAccount.Fingerprint`. Fingerprint *string `json:"fingerprint" yaml:"fingerprint"` // The ID of the partner account to update. PartnerAccountId *string `json:"partnerAccountId" yaml:"partnerAccountId"` // `AWS::IoTWireless::PartnerAccount.PartnerType`. PartnerType *string `json:"partnerType" yaml:"partnerType"` // The Sidewalk account credentials. Sidewalk interface{} `json:"sidewalk" yaml:"sidewalk"` // `AWS::IoTWireless::PartnerAccount.SidewalkUpdate`. SidewalkUpdate interface{} `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. Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"` }
Properties for defining a `CfnPartnerAccount`.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import iotwireless "github.com/aws/aws-cdk-go/awscdk/aws_iotwireless" cfnPartnerAccountProps := &cfnPartnerAccountProps{ accountLinked: jsii.Boolean(false), fingerprint: jsii.String("fingerprint"), partnerAccountId: jsii.String("partnerAccountId"), partnerType: jsii.String("partnerType"), sidewalk: &sidewalkAccountInfoProperty{ appServerPrivateKey: jsii.String("appServerPrivateKey"), }, 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. AppServerPrivateKey *string `json:"appServerPrivateKey" yaml:"appServerPrivateKey"` }
Information about a Sidewalk account.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import iotwireless "github.com/aws/aws-cdk-go/awscdk/aws_iotwireless" sidewalkAccountInfoProperty := &sidewalkAccountInfoProperty{ appServerPrivateKey: jsii.String("appServerPrivateKey"), }
type CfnPartnerAccount_SidewalkUpdateAccountProperty ¶
type CfnPartnerAccount_SidewalkUpdateAccountProperty struct { // The new Sidewalk application server private key. AppServerPrivateKey *string `json:"appServerPrivateKey" yaml:"appServerPrivateKey"` }
Sidewalk update.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import iotwireless "github.com/aws/aws-cdk-go/awscdk/aws_iotwireless" sidewalkUpdateAccountProperty := &sidewalkUpdateAccountProperty{ appServerPrivateKey: jsii.String("appServerPrivateKey"), }
type CfnServiceProfile ¶
type CfnServiceProfile interface { awscdk.CfnResource awscdk.IInspectable // 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 PRAllowed value that describes whether passive roaming is allowed. AttrLoRaWanPrAllowed() awscdk.IResolvable // The RAAllowed value that describes whether roaming activation is allowed. AttrLoRaWanRaAllowed() 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. // Experimental. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. // Experimental. 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. // Experimental. 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. // Experimental. LogicalId() *string // LoRaWAN service profile object. LoRaWan() interface{} SetLoRaWan(val interface{}) // The name of the new resource. Name() *string SetName(val *string) // The construct tree node associated with this construct. // Experimental. Node() awscdk.ConstructNode // 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 })`. // Experimental. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). // Experimental. Stack() awscdk.Stack // 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. Tags() awscdk.TagManager // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. // Experimental. UpdatedProperites() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. // Experimental. 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. // Experimental. 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. // // Experimental. 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. // Experimental. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. // Experimental. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. // Experimental. 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`). // Experimental. 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. // Experimental. GetAtt(attributeName *string) 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. // // Experimental. GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. // Experimental. OnPrepare() // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. // Experimental. OnSynthesize(session constructs.ISynthesisSession) // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. // Experimental. OnValidate() *[]*string // Overrides the auto-generated logical ID with a specific ID. // Experimental. OverrideLogicalId(newLogicalId *string) // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. // Experimental. Prepare() RenderProperties(props *map[string]interface{}) *map[string]interface{} // 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. // Experimental. ShouldSynthesize() *bool // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. // Experimental. Synthesize(session awscdk.ISynthesisSession) // Returns a string representation of this construct. // // Returns: a string representation of this resource. // Experimental. ToString() *string // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. // Experimental. Validate() *[]*string // Experimental. ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::IoTWireless::ServiceProfile`.
Creates a new service profile.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import iotwireless "github.com/aws/aws-cdk-go/awscdk/aws_iotwireless" cfnServiceProfile := 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 awscdk.Construct, id *string, props *CfnServiceProfileProps) CfnServiceProfile
Create a new `AWS::IoTWireless::ServiceProfile`.
type CfnServiceProfileProps ¶
type CfnServiceProfileProps struct { // LoRaWAN service profile object. LoRaWan interface{} `json:"loRaWan" yaml:"loRaWan"` // The name of the new resource. Name *string `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. Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"` }
Properties for defining a `CfnServiceProfile`.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import iotwireless "github.com/aws/aws-cdk-go/awscdk/aws_iotwireless" 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. AddGwMetadata interface{} `json:"addGwMetadata" yaml:"addGwMetadata"` // The ChannelMask value. // // This property is `ReadOnly` and can't be inputted for create. It's returned with `Fn::GetAtt` ChannelMask *string `json:"channelMask" yaml:"channelMask"` // The DevStatusReqFreq value. // // This property is `ReadOnly` and can't be inputted for create. It's returned with `Fn::GetAtt` DevStatusReqFreq *float64 `json:"devStatusReqFreq" yaml:"devStatusReqFreq"` // The DLBucketSize value. // // This property is `ReadOnly` and can't be inputted for create. It's returned with `Fn::GetAtt` DlBucketSize *float64 `json:"dlBucketSize" yaml:"dlBucketSize"` // The DLRate value. // // This property is `ReadOnly` and can't be inputted for create. It's returned with `Fn::GetAtt` DlRate *float64 `json:"dlRate" yaml:"dlRate"` // The DLRatePolicy value. // // This property is `ReadOnly` and can't be inputted for create. It's returned with `Fn::GetAtt` DlRatePolicy *string `json:"dlRatePolicy" yaml:"dlRatePolicy"` // The DRMax value. // // This property is `ReadOnly` and can't be inputted for create. It's returned with `Fn::GetAtt` DrMax *float64 `json:"drMax" yaml:"drMax"` // The DRMin value. // // This property is `ReadOnly` and can't be inputted for create. It's returned with `Fn::GetAtt` DrMin *float64 `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` HrAllowed interface{} `json:"hrAllowed" yaml:"hrAllowed"` // The MinGwDiversity value. // // This property is `ReadOnly` and can't be inputted for create. It's returned with `Fn::GetAtt` MinGwDiversity *float64 `json:"minGwDiversity" yaml:"minGwDiversity"` // The NwkGeoLoc value. // // This property is `ReadOnly` and can't be inputted for create. It's returned with `Fn::GetAtt` NwkGeoLoc interface{} `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` PrAllowed interface{} `json:"prAllowed" yaml:"prAllowed"` // The RAAllowed value that describes whether roaming activation is allowed. RaAllowed interface{} `json:"raAllowed" yaml:"raAllowed"` // The ReportDevStatusBattery value. // // This property is `ReadOnly` and can't be inputted for create. It's returned with `Fn::GetAtt` ReportDevStatusBattery interface{} `json:"reportDevStatusBattery" yaml:"reportDevStatusBattery"` // The ReportDevStatusMargin value. // // This property is `ReadOnly` and can't be inputted for create. It's returned with `Fn::GetAtt` ReportDevStatusMargin interface{} `json:"reportDevStatusMargin" yaml:"reportDevStatusMargin"` // The TargetPer value. // // This property is `ReadOnly` and can't be inputted for create. It's returned with `Fn::GetAtt` TargetPer *float64 `json:"targetPer" yaml:"targetPer"` // The UlBucketSize value. // // This property is `ReadOnly` and can't be inputted for create. It's returned with `Fn::GetAtt` UlBucketSize *float64 `json:"ulBucketSize" yaml:"ulBucketSize"` // The ULRate value. // // This property is `ReadOnly` and can't be inputted for create. It's returned with `Fn::GetAtt` UlRate *float64 `json:"ulRate" yaml:"ulRate"` // The ULRatePolicy value. // // This property is `ReadOnly` and can't be inputted for create. It's returned with `Fn::GetAtt` UlRatePolicy *string `json:"ulRatePolicy" yaml:"ulRatePolicy"` }
LoRaWANServiceProfile object.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import iotwireless "github.com/aws/aws-cdk-go/awscdk/aws_iotwireless" 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 // 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. // // If `false` , the task must me created by calling `CreateWirelessGatewayTask` . AutoCreateTasks() interface{} SetAutoCreateTasks(val interface{}) // Options for this resource, such as condition, update policy etc. // Experimental. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. // Experimental. 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. // Experimental. 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. // Experimental. LogicalId() *string // `AWS::IoTWireless::TaskDefinition.LoRaWANUpdateGatewayTaskEntry`. LoRaWanUpdateGatewayTaskEntry() interface{} SetLoRaWanUpdateGatewayTaskEntry(val interface{}) // The name of the new resource. Name() *string SetName(val *string) // The construct tree node associated with this construct. // Experimental. Node() awscdk.ConstructNode // 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 })`. // Experimental. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). // Experimental. Stack() awscdk.Stack // 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. Tags() awscdk.TagManager // `AWS::IoTWireless::TaskDefinition.TaskDefinitionType`. TaskDefinitionType() *string SetTaskDefinitionType(val *string) // Information about the gateways to update. Update() interface{} SetUpdate(val 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. // Experimental. UpdatedProperites() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. // Experimental. 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. // Experimental. 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. // // Experimental. 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. // Experimental. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. // Experimental. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. // Experimental. 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`). // Experimental. 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. // Experimental. GetAtt(attributeName *string) 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. // // Experimental. GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. // Experimental. OnPrepare() // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. // Experimental. OnSynthesize(session constructs.ISynthesisSession) // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. // Experimental. OnValidate() *[]*string // Overrides the auto-generated logical ID with a specific ID. // Experimental. OverrideLogicalId(newLogicalId *string) // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. // Experimental. Prepare() RenderProperties(props *map[string]interface{}) *map[string]interface{} // 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. // Experimental. ShouldSynthesize() *bool // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. // Experimental. Synthesize(session awscdk.ISynthesisSession) // Returns a string representation of this construct. // // Returns: a string representation of this resource. // Experimental. ToString() *string // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. // Experimental. Validate() *[]*string // Experimental. ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::IoTWireless::TaskDefinition`.
Creates a gateway task definition.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import iotwireless "github.com/aws/aws-cdk-go/awscdk/aws_iotwireless" cfnTaskDefinition := 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 awscdk.Construct, id *string, props *CfnTaskDefinitionProps) CfnTaskDefinition
Create a new `AWS::IoTWireless::TaskDefinition`.
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 me created by calling `CreateWirelessGatewayTask` . AutoCreateTasks interface{} `json:"autoCreateTasks" yaml:"autoCreateTasks"` // `AWS::IoTWireless::TaskDefinition.LoRaWANUpdateGatewayTaskEntry`. LoRaWanUpdateGatewayTaskEntry interface{} `json:"loRaWanUpdateGatewayTaskEntry" yaml:"loRaWanUpdateGatewayTaskEntry"` // The name of the new resource. Name *string `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. Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"` // `AWS::IoTWireless::TaskDefinition.TaskDefinitionType`. TaskDefinitionType *string `json:"taskDefinitionType" yaml:"taskDefinitionType"` // Information about the gateways to update. Update interface{} `json:"update" yaml:"update"` }
Properties for defining a `CfnTaskDefinition`.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import iotwireless "github.com/aws/aws-cdk-go/awscdk/aws_iotwireless" 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. Model *string `json:"model" yaml:"model"` // The version of the wireless gateway firmware. PackageVersion *string `json:"packageVersion" yaml:"packageVersion"` // The basic station version of the wireless gateway. Station *string `json:"station" yaml:"station"` }
LoRaWANGatewayVersion object.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import iotwireless "github.com/aws/aws-cdk-go/awscdk/aws_iotwireless" 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. CurrentVersion interface{} `json:"currentVersion" yaml:"currentVersion"` // The CRC of the signature private key to check. SigKeyCrc *float64 `json:"sigKeyCrc" yaml:"sigKeyCrc"` // The signature used to verify the update firmware. UpdateSignature *string `json:"updateSignature" yaml:"updateSignature"` // The firmware version to update the gateway to. UpdateVersion interface{} `json:"updateVersion" yaml:"updateVersion"` }
The signature used to verify the update firmware.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import iotwireless "github.com/aws/aws-cdk-go/awscdk/aws_iotwireless" 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. CurrentVersion interface{} `json:"currentVersion" yaml:"currentVersion"` // The firmware version to update the gateway to. UpdateVersion interface{} `json:"updateVersion" yaml:"updateVersion"` }
LoRaWANUpdateGatewayTaskEntry object.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import iotwireless "github.com/aws/aws-cdk-go/awscdk/aws_iotwireless" 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. LoRaWan interface{} `json:"loRaWan" yaml:"loRaWan"` // The IAM role used to read data from the S3 bucket. UpdateDataRole *string `json:"updateDataRole" yaml:"updateDataRole"` // The link to the S3 bucket. UpdateDataSource *string `json:"updateDataSource" yaml:"updateDataSource"` }
UpdateWirelessGatewayTaskCreate object.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import iotwireless "github.com/aws/aws-cdk-go/awscdk/aws_iotwireless" 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 // 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. // Experimental. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. // Experimental. 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. // Experimental. CreationStack() *[]*string // The description of the new resource. // // Maximum length is 2048. Description() *string SetDescription(val *string) // 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. 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. // Experimental. LogicalId() *string // The device configuration information to use to create the wireless device. // // Must be at least one of OtaaV10x, OtaaV11, AbpV11, or AbpV10x. LoRaWan() interface{} SetLoRaWan(val interface{}) // The name of the new resource. Name() *string SetName(val *string) // The construct tree node associated with this construct. // Experimental. Node() awscdk.ConstructNode // 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 })`. // Experimental. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). // Experimental. Stack() awscdk.Stack // 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. Tags() awscdk.TagManager // 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) // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. // Experimental. UpdatedProperites() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. // Experimental. 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. // Experimental. 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. // // Experimental. 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. // Experimental. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. // Experimental. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. // Experimental. 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`). // Experimental. 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. // Experimental. GetAtt(attributeName *string) 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. // // Experimental. GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. // Experimental. OnPrepare() // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. // Experimental. OnSynthesize(session constructs.ISynthesisSession) // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. // Experimental. OnValidate() *[]*string // Overrides the auto-generated logical ID with a specific ID. // Experimental. OverrideLogicalId(newLogicalId *string) // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. // Experimental. Prepare() RenderProperties(props *map[string]interface{}) *map[string]interface{} // 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. // Experimental. ShouldSynthesize() *bool // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. // Experimental. Synthesize(session awscdk.ISynthesisSession) // Returns a string representation of this construct. // // Returns: a string representation of this resource. // Experimental. ToString() *string // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. // Experimental. Validate() *[]*string // Experimental. ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::IoTWireless::WirelessDevice`.
Provisions a wireless device.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import iotwireless "github.com/aws/aws-cdk-go/awscdk/aws_iotwireless" cfnWirelessDevice := 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"), 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"), tags: []cfnTag{ &cfnTag{ key: jsii.String("key"), value: jsii.String("value"), }, }, thingArn: jsii.String("thingArn"), })
func NewCfnWirelessDevice ¶
func NewCfnWirelessDevice(scope awscdk.Construct, id *string, props *CfnWirelessDeviceProps) CfnWirelessDevice
Create a new `AWS::IoTWireless::WirelessDevice`.
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. DestinationName *string `json:"destinationName" yaml:"destinationName"` // The wireless device type. Type *string `json:"type" yaml:"type"` // The description of the new resource. // // Maximum length is 2048. Description *string `json:"description" yaml:"description"` // The date and time when the most recent uplink was received. LastUplinkReceivedAt *string `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. LoRaWan interface{} `json:"loRaWan" yaml:"loRaWan"` // The name of the new resource. Name *string `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. Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"` // The ARN of the thing to associate with the wireless device. ThingArn *string `json:"thingArn" yaml:"thingArn"` }
Properties for defining a `CfnWirelessDevice`.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import iotwireless "github.com/aws/aws-cdk-go/awscdk/aws_iotwireless" 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"), 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"), 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. DevAddr *string `json:"devAddr" yaml:"devAddr"` // Session keys for ABP v1.0.x. SessionKeys interface{} `json:"sessionKeys" yaml:"sessionKeys"` }
ABP device object for LoRaWAN specification v1.0.x.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import iotwireless "github.com/aws/aws-cdk-go/awscdk/aws_iotwireless" 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. DevAddr *string `json:"devAddr" yaml:"devAddr"` // Session keys for ABP v1.1. SessionKeys interface{} `json:"sessionKeys" yaml:"sessionKeys"` }
ABP device object for create APIs for v1.1.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import iotwireless "github.com/aws/aws-cdk-go/awscdk/aws_iotwireless" 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_LoRaWANDeviceProperty ¶
type CfnWirelessDevice_LoRaWANDeviceProperty struct { // LoRaWAN object for create APIs. AbpV10X interface{} `json:"abpV10X" yaml:"abpV10X"` // ABP device object for create APIs for v1.1. AbpV11 interface{} `json:"abpV11" yaml:"abpV11"` // The DevEUI value. DevEui *string `json:"devEui" yaml:"devEui"` // The ID of the device profile for the new wireless device. DeviceProfileId *string `json:"deviceProfileId" yaml:"deviceProfileId"` // OTAA device object for create APIs for v1.0.x. OtaaV10X interface{} `json:"otaaV10X" yaml:"otaaV10X"` // OTAA device object for v1.1 for create APIs. OtaaV11 interface{} `json:"otaaV11" yaml:"otaaV11"` // The ID of the service profile. ServiceProfileId *string `json:"serviceProfileId" yaml:"serviceProfileId"` }
LoRaWAN object for create functions.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import iotwireless "github.com/aws/aws-cdk-go/awscdk/aws_iotwireless" 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"), 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, with pattern of `[a-fA-F0-9]{16}` . AppEui *string `json:"appEui" yaml:"appEui"` // 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. AppKey *string `json:"appKey" yaml:"appKey"` }
OTAA device object for create APIs for v1.0.x.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import iotwireless "github.com/aws/aws-cdk-go/awscdk/aws_iotwireless" 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. AppKey *string `json:"appKey" yaml:"appKey"` // The JoinEUI value. JoinEui *string `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. NwkKey *string `json:"nwkKey" yaml:"nwkKey"` }
OTAA device object for v1.1 for create APIs.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import iotwireless "github.com/aws/aws-cdk-go/awscdk/aws_iotwireless" otaaV11Property := &otaaV11Property{ appKey: jsii.String("appKey"), joinEui: jsii.String("joinEui"), nwkKey: jsii.String("nwkKey"), }
type CfnWirelessDevice_SessionKeysAbpV10xProperty ¶
type CfnWirelessDevice_SessionKeysAbpV10xProperty 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. AppSKey *string `json:"appSKey" yaml:"appSKey"` // The NwkSKey is a secret key, which you should handle in a similar way as you would an application password. // // You can protect the NwkSKey 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. NwkSKey *string `json:"nwkSKey" yaml:"nwkSKey"` }
LoRaWAN object for create APIs.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import iotwireless "github.com/aws/aws-cdk-go/awscdk/aws_iotwireless" 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. AppSKey *string `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. FNwkSIntKey *string `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. NwkSEncKey *string `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. SNwkSIntKey *string `json:"sNwkSIntKey" yaml:"sNwkSIntKey"` }
Session keys for ABP v1.1.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import iotwireless "github.com/aws/aws-cdk-go/awscdk/aws_iotwireless" 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 // The ARN of the wireless gateway created. AttrArn() *string // The ID of the wireless gateway created. AttrId() *string // The name of the thing associated with the wireless gateway. // // The value is empty if a thing isn't associated with the gateway. AttrThingName() *string // Options for this resource, such as condition, update policy etc. // Experimental. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. // Experimental. 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. // Experimental. CreationStack() *[]*string // The description of the new resource. // // The maximum length is 2048 characters. 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. // Experimental. 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 construct tree node associated with this construct. // Experimental. Node() awscdk.ConstructNode // 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 })`. // Experimental. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). // Experimental. Stack() awscdk.Stack // 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. Tags() awscdk.TagManager // The ARN of the thing to associate with the wireless gateway. ThingArn() *string SetThingArn(val *string) // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. // Experimental. UpdatedProperites() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. // Experimental. 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. // Experimental. 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. // // Experimental. 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. // Experimental. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. // Experimental. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. // Experimental. 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`). // Experimental. 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. // Experimental. GetAtt(attributeName *string) 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. // // Experimental. GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. // Experimental. OnPrepare() // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. // Experimental. OnSynthesize(session constructs.ISynthesisSession) // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. // Experimental. OnValidate() *[]*string // Overrides the auto-generated logical ID with a specific ID. // Experimental. OverrideLogicalId(newLogicalId *string) // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. // Experimental. Prepare() RenderProperties(props *map[string]interface{}) *map[string]interface{} // 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. // Experimental. ShouldSynthesize() *bool // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. // Experimental. Synthesize(session awscdk.ISynthesisSession) // Returns a string representation of this construct. // // Returns: a string representation of this resource. // Experimental. ToString() *string // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. // Experimental. Validate() *[]*string // Experimental. ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::IoTWireless::WirelessGateway`.
Provisions a wireless gateway.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import iotwireless "github.com/aws/aws-cdk-go/awscdk/aws_iotwireless" cfnWirelessGateway := 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"), })
func NewCfnWirelessGateway ¶
func NewCfnWirelessGateway(scope awscdk.Construct, id *string, props *CfnWirelessGatewayProps) CfnWirelessGateway
Create a new `AWS::IoTWireless::WirelessGateway`.
type CfnWirelessGatewayProps ¶
type CfnWirelessGatewayProps struct { // The gateway configuration information to use to create the wireless gateway. LoRaWan interface{} `json:"loRaWan" yaml:"loRaWan"` // The description of the new resource. // // The maximum length is 2048 characters. Description *string `json:"description" yaml:"description"` // The date and time when the most recent uplink was received. LastUplinkReceivedAt *string `json:"lastUplinkReceivedAt" yaml:"lastUplinkReceivedAt"` // The name of the new resource. Name *string `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. Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"` // The ARN of the thing to associate with the wireless gateway. ThingArn *string `json:"thingArn" yaml:"thingArn"` }
Properties for defining a `CfnWirelessGateway`.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import iotwireless "github.com/aws/aws-cdk-go/awscdk/aws_iotwireless" 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"), }
type CfnWirelessGateway_LoRaWANGatewayProperty ¶
type CfnWirelessGateway_LoRaWANGatewayProperty struct { // The gateway's EUI value. GatewayEui *string `json:"gatewayEui" yaml:"gatewayEui"` // The frequency band (RFRegion) value. RfRegion *string `json:"rfRegion" yaml:"rfRegion"` }
LoRaWAN wireless gateway object.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import iotwireless "github.com/aws/aws-cdk-go/awscdk/aws_iotwireless" loRaWANGatewayProperty := &loRaWANGatewayProperty{ gatewayEui: jsii.String("gatewayEui"), rfRegion: jsii.String("rfRegion"), }