1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. iot
  5. Dimension

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi

aws-native.iot.Dimension

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi

A dimension can be used to limit the scope of a metric used in a security profile for AWS IoT Device Defender.

Example Usage

Example

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AwsNative = Pulumi.AwsNative;

return await Deployment.RunAsync(() => 
{
    var topicFilterForAuthMessagesDimension = new AwsNative.IoT.Dimension("topicFilterForAuthMessagesDimension", new()
    {
        Name = "TopicFilterForAuthMessages",
        Type = AwsNative.IoT.DimensionType.TopicFilter,
        StringValues = new[]
        {
            "device/+/auth",
        },
        Tags = new[]
        {
            new AwsNative.Inputs.TagArgs
            {
                Key = "Application",
                Value = "SmartHome",
            },
        },
    });

});
Copy
package main

import (
	awsnative "github.com/pulumi/pulumi-aws-native/sdk/go/aws"
	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/iot"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := iot.NewDimension(ctx, "topicFilterForAuthMessagesDimension", &iot.DimensionArgs{
			Name: pulumi.String("TopicFilterForAuthMessages"),
			Type: iot.DimensionTypeTopicFilter,
			StringValues: pulumi.StringArray{
				pulumi.String("device/+/auth"),
			},
			Tags: aws.TagArray{
				&aws.TagArgs{
					Key:   pulumi.String("Application"),
					Value: pulumi.String("SmartHome"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy

Coming soon!

import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";

const topicFilterForAuthMessagesDimension = new aws_native.iot.Dimension("topicFilterForAuthMessagesDimension", {
    name: "TopicFilterForAuthMessages",
    type: aws_native.iot.DimensionType.TopicFilter,
    stringValues: ["device/+/auth"],
    tags: [{
        key: "Application",
        value: "SmartHome",
    }],
});
Copy
import pulumi
import pulumi_aws_native as aws_native

topic_filter_for_auth_messages_dimension = aws_native.iot.Dimension("topicFilterForAuthMessagesDimension",
    name="TopicFilterForAuthMessages",
    type=aws_native.iot.DimensionType.TOPIC_FILTER,
    string_values=["device/+/auth"],
    tags=[{
        "key": "Application",
        "value": "SmartHome",
    }])
Copy

Coming soon!

Create Dimension Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Dimension(name: string, args: DimensionArgs, opts?: CustomResourceOptions);
@overload
def Dimension(resource_name: str,
              args: DimensionArgs,
              opts: Optional[ResourceOptions] = None)

@overload
def Dimension(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              string_values: Optional[Sequence[str]] = None,
              type: Optional[DimensionType] = None,
              name: Optional[str] = None,
              tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
func NewDimension(ctx *Context, name string, args DimensionArgs, opts ...ResourceOption) (*Dimension, error)
public Dimension(string name, DimensionArgs args, CustomResourceOptions? opts = null)
public Dimension(String name, DimensionArgs args)
public Dimension(String name, DimensionArgs args, CustomResourceOptions options)
type: aws-native:iot:Dimension
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. DimensionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. DimensionArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. DimensionArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. DimensionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. DimensionArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Dimension Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Dimension resource accepts the following input properties:

StringValues This property is required. List<string>
Specifies the value or list of values for the dimension.
Type This property is required. Pulumi.AwsNative.IoT.DimensionType
Specifies the type of the dimension.
Name string
A unique identifier for the dimension.
Tags List<Pulumi.AwsNative.Inputs.Tag>
Metadata that can be used to manage the dimension.
StringValues This property is required. []string
Specifies the value or list of values for the dimension.
Type This property is required. DimensionType
Specifies the type of the dimension.
Name string
A unique identifier for the dimension.
Tags TagArgs
Metadata that can be used to manage the dimension.
stringValues This property is required. List<String>
Specifies the value or list of values for the dimension.
type This property is required. DimensionType
Specifies the type of the dimension.
name String
A unique identifier for the dimension.
tags List<Tag>
Metadata that can be used to manage the dimension.
stringValues This property is required. string[]
Specifies the value or list of values for the dimension.
type This property is required. DimensionType
Specifies the type of the dimension.
name string
A unique identifier for the dimension.
tags Tag[]
Metadata that can be used to manage the dimension.
string_values This property is required. Sequence[str]
Specifies the value or list of values for the dimension.
type This property is required. DimensionType
Specifies the type of the dimension.
name str
A unique identifier for the dimension.
tags Sequence[TagArgs]
Metadata that can be used to manage the dimension.
stringValues This property is required. List<String>
Specifies the value or list of values for the dimension.
type This property is required. "TOPIC_FILTER"
Specifies the type of the dimension.
name String
A unique identifier for the dimension.
tags List<Property Map>
Metadata that can be used to manage the dimension.

Outputs

All input properties are implicitly available as output properties. Additionally, the Dimension resource produces the following output properties:

Arn string
The ARN (Amazon resource name) of the created dimension.
Id string
The provider-assigned unique ID for this managed resource.
Arn string
The ARN (Amazon resource name) of the created dimension.
Id string
The provider-assigned unique ID for this managed resource.
arn String
The ARN (Amazon resource name) of the created dimension.
id String
The provider-assigned unique ID for this managed resource.
arn string
The ARN (Amazon resource name) of the created dimension.
id string
The provider-assigned unique ID for this managed resource.
arn str
The ARN (Amazon resource name) of the created dimension.
id str
The provider-assigned unique ID for this managed resource.
arn String
The ARN (Amazon resource name) of the created dimension.
id String
The provider-assigned unique ID for this managed resource.

Supporting Types

DimensionType
, DimensionTypeArgs

TopicFilter
TOPIC_FILTER
DimensionTypeTopicFilter
TOPIC_FILTER
TopicFilter
TOPIC_FILTER
TopicFilter
TOPIC_FILTER
TOPIC_FILTER
TOPIC_FILTER
"TOPIC_FILTER"
TOPIC_FILTER

Tag
, TagArgs

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi