Documentation ¶
Index ¶
- type Certificate
- type CertificateArgs
- type CertificateState
- type GetEndpointArgs
- type GetEndpointResult
- type Policy
- type PolicyArgs
- type PolicyAttachment
- type PolicyAttachmentArgs
- type PolicyAttachmentState
- type PolicyState
- type RoleAlias
- type RoleAliasArgs
- type RoleAliasState
- type Thing
- func (r *Thing) Arn() *pulumi.StringOutput
- func (r *Thing) Attributes() *pulumi.MapOutput
- func (r *Thing) DefaultClientId() *pulumi.StringOutput
- func (r *Thing) ID() *pulumi.IDOutput
- func (r *Thing) Name() *pulumi.StringOutput
- func (r *Thing) ThingTypeName() *pulumi.StringOutput
- func (r *Thing) URN() *pulumi.URNOutput
- func (r *Thing) Version() *pulumi.IntOutput
- type ThingArgs
- type ThingPrincipalAttachment
- type ThingPrincipalAttachmentArgs
- type ThingPrincipalAttachmentState
- type ThingState
- type ThingType
- type ThingTypeArgs
- type ThingTypeState
- type TopicRule
- func (r *TopicRule) Arn() *pulumi.StringOutput
- func (r *TopicRule) CloudwatchAlarm() *pulumi.Output
- func (r *TopicRule) CloudwatchMetric() *pulumi.Output
- func (r *TopicRule) Description() *pulumi.StringOutput
- func (r *TopicRule) Dynamodb() *pulumi.Output
- func (r *TopicRule) Elasticsearch() *pulumi.Output
- func (r *TopicRule) Enabled() *pulumi.BoolOutput
- func (r *TopicRule) Firehose() *pulumi.Output
- func (r *TopicRule) ID() *pulumi.IDOutput
- func (r *TopicRule) Kinesis() *pulumi.Output
- func (r *TopicRule) Lambda() *pulumi.Output
- func (r *TopicRule) Name() *pulumi.StringOutput
- func (r *TopicRule) Republish() *pulumi.Output
- func (r *TopicRule) S3() *pulumi.Output
- func (r *TopicRule) Sns() *pulumi.Output
- func (r *TopicRule) Sql() *pulumi.StringOutput
- func (r *TopicRule) SqlVersion() *pulumi.StringOutput
- func (r *TopicRule) Sqs() *pulumi.Output
- func (r *TopicRule) URN() *pulumi.URNOutput
- type TopicRuleArgs
- type TopicRuleState
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Certificate ¶
type Certificate struct {
// contains filtered or unexported fields
}
Creates and manages an AWS IoT certificate.
func GetCertificate ¶
func GetCertificate(ctx *pulumi.Context, name string, id pulumi.ID, state *CertificateState, opts ...pulumi.ResourceOpt) (*Certificate, error)
GetCertificate gets an existing Certificate resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewCertificate ¶
func NewCertificate(ctx *pulumi.Context, name string, args *CertificateArgs, opts ...pulumi.ResourceOpt) (*Certificate, error)
NewCertificate registers a new resource with the given unique name, arguments, and options.
func (*Certificate) Active ¶
func (r *Certificate) Active() *pulumi.BoolOutput
Boolean flag to indicate if the certificate should be active
func (*Certificate) Arn ¶
func (r *Certificate) Arn() *pulumi.StringOutput
The ARN of the created AWS IoT certificate
func (*Certificate) Csr ¶
func (r *Certificate) Csr() *pulumi.StringOutput
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).
func (*Certificate) ID ¶
func (r *Certificate) ID() *pulumi.IDOutput
ID is this resource's unique identifier assigned by its provider.
func (*Certificate) URN ¶
func (r *Certificate) URN() *pulumi.URNOutput
URN is this resource's unique name assigned by Pulumi.
type CertificateArgs ¶
type CertificateArgs struct { // Boolean flag to indicate if the certificate should be active Active interface{} // 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). Csr interface{} }
The set of arguments for constructing a Certificate resource.
type CertificateState ¶
type CertificateState struct { // Boolean flag to indicate if the certificate should be active Active interface{} // The ARN of the created AWS IoT certificate Arn interface{} // 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). Csr interface{} }
Input properties used for looking up and filtering Certificate resources.
type GetEndpointArgs ¶ added in v0.16.2
type GetEndpointArgs struct {
// Endpoint type. Valid values: `iot:CredentialProvider`, `iot:Data`, `iot:Data-ATS`, `iot:Job`.
EndpointType interface{}
}
A collection of arguments for invoking getEndpoint.
type GetEndpointResult ¶
type GetEndpointResult struct { // The endpoint based on `endpoint_type`: // * No `endpoint_type`: Either `iot:Data` or `iot:Data-ATS` [depending on region](https://aws.amazon.com/blogs/iot/aws-iot-core-ats-endpoints/) // * `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` EndpointAddress interface{} // id is the provider-assigned unique ID for this managed resource. Id interface{} }
A collection of values returned by getEndpoint.
func LookupEndpoint ¶
func LookupEndpoint(ctx *pulumi.Context, args *GetEndpointArgs) (*GetEndpointResult, error)
Returns a unique endpoint specific to the AWS account making the call.
type Policy ¶
type Policy struct {
// contains filtered or unexported fields
}
Provides an IoT policy.
func GetPolicy ¶
func GetPolicy(ctx *pulumi.Context, name string, id pulumi.ID, state *PolicyState, opts ...pulumi.ResourceOpt) (*Policy, error)
GetPolicy gets an existing Policy resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewPolicy ¶
func NewPolicy(ctx *pulumi.Context, name string, args *PolicyArgs, opts ...pulumi.ResourceOpt) (*Policy, error)
NewPolicy registers a new resource with the given unique name, arguments, and options.
func (*Policy) Arn ¶
func (r *Policy) Arn() *pulumi.StringOutput
The ARN assigned by AWS to this policy.
func (*Policy) DefaultVersionId ¶
func (r *Policy) DefaultVersionId() *pulumi.StringOutput
The default version of this policy.
func (*Policy) Policy ¶
func (r *Policy) Policy() *pulumi.StringOutput
The policy document. This is a JSON formatted string. Use the [IoT Developer Guide](http://docs.aws.amazon.com/iot/latest/developerguide/iot-policies.html) for more information on IoT Policies. For more information about building AWS IAM policy documents with Terraform, see the [AWS IAM Policy Document Guide](https://www.terraform.io/docs/providers/aws/guides/iam-policy-documents.html).
type PolicyArgs ¶
type PolicyArgs struct { // The name of the policy. Name interface{} // The policy document. This is a JSON formatted string. Use the [IoT Developer Guide](http://docs.aws.amazon.com/iot/latest/developerguide/iot-policies.html) for more information on IoT Policies. For more information about building AWS IAM policy documents with Terraform, see the [AWS IAM Policy Document Guide](https://www.terraform.io/docs/providers/aws/guides/iam-policy-documents.html). Policy interface{} }
The set of arguments for constructing a Policy resource.
type PolicyAttachment ¶ added in v0.16.2
type PolicyAttachment struct {
// contains filtered or unexported fields
}
Provides an IoT policy attachment.
func GetPolicyAttachment ¶ added in v0.16.2
func GetPolicyAttachment(ctx *pulumi.Context, name string, id pulumi.ID, state *PolicyAttachmentState, opts ...pulumi.ResourceOpt) (*PolicyAttachment, error)
GetPolicyAttachment gets an existing PolicyAttachment resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewPolicyAttachment ¶ added in v0.16.2
func NewPolicyAttachment(ctx *pulumi.Context, name string, args *PolicyAttachmentArgs, opts ...pulumi.ResourceOpt) (*PolicyAttachment, error)
NewPolicyAttachment registers a new resource with the given unique name, arguments, and options.
func (*PolicyAttachment) ID ¶ added in v0.16.2
func (r *PolicyAttachment) ID() *pulumi.IDOutput
ID is this resource's unique identifier assigned by its provider.
func (*PolicyAttachment) Policy ¶ added in v0.16.2
func (r *PolicyAttachment) Policy() *pulumi.StringOutput
The name of the policy to attach.
func (*PolicyAttachment) Target ¶ added in v0.16.2
func (r *PolicyAttachment) Target() *pulumi.StringOutput
The identity to which the policy is attached.
func (*PolicyAttachment) URN ¶ added in v0.16.2
func (r *PolicyAttachment) URN() *pulumi.URNOutput
URN is this resource's unique name assigned by Pulumi.
type PolicyAttachmentArgs ¶ added in v0.16.2
type PolicyAttachmentArgs struct { // The name of the policy to attach. Policy interface{} // The identity to which the policy is attached. Target interface{} }
The set of arguments for constructing a PolicyAttachment resource.
type PolicyAttachmentState ¶ added in v0.16.2
type PolicyAttachmentState struct { // The name of the policy to attach. Policy interface{} // The identity to which the policy is attached. Target interface{} }
Input properties used for looking up and filtering PolicyAttachment resources.
type PolicyState ¶
type PolicyState struct { // The ARN assigned by AWS to this policy. Arn interface{} // The default version of this policy. DefaultVersionId interface{} // The name of the policy. Name interface{} // The policy document. This is a JSON formatted string. Use the [IoT Developer Guide](http://docs.aws.amazon.com/iot/latest/developerguide/iot-policies.html) for more information on IoT Policies. For more information about building AWS IAM policy documents with Terraform, see the [AWS IAM Policy Document Guide](https://www.terraform.io/docs/providers/aws/guides/iam-policy-documents.html). Policy interface{} }
Input properties used for looking up and filtering Policy resources.
type RoleAlias ¶ added in v0.16.9
type RoleAlias struct {
// contains filtered or unexported fields
}
Provides an IoT role alias.
func GetRoleAlias ¶ added in v0.16.9
func GetRoleAlias(ctx *pulumi.Context, name string, id pulumi.ID, state *RoleAliasState, opts ...pulumi.ResourceOpt) (*RoleAlias, error)
GetRoleAlias gets an existing RoleAlias resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewRoleAlias ¶ added in v0.16.9
func NewRoleAlias(ctx *pulumi.Context, name string, args *RoleAliasArgs, opts ...pulumi.ResourceOpt) (*RoleAlias, error)
NewRoleAlias registers a new resource with the given unique name, arguments, and options.
func (*RoleAlias) Alias ¶ added in v0.16.9
func (r *RoleAlias) Alias() *pulumi.StringOutput
The name of the role alias.
func (*RoleAlias) CredentialDuration ¶ added in v0.16.9
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).
func (*RoleAlias) ID ¶ added in v0.16.9
ID is this resource's unique identifier assigned by its provider.
func (*RoleAlias) RoleArn ¶ added in v0.16.9
func (r *RoleAlias) RoleArn() *pulumi.StringOutput
The identity of the role to which the alias refers.
type RoleAliasArgs ¶ added in v0.16.9
type RoleAliasArgs struct { // The name of the role alias. Alias interface{} // 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). CredentialDuration interface{} // The identity of the role to which the alias refers. RoleArn interface{} }
The set of arguments for constructing a RoleAlias resource.
type RoleAliasState ¶ added in v0.16.9
type RoleAliasState struct { // The name of the role alias. Alias interface{} // 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). CredentialDuration interface{} // The identity of the role to which the alias refers. RoleArn interface{} }
Input properties used for looking up and filtering RoleAlias resources.
type Thing ¶
type Thing struct {
// contains filtered or unexported fields
}
Creates and manages an AWS IoT Thing.
func GetThing ¶
func GetThing(ctx *pulumi.Context, name string, id pulumi.ID, state *ThingState, opts ...pulumi.ResourceOpt) (*Thing, error)
GetThing gets an existing Thing resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewThing ¶
func NewThing(ctx *pulumi.Context, name string, args *ThingArgs, opts ...pulumi.ResourceOpt) (*Thing, error)
NewThing registers a new resource with the given unique name, arguments, and options.
func (*Thing) Attributes ¶
Map of attributes of the thing.
func (*Thing) DefaultClientId ¶
func (r *Thing) DefaultClientId() *pulumi.StringOutput
The default client ID.
func (*Thing) ThingTypeName ¶
func (r *Thing) ThingTypeName() *pulumi.StringOutput
The thing type name.
type ThingArgs ¶
type ThingArgs struct { // Map of attributes of the thing. Attributes interface{} // The name of the thing. Name interface{} // The thing type name. ThingTypeName interface{} }
The set of arguments for constructing a Thing resource.
type ThingPrincipalAttachment ¶ added in v0.16.2
type ThingPrincipalAttachment struct {
// contains filtered or unexported fields
}
Attaches Principal to AWS IoT Thing.
func GetThingPrincipalAttachment ¶ added in v0.16.2
func GetThingPrincipalAttachment(ctx *pulumi.Context, name string, id pulumi.ID, state *ThingPrincipalAttachmentState, opts ...pulumi.ResourceOpt) (*ThingPrincipalAttachment, error)
GetThingPrincipalAttachment gets an existing ThingPrincipalAttachment resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewThingPrincipalAttachment ¶ added in v0.16.2
func NewThingPrincipalAttachment(ctx *pulumi.Context, name string, args *ThingPrincipalAttachmentArgs, opts ...pulumi.ResourceOpt) (*ThingPrincipalAttachment, error)
NewThingPrincipalAttachment registers a new resource with the given unique name, arguments, and options.
func (*ThingPrincipalAttachment) ID ¶ added in v0.16.2
func (r *ThingPrincipalAttachment) ID() *pulumi.IDOutput
ID is this resource's unique identifier assigned by its provider.
func (*ThingPrincipalAttachment) Principal ¶ added in v0.16.2
func (r *ThingPrincipalAttachment) Principal() *pulumi.StringOutput
The AWS IoT Certificate ARN or Amazon Cognito Identity ID.
func (*ThingPrincipalAttachment) Thing ¶ added in v0.16.2
func (r *ThingPrincipalAttachment) Thing() *pulumi.StringOutput
The name of the thing.
func (*ThingPrincipalAttachment) URN ¶ added in v0.16.2
func (r *ThingPrincipalAttachment) URN() *pulumi.URNOutput
URN is this resource's unique name assigned by Pulumi.
type ThingPrincipalAttachmentArgs ¶ added in v0.16.2
type ThingPrincipalAttachmentArgs struct { // The AWS IoT Certificate ARN or Amazon Cognito Identity ID. Principal interface{} // The name of the thing. Thing interface{} }
The set of arguments for constructing a ThingPrincipalAttachment resource.
type ThingPrincipalAttachmentState ¶ added in v0.16.2
type ThingPrincipalAttachmentState struct { // The AWS IoT Certificate ARN or Amazon Cognito Identity ID. Principal interface{} // The name of the thing. Thing interface{} }
Input properties used for looking up and filtering ThingPrincipalAttachment resources.
type ThingState ¶
type ThingState struct { // The ARN of the thing. Arn interface{} // Map of attributes of the thing. Attributes interface{} // The default client ID. DefaultClientId interface{} // The name of the thing. Name interface{} // The thing type name. ThingTypeName interface{} // The current version of the thing record in the registry. Version interface{} }
Input properties used for looking up and filtering Thing resources.
type ThingType ¶
type ThingType struct {
// contains filtered or unexported fields
}
Creates and manages an AWS IoT Thing Type.
func GetThingType ¶
func GetThingType(ctx *pulumi.Context, name string, id pulumi.ID, state *ThingTypeState, opts ...pulumi.ResourceOpt) (*ThingType, error)
GetThingType gets an existing ThingType resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewThingType ¶
func NewThingType(ctx *pulumi.Context, name string, args *ThingTypeArgs, opts ...pulumi.ResourceOpt) (*ThingType, error)
NewThingType registers a new resource with the given unique name, arguments, and options.
func (*ThingType) Arn ¶
func (r *ThingType) Arn() *pulumi.StringOutput
The ARN of the created AWS IoT Thing Type.
func (*ThingType) Deprecated ¶
func (r *ThingType) Deprecated() *pulumi.BoolOutput
Whether the thing type is deprecated. If true, no new things could be associated with this type.
func (*ThingType) Name ¶
func (r *ThingType) Name() *pulumi.StringOutput
The name of the thing type.
func (*ThingType) Properties ¶
type ThingTypeArgs ¶
type ThingTypeArgs struct { // Whether the thing type is deprecated. If true, no new things could be associated with this type. Deprecated interface{} // The name of the thing type. Name interface{} Properties interface{} }
The set of arguments for constructing a ThingType resource.
type ThingTypeState ¶
type ThingTypeState struct { // The ARN of the created AWS IoT Thing Type. Arn interface{} // Whether the thing type is deprecated. If true, no new things could be associated with this type. Deprecated interface{} // The name of the thing type. Name interface{} Properties interface{} }
Input properties used for looking up and filtering ThingType resources.
type TopicRule ¶
type TopicRule struct {
// contains filtered or unexported fields
}
func GetTopicRule ¶
func GetTopicRule(ctx *pulumi.Context, name string, id pulumi.ID, state *TopicRuleState, opts ...pulumi.ResourceOpt) (*TopicRule, error)
GetTopicRule gets an existing TopicRule resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewTopicRule ¶
func NewTopicRule(ctx *pulumi.Context, name string, args *TopicRuleArgs, opts ...pulumi.ResourceOpt) (*TopicRule, error)
NewTopicRule registers a new resource with the given unique name, arguments, and options.
func (*TopicRule) CloudwatchAlarm ¶
func (*TopicRule) CloudwatchMetric ¶
func (*TopicRule) Description ¶
func (r *TopicRule) Description() *pulumi.StringOutput
The description of the rule.
func (*TopicRule) Elasticsearch ¶
func (*TopicRule) Enabled ¶
func (r *TopicRule) Enabled() *pulumi.BoolOutput
Specifies whether the rule is enabled.
func (*TopicRule) Sql ¶
func (r *TopicRule) Sql() *pulumi.StringOutput
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.
func (*TopicRule) SqlVersion ¶
func (r *TopicRule) SqlVersion() *pulumi.StringOutput
The version of the SQL rules engine to use when evaluating the rule.
type TopicRuleArgs ¶
type TopicRuleArgs struct { CloudwatchAlarm interface{} CloudwatchMetric interface{} // The description of the rule. Description interface{} Dynamodb interface{} Elasticsearch interface{} // Specifies whether the rule is enabled. Enabled interface{} Firehose interface{} Kinesis interface{} Lambda interface{} // The name of the rule. Name interface{} Republish interface{} S3 interface{} Sns interface{} // 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 interface{} // The version of the SQL rules engine to use when evaluating the rule. SqlVersion interface{} Sqs interface{} }
The set of arguments for constructing a TopicRule resource.
type TopicRuleState ¶
type TopicRuleState struct { // The ARN of the topic rule Arn interface{} CloudwatchAlarm interface{} CloudwatchMetric interface{} // The description of the rule. Description interface{} Dynamodb interface{} Elasticsearch interface{} // Specifies whether the rule is enabled. Enabled interface{} Firehose interface{} Kinesis interface{} Lambda interface{} // The name of the rule. Name interface{} Republish interface{} S3 interface{} Sns interface{} // 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 interface{} // The version of the SQL rules engine to use when evaluating the rule. SqlVersion interface{} Sqs interface{} }
Input properties used for looking up and filtering TopicRule resources.