Creates an AWS IoT thing, certificate, policy, and associates the three together
Project description
AWS IoT Thing, Certificate, and Policy Construct Library
An L3 CDK construct to create and associate a singular AWS IoT Thing, Certificate, and IoT Policy. The construct also retrieves and returns AWS IoT account specific details such as the AWS IoT data endpoint and the AWS IoT Credential provider endpoint.
The certificate and its private key are stored as AWS Systems Manager Parameter Store parameters that can be retrieved via the AWS Console or programmatically via construct members.
Installation and use
TypeScript
Installation:
npm install cdk-aws-iot-thing-certificate-policy
Example:
import aws_cdk as cdk
from cdklabs.cdk_aws_iot_thing_certificate_policy import IotThingCertificatePolicy
#
# A minimum IoT Policy template using substitution variables for actual
# policy to be deployed for "region", "account", and "thingname". Allows
# the thing to publish and subscribe on any topics under "thing/*" topic
# namespace. Normal IoT Policy conventions such as "*", apply.
#
minimal_iot_policy = """{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": ["iot:Connect"],
"Resource": "arn:aws:iot:{{region}}:{{account}}:client/{{thingname}}"
},
{
"Effect": "Allow",
"Action": ["iot:Publish"],
"Resource": [
"arn:aws:iot:{{region}}:{{account}}:topic/{{thingname}}/*"
]
},
{
"Effect": "Allow",
"Action": ["iot:Subscribe"],
"Resource": [
"arn:aws:iot:{{region}}:{{account}}:topicfilter/{{thingname}}/*"
]
},
{
"Effect": "Allow",
"Action": ["iot:Receive"],
"Resource": [
"arn:aws:iot:{{region}}:{{account}}:topic/{{thingname}}/*"
]
}
]
}"""
app = cdk.App()
#
# Create the thing, certificate, and policy, then associate the
# certificate to both the thing and the policy and fully activate.
#
foo_thing = IotThingCertificatePolicy(app, "MyFooThing",
thing_name="foo-thing", # Name to assign to AWS IoT thing, and value for {{thingname}} in policy template
iot_policy_name="foo-iot-policy", # Name to assign to AWS IoT policy
iot_policy=minimal_iot_policy, # Policy with or without substitution parameters from above
encryption_algorithm="ECC", # Algorithm to use to private key (RSA or ECC)
policy_parameter_mapping=[PolicyMapping(
name="region",
value=cdk.Fn.ref("AWS::Region")
), PolicyMapping(
name="account",
value=cdk.Fn.ref("AWS::AccountId")
)
]
)
# The AWS IoT Thing Arn as a stack output
cdk.CfnOutput(app, "ThingArn",
value=foo_thing.thing_arn
)
# The AWS account unique endpoint for the MQTT data connection
# See API for other available public values that can be referenced
cdk.CfnOutput(app, "IotEndpoint",
value=foo_thing.data_ats_endpoint_address
)
Python
Installation:
pip install cdklabs.cdk-aws-iot-thing-certificate-policy
Example:
import aws_cdk as cdk
from cdklabs.cdk_aws_iot_thing_certificate_policy import (
IotThingCertificatePolicy,
)
minimal_iot_policy = """{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": ["iot:Connect"],
"Resource": "arn:aws:iot:{{region}}:{{account}}:client/{{thingname}}"
},
{
"Effect": "Allow",
"Action": ["iot:Publish"],
"Resource": [
"arn:aws:iot:{{region}}:{{account}}:topic/{{thingname}}/*"
]
},
{
"Effect": "Allow",
"Action": ["iot:Subscribe"],
"Resource": [
"arn:aws:iot:{{region}}:{{account}}:topicfilter/{{thingname}}/*"
]
},
{
"Effect": "Allow",
"Action": ["iot:Receive"],
"Resource": [
"arn:aws:iot:{{region}}:{{account}}:topic/{{thingname}}/*"
]
}
]
}"""
app = cdk.App()
foo_thing = IotThingCertificatePolicy(
app,
"MyFooThing",
thing_name="foo-thing",
iot_policy_name="foo-iot-policy",
iot_policy=minimal_iot_policy,
encryption_algorithm="ECC",
policy_parameter_mapping=[
{
"name": "region",
"value": cdk.Fn.ref("AWS::Region")
},
{
"name": "account",
"value": cdk.Fn.ref("AWS::AccountId")
}
],
)
cdk.CfnOutput(app, "ThingArn", value=foo_thing.thing_arn)
cdk.CfnOutput(app, "IotEndpoint", value=foo_thing.data_ats_endpoint_address)
C#
Installation:
dotnet add package Cdklabs.CdkAwsIotThingCertificatePolicy
Example: coming soon
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for cdklabs.cdk-aws-iot-thing-certificate-policy-0.0.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9a4dbabf313453e661b6f6786b891d1d1598053c6a5d4dd07729270506d6983d |
|
MD5 | 5fa729c86e38709c5b71be8acec56416 |
|
BLAKE2b-256 | 7de81ca3fa60d6f484f7d74e9777416434bf7b84663ad5a2fd7ed001788d0d38 |
Close
Hashes for cdklabs.cdk_aws_iot_thing_certificate_policy-0.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a10b55d40d0981c09cd458a87fc995d5003a4ececcb6c24670ca5774d7a7f5e4 |
|
MD5 | 9dbf27d3d833c2e224064eb4e97d216b |
|
BLAKE2b-256 | ebf7c4f94419d111c4f02d683a2b1e6d61ca88940f13f051f20628a359335f59 |