Module iot

@pulumi/aws > iot

Index

iot/certificate.ts iot/getEndpoint.ts iot/policy.ts iot/policyAttachment.ts iot/thing.ts iot/thingPrincipalAttachment.ts iot/thingType.ts iot/topicRule.ts

class Certificate

Creates and manages an AWS IoT certificate.

constructor

new Certificate(name: string, args: CertificateArgs, opts?: pulumi.CustomResourceOptions)

Create a Certificate resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: CertificateState): Certificate

Get an existing Certificate resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property active

public active: pulumi.Output<boolean>;

Boolean flag to indicate if the certificate should be active

property arn

public arn: pulumi.Output<string>;

The ARN of the created AWS IoT certificate

property csr

public csr: pulumi.Output<string>;

The certificate signing request. Review the [IoT API Reference Guide] (http://docs.aws.amazon.com/iot/latest/apireference/API_CreateCertificateFromCsr.html) for more information on creating a certificate from a certificate signing request (CSR).

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class Policy

Provides an IoT policy.

constructor

new Policy(name: string, args: PolicyArgs, opts?: pulumi.CustomResourceOptions)

Create a Policy resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: PolicyState): Policy

Get an existing Policy resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property arn

public arn: pulumi.Output<string>;

The ARN assigned by AWS to this policy.

property defaultVersionId

public defaultVersionId: pulumi.Output<string>;

The default version of this policy.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the policy.

property policy

public policy: pulumi.Output<string>;

The policy document. This is a JSON formatted string. Use the IoT Developer Guide for more information on IoT Policies. For more information about building AWS IAM policy documents with Terraform, see the AWS IAM Policy Document Guide.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class PolicyAttachment

Provides an IoT policy attachment.

constructor

new PolicyAttachment(name: string, args: PolicyAttachmentArgs, opts?: pulumi.CustomResourceOptions)

Create a PolicyAttachment resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: PolicyAttachmentState): PolicyAttachment

Get an existing PolicyAttachment resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property policy

public policy: pulumi.Output<string>;

The name of the policy to attach.

property target

public target: pulumi.Output<ARN>;

The identity to which the policy is attached.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class Thing

Creates and manages an AWS IoT Thing.

constructor

new Thing(name: string, args?: ThingArgs, opts?: pulumi.CustomResourceOptions)

Create a Thing resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ThingState): Thing

Get an existing Thing resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property arn

public arn: pulumi.Output<string>;

The ARN of the thing.

property attributes

public attributes: pulumi.Output<{ ... } | undefined>;

Map of attributes of the thing.

property defaultClientId

public defaultClientId: pulumi.Output<string>;

The default client ID.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the thing.

property thingTypeName

public thingTypeName: pulumi.Output<string | undefined>;

The thing type name.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property version

public version: pulumi.Output<number>;

The current version of the thing record in the registry.

class ThingPrincipalAttachment

Attaches Principal to AWS IoT Thing.

constructor

new ThingPrincipalAttachment(name: string, args: ThingPrincipalAttachmentArgs, opts?: pulumi.CustomResourceOptions)

Create a ThingPrincipalAttachment resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ThingPrincipalAttachmentState): ThingPrincipalAttachment

Get an existing ThingPrincipalAttachment resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property principal

public principal: pulumi.Output<ARN>;

The AWS IoT Certificate ARN or Amazon Cognito Identity ID.

property thing

public thing: pulumi.Output<string>;

The name of the thing.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class ThingType

Creates and manages an AWS IoT Thing Type.

constructor

new ThingType(name: string, args?: ThingTypeArgs, opts?: pulumi.CustomResourceOptions)

Create a ThingType resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ThingTypeState): ThingType

Get an existing ThingType resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property arn

public arn: pulumi.Output<string>;

The ARN of the created AWS IoT Thing Type.

property deprecated

public deprecated: pulumi.Output<boolean | undefined>;

Whether the thing type is deprecated. If true, no new things could be associated with this type.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the thing type.

property properties

public properties: pulumi.Output<{ ... } | undefined>;

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class TopicRule

constructor

new TopicRule(name: string, args: TopicRuleArgs, opts?: pulumi.CustomResourceOptions)

Create a TopicRule resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: TopicRuleState): TopicRule

Get an existing TopicRule resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property arn

public arn: pulumi.Output<string>;

The ARN of the topic rule

property cloudwatchAlarm

public cloudwatchAlarm: pulumi.Output<{ ... } | undefined>;

property cloudwatchMetric

public cloudwatchMetric: pulumi.Output<{ ... } | undefined>;

property description

public description: pulumi.Output<string | undefined>;

The description of the rule.

property dynamodb

public dynamodb: pulumi.Output<{ ... } | undefined>;

property elasticsearch

public elasticsearch: pulumi.Output<{ ... } | undefined>;

property enabled

public enabled: pulumi.Output<boolean>;

Specifies whether the rule is enabled.

property firehose

public firehose: pulumi.Output<{ ... } | undefined>;

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property kinesis

public kinesis: pulumi.Output<{ ... } | undefined>;

property lambda

public lambda: pulumi.Output<{ ... } | undefined>;

property name

public name: pulumi.Output<string>;

The name of the rule.

property republish

public republish: pulumi.Output<{ ... } | undefined>;

property s3

public s3: pulumi.Output<{ ... } | undefined>;

property sns

public sns: pulumi.Output<{ ... } | undefined>;

property sql

public sql: pulumi.Output<string>;

The SQL statement used to query the topic. For more information, see AWS IoT SQL Reference (http://docs.aws.amazon.com/iot/latest/developerguide/iot-rules.html#aws-iot-sql-reference) in the AWS IoT Developer Guide.

property sqlVersion

public sqlVersion: pulumi.Output<string>;

The version of the SQL rules engine to use when evaluating the rule.

property sqs

public sqs: pulumi.Output<{ ... } | undefined>;

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

function getEndpoint

getEndpoint(args?: GetEndpointArgs, opts?: pulumi.InvokeOptions): Promise<GetEndpointResult>

Returns a unique endpoint specific to the AWS account making the call.

interface CertificateArgs

The set of arguments for constructing a Certificate resource.

property active

active: pulumi.Input<boolean>;

Boolean flag to indicate if the certificate should be active

property csr

csr: pulumi.Input<string>;

The certificate signing request. Review the [IoT API Reference Guide] (http://docs.aws.amazon.com/iot/latest/apireference/API_CreateCertificateFromCsr.html) for more information on creating a certificate from a certificate signing request (CSR).

interface CertificateState

Input properties used for looking up and filtering Certificate resources.

property active

active?: pulumi.Input<boolean>;

Boolean flag to indicate if the certificate should be active

property arn

arn?: pulumi.Input<string>;

The ARN of the created AWS IoT certificate

property csr

csr?: pulumi.Input<string>;

The certificate signing request. Review the [IoT API Reference Guide] (http://docs.aws.amazon.com/iot/latest/apireference/API_CreateCertificateFromCsr.html) for more information on creating a certificate from a certificate signing request (CSR).

interface GetEndpointArgs

A collection of arguments for invoking getEndpoint.

property endpointType

endpointType?: string;

Endpoint type. Valid values: iot:CredentialProvider, iot:Data, iot:Data-ATS, iot:Job.

interface GetEndpointResult

A collection of values returned by getEndpoint.

property endpointAddress

endpointAddress: string;

The endpoint based on endpoint_type:

  • No endpoint_type: Either iot:Data or iot:Data-ATS depending on region
  • iot:CredentialsProvider: IDENTIFIER.credentials.iot.REGION.amazonaws.com
  • iot:Data: IDENTIFIER.iot.REGION.amazonaws.com
  • iot:Data-ATS: IDENTIFIER-ats.iot.REGION.amazonaws.com
  • iot:Job: IDENTIFIER.jobs.iot.REGION.amazonaws.com

property id

id: string;

id is the provider-assigned unique ID for this managed resource.

interface PolicyArgs

The set of arguments for constructing a Policy resource.

property name

name?: pulumi.Input<string>;

The name of the policy.

property policy

policy: pulumi.Input<string>;

The policy document. This is a JSON formatted string. Use the IoT Developer Guide for more information on IoT Policies. For more information about building AWS IAM policy documents with Terraform, see the AWS IAM Policy Document Guide.

interface PolicyAttachmentArgs

The set of arguments for constructing a PolicyAttachment resource.

property policy

policy: pulumi.Input<string | Policy>;

The name of the policy to attach.

property target

target: pulumi.Input<ARN>;

The identity to which the policy is attached.

interface PolicyAttachmentState

Input properties used for looking up and filtering PolicyAttachment resources.

property policy

policy?: pulumi.Input<string | Policy>;

The name of the policy to attach.

property target

target?: pulumi.Input<ARN>;

The identity to which the policy is attached.

interface PolicyState

Input properties used for looking up and filtering Policy resources.

property arn

arn?: pulumi.Input<string>;

The ARN assigned by AWS to this policy.

property defaultVersionId

defaultVersionId?: pulumi.Input<string>;

The default version of this policy.

property name

name?: pulumi.Input<string>;

The name of the policy.

property policy

policy?: pulumi.Input<string>;

The policy document. This is a JSON formatted string. Use the IoT Developer Guide for more information on IoT Policies. For more information about building AWS IAM policy documents with Terraform, see the AWS IAM Policy Document Guide.

interface ThingArgs

The set of arguments for constructing a Thing resource.

property attributes

attributes?: pulumi.Input<{ ... }>;

Map of attributes of the thing.

property name

name?: pulumi.Input<string>;

The name of the thing.

property thingTypeName

thingTypeName?: pulumi.Input<string>;

The thing type name.

interface ThingPrincipalAttachmentArgs

The set of arguments for constructing a ThingPrincipalAttachment resource.

property principal

principal: pulumi.Input<ARN>;

The AWS IoT Certificate ARN or Amazon Cognito Identity ID.

property thing

thing: pulumi.Input<string>;

The name of the thing.

interface ThingPrincipalAttachmentState

Input properties used for looking up and filtering ThingPrincipalAttachment resources.

property principal

principal?: pulumi.Input<ARN>;

The AWS IoT Certificate ARN or Amazon Cognito Identity ID.

property thing

thing?: pulumi.Input<string>;

The name of the thing.

interface ThingState

Input properties used for looking up and filtering Thing resources.

property arn

arn?: pulumi.Input<string>;

The ARN of the thing.

property attributes

attributes?: pulumi.Input<{ ... }>;

Map of attributes of the thing.

property defaultClientId

defaultClientId?: pulumi.Input<string>;

The default client ID.

property name

name?: pulumi.Input<string>;

The name of the thing.

property thingTypeName

thingTypeName?: pulumi.Input<string>;

The thing type name.

property version

version?: pulumi.Input<number>;

The current version of the thing record in the registry.

interface ThingTypeArgs

The set of arguments for constructing a ThingType resource.

property deprecated

deprecated?: pulumi.Input<boolean>;

Whether the thing type is deprecated. If true, no new things could be associated with this type.

property name

name?: pulumi.Input<string>;

The name of the thing type.

property properties

properties?: pulumi.Input<{ ... }>;

interface ThingTypeState

Input properties used for looking up and filtering ThingType resources.

property arn

arn?: pulumi.Input<string>;

The ARN of the created AWS IoT Thing Type.

property deprecated

deprecated?: pulumi.Input<boolean>;

Whether the thing type is deprecated. If true, no new things could be associated with this type.

property name

name?: pulumi.Input<string>;

The name of the thing type.

property properties

properties?: pulumi.Input<{ ... }>;

interface TopicRuleArgs

The set of arguments for constructing a TopicRule resource.

property cloudwatchAlarm

cloudwatchAlarm?: pulumi.Input<{ ... }>;

property cloudwatchMetric

cloudwatchMetric?: pulumi.Input<{ ... }>;

property description

description?: pulumi.Input<string>;

The description of the rule.

property dynamodb

dynamodb?: pulumi.Input<{ ... }>;

property elasticsearch

elasticsearch?: pulumi.Input<{ ... }>;

property enabled

enabled: pulumi.Input<boolean>;

Specifies whether the rule is enabled.

property firehose

firehose?: pulumi.Input<{ ... }>;

property kinesis

kinesis?: pulumi.Input<{ ... }>;

property lambda

lambda?: pulumi.Input<{ ... }>;

property name

name?: pulumi.Input<string>;

The name of the rule.

property republish

republish?: pulumi.Input<{ ... }>;

property s3

s3?: pulumi.Input<{ ... }>;

property sns

sns?: pulumi.Input<{ ... }>;

property sql

sql: pulumi.Input<string>;

The SQL statement used to query the topic. For more information, see AWS IoT SQL Reference (http://docs.aws.amazon.com/iot/latest/developerguide/iot-rules.html#aws-iot-sql-reference) in the AWS IoT Developer Guide.

property sqlVersion

sqlVersion: pulumi.Input<string>;

The version of the SQL rules engine to use when evaluating the rule.

property sqs

sqs?: pulumi.Input<{ ... }>;

interface TopicRuleState

Input properties used for looking up and filtering TopicRule resources.

property arn

arn?: pulumi.Input<string>;

The ARN of the topic rule

property cloudwatchAlarm

cloudwatchAlarm?: pulumi.Input<{ ... }>;

property cloudwatchMetric

cloudwatchMetric?: pulumi.Input<{ ... }>;

property description

description?: pulumi.Input<string>;

The description of the rule.

property dynamodb

dynamodb?: pulumi.Input<{ ... }>;

property elasticsearch

elasticsearch?: pulumi.Input<{ ... }>;

property enabled

enabled?: pulumi.Input<boolean>;

Specifies whether the rule is enabled.

property firehose

firehose?: pulumi.Input<{ ... }>;

property kinesis

kinesis?: pulumi.Input<{ ... }>;

property lambda

lambda?: pulumi.Input<{ ... }>;

property name

name?: pulumi.Input<string>;

The name of the rule.

property republish

republish?: pulumi.Input<{ ... }>;

property s3

s3?: pulumi.Input<{ ... }>;

property sns

sns?: pulumi.Input<{ ... }>;

property sql

sql?: pulumi.Input<string>;

The SQL statement used to query the topic. For more information, see AWS IoT SQL Reference (http://docs.aws.amazon.com/iot/latest/developerguide/iot-rules.html#aws-iot-sql-reference) in the AWS IoT Developer Guide.

property sqlVersion

sqlVersion?: pulumi.Input<string>;

The version of the SQL rules engine to use when evaluating the rule.

property sqs

sqs?: pulumi.Input<{ ... }>;