Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. iot
  5. getThingGroup

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

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.iot.getThingGroup

Explore with Pulumi AI

aws-native logo

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

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::IoT::ThingGroup

    Using getThingGroup

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getThingGroup(args: GetThingGroupArgs, opts?: InvokeOptions): Promise<GetThingGroupResult>
function getThingGroupOutput(args: GetThingGroupOutputArgs, opts?: InvokeOptions): Output<GetThingGroupResult>
    def get_thing_group(thing_group_name: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetThingGroupResult
def get_thing_group_output(thing_group_name: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetThingGroupResult]
    func LookupThingGroup(ctx *Context, args *LookupThingGroupArgs, opts ...InvokeOption) (*LookupThingGroupResult, error)
func LookupThingGroupOutput(ctx *Context, args *LookupThingGroupOutputArgs, opts ...InvokeOption) LookupThingGroupResultOutput

    > Note: This function is named LookupThingGroup in the Go SDK.

    public static class GetThingGroup 
{
    public static Task<GetThingGroupResult> InvokeAsync(GetThingGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetThingGroupResult> Invoke(GetThingGroupInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetThingGroupResult> getThingGroup(GetThingGroupArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: aws-native:iot:getThingGroup
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ThingGroupName string
    The thing group name.
    ThingGroupName string
    The thing group name.
    thingGroupName String
    The thing group name.
    thingGroupName string
    The thing group name.
    thing_group_name str
    The thing group name.
    thingGroupName String
    The thing group name.

    getThingGroup Result

    The following output properties are available:

    Arn string
    The thing group ARN.
    Id string
    The thing group ID.
    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.Outputs.Tag>
    An array of key-value pairs to apply to this resource.
    ThingGroupProperties Pulumi.AwsNative.IoT.Outputs.ThingGroupPropertiesProperties
    Thing group properties.
    Arn string
    The thing group ARN.
    Id string
    The thing group ID.
    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.
    ThingGroupProperties ThingGroupPropertiesProperties
    Thing group properties.
    arn String
    The thing group ARN.
    id String
    The thing group ID.
    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.
    thingGroupProperties ThingGroupPropertiesProperties
    Thing group properties.
    arn string
    The thing group ARN.
    id string
    The thing group ID.
    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.
    thingGroupProperties ThingGroupPropertiesProperties
    Thing group properties.
    arn str
    The thing group ARN.
    id str
    The thing group ID.
    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[root_Tag]
    An array of key-value pairs to apply to this resource.
    thing_group_properties ThingGroupPropertiesProperties
    Thing group properties.
    arn String
    The thing group ARN.
    id String
    The thing group ID.
    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.
    thingGroupProperties Property Map
    Thing group properties.

    Supporting Types

    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 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

    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

    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

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

    AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
    pulumi/pulumi-aws-native