iot

class pulumi_aws.iot.Certificate(resource_name, opts=None, active=None, csr=None, __name__=None, __opts__=None)

Creates and manages an AWS IoT certificate.

Parameters:
active = None

Boolean flag to indicate if the certificate should be active

arn = None

The ARN of the created AWS IoT certificate

csr = None

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).

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.iot.GetEndpointResult(endpoint_address=None, id=None)

A collection of values returned by getEndpoint.

endpoint_address = None

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
id = None

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

class pulumi_aws.iot.Policy(resource_name, opts=None, name=None, policy=None, __name__=None, __opts__=None)

Provides an IoT policy.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • name (pulumi.Input[str]) – The name of the policy.
  • policy (pulumi.Input[str]) – 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.
arn = None

The ARN assigned by AWS to this policy.

default_version_id = None

The default version of this policy.

name = None

The name of the policy.

policy = None

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.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.iot.PolicyAttachment(resource_name, opts=None, policy=None, target=None, __name__=None, __opts__=None)

Provides an IoT policy attachment.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • policy (pulumi.Input[str]) – The name of the policy to attach.
  • target (pulumi.Input[str]) – The identity to which the policy is attached.
policy = None

The name of the policy to attach.

target = None

The identity to which the policy is attached.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.iot.RoleAlias(resource_name, opts=None, alias=None, credential_duration=None, role_arn=None, __name__=None, __opts__=None)

Provides an IoT role alias.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • alias (pulumi.Input[str]) – The name of the role alias.
  • credential_duration (pulumi.Input[float]) – The duration of the credential, in seconds. If you do not specify a value for this setting, the default maximum of one hour is applied. This setting can have a value from 900 seconds (15 minutes) to 3600 seconds (60 minutes).
  • role_arn (pulumi.Input[str]) – The identity of the role to which the alias refers.
alias = None

The name of the role alias.

credential_duration = None

The duration of the credential, in seconds. If you do not specify a value for this setting, the default maximum of one hour is applied. This setting can have a value from 900 seconds (15 minutes) to 3600 seconds (60 minutes).

role_arn = None

The identity of the role to which the alias refers.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.iot.Thing(resource_name, opts=None, attributes=None, name=None, thing_type_name=None, __name__=None, __opts__=None)

Creates and manages an AWS IoT Thing.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • attributes (pulumi.Input[dict]) – Map of attributes of the thing.
  • name (pulumi.Input[str]) – The name of the thing.
  • thing_type_name (pulumi.Input[str]) – The thing type name.
arn = None

The ARN of the thing.

attributes = None

Map of attributes of the thing.

default_client_id = None

The default client ID.

name = None

The name of the thing.

thing_type_name = None

The thing type name.

version = None

The current version of the thing record in the registry.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.iot.ThingPrincipalAttachment(resource_name, opts=None, principal=None, thing=None, __name__=None, __opts__=None)

Attaches Principal to AWS IoT Thing.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • principal (pulumi.Input[str]) – The AWS IoT Certificate ARN or Amazon Cognito Identity ID.
  • thing (pulumi.Input[str]) – The name of the thing.
principal = None

The AWS IoT Certificate ARN or Amazon Cognito Identity ID.

thing = None

The name of the thing.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.iot.ThingType(resource_name, opts=None, deprecated=None, name=None, properties=None, __name__=None, __opts__=None)

Creates and manages an AWS IoT Thing Type.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • deprecated (pulumi.Input[bool]) – Whether the thing type is deprecated. If true, no new things could be associated with this type.
  • name (pulumi.Input[str]) – The name of the thing type.
arn = None

The ARN of the created AWS IoT Thing Type.

deprecated = None

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

name = None

The name of the thing type.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.iot.TopicRule(resource_name, opts=None, cloudwatch_alarm=None, cloudwatch_metric=None, description=None, dynamodb=None, elasticsearch=None, enabled=None, firehose=None, kinesis=None, lambda_=None, name=None, republish=None, s3=None, sns=None, sql=None, sql_version=None, sqs=None, __name__=None, __opts__=None)

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

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • description (pulumi.Input[str]) – The description of the rule.
  • enabled (pulumi.Input[bool]) – Specifies whether the rule is enabled.
  • name (pulumi.Input[str]) – The name of the rule.
  • sql (pulumi.Input[str]) – 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.
  • sql_version (pulumi.Input[str]) – The version of the SQL rules engine to use when evaluating the rule.
arn = None

The ARN of the topic rule

description = None

The description of the rule.

enabled = None

Specifies whether the rule is enabled.

name = None

The name of the rule.

sql = None

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.

sql_version = None

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

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
pulumi_aws.iot.get_endpoint(endpoint_type=None, opts=None)

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