Class CfnDimension
A CloudFormation AWS::IoT::Dimension
.
Inherited Members
Namespace: Amazon.CDK.AWS.IoT
Assembly: Amazon.CDK.AWS.IoT.dll
Syntax (csharp)
public class CfnDimension : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnDimension
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
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 and for general information, see Scoping metrics in security profiles using dimensions .
CloudformationResource: AWS::IoT::Dimension
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-dimension.html
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.IoT;
var cfnDimension = new CfnDimension(this, "MyCfnDimension", new CfnDimensionProps {
StringValues = new [] { "stringValues" },
Type = "type",
// the properties below are optional
Name = "name",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnDimension(Construct, String, ICfnDimensionProps) | Create a new |
CfnDimension(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnDimension(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrArn | The Amazon Resource Name (ARN) of the dimension. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Name | A unique identifier for the dimension. |
StringValues | Specifies the value or list of values for the dimension. |
Tags | Metadata that can be used to manage the dimension. |
Type | Specifies the type of dimension. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnDimension(Construct, String, ICfnDimensionProps)
Create a new AWS::IoT::Dimension
.
public CfnDimension(Construct scope, string id, ICfnDimensionProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnDimensionProps
- resource properties.
CfnDimension(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnDimension(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnDimension(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnDimension(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrArn
The Amazon Resource Name (ARN) of the dimension.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Name
A unique identifier for the dimension.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
StringValues
Specifies the value or list of values for the dimension.
public virtual string[] StringValues { get; set; }
Property Value
System.String[]
Remarks
For TOPIC_FILTER
dimensions, this is a pattern used to match the MQTT topic (for example, "admin/#").
Tags
Metadata that can be used to manage the dimension.
public virtual TagManager Tags { get; }
Property Value
Remarks
Type
Specifies the type of dimension.
public virtual string Type { get; set; }
Property Value
System.String
Remarks
Supported types: TOPIC_FILTER.
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>