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

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

AWS Native v0.112.0 published on Wednesday, Jul 24, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.iot.ThingGroup

Explore with Pulumi AI

aws-native logo

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

AWS Native v0.112.0 published on Wednesday, Jul 24, 2024 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::IoT::ThingGroup

    Create ThingGroup Resource

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

    Constructor syntax

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

@overload
def ThingGroup(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               parent_group_name: Optional[str] = None,
               query_string: Optional[str] = None,
               tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
               thing_group_name: Optional[str] = None,
               thing_group_properties: Optional[ThingGroupPropertiesPropertiesArgs] = None)
    func NewThingGroup(ctx *Context, name string, args *ThingGroupArgs, opts ...ResourceOption) (*ThingGroup, error)
    public ThingGroup(string name, ThingGroupArgs? args = null, CustomResourceOptions? opts = null)
    public ThingGroup(String name, ThingGroupArgs args)
public ThingGroup(String name, ThingGroupArgs args, CustomResourceOptions options)

    type: aws-native:iot:ThingGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ThingGroupArgs
    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 ThingGroupArgs
    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 ThingGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ThingGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ThingGroupArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    ThingGroup 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 ThingGroup resource accepts the following input properties:

    ParentGroupName string

    The parent thing group name.

    A Dynamic Thing Group does not have parentGroupName defined.

    QueryString string

    The dynamic thing group search query string.

    The queryString attribute is required for CreateDynamicThingGroup . The queryString attribute is not required for CreateThingGroup .

    Tags List<Pulumi.AwsNative.Inputs.Tag>
    An array of key-value pairs to apply to this resource.
    ThingGroupName string
    The thing group name.
    ThingGroupProperties Pulumi.AwsNative.IoT.Inputs.ThingGroupPropertiesProperties
    Thing group properties.
    ParentGroupName string

    The parent thing group name.

    A Dynamic Thing Group does not have parentGroupName defined.

    QueryString string

    The dynamic thing group search query string.

    The queryString attribute is required for CreateDynamicThingGroup . The queryString attribute is not required for CreateThingGroup .

    Tags TagArgs
    An array of key-value pairs to apply to this resource.
    ThingGroupName string
    The thing group name.
    ThingGroupProperties ThingGroupPropertiesPropertiesArgs
    Thing group properties.
    parentGroupName String

    The parent thing group name.

    A Dynamic Thing Group does not have parentGroupName defined.

    queryString String

    The dynamic thing group search query string.

    The queryString attribute is required for CreateDynamicThingGroup . The queryString attribute is not required for CreateThingGroup .

    tags List<Tag>
    An array of key-value pairs to apply to this resource.
    thingGroupName String
    The thing group name.
    thingGroupProperties ThingGroupPropertiesProperties
    Thing group properties.
    parentGroupName string

    The parent thing group name.

    A Dynamic Thing Group does not have parentGroupName defined.

    queryString string

    The dynamic thing group search query string.

    The queryString attribute is required for CreateDynamicThingGroup . The queryString attribute is not required for CreateThingGroup .

    tags Tag[]
    An array of key-value pairs to apply to this resource.
    thingGroupName string
    The thing group name.
    thingGroupProperties ThingGroupPropertiesProperties
    Thing group properties.
    parent_group_name str

    The parent thing group name.

    A Dynamic Thing Group does not have parentGroupName defined.

    query_string str

    The dynamic thing group search query string.

    The queryString attribute is required for CreateDynamicThingGroup . The queryString attribute is not required for CreateThingGroup .

    tags Sequence[TagArgs]
    An array of key-value pairs to apply to this resource.
    thing_group_name str
    The thing group name.
    thing_group_properties ThingGroupPropertiesPropertiesArgs
    Thing group properties.
    parentGroupName String

    The parent thing group name.

    A Dynamic Thing Group does not have parentGroupName defined.

    queryString String

    The dynamic thing group search query string.

    The queryString attribute is required for CreateDynamicThingGroup . The queryString attribute is not required for CreateThingGroup .

    tags List<Property Map>
    An array of key-value pairs to apply to this resource.
    thingGroupName String
    The thing group name.
    thingGroupProperties Property Map
    Thing group properties.

    Outputs

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

    Arn string
    The thing group ARN.
    AwsId string
    The thing group ID.
    Id string
    The provider-assigned unique ID for this managed resource.
    Arn string
    The thing group ARN.
    AwsId string
    The thing group ID.
    Id string
    The provider-assigned unique ID for this managed resource.
    arn String
    The thing group ARN.
    awsId String
    The thing group ID.
    id String
    The provider-assigned unique ID for this managed resource.
    arn string
    The thing group ARN.
    awsId string
    The thing group ID.
    id string
    The provider-assigned unique ID for this managed resource.
    arn str
    The thing group ARN.
    aws_id str
    The thing group ID.
    id str
    The provider-assigned unique ID for this managed resource.
    arn String
    The thing group ARN.
    awsId String
    The thing group ID.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    ThingGroupAttributePayload, ThingGroupAttributePayloadArgs

    Attributes Dictionary<string, string>

    A JSON string containing up to three key-value pair in JSON format. For example:

    {\"attributes\":{\"string1\":\"string2\"}}

    Attributes map[string]string

    A JSON string containing up to three key-value pair in JSON format. For example:

    {\"attributes\":{\"string1\":\"string2\"}}

    attributes Map<String,String>

    A JSON string containing up to three key-value pair in JSON format. For example:

    {\"attributes\":{\"string1\":\"string2\"}}

    attributes {[key: string]: string}

    A JSON string containing up to three key-value pair in JSON format. For example:

    {\"attributes\":{\"string1\":\"string2\"}}

    attributes Mapping[str, str]

    A JSON string containing up to three key-value pair in JSON format. For example:

    {\"attributes\":{\"string1\":\"string2\"}}

    attributes Map<String>

    A JSON string containing up to three key-value pair in JSON format. For example:

    {\"attributes\":{\"string1\":\"string2\"}}

    ThingGroupPropertiesProperties, ThingGroupPropertiesPropertiesArgs

    AttributePayload Pulumi.AwsNative.IoT.Inputs.ThingGroupAttributePayload
    The thing group attributes in JSON format.
    ThingGroupDescription string
    The thing group description.
    AttributePayload ThingGroupAttributePayload
    The thing group attributes in JSON format.
    ThingGroupDescription string
    The thing group description.
    attributePayload ThingGroupAttributePayload
    The thing group attributes in JSON format.
    thingGroupDescription String
    The thing group description.
    attributePayload ThingGroupAttributePayload
    The thing group attributes in JSON format.
    thingGroupDescription string
    The thing group description.
    attribute_payload ThingGroupAttributePayload
    The thing group attributes in JSON format.
    thing_group_description str
    The thing group description.
    attributePayload Property Map
    The thing group attributes in JSON format.
    thingGroupDescription String
    The thing group description.

    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.112.0 published on Wednesday, Jul 24, 2024 by Pulumi
    pulumi/pulumi-aws-native