AWS Classic

v5.16.0 published on Saturday, Sep 24, 2022 by Pulumi

getMulticastDomain

Get information on an EC2 Transit Gateway Multicast Domain.

Example Usage

By Filter

using System.Collections.Generic;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = Aws.Ec2TransitGateway.GetMulticastDomain.Invoke(new()
    {
        Filters = new[]
        {
            new Aws.Ec2TransitGateway.Inputs.GetMulticastDomainFilterInputArgs
            {
                Name = "transit-gateway-multicast-domain-id",
                Values = new[]
                {
                    "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 com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ec2transitgateway.Ec2transitgatewayFunctions;
import com.pulumi.aws.ec2transitgateway.inputs.GetMulticastDomainArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = Ec2transitgatewayFunctions.getMulticastDomain(GetMulticastDomainArgs.builder()
            .filters(GetMulticastDomainFilterArgs.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 System.Collections.Generic;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = Aws.Ec2TransitGateway.GetMulticastDomain.Invoke(new()
    {
        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 com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ec2transitgateway.Ec2transitgatewayFunctions;
import com.pulumi.aws.ec2transitgateway.inputs.GetMulticastDomainArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = 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<GetMulticastDomainFilter>: One or more configuration blocks containing name-values filters. Detailed below.
Tags Dictionary<string, string>: Key-value tags for the EC2 Transit Gateway Multicast Domain.
TransitGatewayMulticastDomainId string: Identifier of the EC2 Transit Gateway Multicast Domain.

Filters []GetMulticastDomainFilter: One or more configuration blocks containing name-values filters. Detailed below.
Tags map[string]string: Key-value tags for the EC2 Transit Gateway Multicast Domain.
TransitGatewayMulticastDomainId string: Identifier of the EC2 Transit Gateway Multicast Domain.

filters List<GetMulticastDomainFilter>: One or more configuration blocks containing name-values filters. Detailed below.
tags Map<String,String>: Key-value tags for the EC2 Transit Gateway Multicast Domain.
transitGatewayMulticastDomainId String: Identifier of the EC2 Transit Gateway Multicast Domain.

filters GetMulticastDomainFilter[]: One or more configuration blocks containing name-values filters. Detailed below.
tags {[key: string]: string}: Key-value tags for the EC2 Transit Gateway Multicast Domain.
transitGatewayMulticastDomainId string: Identifier of the EC2 Transit Gateway Multicast Domain.

filters Sequence[GetMulticastDomainFilter]: One or more configuration blocks containing name-values filters. Detailed below.
tags Mapping[str, str]: Key-value tags for the EC2 Transit Gateway Multicast Domain.
transit_gateway_multicast_domain_id str: Identifier of the EC2 Transit Gateway Multicast Domain.

filters List<Property Map>: One or more configuration blocks containing name-values filters. Detailed below.
tags Map<String>: Key-value tags for the EC2 Transit Gateway Multicast Domain.
transitGatewayMulticastDomainId String: Identifier of the EC2 Transit Gateway Multicast Domain.

getMulticastDomain Result

The following output properties are available:

Arn string: EC2 Transit Gateway Multicast Domain ARN.
Associations List<GetMulticastDomainAssociation>: EC2 Transit Gateway Multicast Domain Associations
AutoAcceptSharedAssociations 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<GetMulticastDomainMember>: EC2 Multicast Domain Group Members
OwnerId string: Identifier of the AWS account that owns the EC2 Transit Gateway Multicast Domain.
Sources List<GetMulticastDomainSource>: EC2 Multicast Domain Group Sources
State string
StaticSourcesSupport string: Whether to enable support for statically configuring multicast group sources for the EC2 Transit Gateway Multicast Domain.
Tags Dictionary<string, string>: Key-value tags for the EC2 Transit Gateway Multicast Domain.
TransitGatewayAttachmentId string: The ID of the transit gateway attachment.
TransitGatewayId string: EC2 Transit Gateway identifier.
TransitGatewayMulticastDomainId string
Filters List<GetMulticastDomainFilter>

Arn string: EC2 Transit Gateway Multicast Domain ARN.
Associations []GetMulticastDomainAssociationType: EC2 Transit Gateway Multicast Domain Associations
AutoAcceptSharedAssociations 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 []GetMulticastDomainMember: EC2 Multicast Domain Group Members
OwnerId string: Identifier of the AWS account that owns the EC2 Transit Gateway Multicast Domain.
Sources []GetMulticastDomainSource: EC2 Multicast Domain Group Sources
State string
StaticSourcesSupport string: Whether to enable support for statically configuring multicast group sources for the EC2 Transit Gateway Multicast Domain.
Tags map[string]string: Key-value tags for the EC2 Transit Gateway Multicast Domain.
TransitGatewayAttachmentId string: The ID of the transit gateway attachment.
TransitGatewayId string: EC2 Transit Gateway identifier.
TransitGatewayMulticastDomainId string
Filters []GetMulticastDomainFilter

arn String: EC2 Transit Gateway Multicast Domain ARN.
associations List<GetMulticastDomainAssociation>: EC2 Transit Gateway Multicast Domain Associations
autoAcceptSharedAssociations 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<GetMulticastDomainMember>: EC2 Multicast Domain Group Members
ownerId String: Identifier of the AWS account that owns the EC2 Transit Gateway Multicast Domain.
sources List<GetMulticastDomainSource>: EC2 Multicast Domain Group Sources
state String
staticSourcesSupport String: Whether to enable support for statically configuring multicast group sources for the EC2 Transit Gateway Multicast Domain.
tags Map<String,String>: Key-value tags for the EC2 Transit Gateway Multicast Domain.
transitGatewayAttachmentId String: The ID of the transit gateway attachment.
transitGatewayId String: EC2 Transit Gateway identifier.
transitGatewayMulticastDomainId String
filters List<GetMulticastDomainFilter>

arn string: EC2 Transit Gateway Multicast Domain ARN.
associations GetMulticastDomainAssociation[]: EC2 Transit Gateway Multicast Domain Associations
autoAcceptSharedAssociations 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 GetMulticastDomainMember[]: EC2 Multicast Domain Group Members
ownerId string: Identifier of the AWS account that owns the EC2 Transit Gateway Multicast Domain.
sources GetMulticastDomainSource[]: EC2 Multicast Domain Group Sources
state string
staticSourcesSupport string: Whether to enable support for statically configuring multicast group sources for the EC2 Transit Gateway Multicast Domain.
tags {[key: string]: string}: Key-value tags for the EC2 Transit Gateway Multicast Domain.
transitGatewayAttachmentId string: The ID of the transit gateway attachment.
transitGatewayId string: EC2 Transit Gateway identifier.
transitGatewayMulticastDomainId string
filters GetMulticastDomainFilter[]

arn str: EC2 Transit Gateway Multicast Domain ARN.
associations Sequence[GetMulticastDomainAssociation]: EC2 Transit Gateway Multicast Domain Associations
auto_accept_shared_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[GetMulticastDomainMember]: EC2 Multicast Domain Group Members
owner_id str: Identifier of the AWS account that owns the EC2 Transit Gateway Multicast Domain.
sources Sequence[GetMulticastDomainSource]: EC2 Multicast Domain Group Sources
state str
static_sources_support str: Whether to enable support for statically configuring multicast group sources for the EC2 Transit Gateway Multicast Domain.
tags Mapping[str, str]: Key-value tags for the EC2 Transit Gateway Multicast Domain.
transit_gateway_attachment_id str: The ID of the transit gateway attachment.
transit_gateway_id str: EC2 Transit Gateway identifier.
transit_gateway_multicast_domain_id str
filters Sequence[GetMulticastDomainFilter]

arn String: EC2 Transit Gateway Multicast Domain ARN.
associations List<Property Map>: EC2 Transit Gateway Multicast Domain Associations
autoAcceptSharedAssociations 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<Property Map>: EC2 Multicast Domain Group Members
ownerId String: Identifier of the AWS account that owns the EC2 Transit Gateway Multicast Domain.
sources List<Property Map>: EC2 Multicast Domain Group Sources
state String
staticSourcesSupport String: Whether to enable support for statically configuring multicast group sources for the EC2 Transit Gateway Multicast Domain.
tags Map<String>: Key-value tags for the EC2 Transit Gateway Multicast Domain.
transitGatewayAttachmentId String: The ID of the transit gateway attachment.
transitGatewayId String: EC2 Transit Gateway identifier.
transitGatewayMulticastDomainId String
filters List<Property Map>

Supporting Types

GetMulticastDomainAssociation

SubnetId string: The ID of the subnet associated with the transit gateway multicast domain.
TransitGatewayAttachmentId string: The ID of the transit gateway attachment.

SubnetId string: The ID of the subnet associated with the transit gateway multicast domain.
TransitGatewayAttachmentId string: The ID of the transit gateway attachment.

subnetId String: The ID of the subnet associated with the transit gateway multicast domain.
transitGatewayAttachmentId String: The ID of the transit gateway attachment.

subnetId string: The ID of the subnet associated with the transit gateway multicast domain.
transitGatewayAttachmentId string: The ID of the transit gateway attachment.

subnet_id str: The ID of the subnet associated with the transit gateway multicast domain.
transit_gateway_attachment_id str: The ID of the transit gateway attachment.

subnetId String: The ID of the subnet associated with the transit gateway multicast domain.
transitGatewayAttachmentId String: The ID of the transit gateway attachment.

GetMulticastDomainFilter

Name string: 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: 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: 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: 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: 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: 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.

GetMulticastDomainMember

GroupIpAddress string: The IP address assigned to the transit gateway multicast group.
NetworkInterfaceId string: The group members' network interface ID.

GroupIpAddress string: The IP address assigned to the transit gateway multicast group.
NetworkInterfaceId string: The group members' network interface ID.

groupIpAddress String: The IP address assigned to the transit gateway multicast group.
networkInterfaceId String: The group members' network interface ID.

groupIpAddress string: The IP address assigned to the transit gateway multicast group.
networkInterfaceId string: The group members' network interface ID.

group_ip_address str: The IP address assigned to the transit gateway multicast group.
network_interface_id str: The group members' network interface ID.

groupIpAddress String: The IP address assigned to the transit gateway multicast group.
networkInterfaceId String: The group members' network interface ID.

GetMulticastDomainSource

GroupIpAddress string: The IP address assigned to the transit gateway multicast group.
NetworkInterfaceId string: The group members' network interface ID.

GroupIpAddress string: The IP address assigned to the transit gateway multicast group.
NetworkInterfaceId string: The group members' network interface ID.

groupIpAddress String: The IP address assigned to the transit gateway multicast group.
networkInterfaceId String: The group members' network interface ID.

groupIpAddress string: The IP address assigned to the transit gateway multicast group.
networkInterfaceId string: The group members' network interface ID.

group_ip_address str: The IP address assigned to the transit gateway multicast group.
network_interface_id str: The group members' network interface ID.

groupIpAddress String: The IP address assigned to the transit gateway multicast group.
networkInterfaceId String: 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.