awsiot

package
v2.6.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 12, 2022 License: Apache-2.0 Imports: 6 Imported by: 6

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CfnAccountAuditConfiguration_CFN_RESOURCE_TYPE_NAME

func CfnAccountAuditConfiguration_CFN_RESOURCE_TYPE_NAME() *string

func CfnAccountAuditConfiguration_IsCfnElement

func CfnAccountAuditConfiguration_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnAccountAuditConfiguration_IsCfnResource

func CfnAccountAuditConfiguration_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnAccountAuditConfiguration_IsConstruct

func CfnAccountAuditConfiguration_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnAuthorizer_CFN_RESOURCE_TYPE_NAME

func CfnAuthorizer_CFN_RESOURCE_TYPE_NAME() *string

func CfnAuthorizer_IsCfnElement

func CfnAuthorizer_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnAuthorizer_IsCfnResource

func CfnAuthorizer_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnAuthorizer_IsConstruct

func CfnAuthorizer_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnCertificate_CFN_RESOURCE_TYPE_NAME

func CfnCertificate_CFN_RESOURCE_TYPE_NAME() *string

func CfnCertificate_IsCfnElement

func CfnCertificate_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnCertificate_IsCfnResource

func CfnCertificate_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnCertificate_IsConstruct

func CfnCertificate_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnCustomMetric_CFN_RESOURCE_TYPE_NAME

func CfnCustomMetric_CFN_RESOURCE_TYPE_NAME() *string

func CfnCustomMetric_IsCfnElement

func CfnCustomMetric_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnCustomMetric_IsCfnResource

func CfnCustomMetric_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnCustomMetric_IsConstruct

func CfnCustomMetric_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnDimension_CFN_RESOURCE_TYPE_NAME

func CfnDimension_CFN_RESOURCE_TYPE_NAME() *string

func CfnDimension_IsCfnElement

func CfnDimension_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnDimension_IsCfnResource

func CfnDimension_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnDimension_IsConstruct

func CfnDimension_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnDomainConfiguration_CFN_RESOURCE_TYPE_NAME

func CfnDomainConfiguration_CFN_RESOURCE_TYPE_NAME() *string

func CfnDomainConfiguration_IsCfnElement

func CfnDomainConfiguration_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnDomainConfiguration_IsCfnResource

func CfnDomainConfiguration_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnDomainConfiguration_IsConstruct

func CfnDomainConfiguration_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnFleetMetric_CFN_RESOURCE_TYPE_NAME

func CfnFleetMetric_CFN_RESOURCE_TYPE_NAME() *string

func CfnFleetMetric_IsCfnElement

func CfnFleetMetric_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnFleetMetric_IsCfnResource

func CfnFleetMetric_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnFleetMetric_IsConstruct

func CfnFleetMetric_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnJobTemplate_CFN_RESOURCE_TYPE_NAME

func CfnJobTemplate_CFN_RESOURCE_TYPE_NAME() *string

func CfnJobTemplate_IsCfnElement

func CfnJobTemplate_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnJobTemplate_IsCfnResource

func CfnJobTemplate_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnJobTemplate_IsConstruct

func CfnJobTemplate_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnLogging_CFN_RESOURCE_TYPE_NAME

func CfnLogging_CFN_RESOURCE_TYPE_NAME() *string

func CfnLogging_IsCfnElement

func CfnLogging_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnLogging_IsCfnResource

func CfnLogging_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnLogging_IsConstruct

func CfnLogging_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnMitigationAction_CFN_RESOURCE_TYPE_NAME

func CfnMitigationAction_CFN_RESOURCE_TYPE_NAME() *string

func CfnMitigationAction_IsCfnElement

func CfnMitigationAction_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnMitigationAction_IsCfnResource

func CfnMitigationAction_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnMitigationAction_IsConstruct

func CfnMitigationAction_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnPolicyPrincipalAttachment_CFN_RESOURCE_TYPE_NAME

func CfnPolicyPrincipalAttachment_CFN_RESOURCE_TYPE_NAME() *string

func CfnPolicyPrincipalAttachment_IsCfnElement

func CfnPolicyPrincipalAttachment_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnPolicyPrincipalAttachment_IsCfnResource

func CfnPolicyPrincipalAttachment_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnPolicyPrincipalAttachment_IsConstruct

func CfnPolicyPrincipalAttachment_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnPolicy_CFN_RESOURCE_TYPE_NAME

func CfnPolicy_CFN_RESOURCE_TYPE_NAME() *string

func CfnPolicy_IsCfnElement

func CfnPolicy_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnPolicy_IsCfnResource

func CfnPolicy_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnPolicy_IsConstruct

func CfnPolicy_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnProvisioningTemplate_CFN_RESOURCE_TYPE_NAME

func CfnProvisioningTemplate_CFN_RESOURCE_TYPE_NAME() *string

func CfnProvisioningTemplate_IsCfnElement

func CfnProvisioningTemplate_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnProvisioningTemplate_IsCfnResource

func CfnProvisioningTemplate_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnProvisioningTemplate_IsConstruct

func CfnProvisioningTemplate_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnResourceSpecificLogging_CFN_RESOURCE_TYPE_NAME

func CfnResourceSpecificLogging_CFN_RESOURCE_TYPE_NAME() *string

func CfnResourceSpecificLogging_IsCfnElement

func CfnResourceSpecificLogging_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnResourceSpecificLogging_IsCfnResource

func CfnResourceSpecificLogging_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnResourceSpecificLogging_IsConstruct

func CfnResourceSpecificLogging_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnScheduledAudit_CFN_RESOURCE_TYPE_NAME

func CfnScheduledAudit_CFN_RESOURCE_TYPE_NAME() *string

func CfnScheduledAudit_IsCfnElement

func CfnScheduledAudit_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnScheduledAudit_IsCfnResource

func CfnScheduledAudit_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnScheduledAudit_IsConstruct

func CfnScheduledAudit_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnSecurityProfile_CFN_RESOURCE_TYPE_NAME

func CfnSecurityProfile_CFN_RESOURCE_TYPE_NAME() *string

func CfnSecurityProfile_IsCfnElement

func CfnSecurityProfile_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnSecurityProfile_IsCfnResource

func CfnSecurityProfile_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnSecurityProfile_IsConstruct

func CfnSecurityProfile_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnThingPrincipalAttachment_CFN_RESOURCE_TYPE_NAME

func CfnThingPrincipalAttachment_CFN_RESOURCE_TYPE_NAME() *string

func CfnThingPrincipalAttachment_IsCfnElement

func CfnThingPrincipalAttachment_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnThingPrincipalAttachment_IsCfnResource

func CfnThingPrincipalAttachment_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnThingPrincipalAttachment_IsConstruct

func CfnThingPrincipalAttachment_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnThing_CFN_RESOURCE_TYPE_NAME

func CfnThing_CFN_RESOURCE_TYPE_NAME() *string

func CfnThing_IsCfnElement

func CfnThing_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnThing_IsCfnResource

func CfnThing_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnThing_IsConstruct

func CfnThing_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnTopicRuleDestination_CFN_RESOURCE_TYPE_NAME

func CfnTopicRuleDestination_CFN_RESOURCE_TYPE_NAME() *string

func CfnTopicRuleDestination_IsCfnElement

func CfnTopicRuleDestination_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnTopicRuleDestination_IsCfnResource

func CfnTopicRuleDestination_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnTopicRuleDestination_IsConstruct

func CfnTopicRuleDestination_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnTopicRule_CFN_RESOURCE_TYPE_NAME

func CfnTopicRule_CFN_RESOURCE_TYPE_NAME() *string

func CfnTopicRule_IsCfnElement

func CfnTopicRule_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnTopicRule_IsCfnResource

func CfnTopicRule_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnTopicRule_IsConstruct

func CfnTopicRule_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func NewCfnAccountAuditConfiguration_Override

func NewCfnAccountAuditConfiguration_Override(c CfnAccountAuditConfiguration, scope constructs.Construct, id *string, props *CfnAccountAuditConfigurationProps)

Create a new `AWS::IoT::AccountAuditConfiguration`.

func NewCfnAuthorizer_Override

func NewCfnAuthorizer_Override(c CfnAuthorizer, scope constructs.Construct, id *string, props *CfnAuthorizerProps)

Create a new `AWS::IoT::Authorizer`.

func NewCfnCertificate_Override

func NewCfnCertificate_Override(c CfnCertificate, scope constructs.Construct, id *string, props *CfnCertificateProps)

Create a new `AWS::IoT::Certificate`.

func NewCfnCustomMetric_Override

func NewCfnCustomMetric_Override(c CfnCustomMetric, scope constructs.Construct, id *string, props *CfnCustomMetricProps)

Create a new `AWS::IoT::CustomMetric`.

func NewCfnDimension_Override

func NewCfnDimension_Override(c CfnDimension, scope constructs.Construct, id *string, props *CfnDimensionProps)

Create a new `AWS::IoT::Dimension`.

func NewCfnDomainConfiguration_Override

func NewCfnDomainConfiguration_Override(c CfnDomainConfiguration, scope constructs.Construct, id *string, props *CfnDomainConfigurationProps)

Create a new `AWS::IoT::DomainConfiguration`.

func NewCfnFleetMetric_Override

func NewCfnFleetMetric_Override(c CfnFleetMetric, scope constructs.Construct, id *string, props *CfnFleetMetricProps)

Create a new `AWS::IoT::FleetMetric`.

func NewCfnJobTemplate_Override

func NewCfnJobTemplate_Override(c CfnJobTemplate, scope constructs.Construct, id *string, props *CfnJobTemplateProps)

Create a new `AWS::IoT::JobTemplate`.

func NewCfnLogging_Override

func NewCfnLogging_Override(c CfnLogging, scope constructs.Construct, id *string, props *CfnLoggingProps)

Create a new `AWS::IoT::Logging`.

func NewCfnMitigationAction_Override

func NewCfnMitigationAction_Override(c CfnMitigationAction, scope constructs.Construct, id *string, props *CfnMitigationActionProps)

Create a new `AWS::IoT::MitigationAction`.

func NewCfnPolicyPrincipalAttachment_Override

func NewCfnPolicyPrincipalAttachment_Override(c CfnPolicyPrincipalAttachment, scope constructs.Construct, id *string, props *CfnPolicyPrincipalAttachmentProps)

Create a new `AWS::IoT::PolicyPrincipalAttachment`.

func NewCfnPolicy_Override

func NewCfnPolicy_Override(c CfnPolicy, scope constructs.Construct, id *string, props *CfnPolicyProps)

Create a new `AWS::IoT::Policy`.

func NewCfnProvisioningTemplate_Override

func NewCfnProvisioningTemplate_Override(c CfnProvisioningTemplate, scope constructs.Construct, id *string, props *CfnProvisioningTemplateProps)

Create a new `AWS::IoT::ProvisioningTemplate`.

func NewCfnResourceSpecificLogging_Override

func NewCfnResourceSpecificLogging_Override(c CfnResourceSpecificLogging, scope constructs.Construct, id *string, props *CfnResourceSpecificLoggingProps)

Create a new `AWS::IoT::ResourceSpecificLogging`.

func NewCfnScheduledAudit_Override

func NewCfnScheduledAudit_Override(c CfnScheduledAudit, scope constructs.Construct, id *string, props *CfnScheduledAuditProps)

Create a new `AWS::IoT::ScheduledAudit`.

func NewCfnSecurityProfile_Override

func NewCfnSecurityProfile_Override(c CfnSecurityProfile, scope constructs.Construct, id *string, props *CfnSecurityProfileProps)

Create a new `AWS::IoT::SecurityProfile`.

func NewCfnThingPrincipalAttachment_Override

func NewCfnThingPrincipalAttachment_Override(c CfnThingPrincipalAttachment, scope constructs.Construct, id *string, props *CfnThingPrincipalAttachmentProps)

Create a new `AWS::IoT::ThingPrincipalAttachment`.

func NewCfnThing_Override

func NewCfnThing_Override(c CfnThing, scope constructs.Construct, id *string, props *CfnThingProps)

Create a new `AWS::IoT::Thing`.

func NewCfnTopicRuleDestination_Override

func NewCfnTopicRuleDestination_Override(c CfnTopicRuleDestination, scope constructs.Construct, id *string, props *CfnTopicRuleDestinationProps)

Create a new `AWS::IoT::TopicRuleDestination`.

func NewCfnTopicRule_Override

func NewCfnTopicRule_Override(c CfnTopicRule, scope constructs.Construct, id *string, props *CfnTopicRuleProps)

Create a new `AWS::IoT::TopicRule`.

Types

type CfnAccountAuditConfiguration

type CfnAccountAuditConfiguration interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AccountId() *string
	SetAccountId(val *string)
	AuditCheckConfigurations() interface{}
	SetAuditCheckConfigurations(val interface{})
	AuditNotificationTargetConfigurations() interface{}
	SetAuditNotificationTargetConfigurations(val interface{})
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	LogicalId() *string
	Node() constructs.Node
	Ref() *string
	RoleArn() *string
	SetRoleArn(val *string)
	Stack() awscdk.Stack
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::IoT::AccountAuditConfiguration`.

Use the `AWS::IoT::AccountAuditConfiguration` resource to configure or reconfigure the Device Defender audit settings for your account. Settings include how audit notifications are sent and which audit checks are enabled or disabled. For API reference, see [UpdateAccountAuditConfiguration](https://docs.aws.amazon.com/iot/latest/apireference/API_UpdateAccountAuditConfiguration.html) and for detailed information on all available audit checks, see [Audit checks](https://docs.aws.amazon.com/iot/latest/developerguide/device-defender-audit-checks.html) .

TODO: EXAMPLE

func NewCfnAccountAuditConfiguration

func NewCfnAccountAuditConfiguration(scope constructs.Construct, id *string, props *CfnAccountAuditConfigurationProps) CfnAccountAuditConfiguration

Create a new `AWS::IoT::AccountAuditConfiguration`.

type CfnAccountAuditConfigurationProps

type CfnAccountAuditConfigurationProps struct {
	// The ID of the account.
	//
	// You can use the expression `!Sub "${AWS::AccountId}"` to use your account ID.
	AccountId *string `json:"accountId"`
	// Specifies which audit checks are enabled and disabled for this account.
	//
	// Some data collection might start immediately when certain checks are enabled. When a check is disabled, any data collected so far in relation to the check is deleted. To disable a check, set the value of the `Enabled:` key to `false` .
	//
	// If an enabled check is removed from the template, it will also be disabled.
	//
	// You can't disable a check if it's used by any scheduled audit. You must delete the check from the scheduled audit or delete the scheduled audit itself to disable the check.
	//
	// For more information on avialbe auidt checks see [AWS::IoT::AccountAuditConfiguration AuditCheckConfigurations](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-auditcheckconfigurations.html)
	AuditCheckConfigurations interface{} `json:"auditCheckConfigurations"`
	// The Amazon Resource Name (ARN) of the role that grants permission to AWS IoT to access information about your devices, policies, certificates, and other items as required when performing an audit.
	RoleArn *string `json:"roleArn"`
	// Information about the targets to which audit notifications are sent.
	AuditNotificationTargetConfigurations interface{} `json:"auditNotificationTargetConfigurations"`
}

Properties for defining a `CfnAccountAuditConfiguration`.

TODO: EXAMPLE

type CfnAccountAuditConfiguration_AuditCheckConfigurationProperty

type CfnAccountAuditConfiguration_AuditCheckConfigurationProperty struct {
	// True if this audit check is enabled for this account.
	Enabled interface{} `json:"enabled"`
}

Which audit checks are enabled and disabled for this account.

TODO: EXAMPLE

type CfnAccountAuditConfiguration_AuditCheckConfigurationsProperty

type CfnAccountAuditConfiguration_AuditCheckConfigurationsProperty struct {
	// Checks the permissiveness of an authenticated Amazon Cognito identity pool role.
	//
	// For this check, AWS IoT Device Defender audits all Amazon Cognito identity pools that have been used to connect to the AWS IoT message broker during the 31 days before the audit is performed.
	AuthenticatedCognitoRoleOverlyPermissiveCheck interface{} `json:"authenticatedCognitoRoleOverlyPermissiveCheck"`
	// Checks if a CA certificate is expiring.
	//
	// This check applies to CA certificates expiring within 30 days or that have expired.
	CaCertificateExpiringCheck interface{} `json:"caCertificateExpiringCheck"`
	// Checks the quality of the CA certificate key.
	//
	// The quality checks if the key is in a valid format, not expired, and if the key meets a minimum required size. This check applies to CA certificates that are `ACTIVE` or `PENDING_TRANSFER` .
	CaCertificateKeyQualityCheck interface{} `json:"caCertificateKeyQualityCheck"`
	// Checks if multiple devices connect using the same client ID.
	ConflictingClientIdsCheck interface{} `json:"conflictingClientIdsCheck"`
	// Checks if a device certificate is expiring.
	//
	// This check applies to device certificates expiring within 30 days or that have expired.
	DeviceCertificateExpiringCheck interface{} `json:"deviceCertificateExpiringCheck"`
	// Checks the quality of the device certificate key.
	//
	// The quality checks if the key is in a valid format, not expired, signed by a registered certificate authority, and if the key meets a minimum required size.
	DeviceCertificateKeyQualityCheck interface{} `json:"deviceCertificateKeyQualityCheck"`
	// Checks if multiple concurrent connections use the same X.509 certificate to authenticate with AWS IoT .
	DeviceCertificateSharedCheck interface{} `json:"deviceCertificateSharedCheck"`
	// Checks the permissiveness of a policy attached to an authenticated Amazon Cognito identity pool role.
	IotPolicyOverlyPermissiveCheck interface{} `json:"iotPolicyOverlyPermissiveCheck"`
	// Checks if a role alias has access to services that haven't been used for the AWS IoT device in the last year.
	IotRoleAliasAllowsAccessToUnusedServicesCheck interface{} `json:"iotRoleAliasAllowsAccessToUnusedServicesCheck"`
	// Checks if the temporary credentials provided by AWS IoT role aliases are overly permissive.
	IotRoleAliasOverlyPermissiveCheck interface{} `json:"iotRoleAliasOverlyPermissiveCheck"`
	// Checks if AWS IoT logs are disabled.
	LoggingDisabledCheck interface{} `json:"loggingDisabledCheck"`
	// Checks if a revoked CA certificate is still active.
	RevokedCaCertificateStillActiveCheck interface{} `json:"revokedCaCertificateStillActiveCheck"`
	// Checks if a revoked device certificate is still active.
	RevokedDeviceCertificateStillActiveCheck interface{} `json:"revokedDeviceCertificateStillActiveCheck"`
	// Checks if policy attached to an unauthenticated Amazon Cognito identity pool role is too permissive.
	UnauthenticatedCognitoRoleOverlyPermissiveCheck interface{} `json:"unauthenticatedCognitoRoleOverlyPermissiveCheck"`
}

The types of audit checks that can be performed.

TODO: EXAMPLE

type CfnAccountAuditConfiguration_AuditNotificationTargetConfigurationsProperty

type CfnAccountAuditConfiguration_AuditNotificationTargetConfigurationsProperty struct {
	// The `Sns` notification target.
	Sns interface{} `json:"sns"`
}

The configuration of the audit notification target.

TODO: EXAMPLE

type CfnAccountAuditConfiguration_AuditNotificationTargetProperty

type CfnAccountAuditConfiguration_AuditNotificationTargetProperty struct {
	// True if notifications to the target are enabled.
	Enabled interface{} `json:"enabled"`
	// The ARN of the role that grants permission to send notifications to the target.
	RoleArn *string `json:"roleArn"`
	// The ARN of the target (SNS topic) to which audit notifications are sent.
	TargetArn *string `json:"targetArn"`
}

Information about the targets to which audit notifications are sent.

TODO: EXAMPLE

type CfnAuthorizer

type CfnAuthorizer interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrArn() *string
	AuthorizerFunctionArn() *string
	SetAuthorizerFunctionArn(val *string)
	AuthorizerName() *string
	SetAuthorizerName(val *string)
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	LogicalId() *string
	Node() constructs.Node
	Ref() *string
	SigningDisabled() interface{}
	SetSigningDisabled(val interface{})
	Stack() awscdk.Stack
	Status() *string
	SetStatus(val *string)
	Tags() awscdk.TagManager
	TokenKeyName() *string
	SetTokenKeyName(val *string)
	TokenSigningPublicKeys() interface{}
	SetTokenSigningPublicKeys(val interface{})
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::IoT::Authorizer`.

Specifies an authorizer.

TODO: EXAMPLE

func NewCfnAuthorizer

func NewCfnAuthorizer(scope constructs.Construct, id *string, props *CfnAuthorizerProps) CfnAuthorizer

Create a new `AWS::IoT::Authorizer`.

type CfnAuthorizerProps

type CfnAuthorizerProps struct {
	// The authorizer's Lambda function ARN.
	AuthorizerFunctionArn *string `json:"authorizerFunctionArn"`
	// The authorizer name.
	AuthorizerName *string `json:"authorizerName"`
	// Specifies whether AWS IoT validates the token signature in an authorization request.
	SigningDisabled interface{} `json:"signingDisabled"`
	// The status of the authorizer.
	//
	// Valid values: `ACTIVE` | `INACTIVE`
	Status *string `json:"status"`
	// Metadata which can be used to manage the custom authorizer.
	//
	// > For URI Request parameters use format: ...key1=value1&key2=value2...
	// >
	// > For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."
	// >
	// > For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."
	Tags *[]*awscdk.CfnTag `json:"tags"`
	// The key used to extract the token from the HTTP headers.
	TokenKeyName *string `json:"tokenKeyName"`
	// The public keys used to validate the token signature returned by your custom authentication service.
	TokenSigningPublicKeys interface{} `json:"tokenSigningPublicKeys"`
}

Properties for defining a `CfnAuthorizer`.

TODO: EXAMPLE

type CfnCertificate

type CfnCertificate interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrArn() *string
	AttrId() *string
	CaCertificatePem() *string
	SetCaCertificatePem(val *string)
	CertificateMode() *string
	SetCertificateMode(val *string)
	CertificatePem() *string
	SetCertificatePem(val *string)
	CertificateSigningRequest() *string
	SetCertificateSigningRequest(val *string)
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	LogicalId() *string
	Node() constructs.Node
	Ref() *string
	Stack() awscdk.Stack
	Status() *string
	SetStatus(val *string)
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::IoT::Certificate`.

Use the `AWS::IoT::Certificate` resource to declare an AWS IoT X.509 certificate. For information about working with X.509 certificates, see [X.509 Client Certificates](https://docs.aws.amazon.com/iot/latest/developerguide/x509-client-certs.html) in the *AWS IoT Developer Guide* .

TODO: EXAMPLE

func NewCfnCertificate

func NewCfnCertificate(scope constructs.Construct, id *string, props *CfnCertificateProps) CfnCertificate

Create a new `AWS::IoT::Certificate`.

type CfnCertificateProps

type CfnCertificateProps struct {
	// The status of the certificate.
	//
	// Valid values are ACTIVE, INACTIVE, REVOKED, PENDING_TRANSFER, and PENDING_ACTIVATION.
	//
	// The status value REGISTER_INACTIVE is deprecated and should not be used.
	Status *string `json:"status"`
	// The CA certificate used to sign the device certificate being registered, not available when CertificateMode is SNI_ONLY.
	CaCertificatePem *string `json:"caCertificatePem"`
	// Specifies which mode of certificate registration to use with this resource.
	//
	// Valid options are DEFAULT with CaCertificatePem and CertificatePem, SNI_ONLY with CertificatePem, and Default with CertificateSigningRequest.
	CertificateMode *string `json:"certificateMode"`
	// The certificate data in PEM format.
	//
	// Requires SNI_ONLY for the certificate mode or the accompanying CACertificatePem for registration.
	CertificatePem *string `json:"certificatePem"`
	// The certificate signing request (CSR).
	CertificateSigningRequest *string `json:"certificateSigningRequest"`
}

Properties for defining a `CfnCertificate`.

TODO: EXAMPLE

type CfnCustomMetric

type CfnCustomMetric interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrMetricArn() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	DisplayName() *string
	SetDisplayName(val *string)
	LogicalId() *string
	MetricName() *string
	SetMetricName(val *string)
	MetricType() *string
	SetMetricType(val *string)
	Node() constructs.Node
	Ref() *string
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::IoT::CustomMetric`.

Use the `AWS::IoT::CustomMetric` resource to define a custom metric published by your devices to Device Defender. For API reference, see [CreateCustomMetric](https://docs.aws.amazon.com/iot/latest/apireference/API_CreateCustomMetric.html) and for general information, see [Custom metrics](https://docs.aws.amazon.com/iot/latest/developerguide/dd-detect-custom-metrics.html) .

TODO: EXAMPLE

func NewCfnCustomMetric

func NewCfnCustomMetric(scope constructs.Construct, id *string, props *CfnCustomMetricProps) CfnCustomMetric

Create a new `AWS::IoT::CustomMetric`.

type CfnCustomMetricProps

type CfnCustomMetricProps struct {
	// The type of the custom metric.
	//
	// Types include `string-list` , `ip-address-list` , `number-list` , and `number` .
	MetricType *string `json:"metricType"`
	// Field that represents a friendly name in the console for the custom metric;
	//
	// it doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. Can be updated.
	DisplayName *string `json:"displayName"`
	// The name of the custom metric.
	//
	// This will be used in the metric report submitted from the device/thing. It shouldn't begin with `aws:` . Cannot be updated once it's defined.
	MetricName *string `json:"metricName"`
	// Metadata that can be used to manage the custom metric.
	Tags *[]*awscdk.CfnTag `json:"tags"`
}

Properties for defining a `CfnCustomMetric`.

TODO: EXAMPLE

type CfnDimension

type CfnDimension interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrArn() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	LogicalId() *string
	Name() *string
	SetName(val *string)
	Node() constructs.Node
	Ref() *string
	Stack() awscdk.Stack
	StringValues() *[]*string
	SetStringValues(val *[]*string)
	Tags() awscdk.TagManager
	Type() *string
	SetType(val *string)
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::IoT::Dimension`.

Use the `AWS::IoT::Dimension` to limit the scope of a metric used in a security profile for AWS IoT Device Defender . For example, using a `TOPIC_FILTER` dimension, you can narrow down the scope of the metric to only MQTT topics where the name matches the pattern specified in the dimension. For API reference, see [CreateDimension](https://docs.aws.amazon.com/iot/latest/apireference/API_CreateDimension.html) and for general information, see [Scoping metrics in security profiles using dimensions](https://docs.aws.amazon.com/iot/latest/developerguide/scoping-security-behavior.html) .

TODO: EXAMPLE

func NewCfnDimension

func NewCfnDimension(scope constructs.Construct, id *string, props *CfnDimensionProps) CfnDimension

Create a new `AWS::IoT::Dimension`.

type CfnDimensionProps

type CfnDimensionProps struct {
	// Specifies the value or list of values for the dimension.
	//
	// For `TOPIC_FILTER` dimensions, this is a pattern used to match the MQTT topic (for example, "admin/#").
	StringValues *[]*string `json:"stringValues"`
	// Specifies the type of dimension.
	//
	// Supported types: `TOPIC_FILTER.`
	Type *string `json:"type"`
	// A unique identifier for the dimension.
	Name *string `json:"name"`
	// Metadata that can be used to manage the dimension.
	Tags *[]*awscdk.CfnTag `json:"tags"`
}

Properties for defining a `CfnDimension`.

TODO: EXAMPLE

type CfnDomainConfiguration

type CfnDomainConfiguration interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrArn() *string
	AttrDomainType() *string
	AttrServerCertificates() awscdk.IResolvable
	AuthorizerConfig() interface{}
	SetAuthorizerConfig(val interface{})
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	DomainConfigurationName() *string
	SetDomainConfigurationName(val *string)
	DomainConfigurationStatus() *string
	SetDomainConfigurationStatus(val *string)
	DomainName() *string
	SetDomainName(val *string)
	LogicalId() *string
	Node() constructs.Node
	Ref() *string
	ServerCertificateArns() *[]*string
	SetServerCertificateArns(val *[]*string)
	ServiceType() *string
	SetServiceType(val *string)
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	ValidationCertificateArn() *string
	SetValidationCertificateArn(val *string)
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::IoT::DomainConfiguration`.

Specifies a domain configuration.

TODO: EXAMPLE

func NewCfnDomainConfiguration

func NewCfnDomainConfiguration(scope constructs.Construct, id *string, props *CfnDomainConfigurationProps) CfnDomainConfiguration

Create a new `AWS::IoT::DomainConfiguration`.

type CfnDomainConfigurationProps

type CfnDomainConfigurationProps struct {
	// An object that specifies the authorization service for a domain.
	AuthorizerConfig interface{} `json:"authorizerConfig"`
	// The name of the domain configuration.
	//
	// This value must be unique to a region.
	DomainConfigurationName *string `json:"domainConfigurationName"`
	// The status to which the domain configuration should be updated.
	//
	// Valid values: `ENABLED` | `DISABLED`
	DomainConfigurationStatus *string `json:"domainConfigurationStatus"`
	// The name of the domain.
	DomainName *string `json:"domainName"`
	// The ARNs of the certificates that AWS IoT passes to the device during the TLS handshake.
	//
	// Currently you can specify only one certificate ARN. This value is not required for AWS -managed domains.
	ServerCertificateArns *[]*string `json:"serverCertificateArns"`
	// The type of service delivered by the endpoint.
	//
	// > AWS IoT Core currently supports only the `DATA` service type.
	ServiceType *string `json:"serviceType"`
	// Metadata which can be used to manage the domain configuration.
	//
	// > For URI Request parameters use format: ...key1=value1&key2=value2...
	// >
	// > For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."
	// >
	// > For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."
	Tags *[]*awscdk.CfnTag `json:"tags"`
	// The certificate used to validate the server certificate and prove domain name ownership.
	//
	// This certificate must be signed by a public certificate authority. This value is not required for AWS -managed domains.
	ValidationCertificateArn *string `json:"validationCertificateArn"`
}

Properties for defining a `CfnDomainConfiguration`.

TODO: EXAMPLE

type CfnDomainConfiguration_AuthorizerConfigProperty

type CfnDomainConfiguration_AuthorizerConfigProperty struct {
	// A Boolean that specifies whether the domain configuration's authorization service can be overridden.
	AllowAuthorizerOverride interface{} `json:"allowAuthorizerOverride"`
	// The name of the authorization service for a domain configuration.
	DefaultAuthorizerName *string `json:"defaultAuthorizerName"`
}

An object that specifies the authorization service for a domain.

TODO: EXAMPLE

type CfnDomainConfiguration_ServerCertificateSummaryProperty

type CfnDomainConfiguration_ServerCertificateSummaryProperty struct {
	// The ARN of the server certificate.
	ServerCertificateArn *string `json:"serverCertificateArn"`
	// The status of the server certificate.
	ServerCertificateStatus *string `json:"serverCertificateStatus"`
	// Details that explain the status of the server certificate.
	ServerCertificateStatusDetail *string `json:"serverCertificateStatusDetail"`
}

An object that contains information about a server certificate.

TODO: EXAMPLE

type CfnFleetMetric

type CfnFleetMetric interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AggregationField() *string
	SetAggregationField(val *string)
	AggregationType() interface{}
	SetAggregationType(val interface{})
	AttrCreationDate() awscdk.IResolvable
	AttrLastModifiedDate() awscdk.IResolvable
	AttrMetricArn() *string
	AttrVersion() awscdk.IResolvable
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	Description() *string
	SetDescription(val *string)
	IndexName() *string
	SetIndexName(val *string)
	LogicalId() *string
	MetricName() *string
	SetMetricName(val *string)
	Node() constructs.Node
	Period() *float64
	SetPeriod(val *float64)
	QueryString() *string
	SetQueryString(val *string)
	QueryVersion() *string
	SetQueryVersion(val *string)
	Ref() *string
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	Unit() *string
	SetUnit(val *string)
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::IoT::FleetMetric`.

Use the `AWS::IoT::FleetMetric` resource to declare a fleet metric.

TODO: EXAMPLE

func NewCfnFleetMetric

func NewCfnFleetMetric(scope constructs.Construct, id *string, props *CfnFleetMetricProps) CfnFleetMetric

Create a new `AWS::IoT::FleetMetric`.

type CfnFleetMetricProps

type CfnFleetMetricProps struct {
	// The name of the fleet metric to create.
	MetricName *string `json:"metricName"`
	// The field to aggregate.
	AggregationField *string `json:"aggregationField"`
	// The type of the aggregation query.
	AggregationType interface{} `json:"aggregationType"`
	// The fleet metric description.
	Description *string `json:"description"`
	// The name of the index to search.
	IndexName *string `json:"indexName"`
	// The time in seconds between fleet metric emissions.
	//
	// Range [60(1 min), 86400(1 day)] and must be multiple of 60.
	Period *float64 `json:"period"`
	// The search query string.
	QueryString *string `json:"queryString"`
	// The query version.
	QueryVersion *string `json:"queryVersion"`
	// Metadata which can be used to manage the fleet metric.
	Tags *[]*awscdk.CfnTag `json:"tags"`
	// Used to support unit transformation such as milliseconds to seconds.
	//
	// Must be a unit supported by CW metric. Default to null.
	Unit *string `json:"unit"`
}

Properties for defining a `CfnFleetMetric`.

TODO: EXAMPLE

type CfnFleetMetric_AggregationTypeProperty

type CfnFleetMetric_AggregationTypeProperty struct {
	// The name of the aggregation type.
	Name *string `json:"name"`
	// A list of the values of aggregation types.
	Values *[]*string `json:"values"`
}

The type of aggregation queries.

TODO: EXAMPLE

type CfnJobTemplate

type CfnJobTemplate interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AbortConfig() interface{}
	SetAbortConfig(val interface{})
	AttrArn() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	Description() *string
	SetDescription(val *string)
	Document() *string
	SetDocument(val *string)
	DocumentSource() *string
	SetDocumentSource(val *string)
	JobArn() *string
	SetJobArn(val *string)
	JobExecutionsRolloutConfig() interface{}
	SetJobExecutionsRolloutConfig(val interface{})
	JobTemplateId() *string
	SetJobTemplateId(val *string)
	LogicalId() *string
	Node() constructs.Node
	PresignedUrlConfig() interface{}
	SetPresignedUrlConfig(val interface{})
	Ref() *string
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	TimeoutConfig() interface{}
	SetTimeoutConfig(val interface{})
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::IoT::JobTemplate`.

Represents a job template.

TODO: EXAMPLE

func NewCfnJobTemplate

func NewCfnJobTemplate(scope constructs.Construct, id *string, props *CfnJobTemplateProps) CfnJobTemplate

Create a new `AWS::IoT::JobTemplate`.

type CfnJobTemplateProps

type CfnJobTemplateProps struct {
	// A description of the job template.
	Description *string `json:"description"`
	// A unique identifier for the job template.
	//
	// We recommend using a UUID. Alpha-numeric characters, "-", and "_" are valid for use here.
	JobTemplateId *string `json:"jobTemplateId"`
	// The criteria that determine when and how a job abort takes place.
	AbortConfig interface{} `json:"abortConfig"`
	// The job document.
	//
	// Required if you don't specify a value for `documentSource` .
	Document *string `json:"document"`
	// An S3 link to the job document to use in the template.
	//
	// Required if you don't specify a value for `document` .
	//
	// > If the job document resides in an S3 bucket, you must use a placeholder link when specifying the document.
	// >
	// > The placeholder link is of the following form:
	// >
	// > `${aws:iot:s3-presigned-url:https://s3.amazonaws.com/ *bucket* / *key* }`
	// >
	// > where *bucket* is your bucket name and *key* is the object in the bucket to which you are linking.
	DocumentSource *string `json:"documentSource"`
	// The ARN of the job to use as the basis for the job template.
	JobArn *string `json:"jobArn"`
	// Allows you to create a staged rollout of a job.
	JobExecutionsRolloutConfig interface{} `json:"jobExecutionsRolloutConfig"`
	// Configuration for pre-signed S3 URLs.
	PresignedUrlConfig interface{} `json:"presignedUrlConfig"`
	// Metadata that can be used to manage the job template.
	Tags *[]*awscdk.CfnTag `json:"tags"`
	// Specifies the amount of time each device has to finish its execution of the job.
	//
	// A timer is started when the job execution status is set to `IN_PROGRESS` . If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to `TIMED_OUT` .
	TimeoutConfig interface{} `json:"timeoutConfig"`
}

Properties for defining a `CfnJobTemplate`.

TODO: EXAMPLE

type CfnLogging

type CfnLogging interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AccountId() *string
	SetAccountId(val *string)
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	DefaultLogLevel() *string
	SetDefaultLogLevel(val *string)
	LogicalId() *string
	Node() constructs.Node
	Ref() *string
	RoleArn() *string
	SetRoleArn(val *string)
	Stack() awscdk.Stack
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::IoT::Logging`.

Sets the logging options in the V2 logging service.

TODO: EXAMPLE

func NewCfnLogging

func NewCfnLogging(scope constructs.Construct, id *string, props *CfnLoggingProps) CfnLogging

Create a new `AWS::IoT::Logging`.

type CfnLoggingProps

type CfnLoggingProps struct {
	// The unique identifier of the account to use when writing to CloudWatch logs.
	AccountId *string `json:"accountId"`
	// The logging level.
	//
	// Valid values are `DEBUG` , `INFO` , `ERROR` , `WARN` , and `DISABLED` .
	DefaultLogLevel *string `json:"defaultLogLevel"`
	// The ARN of the role that allows IoT to write to Cloudwatch logs.
	RoleArn *string `json:"roleArn"`
}

Properties for defining a `CfnLogging`.

TODO: EXAMPLE

type CfnMitigationAction

type CfnMitigationAction interface {
	awscdk.CfnResource
	awscdk.IInspectable
	ActionName() *string
	SetActionName(val *string)
	ActionParams() interface{}
	SetActionParams(val interface{})
	AttrMitigationActionArn() *string
	AttrMitigationActionId() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	LogicalId() *string
	Node() constructs.Node
	Ref() *string
	RoleArn() *string
	SetRoleArn(val *string)
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::IoT::MitigationAction`.

Defines an action that can be applied to audit findings by using StartAuditMitigationActionsTask. For API reference, see [CreateMitigationAction](https://docs.aws.amazon.com/iot/latest/apireference/API_CreateMitigationAction.html) and for general information, see [Mitigation actions](https://docs.aws.amazon.com/iot/latest/developerguide/dd-mitigation-actions.html) .

TODO: EXAMPLE

func NewCfnMitigationAction

func NewCfnMitigationAction(scope constructs.Construct, id *string, props *CfnMitigationActionProps) CfnMitigationAction

Create a new `AWS::IoT::MitigationAction`.

type CfnMitigationActionProps

type CfnMitigationActionProps struct {
	// The set of parameters for this mitigation action.
	//
	// The parameters vary, depending on the kind of action you apply.
	ActionParams interface{} `json:"actionParams"`
	// The IAM role ARN used to apply this mitigation action.
	RoleArn *string `json:"roleArn"`
	// The friendly name of the mitigation action.
	ActionName *string `json:"actionName"`
	// Metadata that can be used to manage the mitigation action.
	Tags *[]*awscdk.CfnTag `json:"tags"`
}

Properties for defining a `CfnMitigationAction`.

TODO: EXAMPLE

type CfnMitigationAction_ActionParamsProperty

type CfnMitigationAction_ActionParamsProperty struct {
	// Specifies the group to which you want to add the devices.
	AddThingsToThingGroupParams interface{} `json:"addThingsToThingGroupParams"`
	// Specifies the logging level and the role with permissions for logging.
	//
	// You cannot specify a logging level of `DISABLED` .
	EnableIoTLoggingParams interface{} `json:"enableIoTLoggingParams"`
	// Specifies the topic to which the finding should be published.
	PublishFindingToSnsParams interface{} `json:"publishFindingToSnsParams"`
	// Replaces the policy version with a default or blank policy.
	//
	// You specify the template name. Only a value of `BLANK_POLICY` is currently supported.
	ReplaceDefaultPolicyVersionParams interface{} `json:"replaceDefaultPolicyVersionParams"`
	// Specifies the new state for the CA certificate.
	//
	// Only a value of `DEACTIVATE` is currently supported.
	UpdateCaCertificateParams interface{} `json:"updateCaCertificateParams"`
	// Specifies the new state for a device certificate.
	//
	// Only a value of `DEACTIVATE` is currently supported.
	UpdateDeviceCertificateParams interface{} `json:"updateDeviceCertificateParams"`
}

Defines the type of action and the parameters for that action.

TODO: EXAMPLE

type CfnMitigationAction_AddThingsToThingGroupParamsProperty

type CfnMitigationAction_AddThingsToThingGroupParamsProperty struct {
	// The list of groups to which you want to add the things that triggered the mitigation action.
	//
	// You can add a thing to a maximum of 10 groups, but you can't add a thing to more than one group in the same hierarchy.
	ThingGroupNames *[]*string `json:"thingGroupNames"`
	// Specifies if this mitigation action can move the things that triggered the mitigation action even if they are part of one or more dynamic thing groups.
	OverrideDynamicGroups interface{} `json:"overrideDynamicGroups"`
}

Parameters used when defining a mitigation action that move a set of things to a thing group.

TODO: EXAMPLE

type CfnMitigationAction_EnableIoTLoggingParamsProperty

type CfnMitigationAction_EnableIoTLoggingParamsProperty struct {
	// Specifies the type of information to be logged.
	LogLevel *string `json:"logLevel"`
	// The Amazon Resource Name (ARN) of the IAM role used for logging.
	RoleArnForLogging *string `json:"roleArnForLogging"`
}

Parameters used when defining a mitigation action that enable AWS IoT Core logging.

TODO: EXAMPLE

type CfnMitigationAction_PublishFindingToSnsParamsProperty

type CfnMitigationAction_PublishFindingToSnsParamsProperty struct {
	// The ARN of the topic to which you want to publish the findings.
	TopicArn *string `json:"topicArn"`
}

Parameters to define a mitigation action that publishes findings to Amazon SNS.

You can implement your own custom actions in response to the Amazon SNS messages.

TODO: EXAMPLE

type CfnMitigationAction_ReplaceDefaultPolicyVersionParamsProperty

type CfnMitigationAction_ReplaceDefaultPolicyVersionParamsProperty struct {
	// The name of the template to be applied.
	//
	// The only supported value is `BLANK_POLICY` .
	TemplateName *string `json:"templateName"`
}

Parameters to define a mitigation action that adds a blank policy to restrict permissions.

TODO: EXAMPLE

type CfnMitigationAction_UpdateCACertificateParamsProperty

type CfnMitigationAction_UpdateCACertificateParamsProperty struct {
	// The action that you want to apply to the CA certificate.
	//
	// The only supported value is `DEACTIVATE` .
	Action *string `json:"action"`
}

Parameters to define a mitigation action that changes the state of the CA certificate to inactive.

TODO: EXAMPLE

type CfnMitigationAction_UpdateDeviceCertificateParamsProperty

type CfnMitigationAction_UpdateDeviceCertificateParamsProperty struct {
	// The action that you want to apply to the device certificate.
	//
	// The only supported value is `DEACTIVATE` .
	Action *string `json:"action"`
}

Parameters to define a mitigation action that changes the state of the device certificate to inactive.

TODO: EXAMPLE

type CfnPolicy

type CfnPolicy interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrArn() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	LogicalId() *string
	Node() constructs.Node
	PolicyDocument() interface{}
	SetPolicyDocument(val interface{})
	PolicyName() *string
	SetPolicyName(val *string)
	Ref() *string
	Stack() awscdk.Stack
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::IoT::Policy`.

Use the `AWS::IoT::Policy` resource to declare an AWS IoT policy. For more information about working with AWS IoT policies, see [Authorization](https://docs.aws.amazon.com/iot/latest/developerguide/authorization.html) in the *AWS IoT Developer Guide* .

TODO: EXAMPLE

func NewCfnPolicy

func NewCfnPolicy(scope constructs.Construct, id *string, props *CfnPolicyProps) CfnPolicy

Create a new `AWS::IoT::Policy`.

type CfnPolicyPrincipalAttachment

type CfnPolicyPrincipalAttachment interface {
	awscdk.CfnResource
	awscdk.IInspectable
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	LogicalId() *string
	Node() constructs.Node
	PolicyName() *string
	SetPolicyName(val *string)
	Principal() *string
	SetPrincipal(val *string)
	Ref() *string
	Stack() awscdk.Stack
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::IoT::PolicyPrincipalAttachment`.

Use the `AWS::IoT::PolicyPrincipalAttachment` resource to attach an AWS IoT policy to a principal (an X.509 certificate or other credential).

For information about working with AWS IoT policies and principals, see [Authorization](https://docs.aws.amazon.com/iot/latest/developerguide/authorization.html) in the *AWS IoT Developer Guide* .

TODO: EXAMPLE

func NewCfnPolicyPrincipalAttachment

func NewCfnPolicyPrincipalAttachment(scope constructs.Construct, id *string, props *CfnPolicyPrincipalAttachmentProps) CfnPolicyPrincipalAttachment

Create a new `AWS::IoT::PolicyPrincipalAttachment`.

type CfnPolicyPrincipalAttachmentProps

type CfnPolicyPrincipalAttachmentProps struct {
	// The name of the AWS IoT policy.
	PolicyName *string `json:"policyName"`
	// The principal, which can be a certificate ARN (as returned from the `CreateCertificate` operation) or an Amazon Cognito ID.
	Principal *string `json:"principal"`
}

Properties for defining a `CfnPolicyPrincipalAttachment`.

TODO: EXAMPLE

type CfnPolicyProps

type CfnPolicyProps struct {
	// The JSON document that describes the policy.
	PolicyDocument interface{} `json:"policyDocument"`
	// The policy name.
	PolicyName *string `json:"policyName"`
}

Properties for defining a `CfnPolicy`.

TODO: EXAMPLE

type CfnProvisioningTemplate

type CfnProvisioningTemplate interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrTemplateArn() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	Description() *string
	SetDescription(val *string)
	Enabled() interface{}
	SetEnabled(val interface{})
	LogicalId() *string
	Node() constructs.Node
	PreProvisioningHook() interface{}
	SetPreProvisioningHook(val interface{})
	ProvisioningRoleArn() *string
	SetProvisioningRoleArn(val *string)
	Ref() *string
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	TemplateBody() *string
	SetTemplateBody(val *string)
	TemplateName() *string
	SetTemplateName(val *string)
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::IoT::ProvisioningTemplate`.

Creates a fleet provisioning template.

TODO: EXAMPLE

func NewCfnProvisioningTemplate

func NewCfnProvisioningTemplate(scope constructs.Construct, id *string, props *CfnProvisioningTemplateProps) CfnProvisioningTemplate

Create a new `AWS::IoT::ProvisioningTemplate`.

type CfnProvisioningTemplateProps

type CfnProvisioningTemplateProps struct {
	// The role ARN for the role associated with the fleet provisioning template.
	//
	// This IoT role grants permission to provision a device.
	ProvisioningRoleArn *string `json:"provisioningRoleArn"`
	// The JSON formatted contents of the fleet provisioning template version.
	TemplateBody *string `json:"templateBody"`
	// The description of the fleet provisioning template.
	Description *string `json:"description"`
	// True to enable the fleet provisioning template, otherwise false.
	Enabled interface{} `json:"enabled"`
	// Creates a pre-provisioning hook template.
	PreProvisioningHook interface{} `json:"preProvisioningHook"`
	// Metadata that can be used to manage the fleet provisioning template.
	Tags *[]*awscdk.CfnTag `json:"tags"`
	// The name of the fleet provisioning template.
	TemplateName *string `json:"templateName"`
}

Properties for defining a `CfnProvisioningTemplate`.

TODO: EXAMPLE

type CfnProvisioningTemplate_ProvisioningHookProperty

type CfnProvisioningTemplate_ProvisioningHookProperty struct {
	// The payload that was sent to the target function.
	//
	// The valid payload is `"2020-04-01"` .
	PayloadVersion *string `json:"payloadVersion"`
	// The ARN of the target function.
	TargetArn *string `json:"targetArn"`
}

Structure that contains payloadVersion and targetArn.

Provisioning hooks can be used when fleet provisioning to validate device parameters before allowing the device to be provisioned.

TODO: EXAMPLE

type CfnResourceSpecificLogging

type CfnResourceSpecificLogging interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrTargetId() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	LogicalId() *string
	LogLevel() *string
	SetLogLevel(val *string)
	Node() constructs.Node
	Ref() *string
	Stack() awscdk.Stack
	TargetName() *string
	SetTargetName(val *string)
	TargetType() *string
	SetTargetType(val *string)
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::IoT::ResourceSpecificLogging`.

Sets the logging options for a specific resource in the V2 logging service.

TODO: EXAMPLE

func NewCfnResourceSpecificLogging

func NewCfnResourceSpecificLogging(scope constructs.Construct, id *string, props *CfnResourceSpecificLoggingProps) CfnResourceSpecificLogging

Create a new `AWS::IoT::ResourceSpecificLogging`.

type CfnResourceSpecificLoggingProps

type CfnResourceSpecificLoggingProps struct {
	// The logging level.
	//
	// Valid values are `DEBUG` , `INFO` , `ERROR` , `WARN` , and `DISABLED` .
	LogLevel *string `json:"logLevel"`
	// The log target name.
	TargetName *string `json:"targetName"`
	// The log target type.
	TargetType *string `json:"targetType"`
}

Properties for defining a `CfnResourceSpecificLogging`.

TODO: EXAMPLE

type CfnScheduledAudit

type CfnScheduledAudit interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrScheduledAuditArn() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	DayOfMonth() *string
	SetDayOfMonth(val *string)
	DayOfWeek() *string
	SetDayOfWeek(val *string)
	Frequency() *string
	SetFrequency(val *string)
	LogicalId() *string
	Node() constructs.Node
	Ref() *string
	ScheduledAuditName() *string
	SetScheduledAuditName(val *string)
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	TargetCheckNames() *[]*string
	SetTargetCheckNames(val *[]*string)
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::IoT::ScheduledAudit`.

Use the `AWS::IoT::ScheduledAudit` resource to create a scheduled audit that is run at a specified time interval. For API reference, see [CreateScheduleAudit](https://docs.aws.amazon.com/iot/latest/apireference/API_CreateScheduledAudit.html) and for general information, see [Audit](https://docs.aws.amazon.com/iot/latest/developerguide/device-defender-audit.html) .

TODO: EXAMPLE

func NewCfnScheduledAudit

func NewCfnScheduledAudit(scope constructs.Construct, id *string, props *CfnScheduledAuditProps) CfnScheduledAudit

Create a new `AWS::IoT::ScheduledAudit`.

type CfnScheduledAuditProps

type CfnScheduledAuditProps struct {
	// How often the scheduled audit occurs.
	Frequency *string `json:"frequency"`
	// Which checks are performed during the scheduled audit.
	//
	// Checks must be enabled for your account. (Use `DescribeAccountAuditConfiguration` to see the list of all checks, including those that are enabled or use `UpdateAccountAuditConfiguration` to select which checks are enabled.)
	//
	// The following checks are currently aviable:
	//
	// - `AUTHENTICATED_COGNITO_ROLE_OVERLY_PERMISSIVE_CHECK`
	// - `CA_CERTIFICATE_EXPIRING_CHECK`
	// - `CA_CERTIFICATE_KEY_QUALITY_CHECK`
	// - `CONFLICTING_CLIENT_IDS_CHECK`
	// - `DEVICE_CERTIFICATE_EXPIRING_CHECK`
	// - `DEVICE_CERTIFICATE_KEY_QUALITY_CHECK`
	// - `DEVICE_CERTIFICATE_SHARED_CHECK`
	// - `IOT_POLICY_OVERLY_PERMISSIVE_CHECK`
	// - `IOT_ROLE_ALIAS_ALLOWS_ACCESS_TO_UNUSED_SERVICES_CHECK`
	// - `IOT_ROLE_ALIAS_OVERLY_PERMISSIVE_CHECK`
	// - `LOGGING_DISABLED_CHECK`
	// - `REVOKED_CA_CERTIFICATE_STILL_ACTIVE_CHECK`
	// - `REVOKED_DEVICE_CERTIFICATE_STILL_ACTIVE_CHECK`
	// - `UNAUTHENTICATED_COGNITO_ROLE_OVERLY_PERMISSIVE_CHECK`
	TargetCheckNames *[]*string `json:"targetCheckNames"`
	// The day of the month on which the scheduled audit is run (if the `frequency` is "MONTHLY").
	//
	// If days 29-31 are specified, and the month does not have that many days, the audit takes place on the "LAST" day of the month.
	DayOfMonth *string `json:"dayOfMonth"`
	// The day of the week on which the scheduled audit is run (if the `frequency` is "WEEKLY" or "BIWEEKLY").
	DayOfWeek *string `json:"dayOfWeek"`
	// The name of the scheduled audit.
	ScheduledAuditName *string `json:"scheduledAuditName"`
	// Metadata that can be used to manage the scheduled audit.
	Tags *[]*awscdk.CfnTag `json:"tags"`
}

Properties for defining a `CfnScheduledAudit`.

TODO: EXAMPLE

type CfnSecurityProfile

type CfnSecurityProfile interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AdditionalMetricsToRetainV2() interface{}
	SetAdditionalMetricsToRetainV2(val interface{})
	AlertTargets() interface{}
	SetAlertTargets(val interface{})
	AttrSecurityProfileArn() *string
	Behaviors() interface{}
	SetBehaviors(val interface{})
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	LogicalId() *string
	Node() constructs.Node
	Ref() *string
	SecurityProfileDescription() *string
	SetSecurityProfileDescription(val *string)
	SecurityProfileName() *string
	SetSecurityProfileName(val *string)
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	TargetArns() *[]*string
	SetTargetArns(val *[]*string)
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::IoT::SecurityProfile`.

Use the `AWS::IoT::SecurityProfile` resource to create a Device Defender security profile. For API reference, see [CreateSecurityProfile](https://docs.aws.amazon.com/iot/latest/apireference/API_CreateSecurityProfile.html) and for general information, see [Detect](https://docs.aws.amazon.com/iot/latest/developerguide/device-defender-detect.html) .

TODO: EXAMPLE

func NewCfnSecurityProfile

func NewCfnSecurityProfile(scope constructs.Construct, id *string, props *CfnSecurityProfileProps) CfnSecurityProfile

Create a new `AWS::IoT::SecurityProfile`.

type CfnSecurityProfileProps

type CfnSecurityProfileProps struct {
	// A list of metrics whose data is retained (stored).
	//
	// By default, data is retained for any metric used in the profile's `behaviors` , but it's also retained for any metric specified here. Can be used with custom metrics; can't be used with dimensions.
	AdditionalMetricsToRetainV2 interface{} `json:"additionalMetricsToRetainV2"`
	// Specifies the destinations to which alerts are sent.
	//
	// (Alerts are always sent to the console.) Alerts are generated when a device (thing) violates a behavior.
	AlertTargets interface{} `json:"alertTargets"`
	// Specifies the behaviors that, when violated by a device (thing), cause an alert.
	Behaviors interface{} `json:"behaviors"`
	// A description of the security profile.
	SecurityProfileDescription *string `json:"securityProfileDescription"`
	// The name you gave to the security profile.
	SecurityProfileName *string `json:"securityProfileName"`
	// Metadata that can be used to manage the security profile.
	Tags *[]*awscdk.CfnTag `json:"tags"`
	// The ARN of the target (thing group) to which the security profile is attached.
	TargetArns *[]*string `json:"targetArns"`
}

Properties for defining a `CfnSecurityProfile`.

TODO: EXAMPLE

type CfnSecurityProfile_AlertTargetProperty

type CfnSecurityProfile_AlertTargetProperty struct {
	// The Amazon Resource Name (ARN) of the notification target to which alerts are sent.
	AlertTargetArn *string `json:"alertTargetArn"`
	// The ARN of the role that grants permission to send alerts to the notification target.
	RoleArn *string `json:"roleArn"`
}

A structure containing the alert target ARN and the role ARN.

TODO: EXAMPLE

type CfnSecurityProfile_BehaviorCriteriaProperty

type CfnSecurityProfile_BehaviorCriteriaProperty struct {
	// The operator that relates the thing measured ( `metric` ) to the criteria (containing a `value` or `statisticalThreshold` ).
	//
	// Valid operators include:
	//
	// - `string-list` : `in-set` and `not-in-set`
	// - `number-list` : `in-set` and `not-in-set`
	// - `ip-address-list` : `in-cidr-set` and `not-in-cidr-set`
	// - `number` : `less-than` , `less-than-equals` , `greater-than` , and `greater-than-equals`
	ComparisonOperator *string `json:"comparisonOperator"`
	// If a device is in violation of the behavior for the specified number of consecutive datapoints, an alarm occurs.
	//
	// If not specified, the default is 1.
	ConsecutiveDatapointsToAlarm *float64 `json:"consecutiveDatapointsToAlarm"`
	// If an alarm has occurred and the offending device is no longer in violation of the behavior for the specified number of consecutive datapoints, the alarm is cleared.
	//
	// If not specified, the default is 1.
	ConsecutiveDatapointsToClear *float64 `json:"consecutiveDatapointsToClear"`
	// Use this to specify the time duration over which the behavior is evaluated, for those criteria that have a time dimension (for example, `NUM_MESSAGES_SENT` ).
	//
	// For a `statisticalThreshhold` metric comparison, measurements from all devices are accumulated over this time duration before being used to calculate percentiles, and later, measurements from an individual device are also accumulated over this time duration before being given a percentile rank. Cannot be used with list-based metric datatypes.
	DurationSeconds *float64 `json:"durationSeconds"`
	// The confidence level of the detection model.
	MlDetectionConfig interface{} `json:"mlDetectionConfig"`
	// A statistical ranking (percentile)that indicates a threshold value by which a behavior is determined to be in compliance or in violation of the behavior.
	StatisticalThreshold interface{} `json:"statisticalThreshold"`
	// The value to be compared with the `metric` .
	Value interface{} `json:"value"`
}

The criteria by which the behavior is determined to be normal.

TODO: EXAMPLE

type CfnSecurityProfile_BehaviorProperty

type CfnSecurityProfile_BehaviorProperty struct {
	// The name you've given to the behavior.
	Name *string `json:"name"`
	// The criteria that determine if a device is behaving normally in regard to the `metric` .
	Criteria interface{} `json:"criteria"`
	// What is measured by the behavior.
	Metric *string `json:"metric"`
	// The dimension of the metric.
	MetricDimension interface{} `json:"metricDimension"`
	// The alert status.
	//
	// If you set the value to `true` , alerts will be suppressed.
	SuppressAlerts interface{} `json:"suppressAlerts"`
}

A Device Defender security profile behavior.

TODO: EXAMPLE

type CfnSecurityProfile_MachineLearningDetectionConfigProperty

type CfnSecurityProfile_MachineLearningDetectionConfigProperty struct {
	// The model confidence level.
	//
	// There are three levels of confidence, `"high"` , `"medium"` , and `"low"` .
	//
	// The higher the confidence level, the lower the sensitivity, and the lower the alarm frequency will be.
	ConfidenceLevel *string `json:"confidenceLevel"`
}

The `MachineLearningDetectionConfig` property type controls confidence of the machine learning model.

TODO: EXAMPLE

type CfnSecurityProfile_MetricDimensionProperty

type CfnSecurityProfile_MetricDimensionProperty struct {
	// The name of the dimension.
	DimensionName *string `json:"dimensionName"`
	// Operators are constructs that perform logical operations.
	//
	// Valid values are `IN` and `NOT_IN` .
	Operator *string `json:"operator"`
}

The dimension of the metric.

TODO: EXAMPLE

type CfnSecurityProfile_MetricToRetainProperty

type CfnSecurityProfile_MetricToRetainProperty struct {
	// A standard of measurement.
	Metric *string `json:"metric"`
	// The dimension of the metric.
	MetricDimension interface{} `json:"metricDimension"`
}

The metric you want to retain.

Dimensions are optional.

TODO: EXAMPLE

type CfnSecurityProfile_MetricValueProperty

type CfnSecurityProfile_MetricValueProperty struct {
	// If the `comparisonOperator` calls for a set of CIDRs, use this to specify that set to be compared with the `metric` .
	Cidrs *[]*string `json:"cidrs"`
	// If the `comparisonOperator` calls for a numeric value, use this to specify that numeric value to be compared with the `metric` .
	Count *string `json:"count"`
	// `CfnSecurityProfile.MetricValueProperty.Number`.
	Number *float64 `json:"number"`
	// `CfnSecurityProfile.MetricValueProperty.Numbers`.
	Numbers interface{} `json:"numbers"`
	// If the `comparisonOperator` calls for a set of ports, use this to specify that set to be compared with the `metric` .
	Ports interface{} `json:"ports"`
	// `CfnSecurityProfile.MetricValueProperty.Strings`.
	Strings *[]*string `json:"strings"`
}

The value to be compared with the `metric` .

TODO: EXAMPLE

type CfnSecurityProfile_StatisticalThresholdProperty

type CfnSecurityProfile_StatisticalThresholdProperty struct {
	// The percentile that resolves to a threshold value by which compliance with a behavior is determined.
	//
	// Metrics are collected over the specified period ( `durationSeconds` ) from all reporting devices in your account and statistical ranks are calculated. Then, the measurements from a device are collected over the same period. If the accumulated measurements from the device fall above or below ( `comparisonOperator` ) the value associated with the percentile specified, then the device is considered to be in compliance with the behavior, otherwise a violation occurs.
	Statistic *string `json:"statistic"`
}

A statistical ranking (percentile) that indicates a threshold value by which a behavior is determined to be in compliance or in violation of the behavior.

TODO: EXAMPLE

type CfnThing

type CfnThing interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttributePayload() interface{}
	SetAttributePayload(val interface{})
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	LogicalId() *string
	Node() constructs.Node
	Ref() *string
	Stack() awscdk.Stack
	ThingName() *string
	SetThingName(val *string)
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::IoT::Thing`.

Use the `AWS::IoT::Thing` resource to declare an AWS IoT thing.

For information about working with things, see [How AWS IoT Works](https://docs.aws.amazon.com/iot/latest/developerguide/aws-iot-how-it-works.html) and [Device Registry for AWS IoT](https://docs.aws.amazon.com/iot/latest/developerguide/thing-registry.html) in the *AWS IoT Developer Guide* .

TODO: EXAMPLE

func NewCfnThing

func NewCfnThing(scope constructs.Construct, id *string, props *CfnThingProps) CfnThing

Create a new `AWS::IoT::Thing`.

type CfnThingPrincipalAttachment

type CfnThingPrincipalAttachment interface {
	awscdk.CfnResource
	awscdk.IInspectable
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	LogicalId() *string
	Node() constructs.Node
	Principal() *string
	SetPrincipal(val *string)
	Ref() *string
	Stack() awscdk.Stack
	ThingName() *string
	SetThingName(val *string)
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::IoT::ThingPrincipalAttachment`.

Use the `AWS::IoT::ThingPrincipalAttachment` resource to attach a principal (an X.509 certificate or another credential) to a thing.

For more information about working with AWS IoT things and principals, see [Authorization](https://docs.aws.amazon.com/iot/latest/developerguide/authorization.html) in the *AWS IoT Developer Guide* .

TODO: EXAMPLE

func NewCfnThingPrincipalAttachment

func NewCfnThingPrincipalAttachment(scope constructs.Construct, id *string, props *CfnThingPrincipalAttachmentProps) CfnThingPrincipalAttachment

Create a new `AWS::IoT::ThingPrincipalAttachment`.

type CfnThingPrincipalAttachmentProps

type CfnThingPrincipalAttachmentProps struct {
	// The principal, which can be a certificate ARN (as returned from the `CreateCertificate` operation) or an Amazon Cognito ID.
	Principal *string `json:"principal"`
	// The name of the AWS IoT thing.
	ThingName *string `json:"thingName"`
}

Properties for defining a `CfnThingPrincipalAttachment`.

TODO: EXAMPLE

type CfnThingProps

type CfnThingProps struct {
	// A string that contains up to three key value pairs.
	//
	// Maximum length of 800. Duplicates not allowed.
	AttributePayload interface{} `json:"attributePayload"`
	// The name of the thing to update.
	//
	// You can't change a thing's name. To change a thing's name, you must create a new thing, give it the new name, and then delete the old thing.
	ThingName *string `json:"thingName"`
}

Properties for defining a `CfnThing`.

TODO: EXAMPLE

type CfnThing_AttributePayloadProperty

type CfnThing_AttributePayloadProperty struct {
	// A JSON string containing up to three key-value pair in JSON format. For example:.
	//
	// `{\"attributes\":{\"string1\":\"string2\"}}`
	Attributes interface{} `json:"attributes"`
}

The AttributePayload property specifies up to three attributes for an AWS IoT as key-value pairs.

AttributePayload is a property of the [AWS::IoT::Thing](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-thing.html) resource.

TODO: EXAMPLE

type CfnTopicRule

type CfnTopicRule interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrArn() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	LogicalId() *string
	Node() constructs.Node
	Ref() *string
	RuleName() *string
	SetRuleName(val *string)
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	TopicRulePayload() interface{}
	SetTopicRulePayload(val interface{})
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::IoT::TopicRule`.

Use the `AWS::IoT::TopicRule` resource to declare an AWS IoT rule. For information about working with AWS IoT rules, see [Rules for AWS IoT](https://docs.aws.amazon.com/iot/latest/developerguide/iot-rules.html) in the *AWS IoT Developer Guide* .

TODO: EXAMPLE

func NewCfnTopicRule

func NewCfnTopicRule(scope constructs.Construct, id *string, props *CfnTopicRuleProps) CfnTopicRule

Create a new `AWS::IoT::TopicRule`.

type CfnTopicRuleDestination

type CfnTopicRuleDestination interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrArn() *string
	AttrStatusReason() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	HttpUrlProperties() interface{}
	SetHttpUrlProperties(val interface{})
	LogicalId() *string
	Node() constructs.Node
	Ref() *string
	Stack() awscdk.Stack
	Status() *string
	SetStatus(val *string)
	UpdatedProperites() *map[string]interface{}
	VpcProperties() interface{}
	SetVpcProperties(val interface{})
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::IoT::TopicRuleDestination`.

A topic rule destination.

TODO: EXAMPLE

func NewCfnTopicRuleDestination

func NewCfnTopicRuleDestination(scope constructs.Construct, id *string, props *CfnTopicRuleDestinationProps) CfnTopicRuleDestination

Create a new `AWS::IoT::TopicRuleDestination`.

type CfnTopicRuleDestinationProps

type CfnTopicRuleDestinationProps struct {
	// Properties of the HTTP URL.
	HttpUrlProperties interface{} `json:"httpUrlProperties"`
	// - **IN_PROGRESS** - A topic rule destination was created but has not been confirmed.
	//
	// You can set status to `IN_PROGRESS` by calling `UpdateTopicRuleDestination` . Calling `UpdateTopicRuleDestination` causes a new confirmation challenge to be sent to your confirmation endpoint.
	// - **ENABLED** - Confirmation was completed, and traffic to this destination is allowed. You can set status to `DISABLED` by calling `UpdateTopicRuleDestination` .
	// - **DISABLED** - Confirmation was completed, and traffic to this destination is not allowed. You can set status to `ENABLED` by calling `UpdateTopicRuleDestination` .
	// - **ERROR** - Confirmation could not be completed; for example, if the confirmation timed out. You can call `GetTopicRuleDestination` for details about the error. You can set status to `IN_PROGRESS` by calling `UpdateTopicRuleDestination` . Calling `UpdateTopicRuleDestination` causes a new confirmation challenge to be sent to your confirmation endpoint.
	Status *string `json:"status"`
	// Properties of the virtual private cloud (VPC) connection.
	VpcProperties interface{} `json:"vpcProperties"`
}

Properties for defining a `CfnTopicRuleDestination`.

TODO: EXAMPLE

type CfnTopicRuleDestination_HttpUrlDestinationSummaryProperty

type CfnTopicRuleDestination_HttpUrlDestinationSummaryProperty struct {
	// The URL used to confirm the HTTP topic rule destination URL.
	ConfirmationUrl *string `json:"confirmationUrl"`
}

HTTP URL destination properties.

TODO: EXAMPLE

type CfnTopicRuleDestination_VpcDestinationPropertiesProperty

type CfnTopicRuleDestination_VpcDestinationPropertiesProperty struct {
	// The ARN of a role that has permission to create and attach to elastic network interfaces (ENIs).
	RoleArn *string `json:"roleArn"`
	// The security groups of the VPC destination.
	SecurityGroups *[]*string `json:"securityGroups"`
	// The subnet IDs of the VPC destination.
	SubnetIds *[]*string `json:"subnetIds"`
	// The ID of the VPC.
	VpcId *string `json:"vpcId"`
}

The properties of a virtual private cloud (VPC) destination.

TODO: EXAMPLE

type CfnTopicRuleProps

type CfnTopicRuleProps struct {
	// The rule payload.
	TopicRulePayload interface{} `json:"topicRulePayload"`
	// The name of the rule.
	RuleName *string `json:"ruleName"`
	// Metadata which can be used to manage the topic rule.
	//
	// > For URI Request parameters use format: ...key1=value1&key2=value2...
	// >
	// > For the CLI command-line parameter use format: --tags "key1=value1&key2=value2..."
	// >
	// > For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."
	Tags *[]*awscdk.CfnTag `json:"tags"`
}

Properties for defining a `CfnTopicRule`.

TODO: EXAMPLE

type CfnTopicRule_ActionProperty

type CfnTopicRule_ActionProperty struct {
	// Change the state of a CloudWatch alarm.
	CloudwatchAlarm interface{} `json:"cloudwatchAlarm"`
	// `CfnTopicRule.ActionProperty.CloudwatchLogs`.
	CloudwatchLogs interface{} `json:"cloudwatchLogs"`
	// Capture a CloudWatch metric.
	CloudwatchMetric interface{} `json:"cloudwatchMetric"`
	// Write to a DynamoDB table.
	DynamoDb interface{} `json:"dynamoDb"`
	// Write to a DynamoDB table.
	//
	// This is a new version of the DynamoDB action. It allows you to write each attribute in an MQTT message payload into a separate DynamoDB column.
	DynamoDBv2 interface{} `json:"dynamoDBv2"`
	// Write data to an Amazon OpenSearch Service domain.
	//
	// > The `Elasticsearch` action can only be used by existing rule actions. To create a new rule action or to update an existing rule action, use the `OpenSearch` rule action instead. For more information, see [OpenSearchAction](https://docs.aws.amazon.com//iot/latest/apireference/API_OpenSearchAction.html) .
	Elasticsearch interface{} `json:"elasticsearch"`
	// Write to an Amazon Kinesis Firehose stream.
	Firehose interface{} `json:"firehose"`
	// Send data to an HTTPS endpoint.
	Http interface{} `json:"http"`
	// Sends message data to an AWS IoT Analytics channel.
	IotAnalytics interface{} `json:"iotAnalytics"`
	// Sends an input to an AWS IoT Events detector.
	IotEvents interface{} `json:"iotEvents"`
	// Sends data from the MQTT message that triggered the rule to AWS IoT SiteWise asset properties.
	IotSiteWise interface{} `json:"iotSiteWise"`
	// Send messages to an Amazon Managed Streaming for Apache Kafka (Amazon MSK) or self-managed Apache Kafka cluster.
	Kafka interface{} `json:"kafka"`
	// Write data to an Amazon Kinesis stream.
	Kinesis interface{} `json:"kinesis"`
	// Invoke a Lambda function.
	Lambda interface{} `json:"lambda"`
	// Write data to an Amazon OpenSearch Service domain.
	OpenSearch interface{} `json:"openSearch"`
	// Publish to another MQTT topic.
	Republish interface{} `json:"republish"`
	// Write to an Amazon S3 bucket.
	S3 interface{} `json:"s3"`
	// Publish to an Amazon SNS topic.
	Sns interface{} `json:"sns"`
	// Publish to an Amazon SQS queue.
	Sqs interface{} `json:"sqs"`
	// Starts execution of a Step Functions state machine.
	StepFunctions interface{} `json:"stepFunctions"`
	// Writes attributes from an MQTT message.
	Timestream interface{} `json:"timestream"`
}

Describes the actions associated with a rule.

TODO: EXAMPLE

type CfnTopicRule_AssetPropertyTimestampProperty

type CfnTopicRule_AssetPropertyTimestampProperty struct {
	// A string that contains the time in seconds since epoch.
	//
	// Accepts substitution templates.
	TimeInSeconds *string `json:"timeInSeconds"`
	// Optional.
	//
	// A string that contains the nanosecond time offset. Accepts substitution templates.
	OffsetInNanos *string `json:"offsetInNanos"`
}

An asset property timestamp entry containing the following information.

TODO: EXAMPLE

type CfnTopicRule_AssetPropertyValueProperty

type CfnTopicRule_AssetPropertyValueProperty struct {
	// The asset property value timestamp.
	Timestamp interface{} `json:"timestamp"`
	// The value of the asset property.
	Value interface{} `json:"value"`
	// Optional.
	//
	// A string that describes the quality of the value. Accepts substitution templates. Must be `GOOD` , `BAD` , or `UNCERTAIN` .
	Quality *string `json:"quality"`
}

An asset property value entry containing the following information.

TODO: EXAMPLE

type CfnTopicRule_AssetPropertyVariantProperty

type CfnTopicRule_AssetPropertyVariantProperty struct {
	// Optional.
	//
	// A string that contains the boolean value ( `true` or `false` ) of the value entry. Accepts substitution templates.
	BooleanValue *string `json:"booleanValue"`
	// Optional.
	//
	// A string that contains the double value of the value entry. Accepts substitution templates.
	DoubleValue *string `json:"doubleValue"`
	// Optional.
	//
	// A string that contains the integer value of the value entry. Accepts substitution templates.
	IntegerValue *string `json:"integerValue"`
	// Optional.
	//
	// The string value of the value entry. Accepts substitution templates.
	StringValue *string `json:"stringValue"`
}

Contains an asset property value (of a single type).

TODO: EXAMPLE

type CfnTopicRule_CloudwatchAlarmActionProperty

type CfnTopicRule_CloudwatchAlarmActionProperty struct {
	// The CloudWatch alarm name.
	AlarmName *string `json:"alarmName"`
	// The IAM role that allows access to the CloudWatch alarm.
	RoleArn *string `json:"roleArn"`
	// The reason for the alarm change.
	StateReason *string `json:"stateReason"`
	// The value of the alarm state.
	//
	// Acceptable values are: OK, ALARM, INSUFFICIENT_DATA.
	StateValue *string `json:"stateValue"`
}

Describes an action that updates a CloudWatch alarm.

TODO: EXAMPLE

type CfnTopicRule_CloudwatchLogsActionProperty

type CfnTopicRule_CloudwatchLogsActionProperty struct {
	// The CloudWatch log name.
	LogGroupName *string `json:"logGroupName"`
	// The IAM role that allows access to the CloudWatch log.
	RoleArn *string `json:"roleArn"`
}

Describes an action that updates a CloudWatch log.

TODO: EXAMPLE

type CfnTopicRule_CloudwatchMetricActionProperty

type CfnTopicRule_CloudwatchMetricActionProperty struct {
	// The CloudWatch metric name.
	MetricName *string `json:"metricName"`
	// The CloudWatch metric namespace name.
	MetricNamespace *string `json:"metricNamespace"`
	// The [metric unit](https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#Unit) supported by CloudWatch.
	MetricUnit *string `json:"metricUnit"`
	// The CloudWatch metric value.
	MetricValue *string `json:"metricValue"`
	// The IAM role that allows access to the CloudWatch metric.
	RoleArn *string `json:"roleArn"`
	// An optional [Unix timestamp](https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#about_timestamp) .
	MetricTimestamp *string `json:"metricTimestamp"`
}

Describes an action that captures a CloudWatch metric.

TODO: EXAMPLE

type CfnTopicRule_DynamoDBActionProperty

type CfnTopicRule_DynamoDBActionProperty struct {
	// The hash key name.
	HashKeyField *string `json:"hashKeyField"`
	// The hash key value.
	HashKeyValue *string `json:"hashKeyValue"`
	// The ARN of the IAM role that grants access to the DynamoDB table.
	RoleArn *string `json:"roleArn"`
	// The name of the DynamoDB table.
	TableName *string `json:"tableName"`
	// The hash key type.
	//
	// Valid values are "STRING" or "NUMBER"
	HashKeyType *string `json:"hashKeyType"`
	// The action payload.
	//
	// This name can be customized.
	PayloadField *string `json:"payloadField"`
	// The range key name.
	RangeKeyField *string `json:"rangeKeyField"`
	// The range key type.
	//
	// Valid values are "STRING" or "NUMBER"
	RangeKeyType *string `json:"rangeKeyType"`
	// The range key value.
	RangeKeyValue *string `json:"rangeKeyValue"`
}

Describes an action to write to a DynamoDB table.

The `tableName` , `hashKeyField` , and `rangeKeyField` values must match the values used when you created the table.

The `hashKeyValue` and `rangeKeyvalue` fields use a substitution template syntax. These templates provide data at runtime. The syntax is as follows: ${ *sql-expression* }.

You can specify any valid expression in a WHERE or SELECT clause, including JSON properties, comparisons, calculations, and functions. For example, the following field uses the third level of the topic:

`"hashKeyValue": "${topic(3)}"`

The following field uses the timestamp:

`"rangeKeyValue": "${timestamp()}"`

For more information, see [DynamoDBv2 Action](https://docs.aws.amazon.com/iot/latest/developerguide/iot-rule-actions.html) in the *AWS IoT Developer Guide* .

TODO: EXAMPLE

type CfnTopicRule_DynamoDBv2ActionProperty

type CfnTopicRule_DynamoDBv2ActionProperty struct {
	// Specifies the DynamoDB table to which the message data will be written. For example:.
	//
	// `{ "dynamoDBv2": { "roleArn": "aws:iam:12341251:my-role" "putItem": { "tableName": "my-table" } } }`
	//
	// Each attribute in the message payload will be written to a separate column in the DynamoDB database.
	PutItem interface{} `json:"putItem"`
	// The ARN of the IAM role that grants access to the DynamoDB table.
	RoleArn *string `json:"roleArn"`
}

Describes an action to write to a DynamoDB table.

This DynamoDB action writes each attribute in the message payload into it's own column in the DynamoDB table.

TODO: EXAMPLE

type CfnTopicRule_ElasticsearchActionProperty

type CfnTopicRule_ElasticsearchActionProperty struct {
	// The endpoint of your OpenSearch domain.
	Endpoint *string `json:"endpoint"`
	// The unique identifier for the document you are storing.
	Id *string `json:"id"`
	// The index where you want to store your data.
	Index *string `json:"index"`
	// The IAM role ARN that has access to OpenSearch.
	RoleArn *string `json:"roleArn"`
	// The type of document you are storing.
	Type *string `json:"type"`
}

Describes an action that writes data to an Amazon OpenSearch Service domain.

> The `Elasticsearch` action can only be used by existing rule actions. To create a new rule action or to update an existing rule action, use the `OpenSearch` rule action instead. For more information, see [OpenSearchAction](https://docs.aws.amazon.com//iot/latest/apireference/API_OpenSearchAction.html) .

TODO: EXAMPLE

type CfnTopicRule_FirehoseActionProperty

type CfnTopicRule_FirehoseActionProperty struct {
	// The delivery stream name.
	DeliveryStreamName *string `json:"deliveryStreamName"`
	// The IAM role that grants access to the Amazon Kinesis Firehose stream.
	RoleArn *string `json:"roleArn"`
	// `CfnTopicRule.FirehoseActionProperty.BatchMode`.
	BatchMode interface{} `json:"batchMode"`
	// A character separator that will be used to separate records written to the Firehose stream.
	//
	// Valid values are: '\n' (newline), '\t' (tab), '\r\n' (Windows newline), ',' (comma).
	Separator *string `json:"separator"`
}

Describes an action that writes data to an Amazon Kinesis Firehose stream.

TODO: EXAMPLE

type CfnTopicRule_HttpActionHeaderProperty

type CfnTopicRule_HttpActionHeaderProperty struct {
	// The HTTP header key.
	Key *string `json:"key"`
	// The HTTP header value.
	//
	// Substitution templates are supported.
	Value *string `json:"value"`
}

The HTTP action header.

TODO: EXAMPLE

type CfnTopicRule_HttpActionProperty

type CfnTopicRule_HttpActionProperty struct {
	// The endpoint URL.
	//
	// If substitution templates are used in the URL, you must also specify a `confirmationUrl` . If this is a new destination, a new `TopicRuleDestination` is created if possible.
	Url *string `json:"url"`
	// The authentication method to use when sending data to an HTTPS endpoint.
	Auth interface{} `json:"auth"`
	// The URL to which AWS IoT sends a confirmation message.
	//
	// The value of the confirmation URL must be a prefix of the endpoint URL. If you do not specify a confirmation URL AWS IoT uses the endpoint URL as the confirmation URL. If you use substitution templates in the confirmationUrl, you must create and enable topic rule destinations that match each possible value of the substitution template before traffic is allowed to your endpoint URL.
	ConfirmationUrl *string `json:"confirmationUrl"`
	// The HTTP headers to send with the message data.
	Headers interface{} `json:"headers"`
}

Send data to an HTTPS endpoint.

TODO: EXAMPLE

type CfnTopicRule_HttpAuthorizationProperty

type CfnTopicRule_HttpAuthorizationProperty struct {
	// Use Sig V4 authorization.
	//
	// For more information, see [Signature Version 4 Signing Process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) .
	Sigv4 interface{} `json:"sigv4"`
}

The authorization method used to send messages.

TODO: EXAMPLE

type CfnTopicRule_IotAnalyticsActionProperty

type CfnTopicRule_IotAnalyticsActionProperty struct {
	// The name of the IoT Analytics channel to which message data will be sent.
	ChannelName *string `json:"channelName"`
	// The ARN of the role which has a policy that grants IoT Analytics permission to send message data via IoT Analytics (iotanalytics:BatchPutMessage).
	RoleArn *string `json:"roleArn"`
	// `CfnTopicRule.IotAnalyticsActionProperty.BatchMode`.
	BatchMode interface{} `json:"batchMode"`
}

Sends message data to an AWS IoT Analytics channel.

TODO: EXAMPLE

type CfnTopicRule_IotEventsActionProperty

type CfnTopicRule_IotEventsActionProperty struct {
	// The name of the AWS IoT Events input.
	InputName *string `json:"inputName"`
	// The ARN of the role that grants AWS IoT permission to send an input to an AWS IoT Events detector.
	//
	// ("Action":"iotevents:BatchPutMessage").
	RoleArn *string `json:"roleArn"`
	// `CfnTopicRule.IotEventsActionProperty.BatchMode`.
	BatchMode interface{} `json:"batchMode"`
	// The ID of the message. The default `messageId` is a new UUID value.
	//
	// When `batchMode` is `true` , you can't specify a `messageId` --a new UUID value will be assigned.
	//
	// Assign a value to this property to ensure that only one input (message) with a given `messageId` will be processed by an AWS IoT Events detector.
	MessageId *string `json:"messageId"`
}

Sends an input to an AWS IoT Events detector.

TODO: EXAMPLE

type CfnTopicRule_IotSiteWiseActionProperty

type CfnTopicRule_IotSiteWiseActionProperty struct {
	// A list of asset property value entries.
	PutAssetPropertyValueEntries interface{} `json:"putAssetPropertyValueEntries"`
	// The ARN of the role that grants AWS IoT permission to send an asset property value to AWS IoT SiteWise.
	//
	// ( `"Action": "iotsitewise:BatchPutAssetPropertyValue"` ). The trust policy can restrict access to specific asset hierarchy paths.
	RoleArn *string `json:"roleArn"`
}

Describes an action to send data from an MQTT message that triggered the rule to AWS IoT SiteWise asset properties.

TODO: EXAMPLE

type CfnTopicRule_KafkaActionProperty

type CfnTopicRule_KafkaActionProperty struct {
	// Properties of the Apache Kafka producer client.
	ClientProperties interface{} `json:"clientProperties"`
	// The ARN of Kafka action's VPC `TopicRuleDestination` .
	DestinationArn *string `json:"destinationArn"`
	// The Kafka topic for messages to be sent to the Kafka broker.
	Topic *string `json:"topic"`
	// The Kafka message key.
	Key *string `json:"key"`
	// The Kafka message partition.
	Partition *string `json:"partition"`
}

Send messages to an Amazon Managed Streaming for Apache Kafka (Amazon MSK) or self-managed Apache Kafka cluster.

TODO: EXAMPLE

type CfnTopicRule_KinesisActionProperty

type CfnTopicRule_KinesisActionProperty struct {
	// The ARN of the IAM role that grants access to the Amazon Kinesis stream.
	RoleArn *string `json:"roleArn"`
	// The name of the Amazon Kinesis stream.
	StreamName *string `json:"streamName"`
	// The partition key.
	PartitionKey *string `json:"partitionKey"`
}

Describes an action to write data to an Amazon Kinesis stream.

TODO: EXAMPLE

type CfnTopicRule_LambdaActionProperty

type CfnTopicRule_LambdaActionProperty struct {
	// The ARN of the Lambda function.
	FunctionArn *string `json:"functionArn"`
}

Describes an action to invoke a Lambda function.

TODO: EXAMPLE

type CfnTopicRule_OpenSearchActionProperty

type CfnTopicRule_OpenSearchActionProperty struct {
	// The endpoint of your OpenSearch domain.
	Endpoint *string `json:"endpoint"`
	// The unique identifier for the document you are storing.
	Id *string `json:"id"`
	// The OpenSearch index where you want to store your data.
	Index *string `json:"index"`
	// The IAM role ARN that has access to OpenSearch.
	RoleArn *string `json:"roleArn"`
	// The type of document you are storing.
	Type *string `json:"type"`
}

Describes an action that writes data to an Amazon OpenSearch Service domain.

TODO: EXAMPLE

type CfnTopicRule_PutAssetPropertyValueEntryProperty

type CfnTopicRule_PutAssetPropertyValueEntryProperty struct {
	// A list of property values to insert that each contain timestamp, quality, and value (TQV) information.
	PropertyValues interface{} `json:"propertyValues"`
	// The ID of the AWS IoT SiteWise asset.
	//
	// You must specify either a `propertyAlias` or both an `aliasId` and a `propertyId` . Accepts substitution templates.
	AssetId *string `json:"assetId"`
	// Optional.
	//
	// A unique identifier for this entry that you can define to better track which message caused an error in case of failure. Accepts substitution templates. Defaults to a new UUID.
	EntryId *string `json:"entryId"`
	// The name of the property alias associated with your asset property.
	//
	// You must specify either a `propertyAlias` or both an `aliasId` and a `propertyId` . Accepts substitution templates.
	PropertyAlias *string `json:"propertyAlias"`
	// The ID of the asset's property.
	//
	// You must specify either a `propertyAlias` or both an `aliasId` and a `propertyId` . Accepts substitution templates.
	PropertyId *string `json:"propertyId"`
}

An asset property value entry containing the following information.

TODO: EXAMPLE

type CfnTopicRule_PutItemInputProperty

type CfnTopicRule_PutItemInputProperty struct {
	// The table where the message data will be written.
	TableName *string `json:"tableName"`
}

The input for the DynamoActionVS action that specifies the DynamoDB table to which the message data will be written.

TODO: EXAMPLE

type CfnTopicRule_RepublishActionProperty

type CfnTopicRule_RepublishActionProperty struct {
	// The ARN of the IAM role that grants access.
	RoleArn *string `json:"roleArn"`
	// The name of the MQTT topic.
	Topic *string `json:"topic"`
	// The Quality of Service (QoS) level to use when republishing messages.
	//
	// The default value is 0.
	Qos *float64 `json:"qos"`
}

Describes an action to republish to another topic.

TODO: EXAMPLE

type CfnTopicRule_S3ActionProperty

type CfnTopicRule_S3ActionProperty struct {
	// The Amazon S3 bucket.
	BucketName *string `json:"bucketName"`
	// The object key.
	//
	// For more information, see [Actions, resources, and condition keys for Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/list_amazons3.html) .
	Key *string `json:"key"`
	// The ARN of the IAM role that grants access.
	RoleArn *string `json:"roleArn"`
	// The Amazon S3 canned ACL that controls access to the object identified by the object key.
	//
	// For more information, see [S3 canned ACLs](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl) .
	CannedAcl *string `json:"cannedAcl"`
}

Describes an action to write data to an Amazon S3 bucket.

TODO: EXAMPLE

type CfnTopicRule_SigV4AuthorizationProperty

type CfnTopicRule_SigV4AuthorizationProperty struct {
	// The ARN of the signing role.
	RoleArn *string `json:"roleArn"`
	// The service name to use while signing with Sig V4.
	ServiceName *string `json:"serviceName"`
	// The signing region.
	SigningRegion *string `json:"signingRegion"`
}

For more information, see [Signature Version 4 signing process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) .

TODO: EXAMPLE

type CfnTopicRule_SnsActionProperty

type CfnTopicRule_SnsActionProperty struct {
	// The ARN of the IAM role that grants access.
	RoleArn *string `json:"roleArn"`
	// The ARN of the SNS topic.
	TargetArn *string `json:"targetArn"`
	// (Optional) The message format of the message to publish.
	//
	// Accepted values are "JSON" and "RAW". The default value of the attribute is "RAW". SNS uses this setting to determine if the payload should be parsed and relevant platform-specific bits of the payload should be extracted. For more information, see [Amazon SNS Message and JSON Formats](https://docs.aws.amazon.com/sns/latest/dg/json-formats.html) in the *Amazon Simple Notification Service Developer Guide* .
	MessageFormat *string `json:"messageFormat"`
}

Describes an action to publish to an Amazon SNS topic.

TODO: EXAMPLE

type CfnTopicRule_SqsActionProperty

type CfnTopicRule_SqsActionProperty struct {
	// The URL of the Amazon SQS queue.
	QueueUrl *string `json:"queueUrl"`
	// The ARN of the IAM role that grants access.
	RoleArn *string `json:"roleArn"`
	// Specifies whether to use Base64 encoding.
	UseBase64 interface{} `json:"useBase64"`
}

Describes an action to publish data to an Amazon SQS queue.

TODO: EXAMPLE

type CfnTopicRule_StepFunctionsActionProperty

type CfnTopicRule_StepFunctionsActionProperty struct {
	// The ARN of the role that grants IoT permission to start execution of a state machine ("Action":"states:StartExecution").
	RoleArn *string `json:"roleArn"`
	// The name of the Step Functions state machine whose execution will be started.
	StateMachineName *string `json:"stateMachineName"`
	// (Optional) A name will be given to the state machine execution consisting of this prefix followed by a UUID.
	//
	// Step Functions automatically creates a unique name for each state machine execution if one is not provided.
	ExecutionNamePrefix *string `json:"executionNamePrefix"`
}

Starts execution of a Step Functions state machine.

TODO: EXAMPLE

type CfnTopicRule_TimestreamActionProperty

type CfnTopicRule_TimestreamActionProperty struct {
	// The name of an Amazon Timestream database that has the table to write records into.
	DatabaseName *string `json:"databaseName"`
	// Metadata attributes of the time series that are written in each measure record.
	Dimensions interface{} `json:"dimensions"`
	// The Amazon Resource Name (ARN) of the role that grants AWS IoT permission to write to the Timestream database table.
	RoleArn *string `json:"roleArn"`
	// The table where the message data will be written.
	TableName *string `json:"tableName"`
	// `CfnTopicRule.TimestreamActionProperty.BatchMode`.
	BatchMode interface{} `json:"batchMode"`
	// The value to use for the entry's timestamp.
	//
	// If blank, the time that the entry was processed is used.
	Timestamp interface{} `json:"timestamp"`
}

Describes an action that writes records into an Amazon Timestream table.

TODO: EXAMPLE

type CfnTopicRule_TimestreamDimensionProperty

type CfnTopicRule_TimestreamDimensionProperty struct {
	// The metadata dimension name.
	//
	// This is the name of the column in the Amazon Timestream database table record.
	Name *string `json:"name"`
	// The value to write in this column of the database record.
	Value *string `json:"value"`
}

Metadata attributes of the time series that are written in each measure record.

TODO: EXAMPLE

type CfnTopicRule_TimestreamTimestampProperty

type CfnTopicRule_TimestreamTimestampProperty struct {
	// The precision of the timestamp value that results from the expression described in `value` .
	Unit *string `json:"unit"`
	// An expression that returns a long epoch time value.
	Value *string `json:"value"`
}

The value to use for the entry's timestamp.

If blank, the time that the entry was processed is used.

TODO: EXAMPLE

type CfnTopicRule_TopicRulePayloadProperty

type CfnTopicRule_TopicRulePayloadProperty struct {
	// The actions associated with the rule.
	Actions interface{} `json:"actions"`
	// The SQL statement used to query the topic.
	//
	// For more information, see [AWS IoT SQL Reference](https://docs.aws.amazon.com/iot/latest/developerguide/iot-sql-reference.html) in the *AWS IoT Developer Guide* .
	Sql *string `json:"sql"`
	// The version of the SQL rules engine to use when evaluating the rule.
	//
	// The default value is 2015-10-08.
	AwsIotSqlVersion *string `json:"awsIotSqlVersion"`
	// The description of the rule.
	Description *string `json:"description"`
	// The action to take when an error occurs.
	ErrorAction interface{} `json:"errorAction"`
	// Specifies whether the rule is disabled.
	RuleDisabled interface{} `json:"ruleDisabled"`
}

Describes a rule.

TODO: EXAMPLE

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL