-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
6 changed files
with
130 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,10 +1,11 @@ | ||
const { awscdk } = require('projen'); | ||
const project = new awscdk.AwsCdkConstructLibrary({ | ||
author: 'Andy Brunner', | ||
authorAddress: '[email protected]', | ||
author: 'cloudxs GmbH', | ||
authorAddress: 'https://www.cloudxs.ch', | ||
authorOrganization: true, | ||
cdkVersion: '2.1.0', | ||
defaultReleaseBranch: 'main', | ||
name: 'cdk-iot-lorawan', | ||
name: '@cloudxs/cdk-iot-lorawan', | ||
repositoryUrl: 'https://github.com/cloudxsgmbh/cdk-iot-lorawan.git', | ||
|
||
// deps: [], /* Runtime dependencies of this module. */ | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,101 @@ | ||
# API Reference <a name="API Reference" id="api-reference"></a> | ||
|
||
## Constructs <a name="Constructs" id="Constructs"></a> | ||
|
||
### IotWirelessGatewayRole <a name="IotWirelessGatewayRole" id="@cloudxs/cdk-iot-lorawan.IotWirelessGatewayRole"></a> | ||
|
||
Creates a role called 'IoTWirelessGatewayCertManagerRole' that is needed by the IoT Wireless gateway https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan-rfregion-permissions.html#connect-iot-lorawan-onboard-permissions. | ||
|
||
#### Initializers <a name="Initializers" id="@cloudxs/cdk-iot-lorawan.IotWirelessGatewayRole.Initializer"></a> | ||
|
||
```typescript | ||
import { IotWirelessGatewayRole } from '@cloudxs/cdk-iot-lorawan' | ||
|
||
new IotWirelessGatewayRole(scope: Construct, id: string) | ||
``` | ||
|
||
| **Name** | **Type** | **Description** | | ||
| --- | --- | --- | | ||
| <code><a href="#@cloudxs/cdk-iot-lorawan.IotWirelessGatewayRole.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* | | ||
| <code><a href="#@cloudxs/cdk-iot-lorawan.IotWirelessGatewayRole.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* | | ||
|
||
--- | ||
|
||
##### `scope`<sup>Required</sup> <a name="scope" id="@cloudxs/cdk-iot-lorawan.IotWirelessGatewayRole.Initializer.parameter.scope"></a> | ||
|
||
- *Type:* constructs.Construct | ||
|
||
--- | ||
|
||
##### `id`<sup>Required</sup> <a name="id" id="@cloudxs/cdk-iot-lorawan.IotWirelessGatewayRole.Initializer.parameter.id"></a> | ||
|
||
- *Type:* string | ||
|
||
--- | ||
|
||
#### Methods <a name="Methods" id="Methods"></a> | ||
|
||
| **Name** | **Description** | | ||
| --- | --- | | ||
| <code><a href="#@cloudxs/cdk-iot-lorawan.IotWirelessGatewayRole.toString">toString</a></code> | Returns a string representation of this construct. | | ||
|
||
--- | ||
|
||
##### `toString` <a name="toString" id="@cloudxs/cdk-iot-lorawan.IotWirelessGatewayRole.toString"></a> | ||
|
||
```typescript | ||
public toString(): string | ||
``` | ||
|
||
Returns a string representation of this construct. | ||
|
||
#### Static Functions <a name="Static Functions" id="Static Functions"></a> | ||
|
||
| **Name** | **Description** | | ||
| --- | --- | | ||
| <code><a href="#@cloudxs/cdk-iot-lorawan.IotWirelessGatewayRole.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. | | ||
|
||
--- | ||
|
||
##### ~~`isConstruct`~~ <a name="isConstruct" id="@cloudxs/cdk-iot-lorawan.IotWirelessGatewayRole.isConstruct"></a> | ||
|
||
```typescript | ||
import { IotWirelessGatewayRole } from '@cloudxs/cdk-iot-lorawan' | ||
|
||
IotWirelessGatewayRole.isConstruct(x: any) | ||
``` | ||
|
||
Checks if `x` is a construct. | ||
|
||
###### `x`<sup>Required</sup> <a name="x" id="@cloudxs/cdk-iot-lorawan.IotWirelessGatewayRole.isConstruct.parameter.x"></a> | ||
|
||
- *Type:* any | ||
|
||
Any object. | ||
|
||
--- | ||
|
||
#### Properties <a name="Properties" id="Properties"></a> | ||
|
||
| **Name** | **Type** | **Description** | | ||
| --- | --- | --- | | ||
| <code><a href="#@cloudxs/cdk-iot-lorawan.IotWirelessGatewayRole.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. | | ||
|
||
--- | ||
|
||
##### `node`<sup>Required</sup> <a name="node" id="@cloudxs/cdk-iot-lorawan.IotWirelessGatewayRole.property.node"></a> | ||
|
||
```typescript | ||
public readonly node: Node; | ||
``` | ||
|
||
- *Type:* constructs.Node | ||
|
||
The tree node. | ||
|
||
--- | ||
|
||
|
||
|
||
|
||
|
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
import * as cdk from 'aws-cdk-lib'; | ||
import { IotWirelessGatewayRole } from './index'; | ||
|
||
const app = new cdk.App(); | ||
const stack = new cdk.Stack(app, 'MyStack'); | ||
|
||
new IotWirelessGatewayRole(stack, 'IotWirelessGatewayRole'); |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
import * as cdk from 'aws-cdk-lib'; | ||
import { Template } from 'aws-cdk-lib/assertions'; | ||
import { IotWirelessGatewayRole } from '../src/index'; | ||
|
||
test('create app', () => { | ||
const app = new cdk.App(); | ||
const stack = new cdk.Stack(app); | ||
new IotWirelessGatewayRole(stack, 'TestStack'); | ||
|
||
const template = Template.fromStack( stack ); | ||
template.hasResource('AWS::IAM::Role', { | ||
|
||
}); | ||
}); |