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

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.97.0 published on Wednesday, Feb 21, 2024 by Pulumi

aws-native.iot.Dimension

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.97.0 published on Wednesday, Feb 21, 2024 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.IoT.Inputs.DimensionTagArgs
                {
                    Key = "Application",
                    Value = "SmartHome",
                },
            },
        });
    
    });
    
    package main
    
    import (
    	"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: []iot.DimensionTagArgs{
    				{
    					Key:   pulumi.String("Application"),
    					Value: pulumi.String("SmartHome"),
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    

    Coming soon!

    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=[aws_native.iot.DimensionTagArgs(
            key="Application",
            value="SmartHome",
        )])
    
    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",
        }],
    });
    

    Coming soon!

    Create Dimension Resource

    new Dimension(name: string, args: DimensionArgs, opts?: CustomResourceOptions);
    @overload
    def Dimension(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  name: Optional[str] = None,
                  string_values: Optional[Sequence[str]] = None,
                  tags: Optional[Sequence[DimensionTagArgs]] = None,
                  type: Optional[DimensionType] = None)
    @overload
    def Dimension(resource_name: str,
                  args: DimensionArgs,
                  opts: Optional[ResourceOptions] = 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.
    
    
    name string
    The unique name of the resource.
    args DimensionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args 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 string
    The unique name of the resource.
    args DimensionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DimensionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args 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

    The Dimension resource accepts the following input properties:

    StringValues List<string>
    Specifies the value or list of values for the dimension.
    Type Pulumi.AwsNative.IoT.DimensionType
    Specifies the type of the dimension.
    Name string
    A unique identifier for the dimension.
    Tags List<Pulumi.AwsNative.IoT.Inputs.DimensionTag>
    Metadata that can be used to manage the dimension.
    StringValues []string
    Specifies the value or list of values for the dimension.
    Type DimensionType
    Specifies the type of the dimension.
    Name string
    A unique identifier for the dimension.
    Tags []DimensionTagArgs
    Metadata that can be used to manage the dimension.
    stringValues List<String>
    Specifies the value or list of values for the dimension.
    type DimensionType
    Specifies the type of the dimension.
    name String
    A unique identifier for the dimension.
    tags List<DimensionTag>
    Metadata that can be used to manage the dimension.
    stringValues string[]
    Specifies the value or list of values for the dimension.
    type DimensionType
    Specifies the type of the dimension.
    name string
    A unique identifier for the dimension.
    tags DimensionTag[]
    Metadata that can be used to manage the dimension.
    string_values Sequence[str]
    Specifies the value or list of values for the dimension.
    type DimensionType
    Specifies the type of the dimension.
    name str
    A unique identifier for the dimension.
    tags Sequence[DimensionTagArgs]
    Metadata that can be used to manage the dimension.
    stringValues List<String>
    Specifies the value or list of values for the dimension.
    type "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

    DimensionTag, DimensionTagArgs

    Key string
    The tag's key.
    Value string
    The tag's value.
    Key string
    The tag's key.
    Value string
    The tag's value.
    key String
    The tag's key.
    value String
    The tag's value.
    key string
    The tag's key.
    value string
    The tag's value.
    key str
    The tag's key.
    value str
    The tag's value.
    key String
    The tag's key.
    value String
    The tag's value.

    DimensionType, DimensionTypeArgs

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

    Package Details

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

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.97.0 published on Wednesday, Feb 21, 2024 by Pulumi