Skip to content

Latest commit

 

History

History
300 lines (182 loc) · 9.77 KB

API.md

File metadata and controls

300 lines (182 loc) · 9.77 KB
Raw

API Reference

Constructs

ThingWithCert

A CDK Construct for creating an AWS IoT Core thing with a certificate.

Initializers 

import { ThingWithCert } from 'cdk-iot-core-certificates-v3'

new ThingWithCert(scope: Construct, id: string, props: ThingWithCertProps)
Name Type Description
scope constructs.Construct No description.
id string No description.
props ThingWithCertProps No description.
scopeRequired
  • Type: constructs.Construct
idRequired
  • Type: string
propsRequired

Methods

Name Description
toString Returns a string representation of this construct.
toString 
public toString(): string

Returns a string representation of this construct.

Static Functions

Name Description
isConstruct Checks if x is a construct.
isConstruct 
import { ThingWithCert } from 'cdk-iot-core-certificates-v3'

ThingWithCert.isConstruct(x: any)

Checks if x is a construct.

xRequired
  • Type: any

Any object.

Properties

Name Type Description
node constructs.Node The tree node.
certId string The ID of the certificate.
certPem string The certificate PEM.
privKey string The private key.
thingArn string The ARN of the thing.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

certIdRequired 
public readonly certId: string;
  • Type: string

The ID of the certificate.

certPemRequired 
public readonly certPem: string;
  • Type: string

The certificate PEM.

privKeyRequired 
public readonly privKey: string;
  • Type: string

The private key.

thingArnRequired 
public readonly thingArn: string;
  • Type: string

The ARN of the thing.

Structs

ThingWithCertProps

Properties of ThingWithCert construct.

Initializer 

import { ThingWithCertProps } from 'cdk-iot-core-certificates-v3'

const thingWithCertProps: ThingWithCertProps = { ... }

Properties

Name Type Description
account string The AWS account ID this resource belongs to.
environmentFromArn string ARN to deduce region and account from.
physicalName string The value passed in by users to the physical name prop of the resource.
region string The AWS region this resource belongs to.
thingName string The name of the thing.
paramPrefix string The prefix for the parameter store path.
saveFileBucket aws-cdk-lib.aws_s3.IBucket The bucket to save the certificate and private key files.
saveToParamStore boolean Whether to save the certificate and private key to AWS Systems Manager Parameter Store.
accountOptional 
public readonly account: string;
  • Type: string
  • Default: the resource is in the same account as the stack it belongs to

The AWS account ID this resource belongs to.

environmentFromArnOptional 
public readonly environmentFromArn: string;
  • Type: string
  • Default: take environment from account, region parameters, or use Stack environment.

ARN to deduce region and account from.

The ARN is parsed and the account and region are taken from the ARN. This should be used for imported resources.

Cannot be supplied together with either account or region.

physicalNameOptional 
public readonly physicalName: string;
  • Type: string
  • Default: The physical name will be allocated by CloudFormation at deployment time

The value passed in by users to the physical name prop of the resource.

undefined implies that a physical name will be allocated by CloudFormation during deployment.

  • a concrete value implies a specific physical name
  • PhysicalName.GENERATE_IF_NEEDED is a marker that indicates that a physical will only be generated by the CDK if it is needed for cross-environment references. Otherwise, it will be allocated by CloudFormation.
regionOptional 
public readonly region: string;
  • Type: string
  • Default: the resource is in the same region as the stack it belongs to

The AWS region this resource belongs to.

thingNameRequired 
public readonly thingName: string;
  • Type: string

The name of the thing.

paramPrefixOptional 
public readonly paramPrefix: string;
  • Type: string

The prefix for the parameter store path.

saveFileBucketOptional 
public readonly saveFileBucket: IBucket;
  • Type: aws-cdk-lib.aws_s3.IBucket
  • Default: do not save the files

The bucket to save the certificate and private key files.

saveToParamStoreOptional 
public readonly saveToParamStore: boolean;
  • Type: boolean

Whether to save the certificate and private key to AWS Systems Manager Parameter Store.