AWS Classic
getMulticastDomain
Get information on an EC2 Transit Gateway Multicast Domain.
Example Usage
By Filter
using Pulumi;
using Aws = Pulumi.Aws;
class MyStack : Stack
{
public MyStack()
{
var example = Output.Create(Aws.Ec2TransitGateway.GetMulticastDomain.InvokeAsync(new Aws.Ec2TransitGateway.GetMulticastDomainArgs
{
Filters =
{
new Aws.Ec2TransitGateway.Inputs.GetMulticastDomainFilterArgs
{
Name = "transit-gateway-multicast-domain-id",
Values =
{
"tgw-mcast-domain-12345678",
},
},
},
}));
}
}
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/ec2transitgateway"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := ec2transitgateway.LookupMulticastDomain(ctx, &ec2transitgateway.LookupMulticastDomainArgs{
Filters: []ec2transitgateway.GetMulticastDomainFilter{
ec2transitgateway.GetMulticastDomainFilter{
Name: "transit-gateway-multicast-domain-id",
Values: []string{
"tgw-mcast-domain-12345678",
},
},
},
}, nil)
if err != nil {
return err
}
return nil
})
}
package generated_program;
import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var example = Output.of(Ec2transitgatewayFunctions.getMulticastDomain(GetMulticastDomainArgs.builder()
.filters(GetMulticastDomainFilter.builder()
.name("transit-gateway-multicast-domain-id")
.values("tgw-mcast-domain-12345678")
.build())
.build()));
}
}
import pulumi
import pulumi_aws as aws
example = aws.ec2transitgateway.get_multicast_domain(filters=[aws.ec2transitgateway.GetMulticastDomainFilterArgs(
name="transit-gateway-multicast-domain-id",
values=["tgw-mcast-domain-12345678"],
)])
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = pulumi.output(aws.ec2transitgateway.getMulticastDomain({
filters: [{
name: "transit-gateway-multicast-domain-id",
values: ["tgw-mcast-domain-12345678"],
}],
}));
variables:
example:
Fn::Invoke:
Function: aws:ec2transitgateway:getMulticastDomain
Arguments:
filters:
- name: transit-gateway-multicast-domain-id
values:
- tgw-mcast-domain-12345678
By Identifier
using Pulumi;
using Aws = Pulumi.Aws;
class MyStack : Stack
{
public MyStack()
{
var example = Output.Create(Aws.Ec2TransitGateway.GetMulticastDomain.InvokeAsync(new Aws.Ec2TransitGateway.GetMulticastDomainArgs
{
TransitGatewayMulticastDomainId = "tgw-mcast-domain-12345678",
}));
}
}
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/ec2transitgateway"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := ec2transitgateway.LookupMulticastDomain(ctx, &ec2transitgateway.LookupMulticastDomainArgs{
TransitGatewayMulticastDomainId: pulumi.StringRef("tgw-mcast-domain-12345678"),
}, nil)
if err != nil {
return err
}
return nil
})
}
package generated_program;
import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var example = Output.of(Ec2transitgatewayFunctions.getMulticastDomain(GetMulticastDomainArgs.builder()
.transitGatewayMulticastDomainId("tgw-mcast-domain-12345678")
.build()));
}
}
import pulumi
import pulumi_aws as aws
example = aws.ec2transitgateway.get_multicast_domain(transit_gateway_multicast_domain_id="tgw-mcast-domain-12345678")
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = pulumi.output(aws.ec2transitgateway.getMulticastDomain({
transitGatewayMulticastDomainId: "tgw-mcast-domain-12345678",
}));
variables:
example:
Fn::Invoke:
Function: aws:ec2transitgateway:getMulticastDomain
Arguments:
transitGatewayMulticastDomainId: tgw-mcast-domain-12345678
Using getMulticastDomain
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 getMulticastDomain(args: GetMulticastDomainArgs, opts?: InvokeOptions): Promise<GetMulticastDomainResult>
function getMulticastDomainOutput(args: GetMulticastDomainOutputArgs, opts?: InvokeOptions): Output<GetMulticastDomainResult>
def get_multicast_domain(filters: Optional[Sequence[GetMulticastDomainFilter]] = None,
tags: Optional[Mapping[str, str]] = None,
transit_gateway_multicast_domain_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetMulticastDomainResult
def get_multicast_domain_output(filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetMulticastDomainFilterArgs]]]] = None,
tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
transit_gateway_multicast_domain_id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetMulticastDomainResult]
func LookupMulticastDomain(ctx *Context, args *LookupMulticastDomainArgs, opts ...InvokeOption) (*LookupMulticastDomainResult, error)
func LookupMulticastDomainOutput(ctx *Context, args *LookupMulticastDomainOutputArgs, opts ...InvokeOption) LookupMulticastDomainResultOutput
> Note: This function is named LookupMulticastDomain
in the Go SDK.
public static class GetMulticastDomain
{
public static Task<GetMulticastDomainResult> InvokeAsync(GetMulticastDomainArgs args, InvokeOptions? opts = null)
public static Output<GetMulticastDomainResult> Invoke(GetMulticastDomainInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetMulticastDomainResult> getMulticastDomain(GetMulticastDomainArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
Function: aws:ec2transitgateway/getMulticastDomain:getMulticastDomain
Arguments:
# Arguments dictionary
The following arguments are supported:
- Filters
List<Get
Multicast Domain Filter> One or more configuration blocks containing name-values filters. Detailed below.
- Dictionary<string, string>
Key-value tags for the EC2 Transit Gateway Multicast Domain.
- Transit
Gateway stringMulticast Domain Id Identifier of the EC2 Transit Gateway Multicast Domain.
- Filters
[]Get
Multicast Domain Filter One or more configuration blocks containing name-values filters. Detailed below.
- map[string]string
Key-value tags for the EC2 Transit Gateway Multicast Domain.
- Transit
Gateway stringMulticast Domain Id Identifier of the EC2 Transit Gateway Multicast Domain.
- filters
List
Multicast Domain Filter> One or more configuration blocks containing name-values filters. Detailed below.
- Map
Key-value tags for the EC2 Transit Gateway Multicast Domain.
- transit
Gateway StringMulticast Domain Id Identifier of the EC2 Transit Gateway Multicast Domain.
- filters
Get
Multicast Domain Filter[] One or more configuration blocks containing name-values filters. Detailed below.
- {[key: string]: string}
Key-value tags for the EC2 Transit Gateway Multicast Domain.
- transit
Gateway stringMulticast Domain Id Identifier of the EC2 Transit Gateway Multicast Domain.
- filters
Sequence[Get
Multicast Domain Filter] One or more configuration blocks containing name-values filters. Detailed below.
- Mapping[str, str]
Key-value tags for the EC2 Transit Gateway Multicast Domain.
- transit_
gateway_ strmulticast_ domain_ id Identifier of the EC2 Transit Gateway Multicast Domain.
- filters
List
One or more configuration blocks containing name-values filters. Detailed below.
- Map
Key-value tags for the EC2 Transit Gateway Multicast Domain.
- transit
Gateway StringMulticast Domain Id Identifier of the EC2 Transit Gateway Multicast Domain.
getMulticastDomain Result
The following output properties are available:
- Arn string
EC2 Transit Gateway Multicast Domain Amazon Resource Name (ARN).
- Associations
List<Get
Multicast Domain Association> EC2 Transit Gateway Multicast Domain Associations
- string
Whether to automatically accept cross-account subnet associations that are associated with the EC2 Transit Gateway Multicast Domain.
- Id string
The provider-assigned unique ID for this managed resource.
- Igmpv2Support string
Whether to enable Internet Group Management Protocol (IGMP) version 2 for the EC2 Transit Gateway Multicast Domain.
- Members
List<Get
Multicast Domain Member> EC2 Multicast Domain Group Members
- Owner
Id string Identifier of the AWS account that owns the EC2 Transit Gateway Multicast Domain.
- Sources
List<Get
Multicast Domain Source> EC2 Multicast Domain Group Sources
- State string
- Static
Sources stringSupport Whether to enable support for statically configuring multicast group sources for the EC2 Transit Gateway Multicast Domain.
- Dictionary<string, string>
Key-value tags for the EC2 Transit Gateway Multicast Domain.
- Transit
Gateway stringAttachment Id The ID of the transit gateway attachment.
- Transit
Gateway stringId EC2 Transit Gateway identifier.
- Transit
Gateway stringMulticast Domain Id - Filters
List<Get
Multicast Domain Filter>
- Arn string
EC2 Transit Gateway Multicast Domain Amazon Resource Name (ARN).
- Associations
[]Get
Multicast Domain Association Type EC2 Transit Gateway Multicast Domain Associations
- string
Whether to automatically accept cross-account subnet associations that are associated with the EC2 Transit Gateway Multicast Domain.
- Id string
The provider-assigned unique ID for this managed resource.
- Igmpv2Support string
Whether to enable Internet Group Management Protocol (IGMP) version 2 for the EC2 Transit Gateway Multicast Domain.
- Members
[]Get
Multicast Domain Member EC2 Multicast Domain Group Members
- Owner
Id string Identifier of the AWS account that owns the EC2 Transit Gateway Multicast Domain.
- Sources
[]Get
Multicast Domain Source EC2 Multicast Domain Group Sources
- State string
- Static
Sources stringSupport Whether to enable support for statically configuring multicast group sources for the EC2 Transit Gateway Multicast Domain.
- map[string]string
Key-value tags for the EC2 Transit Gateway Multicast Domain.
- Transit
Gateway stringAttachment Id The ID of the transit gateway attachment.
- Transit
Gateway stringId EC2 Transit Gateway identifier.
- Transit
Gateway stringMulticast Domain Id - Filters
[]Get
Multicast Domain Filter
- arn String
EC2 Transit Gateway Multicast Domain Amazon Resource Name (ARN).
- associations
List
Multicast Domain Association> EC2 Transit Gateway Multicast Domain Associations
- String
Whether to automatically accept cross-account subnet associations that are associated with the EC2 Transit Gateway Multicast Domain.
- id String
The provider-assigned unique ID for this managed resource.
- igmpv2Support String
Whether to enable Internet Group Management Protocol (IGMP) version 2 for the EC2 Transit Gateway Multicast Domain.
- members
List
Multicast Domain Member> EC2 Multicast Domain Group Members
- owner
Id String Identifier of the AWS account that owns the EC2 Transit Gateway Multicast Domain.
- sources
List
Multicast Domain Source> EC2 Multicast Domain Group Sources
- state String
- static
Sources StringSupport Whether to enable support for statically configuring multicast group sources for the EC2 Transit Gateway Multicast Domain.
- Map
Key-value tags for the EC2 Transit Gateway Multicast Domain.
- transit
Gateway StringAttachment Id The ID of the transit gateway attachment.
- transit
Gateway StringId EC2 Transit Gateway identifier.
- transit
Gateway StringMulticast Domain Id - filters
List
Multicast Domain Filter>
- arn string
EC2 Transit Gateway Multicast Domain Amazon Resource Name (ARN).
- associations
Get
Multicast Domain Association[] EC2 Transit Gateway Multicast Domain Associations
- string
Whether to automatically accept cross-account subnet associations that are associated with the EC2 Transit Gateway Multicast Domain.
- id string
The provider-assigned unique ID for this managed resource.
- igmpv2Support string
Whether to enable Internet Group Management Protocol (IGMP) version 2 for the EC2 Transit Gateway Multicast Domain.
- members
Get
Multicast Domain Member[] EC2 Multicast Domain Group Members
- owner
Id string Identifier of the AWS account that owns the EC2 Transit Gateway Multicast Domain.
- sources
Get
Multicast Domain Source[] EC2 Multicast Domain Group Sources
- state string
- static
Sources stringSupport Whether to enable support for statically configuring multicast group sources for the EC2 Transit Gateway Multicast Domain.
- {[key: string]: string}
Key-value tags for the EC2 Transit Gateway Multicast Domain.
- transit
Gateway stringAttachment Id The ID of the transit gateway attachment.
- transit
Gateway stringId EC2 Transit Gateway identifier.
- transit
Gateway stringMulticast Domain Id - filters
Get
Multicast Domain Filter[]
- arn str
EC2 Transit Gateway Multicast Domain Amazon Resource Name (ARN).
- associations
Sequence[Get
Multicast Domain Association] EC2 Transit Gateway Multicast Domain Associations
- str
Whether to automatically accept cross-account subnet associations that are associated with the EC2 Transit Gateway Multicast Domain.
- id str
The provider-assigned unique ID for this managed resource.
- igmpv2_
support str Whether to enable Internet Group Management Protocol (IGMP) version 2 for the EC2 Transit Gateway Multicast Domain.
- members
Sequence[Get
Multicast Domain Member] EC2 Multicast Domain Group Members
- owner_
id str Identifier of the AWS account that owns the EC2 Transit Gateway Multicast Domain.
- sources
Sequence[Get
Multicast Domain Source] EC2 Multicast Domain Group Sources
- state str
- static_
sources_ strsupport Whether to enable support for statically configuring multicast group sources for the EC2 Transit Gateway Multicast Domain.
- Mapping[str, str]
Key-value tags for the EC2 Transit Gateway Multicast Domain.
- transit_
gateway_ strattachment_ id The ID of the transit gateway attachment.
- transit_
gateway_ strid EC2 Transit Gateway identifier.
- transit_
gateway_ strmulticast_ domain_ id - filters
Sequence[Get
Multicast Domain Filter]
- arn String
EC2 Transit Gateway Multicast Domain Amazon Resource Name (ARN).
- associations
List
EC2 Transit Gateway Multicast Domain Associations
- String
Whether to automatically accept cross-account subnet associations that are associated with the EC2 Transit Gateway Multicast Domain.
- id String
The provider-assigned unique ID for this managed resource.
- igmpv2Support String
Whether to enable Internet Group Management Protocol (IGMP) version 2 for the EC2 Transit Gateway Multicast Domain.
- members
List
EC2 Multicast Domain Group Members
- owner
Id String Identifier of the AWS account that owns the EC2 Transit Gateway Multicast Domain.
- sources
List
EC2 Multicast Domain Group Sources
- state String
- static
Sources StringSupport Whether to enable support for statically configuring multicast group sources for the EC2 Transit Gateway Multicast Domain.
- Map
Key-value tags for the EC2 Transit Gateway Multicast Domain.
- transit
Gateway StringAttachment Id The ID of the transit gateway attachment.
- transit
Gateway StringId EC2 Transit Gateway identifier.
- transit
Gateway StringMulticast Domain Id - filters
List
Supporting Types
GetMulticastDomainAssociation
- Subnet
Id string The ID of the subnet associated with the transit gateway multicast domain.
- Transit
Gateway stringAttachment Id The ID of the transit gateway attachment.
- Subnet
Id string The ID of the subnet associated with the transit gateway multicast domain.
- Transit
Gateway stringAttachment Id The ID of the transit gateway attachment.
- subnet
Id String The ID of the subnet associated with the transit gateway multicast domain.
- transit
Gateway StringAttachment Id The ID of the transit gateway attachment.
- subnet
Id string The ID of the subnet associated with the transit gateway multicast domain.
- transit
Gateway stringAttachment Id The ID of the transit gateway attachment.
- subnet_
id str The ID of the subnet associated with the transit gateway multicast domain.
- transit_
gateway_ strattachment_ id The ID of the transit gateway attachment.
- subnet
Id String The ID of the subnet associated with the transit gateway multicast domain.
- transit
Gateway StringAttachment Id The ID of the transit gateway attachment.
GetMulticastDomainFilter
- Name string
The name of the field to filter by, as defined by the underlying AWS API.
- Values List<string>
Set of values that are accepted for the given field. A multicast domain will be selected if any one of the given values matches.
- Name string
The name of the field to filter by, as defined by the underlying AWS API.
- Values []string
Set of values that are accepted for the given field. A multicast domain will be selected if any one of the given values matches.
- name String
The name of the field to filter by, as defined by the underlying AWS API.
- values
List
Set of values that are accepted for the given field. A multicast domain will be selected if any one of the given values matches.
- name string
The name of the field to filter by, as defined by the underlying AWS API.
- values string[]
Set of values that are accepted for the given field. A multicast domain will be selected if any one of the given values matches.
- name str
The name of the field to filter by, as defined by the underlying AWS API.
- values Sequence[str]
Set of values that are accepted for the given field. A multicast domain will be selected if any one of the given values matches.
- name String
The name of the field to filter by, as defined by the underlying AWS API.
- values
List
Set of values that are accepted for the given field. A multicast domain will be selected if any one of the given values matches.
GetMulticastDomainMember
- Group
Ip stringAddress The IP address assigned to the transit gateway multicast group.
- Network
Interface stringId The group members' network interface ID.
- Group
Ip stringAddress The IP address assigned to the transit gateway multicast group.
- Network
Interface stringId The group members' network interface ID.
- group
Ip StringAddress The IP address assigned to the transit gateway multicast group.
- network
Interface StringId The group members' network interface ID.
- group
Ip stringAddress The IP address assigned to the transit gateway multicast group.
- network
Interface stringId The group members' network interface ID.
- group_
ip_ straddress The IP address assigned to the transit gateway multicast group.
- network_
interface_ strid The group members' network interface ID.
- group
Ip StringAddress The IP address assigned to the transit gateway multicast group.
- network
Interface StringId The group members' network interface ID.
GetMulticastDomainSource
- Group
Ip stringAddress The IP address assigned to the transit gateway multicast group.
- Network
Interface stringId The group members' network interface ID.
- Group
Ip stringAddress The IP address assigned to the transit gateway multicast group.
- Network
Interface stringId The group members' network interface ID.
- group
Ip StringAddress The IP address assigned to the transit gateway multicast group.
- network
Interface StringId The group members' network interface ID.
- group
Ip stringAddress The IP address assigned to the transit gateway multicast group.
- network
Interface stringId The group members' network interface ID.
- group_
ip_ straddress The IP address assigned to the transit gateway multicast group.
- network_
interface_ strid The group members' network interface ID.
- group
Ip StringAddress The IP address assigned to the transit gateway multicast group.
- network
Interface StringId The group members' network interface ID.
Package Details
- Repository
- https://github.com/pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
aws
Terraform Provider.