1. Packages
  2. AWS Native
  3. API Docs
  4. iotwireless
  5. getMulticastGroup

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

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi

aws-native.iotwireless.getMulticastGroup

Explore with Pulumi AI

aws-native logo

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

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi

    Create and manage Multicast groups.

    Using getMulticastGroup

    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 getMulticastGroup(args: GetMulticastGroupArgs, opts?: InvokeOptions): Promise<GetMulticastGroupResult>
    function getMulticastGroupOutput(args: GetMulticastGroupOutputArgs, opts?: InvokeOptions): Output<GetMulticastGroupResult>
    def get_multicast_group(id: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetMulticastGroupResult
    def get_multicast_group_output(id: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetMulticastGroupResult]
    func LookupMulticastGroup(ctx *Context, args *LookupMulticastGroupArgs, opts ...InvokeOption) (*LookupMulticastGroupResult, error)
    func LookupMulticastGroupOutput(ctx *Context, args *LookupMulticastGroupOutputArgs, opts ...InvokeOption) LookupMulticastGroupResultOutput

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

    public static class GetMulticastGroup 
    {
        public static Task<GetMulticastGroupResult> InvokeAsync(GetMulticastGroupArgs args, InvokeOptions? opts = null)
        public static Output<GetMulticastGroupResult> Invoke(GetMulticastGroupInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetMulticastGroupResult> getMulticastGroup(GetMulticastGroupArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws-native:iotwireless:getMulticastGroup
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    Multicast group id. Returned after successful create.
    Id string
    Multicast group id. Returned after successful create.
    id String
    Multicast group id. Returned after successful create.
    id string
    Multicast group id. Returned after successful create.
    id str
    Multicast group id. Returned after successful create.
    id String
    Multicast group id. Returned after successful create.

    getMulticastGroup Result

    The following output properties are available:

    Arn string
    Multicast group arn. Returned after successful create.
    AssociateWirelessDevice string
    Wireless device to associate. Only for update request.
    Description string
    Multicast group description
    DisassociateWirelessDevice string
    Wireless device to disassociate. Only for update request.
    Id string
    Multicast group id. Returned after successful create.
    LoRaWan Pulumi.AwsNative.IoTWireless.Outputs.MulticastGroupLoRaWan
    Multicast group LoRaWAN
    Name string
    Name of Multicast group
    Status string
    Multicast group status. Returned after successful read.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    A list of key-value pairs that contain metadata for the Multicast group.
    Arn string
    Multicast group arn. Returned after successful create.
    AssociateWirelessDevice string
    Wireless device to associate. Only for update request.
    Description string
    Multicast group description
    DisassociateWirelessDevice string
    Wireless device to disassociate. Only for update request.
    Id string
    Multicast group id. Returned after successful create.
    LoRaWan MulticastGroupLoRaWan
    Multicast group LoRaWAN
    Name string
    Name of Multicast group
    Status string
    Multicast group status. Returned after successful read.
    Tags Tag
    A list of key-value pairs that contain metadata for the Multicast group.
    arn String
    Multicast group arn. Returned after successful create.
    associateWirelessDevice String
    Wireless device to associate. Only for update request.
    description String
    Multicast group description
    disassociateWirelessDevice String
    Wireless device to disassociate. Only for update request.
    id String
    Multicast group id. Returned after successful create.
    loRaWan MulticastGroupLoRaWan
    Multicast group LoRaWAN
    name String
    Name of Multicast group
    status String
    Multicast group status. Returned after successful read.
    tags List<Tag>
    A list of key-value pairs that contain metadata for the Multicast group.
    arn string
    Multicast group arn. Returned after successful create.
    associateWirelessDevice string
    Wireless device to associate. Only for update request.
    description string
    Multicast group description
    disassociateWirelessDevice string
    Wireless device to disassociate. Only for update request.
    id string
    Multicast group id. Returned after successful create.
    loRaWan MulticastGroupLoRaWan
    Multicast group LoRaWAN
    name string
    Name of Multicast group
    status string
    Multicast group status. Returned after successful read.
    tags Tag[]
    A list of key-value pairs that contain metadata for the Multicast group.
    arn str
    Multicast group arn. Returned after successful create.
    associate_wireless_device str
    Wireless device to associate. Only for update request.
    description str
    Multicast group description
    disassociate_wireless_device str
    Wireless device to disassociate. Only for update request.
    id str
    Multicast group id. Returned after successful create.
    lo_ra_wan MulticastGroupLoRaWan
    Multicast group LoRaWAN
    name str
    Name of Multicast group
    status str
    Multicast group status. Returned after successful read.
    tags Sequence[root_Tag]
    A list of key-value pairs that contain metadata for the Multicast group.
    arn String
    Multicast group arn. Returned after successful create.
    associateWirelessDevice String
    Wireless device to associate. Only for update request.
    description String
    Multicast group description
    disassociateWirelessDevice String
    Wireless device to disassociate. Only for update request.
    id String
    Multicast group id. Returned after successful create.
    loRaWan Property Map
    Multicast group LoRaWAN
    name String
    Name of Multicast group
    status String
    Multicast group status. Returned after successful read.
    tags List<Property Map>
    A list of key-value pairs that contain metadata for the Multicast group.

    Supporting Types

    MulticastGroupLoRaWan

    DlClass string
    Multicast group LoRaWAN DL Class
    RfRegion string
    Multicast group LoRaWAN RF region
    NumberOfDevicesInGroup int
    Multicast group number of devices in group. Returned after successful read.
    NumberOfDevicesRequested int
    Multicast group number of devices requested. Returned after successful read.
    DlClass string
    Multicast group LoRaWAN DL Class
    RfRegion string
    Multicast group LoRaWAN RF region
    NumberOfDevicesInGroup int
    Multicast group number of devices in group. Returned after successful read.
    NumberOfDevicesRequested int
    Multicast group number of devices requested. Returned after successful read.
    dlClass String
    Multicast group LoRaWAN DL Class
    rfRegion String
    Multicast group LoRaWAN RF region
    numberOfDevicesInGroup Integer
    Multicast group number of devices in group. Returned after successful read.
    numberOfDevicesRequested Integer
    Multicast group number of devices requested. Returned after successful read.
    dlClass string
    Multicast group LoRaWAN DL Class
    rfRegion string
    Multicast group LoRaWAN RF region
    numberOfDevicesInGroup number
    Multicast group number of devices in group. Returned after successful read.
    numberOfDevicesRequested number
    Multicast group number of devices requested. Returned after successful read.
    dl_class str
    Multicast group LoRaWAN DL Class
    rf_region str
    Multicast group LoRaWAN RF region
    number_of_devices_in_group int
    Multicast group number of devices in group. Returned after successful read.
    number_of_devices_requested int
    Multicast group number of devices requested. Returned after successful read.
    dlClass String
    Multicast group LoRaWAN DL Class
    rfRegion String
    Multicast group LoRaWAN RF region
    numberOfDevicesInGroup Number
    Multicast group number of devices in group. Returned after successful read.
    numberOfDevicesRequested Number
    Multicast group number of devices requested. Returned after successful read.

    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

    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 Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi